Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateWorkspacesPool

Note

End of support notice: On December 31, 2027, AWS will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support.

Creates a pool of WorkSpaces.

Request Syntax


{
   "ApplicationSettings": { 
      "SettingsGroup": "string",
      "Status": "string"
   },
   "BundleId": "string",
   "Capacity": { 
      "DesiredUserSessions": number
   },
   "Description": "string",
   "DirectoryId": "string",
   "PoolName": "string",
   "RunningMode": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TimeoutSettings": { 
      "DisconnectTimeoutInSeconds": number,
      "IdleDisconnectTimeoutInSeconds": number,
      "MaxUserDurationInSeconds": number
   }
}

Request Parameters

The request accepts the following data in JSON format.

ApplicationSettings

Indicates the application settings of the pool.

Type: ApplicationSettingsRequest object

Required: No

BundleId

The identifier of the bundle for the pool.

Type: String

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

Required: Yes

Capacity

The user capacity of the pool.

Type: Capacity object

Required: Yes

Description

The pool description.

Type: String

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

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

Required: Yes

DirectoryId

The identifier of the directory for 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

PoolName

The name of the pool.

Type: String

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

Required: Yes

RunningMode

The running mode for the pool.

Type: String

Valid Values: AUTO_STOP | ALWAYS_ON

Required: No

Tags

The tags for the pool.

Type: Array of Tag objects

Required: No

TimeoutSettings

Indicates the timeout settings of the pool.

Type: TimeoutSettings object

Required: No

Response Syntax


{
   "WorkspacesPool": { 
      "ApplicationSettings": { 
         "S3BucketName": "string",
         "SettingsGroup": "string",
         "Status": "string"
      },
      "BundleId": "string",
      "CapacityStatus": { 
         "ActiveUserSessions": number,
         "ActualUserSessions": number,
         "AvailableUserSessions": number,
         "DesiredUserSessions": number
      },
      "CreatedAt": number,
      "Description": "string",
      "DirectoryId": "string",
      "Errors": [ 
         { 
            "ErrorCode": "string",
            "ErrorMessage": "string"
         }
      ],
      "PoolArn": "string",
      "PoolId": "string",
      "PoolName": "string",
      "RunningMode": "string",
      "State": "string",
      "TimeoutSettings": { 
         "DisconnectTimeoutInSeconds": number,
         "IdleDisconnectTimeoutInSeconds": number,
         "MaxUserDurationInSeconds": number
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

WorkspacesPool

Indicates the pool to create.

Type: WorkspacesPool object

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400

InvalidParameterValuesException

One or more parameter values are not valid.

message: The exception error message.

HTTP Status Code: 400

OperationNotSupportedException

This operation is not supported.

message: The exception error message.
reason: The exception error reason.

HTTP Status Code: 400

ResourceAlreadyExistsException

The specified resource already exists.

HTTP Status Code: 400

ResourceLimitExceededException

Your resource limits have been exceeded.

message: The exception error message.

HTTP Status Code: 400

ResourceNotFoundException

The resource could not be found.

message: The resource could not be found.
ResourceId: The ID of the resource that could not be found.

HTTP Status Code: 400