DescribeWorkspaceBundles
Retrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
Request Syntax
{
"BundleIds": [ "string" ],
"NextToken": "string",
"Owner": "string"
}Request Parameters
The request accepts the following data in JSON format.
- BundleIds
-
The identifiers of the bundles. You cannot combine this parameter with any other filter.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Pattern:
^wsb-[0-9a-z]{8,63}$Required: No
- NextToken
-
The token for the next set of results. (You received this token from a previous call.)
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
- Owner
-
The owner of the bundles. You cannot combine this parameter with any other filter.
To describe the bundles provided by AWS, specify
AMAZON. To describe the bundles that belong to your account, don't specify a value.Type: String
Required: No
Response Syntax
{
"Bundles": [
{
"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"
}
}
],
"NextToken": "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.
- Bundles
-
Information about the bundles.
Type: Array of WorkspaceBundle objects
- NextToken
-
The token to use to retrieve the next page of results. This value is null when there are no more results to return. This token is valid for one day and must be used within that time frame.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
