Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ssm ]

resume-session

Description

Reconnects a session to an instance 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 is not intended for any other use.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  resume-session
--session-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--session-id (string)

The ID of the disconnected session to resume.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To resume a Session Manager session

This example resumes a Session Manager session with an instance after it has been disconnected.

Note that this interactive command requires the Session Manager plugin to be installed on the client machine making the call. For more information, see Install the Session Manager Plugin for the AWS CLI in the AWS Systems Manager User Guide.

Command:

aws ssm resume-session -session-id Dan-07a16060613c408b5

Output:

{
  "SessionId": "Dan-07a16060613c408b5",
  "TokenValue": "AAEAAVbTGsaOnyvcUoNGqifbv5r/8lgxuQljCuY8qVcvOnoBAAAAAFxtd3jIXAFUUXGTJ7zF/AWJPwDviOlF5p3dlAgrqVIVO6IEXhkHLz0/1gXKRKEME71E6TLOplLDJAMZ+kREejkZu4c5AxMkrQjMF+gtHP1bYJKTwtHQd1wjulPLexO8SHl7g5R/wekrj6WsDUpnEegFBfGftpAIz2GXQVfTJXKfkc5qepQ11C11DOIT2dozOqXgHwfQHfAKLErM5dWDZqKwyT1Z3iw7unQdm3p5qsbrugiOZ7CRANTE+ihfGa6MEJJ97Jmat/a2TspEnOjNn9Mvu5iwXIW2yCvWZrGUj+/QI5Xr7s1XJBEnSKR54o4fN0GV9RWl0RZsZm1m1ki0JJtiwwgZ",
  "StreamUrl": "wss://ssmmessages.us-east-1.amazonaws.com/v1/data-channel/Dan-07a16060613c408b5?role=publish_subscribe"
}

Output

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 instance.

StreamUrl -> (string)

A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance. 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 the AWS Systems Manager table of regions and endpoints in the AWS General Reference .

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