Session
Information about a Session Manager connection to a managed node.
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
- MaxSessionDuration
-
The maximum duration of a session before it terminates.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4.
Pattern:
^([1-9]|[1-9][0-9]|[1-9][0-9][0-9]|1[0-4][0-3][0-9]|1440)$Required: No
- OutputUrl
-
Reserved for future use.
Type: SessionManagerOutputUrl object
Required: No
- Owner
-
The ID of the Amazon Web Services user that started the session.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- Reason
-
The reason for connecting to the instance.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^.{1,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 | FailedRequired: No
- Target
-
The managed node that the Session Manager session connected to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 400.
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: