/

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

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

🟠480InvalidDocument

🟠481TargetNotConnected

🟠482InternalServerError

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'http://ssm.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data '{
    "Target": "string",
    "DocumentName": "string",
    "Reason": "string",
    "Parameters": {
        "property1": [
            "string"
        ],
        "property2": [
            "string"
        ]
    }
}'

Response Example

200 - Example 1

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

Modified at 2023-08-15 10:32:33