Table Of Contents

Feedback

User Guide

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

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ssm ]

terminate-session

Description

Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance. A terminated session cannot be resumed.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

--session-id (string)

The ID of the session to terminate.

--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 end a Session Manager session

This terminate-session example permanently ends a session that was created by the user "Shirley-Rodriguez" and closes the data connection between the Session Manager client and SSM Agent on the instance.

aws ssm terminate-session \
    --session-id "Shirley-Rodriguez-07a16060613c408b5"

Output:

{
    "SessionId": "Shirley-Rodriguez-07a16060613c408b5"
}

For more information, see Terminate a Session in the AWS Systems Manager User Guide.

Output

SessionId -> (string)

The ID of the session that has been terminated.