[ aws . workspaces ]

describe-workspace-bundles

Description

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

See ‘aws help’ for descriptions of global parameters.

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

Synopsis

  describe-workspace-bundles
[--bundle-ids <value>]
[--owner <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--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.

Specify AMAZON to describe the bundles provided by AWS or null to describe the bundles that belong to your account.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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 the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken 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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To describe your WorkSpace bundles

This example describes all of the WorkSpace bundles that are provided by AWS.

Command:

aws workspaces describe-workspace-bundles --owner AMAZON

Output:

{
    "Bundles": [
        {
            "ComputeType": {
                "Name": "PERFORMANCE"
            },
            "Description": "Performance Bundle",
            "BundleId": "wsb-b0s22j3d7",
            "Owner": "Amazon",
            "UserStorage": {
                "Capacity": "100"
            },
            "Name": "Performance"
        },
        {
            "ComputeType": {
                "Name": "VALUE"
            },
            "Description": "Value Base Bundle",
            "BundleId": "wsb-92tn3b7gx",
            "Owner": "Amazon",
            "UserStorage": {
                "Capacity": "10"
            },
            "Name": "Value"
        },
        {
            "ComputeType": {
                "Name": "STANDARD"
            },
            "Description": "Standard Bundle",
            "BundleId": "wsb-3t36q0xfc",
            "Owner": "Amazon",
            "UserStorage": {
                "Capacity": "50"
            },
            "Name": "Standard"
        },
        {
            "ComputeType": {
                "Name": "PERFORMANCE"
            },
            "Description": "Performance Plus Bundle",
            "BundleId": "wsb-1b5w6vnz6",
            "Owner": "Amazon",
            "UserStorage": {
                "Capacity": "100"
            },
            "Name": "Performance Plus"
        },
        {
            "ComputeType": {
                "Name": "VALUE"
            },
            "Description": "Value Plus Office 2013",
            "BundleId": "wsb-fgy4lgypc",
            "Owner": "Amazon",
            "UserStorage": {
                "Capacity": "10"
            },
            "Name": "Value Plus Office 2013"
        },
        {
            "ComputeType": {
                "Name": "PERFORMANCE"
            },
            "Description": "Performance Plus Office 2013",
            "BundleId": "wsb-vbsjd64y6",
            "Owner": "Amazon",
            "UserStorage": {
                "Capacity": "100"
            },
            "Name": "Performance Plus Office 2013"
        },
        {
            "ComputeType": {
                "Name": "VALUE"
            },
            "Description": "Value Plus Bundle",
            "BundleId": "wsb-kgjp98lt8",
            "Owner": "Amazon",
            "UserStorage": {
                "Capacity": "10"
            },
            "Name": "Value Plus"
        },
        {
            "ComputeType": {
                "Name": "STANDARD"
            },
            "Description": "Standard Plus Office 2013",
            "BundleId": "wsb-5h1pf1zxc",
            "Owner": "Amazon",
            "UserStorage": {
                "Capacity": "50"
            },
            "Name": "Standard Plus Office 2013"
        },
        {
            "ComputeType": {
                "Name": "STANDARD"
            },
            "Description": "Standard Plus Bundle",
            "BundleId": "wsb-vlsvncjjf",
            "Owner": "Amazon",
            "UserStorage": {
                "Capacity": "50"
            },
            "Name": "Standard Plus"
        }
    ]
}

Output

Bundles -> (list)

Information about the bundles.

(structure)

Describes a WorkSpace bundle.

BundleId -> (string)

The bundle identifier.

Name -> (string)

The name of the bundle.

Owner -> (string)

The owner of the bundle. This is the account identifier of the owner, or AMAZON if the bundle is provided by AWS.

Description -> (string)

A description.

ImageId -> (string)

The image identifier of 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 storage.

Capacity -> (string)

The size of the user storage.

ComputeType -> (structure)

The compute type. For more information, see Amazon WorkSpaces Bundles .

Name -> (string)

The compute type.

LastUpdatedTime -> (timestamp)

The last time that the bundle was updated.

NextToken -> (string)

The token to use to retrieve the next set of results, or null if there are no more results available. This token is valid for one day and must be used within that time frame.