CreateWorkspaceBundle
Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.
Request Syntax
{
"BundleDescription": "string",
"BundleName": "string",
"ComputeType": {
"Name": "string"
},
"ImageId": "string",
"RootStorage": {
"Capacity": "string"
},
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"UserStorage": {
"Capacity": "string"
}
}Request Parameters
The request accepts the following data in JSON format.
- BundleDescription
-
The description of the bundle.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9_./() -]+$Required: Yes
- BundleName
-
The name of the bundle.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9_./()\\-]+$Required: Yes
- ComputeType
-
Describes the compute type of the bundle.
Type: ComputeType object
Required: Yes
- ImageId
-
The identifier of the image that is used to create the bundle.
Type: String
Pattern:
wsi-[0-9a-z]{9,63}$Required: Yes
- RootStorage
-
Describes the root volume for a WorkSpace bundle.
Type: RootStorage object
Required: No
- Tags
-
The tags associated with the bundle.
Note
To add tags at the same time when you're creating the bundle, you must create an IAM policy that grants your IAM user permissions to use
workspaces:CreateTags.Type: Array of Tag objects
Required: No
- UserStorage
-
Describes the user volume for a WorkSpace bundle.
Type: UserStorage object
Required: Yes
Response Syntax
{
"WorkspaceBundle": {
"BundleId": "string",
"BundleType": "string",
"ComputeType": {
"Name": "string"
},
"CreationTime": number,
"Description": "string",
"ImageId": "string",
"LastUpdatedTime": number,
"Name": "string",
"Owner": "string",
"RootStorage": {
"Capacity": "string"
},
"State": "string",
"UserStorage": {
"Capacity": "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.
- WorkspaceBundle
-
Describes a WorkSpace bundle.
Type: WorkspaceBundle object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The user is not authorized to access a resource.
HTTP Status Code: 400
- InvalidParameterValuesException
-
One or more parameter values are not valid.
HTTP Status Code: 400
- ResourceAlreadyExistsException
-
The specified resource already exists.
HTTP Status Code: 400
- ResourceLimitExceededException
-
Your resource limits have been exceeded.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource could not be found.
HTTP Status Code: 400
- ResourceUnavailableException
-
The specified resource is not available.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
