/AWS1/CL_SSMSESSION¶
Information about a Session Manager connection to a managed node.
CONSTRUCTOR
¶
IMPORTING¶
Optional arguments:¶
iv_sessionid
TYPE /AWS1/SSMSESSIONID
/AWS1/SSMSESSIONID
¶
The ID of the session.
iv_target
TYPE /AWS1/SSMSESSIONTARGET
/AWS1/SSMSESSIONTARGET
¶
The managed node that the Session Manager session connected to.
iv_status
TYPE /AWS1/SSMSESSIONSTATUS
/AWS1/SSMSESSIONSTATUS
¶
The status of the session. For example, "Connected" or "Terminated".
iv_startdate
TYPE /AWS1/SSMDATETIME
/AWS1/SSMDATETIME
¶
The date and time, in ISO-8601 Extended format, when the session began.
iv_enddate
TYPE /AWS1/SSMDATETIME
/AWS1/SSMDATETIME
¶
The date and time, in ISO-8601 Extended format, when the session was terminated.
iv_documentname
TYPE /AWS1/SSMDOCUMENTNAME
/AWS1/SSMDOCUMENTNAME
¶
The name of the Session Manager SSM document used to define the parameters and plugin settings for the session. For example,
SSM-SessionManagerRunShell
.
iv_owner
TYPE /AWS1/SSMSESSIONOWNER
/AWS1/SSMSESSIONOWNER
¶
The ID of the Amazon Web Services user that started the session.
iv_reason
TYPE /AWS1/SSMSESSIONREASON
/AWS1/SSMSESSIONREASON
¶
The reason for connecting to the instance.
iv_details
TYPE /AWS1/SSMSESSIONDETAILS
/AWS1/SSMSESSIONDETAILS
¶
Reserved for future use.
io_outputurl
TYPE REF TO /AWS1/CL_SSMSESSMANAGEROUTURL
/AWS1/CL_SSMSESSMANAGEROUTURL
¶
Reserved for future use.
iv_maxsessionduration
TYPE /AWS1/SSMMAXSESSIONDURATION
/AWS1/SSMMAXSESSIONDURATION
¶
The maximum duration of a session before it terminates.
iv_accesstype
TYPE /AWS1/SSMACCESSTYPE
/AWS1/SSMACCESSTYPE
¶
Standard
access type is the default for Session Manager sessions.JustInTime
is the access type for Just-in-time node access.
Queryable Attributes¶
SessionId¶
The ID of the session.
Accessible with the following methods¶
Method | Description |
---|---|
GET_SESSIONID() |
Getter for SESSIONID, with configurable default |
ASK_SESSIONID() |
Getter for SESSIONID w/ exceptions if field has no value |
HAS_SESSIONID() |
Determine if SESSIONID has a value |
Target¶
The managed node that the Session Manager session connected to.
Accessible with the following methods¶
Method | Description |
---|---|
GET_TARGET() |
Getter for TARGET, with configurable default |
ASK_TARGET() |
Getter for TARGET w/ exceptions if field has no value |
HAS_TARGET() |
Determine if TARGET has a value |
Status¶
The status of the session. For example, "Connected" or "Terminated".
Accessible with the following methods¶
Method | Description |
---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
StartDate¶
The date and time, in ISO-8601 Extended format, when the session began.
Accessible with the following methods¶
Method | Description |
---|---|
GET_STARTDATE() |
Getter for STARTDATE, with configurable default |
ASK_STARTDATE() |
Getter for STARTDATE w/ exceptions if field has no value |
HAS_STARTDATE() |
Determine if STARTDATE has a value |
EndDate¶
The date and time, in ISO-8601 Extended format, when the session was terminated.
Accessible with the following methods¶
Method | Description |
---|---|
GET_ENDDATE() |
Getter for ENDDATE, with configurable default |
ASK_ENDDATE() |
Getter for ENDDATE w/ exceptions if field has no value |
HAS_ENDDATE() |
Determine if ENDDATE has a value |
DocumentName¶
The name of the Session Manager SSM document used to define the parameters and plugin settings for the session. For example,
SSM-SessionManagerRunShell
.
Accessible with the following methods¶
Method | Description |
---|---|
GET_DOCUMENTNAME() |
Getter for DOCUMENTNAME, with configurable default |
ASK_DOCUMENTNAME() |
Getter for DOCUMENTNAME w/ exceptions if field has no value |
HAS_DOCUMENTNAME() |
Determine if DOCUMENTNAME has a value |
Owner¶
The ID of the Amazon Web Services user that started the session.
Accessible with the following methods¶
Method | Description |
---|---|
GET_OWNER() |
Getter for OWNER, with configurable default |
ASK_OWNER() |
Getter for OWNER w/ exceptions if field has no value |
HAS_OWNER() |
Determine if OWNER has a value |
Reason¶
The reason for connecting to the instance.
Accessible with the following methods¶
Method | Description |
---|---|
GET_REASON() |
Getter for REASON, with configurable default |
ASK_REASON() |
Getter for REASON w/ exceptions if field has no value |
HAS_REASON() |
Determine if REASON has a value |
Details¶
Reserved for future use.
Accessible with the following methods¶
Method | Description |
---|---|
GET_DETAILS() |
Getter for DETAILS, with configurable default |
ASK_DETAILS() |
Getter for DETAILS w/ exceptions if field has no value |
HAS_DETAILS() |
Determine if DETAILS has a value |
OutputUrl¶
Reserved for future use.
Accessible with the following methods¶
Method | Description |
---|---|
GET_OUTPUTURL() |
Getter for OUTPUTURL |
MaxSessionDuration¶
The maximum duration of a session before it terminates.
Accessible with the following methods¶
Method | Description |
---|---|
GET_MAXSESSIONDURATION() |
Getter for MAXSESSIONDURATION, with configurable default |
ASK_MAXSESSIONDURATION() |
Getter for MAXSESSIONDURATION w/ exceptions if field has no |
HAS_MAXSESSIONDURATION() |
Determine if MAXSESSIONDURATION has a value |
AccessType¶
Standard
access type is the default for Session Manager sessions.JustInTime
is the access type for Just-in-time node access.
Accessible with the following methods¶
Method | Description |
---|---|
GET_ACCESSTYPE() |
Getter for ACCESSTYPE, with configurable default |
ASK_ACCESSTYPE() |
Getter for ACCESSTYPE w/ exceptions if field has no value |
HAS_ACCESSTYPE() |
Determine if ACCESSTYPE has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_SESSIONLIST
¶
TYPES TT_SESSIONLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_SSMSESSION WITH DEFAULT KEY
.