Skip to content

WorkspacesPool

Source code in docs_src/capo_workspaces/types/workspaces_pool.py
class WorkspacesPool(TypedDict, closed=True):
    pool_id: "capo_workspaces.types.workspaces_pool_id.WorkspacesPoolId"
    """<p>The identifier of a pool.</p>"""
    pool_arn: "capo_workspaces.types.arn.ARN"
    """<p>The Amazon Resource Name (ARN) for the pool.</p>"""
    capacity_status: "capo_workspaces.types.capacity_status.CapacityStatus"
    """<p>The capacity status for the pool</p>"""
    pool_name: "capo_workspaces.types.workspaces_pool_name.WorkspacesPoolName"
    """<p>The name of the pool.</p>"""
    description: NotRequired[
        "capo_workspaces.types.update_description.UpdateDescription"
    ]
    """<p>The description of the pool.</p>"""
    state: "capo_workspaces.types.workspaces_pool_state.WorkspacesPoolState"
    """<p>The current state of the pool.</p>"""
    created_at: "capo_workspaces.types.timestamp.Timestamp"
    """<p>The time the pool was created.</p>"""
    bundle_id: "capo_workspaces.types.bundle_id.BundleId"
    """<p>The identifier of the bundle used by the pool.</p>"""
    directory_id: "capo_workspaces.types.directory_id.DirectoryId"
    """<p>The identifier of the directory used by the pool.</p>"""
    errors: NotRequired[
        "capo_workspaces.types.workspaces_pool_errors.WorkspacesPoolErrors"
    ]
    """<p>The pool errors.</p>"""
    application_settings: NotRequired[
        "capo_workspaces.types.application_settings_response.ApplicationSettingsResponse"
    ]
    """<p>The persistent application settings for users of the pool.</p>"""
    timeout_settings: NotRequired[
        "capo_workspaces.types.timeout_settings.TimeoutSettings"
    ]
    """<p>The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.</p>"""
    running_mode: "capo_workspaces.types.pools_running_mode.PoolsRunningMode"
    """<p>The running mode of the pool.</p>"""

application_settings instance-attribute

application_settings: NotRequired[ApplicationSettingsResponse]

The persistent application settings for users of the pool.

bundle_id instance-attribute

bundle_id: BundleId

The identifier of the bundle used by the pool.

capacity_status instance-attribute

capacity_status: CapacityStatus

The capacity status for the pool

created_at instance-attribute

created_at: Timestamp

The time the pool was created.

description instance-attribute

description: NotRequired[UpdateDescription]

The description of the pool.

directory_id instance-attribute

directory_id: DirectoryId

The identifier of the directory used by the pool.

errors instance-attribute

errors: NotRequired[WorkspacesPoolErrors]

The pool errors.

pool_arn instance-attribute

pool_arn: ARN

The Amazon Resource Name (ARN) for the pool.

pool_id instance-attribute

The identifier of a pool.

pool_name instance-attribute

pool_name: WorkspacesPoolName

The name of the pool.

running_mode instance-attribute

running_mode: PoolsRunningMode

The running mode of the pool.

state instance-attribute

The current state of the pool.

timeout_settings instance-attribute

timeout_settings: NotRequired[TimeoutSettings]

The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.