CapacityStatus - Amazon WorkSpaces Service

CapacityStatus

Describes the capacity status for a pool of WorkSpaces.

Contents

ActiveUserSessions

The number of user sessions currently being used for your pool.

Type: Integer

Valid Range: Minimum value of 0.

Required: Yes

ActualUserSessions

The total number of user sessions that are available for streaming or are currently streaming in your pool.

ActualUserSessions = AvailableUserSessions + ActiveUserSessions

Type: Integer

Valid Range: Minimum value of 0.

Required: Yes

AvailableUserSessions

The number of user sessions currently available for streaming from your pool.

AvailableUserSessions = ActualUserSessions - ActiveUserSessions

Type: Integer

Valid Range: Minimum value of 0.

Required: Yes

DesiredUserSessions

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

Type: Integer

Valid Range: Minimum value of 0.

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: