Amazon WorkSpaces

2019/11/26 - Amazon WorkSpaces - 1 updated api methods

Changes  For the WorkspaceBundle API, added the image identifier and the time of the last update.

DescribeWorkspaceBundles (updated) Link ΒΆ
Changes (response)
{'Bundles': {'ImageId': 'string', 'LastUpdatedTime': 'timestamp'}}

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

Request Syntax

client.describe_workspace_bundles(
    BundleIds=[
        'string',
    ],
    Owner='string',
    NextToken='string'
)
type BundleIds

list

param BundleIds

The identifiers of the bundles. You cannot combine this parameter with any other filter.

  • (string) --

type Owner

string

param Owner

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.

type NextToken

string

param NextToken

The token for the next set of results. (You received this token from a previous call.)

rtype

dict

returns

Response Syntax

{
    'Bundles': [
        {
            'BundleId': 'string',
            'Name': 'string',
            'Owner': 'string',
            'Description': 'string',
            'ImageId': 'string',
            'RootStorage': {
                'Capacity': 'string'
            },
            'UserStorage': {
                'Capacity': 'string'
            },
            'ComputeType': {
                'Name': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'
            },
            'LastUpdatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Bundles (list) --

      Information about the bundles.

      • (dict) --

        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 (dict) --

          The size of the root volume.

          • Capacity (string) --

            The size of the root volume.

        • UserStorage (dict) --

          The size of the user storage.

          • Capacity (string) --

            The size of the user storage.

        • ComputeType (dict) --

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

          • Name (string) --

            The compute type.

        • LastUpdatedTime (datetime) --

          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.