SSM / Client / resume_session

resume_session#

SSM.Client.resume_session(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.resume_session(
    SessionId='string'
)

Parameters:

SessionId (string) –

[REQUIRED]

The ID of the disconnected session to resume.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- SessionId (string) –
  
  The ID of the session.
- TokenValue (string) –
  
  An encrypted token value containing session and caller information. Used to authenticate the connection to the managed node.
- StreamUrl (string) –
  
  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 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.

Exceptions

SSM.Client.exceptions.DoesNotExistException
SSM.Client.exceptions.InternalServerError