CreateWorkspaces
Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
Note
-
The
MANUALrunning mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core. -
You don't need to specify the
PCOIPprotocol for Linux bundles becauseDCV(formerly WSP) is the default protocol for those bundles. -
User-decoupled WorkSpaces are only supported by Amazon WorkSpaces Core.
-
Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?
Request Syntax
{
"Workspaces": [
{
"BundleId": "string",
"DirectoryId": "string",
"RootVolumeEncryptionEnabled": boolean,
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"UserName": "string",
"UserVolumeEncryptionEnabled": boolean,
"VolumeEncryptionKey": "string",
"WorkspaceName": "string",
"WorkspaceProperties": {
"ComputeTypeName": "string",
"GlobalAccelerator": {
"Mode": "string",
"PreferredProtocol": "string"
},
"OperatingSystemName": "string",
"Protocols": [ "string" ],
"RootVolumeSizeGib": number,
"RunningMode": "string",
"RunningModeAutoStopTimeoutInMinutes": number,
"UserVolumeSizeGib": number
}
}
]
}Request Parameters
The request accepts the following data in JSON format.
- Workspaces
-
The WorkSpaces to create. You can specify up to 25 WorkSpaces.
Type: Array of WorkspaceRequest objects
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Required: Yes
Response Syntax
{
"FailedRequests": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"WorkspaceRequest": {
"BundleId": "string",
"DirectoryId": "string",
"RootVolumeEncryptionEnabled": boolean,
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"UserName": "string",
"UserVolumeEncryptionEnabled": boolean,
"VolumeEncryptionKey": "string",
"WorkspaceName": "string",
"WorkspaceProperties": {
"ComputeTypeName": "string",
"GlobalAccelerator": {
"Mode": "string",
"PreferredProtocol": "string"
},
"OperatingSystemName": "string",
"Protocols": [ "string" ],
"RootVolumeSizeGib": number,
"RunningMode": "string",
"RunningModeAutoStopTimeoutInMinutes": number,
"UserVolumeSizeGib": number
}
}
}
],
"PendingRequests": [
{
"BundleId": "string",
"ComputerName": "string",
"DataReplicationSettings": {
"DataReplication": "string",
"RecoverySnapshotTime": number
},
"DirectoryId": "string",
"ErrorCode": "string",
"ErrorMessage": "string",
"IpAddress": "string",
"ModificationStates": [
{
"Resource": "string",
"State": "string"
}
],
"RelatedWorkspaces": [
{
"Region": "string",
"State": "string",
"Type": "string",
"WorkspaceId": "string"
}
],
"RootVolumeEncryptionEnabled": boolean,
"StandbyWorkspacesProperties": [
{
"DataReplication": "string",
"RecoverySnapshotTime": number,
"StandbyWorkspaceId": "string"
}
],
"State": "string",
"SubnetId": "string",
"UserName": "string",
"UserVolumeEncryptionEnabled": boolean,
"VolumeEncryptionKey": "string",
"WorkspaceId": "string",
"WorkspaceName": "string",
"WorkspaceProperties": {
"ComputeTypeName": "string",
"GlobalAccelerator": {
"Mode": "string",
"PreferredProtocol": "string"
},
"OperatingSystemName": "string",
"Protocols": [ "string" ],
"RootVolumeSizeGib": number,
"RunningMode": "string",
"RunningModeAutoStopTimeoutInMinutes": number,
"UserVolumeSizeGib": 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.
- FailedRequests
-
Information about the WorkSpaces that could not be created.
Type: Array of FailedCreateWorkspaceRequest objects
- PendingRequests
-
Information about the WorkSpaces that were created.
Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.
Type: Array of Workspace objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterValuesException
-
One or more parameter values are not valid.
HTTP Status Code: 400
- ResourceLimitExceededException
-
Your resource limits have been exceeded.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
