Skip to content

StartSessionRequest

Source code in docs_src/capo_ssm/types/start_session_request.py 
16
17
18
19
20
21
22
23
24
25
26
class StartSessionRequest(TypedDict, closed=True):
    target: "capo_ssm.types.session_target.SessionTarget"
    """<p>The managed node to connect to for the session.</p>"""
    document_name: NotRequired["capo_ssm.types.document_arn.DocumentARN"]
    """<p>The name of the SSM document you want to use to define the type of session, input parameters, or preferences for the session. For example, <code>SSM-SessionManagerRunShell</code>. You can call the <a>GetDocument</a> API to verify the document exists before attempting to start a session. If no document name is provided, a shell to the managed node is launched by default. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-sessions-start.html">Start a session</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>"""
    reason: NotRequired["capo_ssm.types.session_reason.SessionReason"]
    """<p>The reason for connecting to the instance. This value is included in the details for the Amazon CloudWatch Events event created when you start the session.</p>"""
    parameters: NotRequired[
        "capo_ssm.types.session_manager_parameters.SessionManagerParameters"
    ]
    """<p>The values you want to specify for the parameters defined in the Session document. For more information about these parameters, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/getting-started-create-preferences-cli.html">Create a Session Manager preferences document</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>"""

document_name instance-attribute 

document_name: NotRequired[DocumentARN]

The name of the SSM document you want to use to define the type of session, input parameters, or preferences for the session. For example, SSM-SessionManagerRunShell. You can call the GetDocument API to verify the document exists before attempting to start a session. If no document name is provided, a shell to the managed node is launched by default. For more information, see Start a session in the Amazon Web Services Systems Manager User Guide.

parameters instance-attribute 

parameters: NotRequired[SessionManagerParameters]

The values you want to specify for the parameters defined in the Session document. For more information about these parameters, see Create a Session Manager preferences document in the Amazon Web Services Systems Manager User Guide.

reason instance-attribute 

reason: NotRequired[SessionReason]

The reason for connecting to the instance. This value is included in the details for the Amazon CloudWatch Events event created when you start the session.

target instance-attribute 

target: SessionTarget

The managed node to connect to for the session.