Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ResumeSession

Reconnects a session to a managed node after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.

Note

This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It isn't intended for any other use.

Request Syntax


{
   "SessionId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

SessionId

The ID of the disconnected session to resume.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 96.

Required: Yes

Response Syntax


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

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

SessionId

The ID of the session.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 96.

StreamUrl

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

region represents the Region identifier for an AWS Region supported by AWS 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.

Type: String

TokenValue

An encrypted token value containing session and caller information. Used to authenticate the connection to the managed node.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 300.

Errors

For information about the errors that are common to all actions, see Common Errors.

DoesNotExistException

Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.

For information about resource quotas in AWS Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

HTTP Status Code: 400

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

Examples

Example

This example illustrates one usage of ResumeSession.

Sample Request


POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ResumeSession
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240221T181144Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240221/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 50

{
    "SessionId": "John-Doe-0402960697EXAMPLE"
}

Sample Response


{{
    "SessionId": "John-Doe-0402960697EXAMPLE",
    "StreamUrl": "wss://ssmmessages.us-east-2.amazonaws.com/v1/data-channel/John-Doe-0402960697EXAMPLE?role=publish_subscribe",
    "TokenValue": "EXAMPLENPKTm3/39c3b3042cd2aEXAMPLE/a3f5ff34-9bc4-4d2c-a665-4d1c1EXAMPLE"
}