/

The Amazon SSM multi-region endpoint

http://ssm.{region}.amazonaws.com

POST

Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "State": "Active",
    "MaxResults": 0,
    "NextToken": "string",
    "Filters": []
}'

Response Example

200 - Example 1

{
    "Sessions": [],
    "NextToken": "string"
}

Request

Query Params

MaxResults

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

State

enum<string>

required

The session status to retrieve a list of sessions for. For example, "Active".

Allowed values:

ActiveHistory

MaxResults

integer

optional

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

>= 1<= 200

NextToken

string

optional

The token for the next set of items to return. (You received this token from a previous call.)

Filters

array[object (SessionFilter) {2}]

optional

One or more filters to limit the type of sessions returned by the request.

>= 1 items<= 6 items

key

enum<string>

required

The name of the filter.

Allowed values:

InvokedAfterInvokedBeforeTargetOwnerStatusSessionId

value

string

required

The filter value. Valid values for each filter key are as follows:

InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started August 29, 2018, and later.
InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started before August 29, 2018.
Target: Specify a managed node to which session connections have been made.
Owner: Specify an Amazon Web Services user to see a list of sessions started by that user.
Status: Specify a valid session status to see a list of all sessions with that status. Status values you can specify include:
- Connected
- Connecting
- Disconnected
- Terminated
- Terminating
- Failed
SessionId: Specify a session ID to return details about the session.

>= 1 characters<= 400 characters

Examples

Responses

🟢200Success

application/json

Body

Sessions

array[object (Session) {11}]

optional

A list of sessions meeting the request parameters.

SessionId

string

optional

The ID of the session.

>= 1 characters<= 96 characters

Target

string

optional

The managed node that the Session Manager session connected to.

>= 1 characters<= 400 characters

Status

enum<string>

optional

The status of the session. For example, "Connected" or "Terminated".

Allowed values:

ConnectedConnectingDisconnectedTerminatedTerminatingFailed

StartDate

string <date-time>

optional

The date and time, in ISO-8601 Extended format, when the session began.

EndDate

string <date-time>

optional

The date and time, in ISO-8601 Extended format, when the session was terminated.

DocumentName

string

optional

The name of the Session Manager SSM document used to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell.

Match pattern:

^[a-zA-Z0-9_\-.]{3,128}$

Owner

string

optional

The ID of the Amazon Web Services user that started the session.

>= 1 characters<= 256 characters

Reason

string

optional

The reason for connecting to the instance.

>= 1 characters<= 256 characters

Match pattern:

^.{1,256}$

Details

string

optional

Reserved for future use.

>= 1 characters<= 1024 characters

OutputUrl

object

optional

Reserved for future use.

MaxSessionDuration

string

optional

The maximum duration of a session before it terminates.

>= 1 characters<= 4 characters

Match pattern:

^([1-9]|[1-9][0-9]|[1-9][0-9][0-9]|1[0-4][0-3][0-9]|1440)$

NextToken

string

optional

The token for the next set of items to return. (You received this token from a previous call.)

🟠480InternalServerError

🟠481InvalidFilterKey

🟠482InvalidNextToken