Skip to content

ComputeCapacityStatus

Source code in docs_src/capo_appstream/types/compute_capacity_status.py
class ComputeCapacityStatus(TypedDict, closed=True):
    desired: NotRequired["capo_appstream.types.integer.Integer"]
    """<p>The desired number of streaming instances.</p>"""
    running: NotRequired["capo_appstream.types.integer.Integer"]
    """<p>The total number of simultaneous streaming instances that are running.</p>"""
    in_use: NotRequired["capo_appstream.types.integer.Integer"]
    """<p>The number of instances in use for streaming.</p>"""
    available: NotRequired["capo_appstream.types.integer.Integer"]
    """<p>The number of currently available instances that can be used to stream sessions.</p>"""
    desired_user_sessions: NotRequired["capo_appstream.types.integer.Integer"]
    """<p>The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your fleet can support in a steady state.</p> <p>DesiredUserSessionCapacity = ActualUserSessionCapacity + PendingUserSessionCapacity</p> <p>This only applies to multi-session fleets.</p>"""
    available_user_sessions: NotRequired["capo_appstream.types.integer.Integer"]
    """<p>The number of idle session slots currently available for user sessions.</p> <p>AvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessions</p> <p>This only applies to multi-session fleets.</p>"""
    active_user_sessions: NotRequired["capo_appstream.types.integer.Integer"]
    """<p>The number of user sessions currently being used for streaming sessions. This only applies to multi-session fleets.</p>"""
    actual_user_sessions: NotRequired["capo_appstream.types.integer.Integer"]
    """<p>The total number of session slots that are available for streaming or are currently streaming.</p> <p>ActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessions</p> <p>This only applies to multi-session fleets.</p>"""
    draining: NotRequired["capo_appstream.types.integer.Integer"]
    """<p>The number of instances in drain mode. This only applies to multi-session fleets.</p>"""
    drain_mode_active_user_sessions: NotRequired["capo_appstream.types.integer.Integer"]
    """<p>The number of active user sessions on instances in drain mode. This only applies to multi-session fleets.</p>"""
    drain_mode_unused_user_sessions: NotRequired["capo_appstream.types.integer.Integer"]
    """<p>The number of unused session slots on instances in drain mode that cannot be used for user session provisioning. This only applies to multi-session fleets.</p>"""

active_user_sessions instance-attribute

active_user_sessions: NotRequired[Integer]

The number of user sessions currently being used for streaming sessions. This only applies to multi-session fleets.

actual_user_sessions instance-attribute

actual_user_sessions: NotRequired[Integer]

The total number of session slots that are available for streaming or are currently streaming.

ActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessions

This only applies to multi-session fleets.

available instance-attribute

available: NotRequired[Integer]

The number of currently available instances that can be used to stream sessions.

available_user_sessions instance-attribute

available_user_sessions: NotRequired[Integer]

The number of idle session slots currently available for user sessions.

AvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessions

This only applies to multi-session fleets.

desired instance-attribute

desired: NotRequired[Integer]

The desired number of streaming instances.

desired_user_sessions instance-attribute

desired_user_sessions: NotRequired[Integer]

The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your fleet can support in a steady state.

DesiredUserSessionCapacity = ActualUserSessionCapacity + PendingUserSessionCapacity

This only applies to multi-session fleets.

drain_mode_active_user_sessions instance-attribute

drain_mode_active_user_sessions: NotRequired[Integer]

The number of active user sessions on instances in drain mode. This only applies to multi-session fleets.

drain_mode_unused_user_sessions instance-attribute

drain_mode_unused_user_sessions: NotRequired[Integer]

The number of unused session slots on instances in drain mode that cannot be used for user session provisioning. This only applies to multi-session fleets.

draining instance-attribute

draining: NotRequired[Integer]

The number of instances in drain mode. This only applies to multi-session fleets.

in_use instance-attribute

in_use: NotRequired[Integer]

The number of instances in use for streaming.

running instance-attribute

running: NotRequired[Integer]

The total number of simultaneous streaming instances that are running.