/

The Amazon SSM multi-region endpoint

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

POST

Initiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.

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 '{
    "Target": "string",
    "DocumentName": "string",
    "Reason": "string",
    "Parameters": {
        "property1": [
            "string"
        ],
        "property2": [
            "string"
        ]
    }
}'

Response Example

200 - Example 1

{
    "SessionId": "string",
    "TokenValue": "string",
    "StreamUrl": "string"
}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

Target

string

required

The managed node to connect to for the session.

>= 1 characters<= 400 characters

DocumentName

string

optional

The name of the SSM document you want to use to define the type of session, input parameters, or preferences for the session. For example, SSM-SessionManagerRunShell. You can call the GetDocument API to verify the document exists before attempting to start a session. If no document name is provided, a shell to the managed node is launched by default. For more information, see Start a session in the Amazon Web Services Systems Manager User Guide.

Match pattern:

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

Reason

string

optional

The reason for connecting to the instance. This value is included in the details for the Amazon CloudWatch Events event created when you start the session.

>= 1 characters<= 256 characters

Match pattern:

^.{1,256}$

Parameters

object

optional

The values you want to specify for the parameters defined in the Session document.

Examples

Responses

🟢200Success

application/json

Body

SessionId

string

optional

The ID of the session.

>= 1 characters<= 96 characters

TokenValue

string

optional

An encrypted token value containing session and caller information. This token is used to authenticate the connection to the managed node, and is valid only long enough to ensure the connection is successful. Never share your session's token.

>= 0 characters<= 300 characters

StreamUrl

string

optional

A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and receive output from the node. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)

region represents the Region identifier for an Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference.

session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.

🟠480InvalidDocument

🟠481TargetNotConnected

🟠482InternalServerError