Session ¶

class Session(TypedDict, closed=True):
    id: NotRequired["capo_appstream.types.string.String"]
    """<p>The identifier of the streaming session.</p>"""
    user_id: NotRequired["capo_appstream.types.user_id.UserId"]
    """<p>The identifier of the user for whom the session was created.</p>"""
    stack_name: NotRequired["capo_appstream.types.string.String"]
    """<p>The name of the stack for the streaming session.</p>"""
    fleet_name: NotRequired["capo_appstream.types.string.String"]
    """<p>The name of the fleet for the streaming session.</p>"""
    state: NotRequired["capo_appstream.types.session_state.SessionState"]
    """<p>The current state of the streaming session.</p>"""
    connection_state: NotRequired[
        "capo_appstream.types.session_connection_state.SessionConnectionState"
    ]
    """<p>Specifies whether a user is connected to the streaming session.</p>"""
    start_time: NotRequired["capo_appstream.types.timestamp.Timestamp"]
    """<p>The time when a streaming instance is dedicated for the user.</p>"""
    max_expiration_time: NotRequired["capo_appstream.types.timestamp.Timestamp"]
    """<p>The time when the streaming session is set to expire. This time is based on the <code>MaxUserDurationinSeconds</code> value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in <code>SessionMaxExpirationTime</code>, when the <code>DisconnectTimeOutInSeconds</code> elapses or the user chooses to end his or her session. If the <code>DisconnectTimeOutInSeconds</code> elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.</p>"""
    authentication_type: NotRequired[
        "capo_appstream.types.authentication_type.AuthenticationType"
    ]
    """<p>The authentication method. The user is authenticated using a streaming URL (<code>API</code>) or SAML 2.0 federation (<code>SAML</code>).</p>"""
    network_access_configuration: NotRequired[
        "capo_appstream.types.network_access_configuration.NetworkAccessConfiguration"
    ]
    """<p>The network details for the streaming session.</p>"""
    instance_id: NotRequired["capo_appstream.types.string.String"]
    """<p>The identifier for the instance hosting the session.</p>"""
    instance_drain_status: NotRequired[
        "capo_appstream.types.instance_drain_status.InstanceDrainStatus"
    ]
    """<p>The drain status of the instance hosting the streaming session. This only applies to multi-session fleets.</p>"""