CreateStandbyWorkspaces - Amazon WorkSpaces Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Creates a standby WorkSpace in a secondary Region.

Request Syntax

{ "PrimaryRegion": "string", "StandbyWorkspaces": [ { "DataReplication": "string", "DirectoryId": "string", "PrimaryWorkspaceId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeEncryptionKey": "string" } ] }

Request Parameters

The request accepts the following data in JSON format.


The Region of the primary WorkSpace.

Type: String

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

Pattern: ^[-0-9a-z]{1,31}$

Required: Yes


Information about the standby WorkSpace to be created.

Type: Array of StandbyWorkspace objects

Required: Yes

Response Syntax

{ "FailedStandbyRequests": [ { "ErrorCode": "string", "ErrorMessage": "string", "StandbyWorkspaceRequest": { "DataReplication": "string", "DirectoryId": "string", "PrimaryWorkspaceId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeEncryptionKey": "string" } } ], "PendingStandbyRequests": [ { "DirectoryId": "string", "State": "string", "UserName": "string", "WorkspaceId": "string" } ] }

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.


Information about the standby WorkSpace that could not be created.

Type: Array of FailedCreateStandbyWorkspacesRequest objects


Information about the standby WorkSpace that was created.

Type: Array of PendingCreateStandbyWorkspacesRequest objects


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


The user is not authorized to access a resource.

HTTP Status Code: 400


One or more parameter values are not valid.

HTTP Status Code: 400


This operation is not supported.

HTTP Status Code: 400


Your resource limits have been exceeded.

HTTP Status Code: 400


The resource could not be found.

HTTP Status Code: 400

See Also

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