AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . workspaces ]
Retrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
See also: AWS API Documentation
describe-workspace-bundles
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: Bundles
describe-workspace-bundles
[--bundle-ids <value>]
[--owner <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--bundle-ids
(list)
The identifiers of the bundles. You cannot combine this parameter with any other filter.
(string)
Syntax:
"string" "string" ...
--owner
(string)
The owner of the bundles. You cannot combine this parameter with any other filter.
To describe the bundles provided by Amazon Web Services, specify
AMAZON
. To describe the bundles that belong to your account, don't specify a value.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command's output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command's output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To list the bundles provided by Amazon
The following describe-workspace-bundles
example lists the names and IDs of the bundles provided by Amazon, in table format and sorted by name.
aws workspaces describe-workspace-bundles \
--owner AMAZON \
--query "Bundles[*].[Name, BundleId]"
Output:
[
[
"Standard with Amazon Linux 2",
"wsb-clj85qzj1"
],
[
"Performance with Windows 10 (Server 2016 based)",
"wsb-gm4d5tx2v"
],
[
"PowerPro with Windows 7",
"wsb-1pzkp0bx4"
],
[
"Power with Amazon Linux 2",
"wsb-2bs6k5lgn"
],
[
"Graphics with Windows 10 (Server 2019 based)",
"wsb-03gyjnfyy"
],
...
]
For more information, see WorkSpaces bundles and images in the Amazon WorkSpaces Administration Guide.
Bundles -> (list)
Information about the bundles.
(structure)
Describes a WorkSpace bundle.
BundleId -> (string)
The identifier of the bundle.Name -> (string)
The name of the bundle.Owner -> (string)
The owner of the bundle. This is the account identifier of the owner, orAMAZON
if the bundle is provided by Amazon Web Services.Description -> (string)
The description of the bundle.ImageId -> (string)
The identifier of the image that was used to create the bundle.RootStorage -> (structure)
The size of the root volume.
Capacity -> (string)
The size of the root volume.UserStorage -> (structure)
The size of the user volume.
Capacity -> (string)
The size of the user volume.ComputeType -> (structure)
The compute type of the bundle. For more information, see Amazon WorkSpaces Bundles .
Name -> (string)
The compute type.LastUpdatedTime -> (timestamp)
The last time that the bundle was updated.CreationTime -> (timestamp)
The time when the bundle was created.State -> (string)
The state of the WorkSpace bundle.BundleType -> (string)
The type of WorkSpace bundle.
NextToken -> (string)
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.