Skip to content

StartSessionResponse

Source code in docs_src/capo_ssm/types/start_session_response.py 
13
14
15
16
17
18
19
class StartSessionResponse(TypedDict, closed=True):
    session_id: NotRequired["capo_ssm.types.session_id.SessionId"]
    """<p>The ID of the session.</p>"""
    token_value: NotRequired["capo_ssm.types.token_value.TokenValue"]
    """<p>An encrypted token value containing session and caller information. This token is used to authenticate the connection to the managed node, and is valid only long enough to ensure the connection is successful. Never share your session's token.</p>"""
    stream_url: NotRequired["capo_ssm.types.stream_url.StreamUrl"]
    """<p>A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and receive output from the node. Format: <code>wss://ssmmessages.<b>region</b>.amazonaws.com/v1/data-channel/<b>session-id</b>?stream=(input|output)</code> </p> <p> <b>region</b> represents the Region identifier for an Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as <code>us-east-2</code> for the US East (Ohio) Region. For a list of supported <b>region</b> values, see the <b>Region</b> column in <a href="https://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region">Systems Manager service endpoints</a> in the <i>Amazon Web Services General Reference</i>.</p> <p> <b>session-id</b> represents the ID of a Session Manager session, such as <code>1a2b3c4dEXAMPLE</code>.</p>"""

session_id instance-attribute 

session_id: NotRequired[SessionId]

The ID of the session.

stream_url instance-attribute 

stream_url: NotRequired[StreamUrl]

A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and receive output from the node. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)

region represents the Region identifier for an Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference.

session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.

token_value instance-attribute 

token_value: NotRequired[TokenValue]

An encrypted token value containing session and caller information. This token is used to authenticate the connection to the managed node, and is valid only long enough to ensure the connection is successful. Never share your session's token.