TerminateSession - AWS Systems Manager

TerminateSession

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.

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 session to terminate.

Type: String

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

Required: Yes

Response Syntax

{ "SessionId": "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 that has been terminated.

Type: String

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

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 Systems Manager, see Systems Manager service quotas in the AWS General Reference.

HTTP Status Code: 400

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

Example

Sample Request

POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.TerminateSession 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: 20200221T182708Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20200221/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" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: