Skip to content

Session

Source code in docs_src/capo_ssm/types/session.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
class Session(TypedDict, closed=True):
    session_id: NotRequired["capo_ssm.types.session_id.SessionId"]
    """<p>The ID of the session.</p>"""
    target: NotRequired["capo_ssm.types.session_target.SessionTarget"]
    """<p>The managed node that the Session Manager session connected to.</p>"""
    status: NotRequired["capo_ssm.types.session_status.SessionStatus"]
    """<p>The status of the session. For example, "Connected" or "Terminated".</p>"""
    start_date: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>The date and time, in ISO-8601 Extended format, when the session began.</p>"""
    end_date: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>The date and time, in ISO-8601 Extended format, when the session was terminated.</p>"""
    document_name: NotRequired["capo_ssm.types.document_name.DocumentName"]
    """<p>The name of the Session Manager SSM document used to define the parameters and plugin settings for the session. For example, <code>SSM-SessionManagerRunShell</code>.</p>"""
    owner: NotRequired["capo_ssm.types.session_owner.SessionOwner"]
    """<p>The ID of the Amazon Web Services user that started the session.</p>"""
    reason: NotRequired["capo_ssm.types.session_reason.SessionReason"]
    """<p>The reason for connecting to the instance.</p>"""
    details: NotRequired["capo_ssm.types.session_details.SessionDetails"]
    """<p>Reserved for future use.</p>"""
    output_url: NotRequired[
        "capo_ssm.types.session_manager_output_url.SessionManagerOutputUrl"
    ]
    """<p>Reserved for future use.</p>"""
    max_session_duration: NotRequired[
        "capo_ssm.types.max_session_duration.MaxSessionDuration"
    ]
    """<p>The maximum duration of a session before it terminates.</p>"""
    access_type: NotRequired["capo_ssm.types.access_type.AccessType"]
    """<p> <code>Standard</code> access type is the default for Session Manager sessions. <code>JustInTime</code> is the access type for <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-just-in-time-node-access.html">Just-in-time node access</a>.</p>"""

access_type instance-attribute 

access_type: NotRequired[AccessType]

Standard access type is the default for Session Manager sessions. JustInTime is the access type for Just-in-time node access.

details instance-attribute 

details: NotRequired[SessionDetails]

Reserved for future use.

document_name instance-attribute 

document_name: NotRequired[DocumentName]

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

end_date instance-attribute 

end_date: NotRequired[DateTime]

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

max_session_duration instance-attribute 

max_session_duration: NotRequired[MaxSessionDuration]

The maximum duration of a session before it terminates.

output_url instance-attribute 

output_url: NotRequired[SessionManagerOutputUrl]

Reserved for future use.

owner instance-attribute 

owner: NotRequired[SessionOwner]

The ID of the Amazon Web Services user that started the session.

reason instance-attribute 

reason: NotRequired[SessionReason]

The reason for connecting to the instance.

session_id instance-attribute 

session_id: NotRequired[SessionId]

The ID of the session.

start_date instance-attribute 

start_date: NotRequired[DateTime]

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

status instance-attribute 

status: NotRequired[SessionStatus]

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

target instance-attribute 

target: NotRequired[SessionTarget]

The managed node that the Session Manager session connected to.