Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

WorkspacesPool - Amazon WorkSpaces Service

WorkspacesPool

Describes a pool of WorkSpaces.

Contents

BundleId

The identifier of the bundle used by the pool.

Type: String

Pattern: ^wsb-[0-9a-z]{8,63}$

Required: Yes

CapacityStatus

The capacity status for the pool

Type: CapacityStatus object

Required: Yes

CreatedAt

The time the pool was created.

Type: Timestamp

Required: Yes

DirectoryId

The identifier of the directory used by the pool.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 65.

Pattern: ^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)

Required: Yes

PoolArn

The Amazon Resource Name (ARN) for the pool.

Type: String

Pattern: ^arn:aws[a-z-]{0,7}:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-]{0,1023}$

Required: Yes

PoolId

The identifier of a pool.

Type: String

Pattern: ^wspool-[0-9a-z]{9}$

Required: Yes

PoolName

The name of the pool,

Type: String

Pattern: ^[A-Za-z0-9][A-Za-z0-9_.-]{0,63}$

Required: Yes

State

The current state of the pool.

Type: String

Valid Values: CREATING | DELETING | RUNNING | STARTING | STOPPED | STOPPING | UPDATING

Required: Yes

ApplicationSettings

The persistent application settings for users of the pool.

Type: ApplicationSettingsResponse object

Required: No

Description

The description of the pool.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z0-9_./() -]+$

Required: No

Errors

The pool errors.

Type: Array of WorkspacesPoolError objects

Required: No

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.

Type: TimeoutSettings object

Required: No

See Also

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

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.