Skip to content

WorkspacesPoolSession

Source code in docs_src/capo_workspaces/types/workspaces_pool_session.py
class WorkspacesPoolSession(TypedDict, closed=True):
    authentication_type: NotRequired[
        "capo_workspaces.types.authentication_type.AuthenticationType"
    ]
    """<p>The authentication method. The user is authenticated using a WorkSpaces Pools URL (API) or SAML 2.0 federation (SAML).</p>"""
    connection_state: NotRequired[
        "capo_workspaces.types.session_connection_state.SessionConnectionState"
    ]
    """<p>Specifies whether a user is connected to the pool session.</p>"""
    session_id: "capo_workspaces.types.amazon_uuid.AmazonUuid"
    """<p>The identifier of the session.</p>"""
    instance_id: NotRequired[
        "capo_workspaces.types.session_instance_id.SessionInstanceId"
    ]
    """<p>The identifier for the instance hosting the session.</p>"""
    pool_id: "capo_workspaces.types.workspaces_pool_id.WorkspacesPoolId"
    """<p>The identifier of the pool.</p>"""
    expiration_time: NotRequired["capo_workspaces.types.timestamp.Timestamp"]
    """<p>The time that the pool session ended.</p>"""
    network_access_configuration: NotRequired[
        "capo_workspaces.types.network_access_configuration.NetworkAccessConfiguration"
    ]
    """<p>Describes the network details of the pool.</p>"""
    start_time: NotRequired["capo_workspaces.types.timestamp.Timestamp"]
    """<p>The time that the pool sission started.</p>"""
    user_id: "capo_workspaces.types.workspaces_pool_user_id.WorkspacesPoolUserId"
    """<p>The identifier of the user.</p>"""

authentication_type instance-attribute

authentication_type: NotRequired[AuthenticationType]

The authentication method. The user is authenticated using a WorkSpaces Pools URL (API) or SAML 2.0 federation (SAML).

connection_state instance-attribute

connection_state: NotRequired[SessionConnectionState]

Specifies whether a user is connected to the pool session.

expiration_time instance-attribute

expiration_time: NotRequired[Timestamp]

The time that the pool session ended.

instance_id instance-attribute

instance_id: NotRequired[SessionInstanceId]

The identifier for the instance hosting the session.

network_access_configuration instance-attribute

network_access_configuration: NotRequired[NetworkAccessConfiguration]

Describes the network details of the pool.

pool_id instance-attribute

The identifier of the pool.

session_id instance-attribute

session_id: AmazonUuid

The identifier of the session.

start_time instance-attribute

start_time: NotRequired[Timestamp]

The time that the pool sission started.

user_id instance-attribute

The identifier of the user.