AWS Systems Manager
API Reference (API Version 2014-11-06)

Session

Information about a Session Manager connection to an instance.

Contents

Details

Reserved for future use.

Type: String

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

Required: No

DocumentName

The name of the Session Manager SSM document used to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell.

Type: String

Pattern: ^[a-zA-Z0-9_\-.]{3,128}$

Required: No

EndDate

The date and time, in ISO-8601 Extended format, when the session was terminated.

Type: Timestamp

Required: No

OutputUrl

Reserved for future use.

Type: SessionManagerOutputUrl object

Required: No

Owner

The ID of the AWS user account that started the session.

Type: String

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

Required: No

SessionId

The ID of the session.

Type: String

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

Required: No

StartDate

The date and time, in ISO-8601 Extended format, when the session began.

Type: Timestamp

Required: No

Status

The status of the session. For example, "Connected" or "Terminated".

Type: String

Valid Values: Connected | Connecting | Disconnected | Terminated | Terminating | Failed

Required: No

Target

The instance that the Session Manager session connected to.

Type: String

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

Required: No

See Also

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

On this page: