Skip to content

TimeoutSettings

Used by
Source code in docs_src/capo_workspaces/types/timeout_settings.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
class TimeoutSettings(TypedDict, closed=True):
    disconnect_timeout_in_seconds: NotRequired[
        "capo_workspaces.types.disconnect_timeout_in_seconds.DisconnectTimeoutInSeconds"
    ]
    """<p>Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.</p>"""
    idle_disconnect_timeout_in_seconds: NotRequired[
        "capo_workspaces.types.idle_disconnect_timeout_in_seconds.IdleDisconnectTimeoutInSeconds"
    ]
    """<p>The amount of time in seconds a connection will stay active while idle.</p>"""
    max_user_duration_in_seconds: NotRequired[
        "capo_workspaces.types.max_user_duration_in_seconds.MaxUserDurationInSeconds"
    ]
    """<p>Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.</p>"""

disconnect_timeout_in_seconds instance-attribute 

disconnect_timeout_in_seconds: NotRequired[DisconnectTimeoutInSeconds]

Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

idle_disconnect_timeout_in_seconds instance-attribute 

idle_disconnect_timeout_in_seconds: NotRequired[IdleDisconnectTimeoutInSeconds]

The amount of time in seconds a connection will stay active while idle.

max_user_duration_in_seconds instance-attribute 

max_user_duration_in_seconds: NotRequired[MaxUserDurationInSeconds]

Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.