DescribeWorkspaceBundles

class WorkSpaces.Paginator.DescribeWorkspaceBundles

paginator = client.get_paginator('describe_workspace_bundles')

paginate(**kwargs)

Creates an iterator that will paginate through responses from WorkSpaces.Client.describe_workspace_bundles().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    BundleIds=[
        'string',
    ],
    Owner='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters

• BundleIds (list) --

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

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

• PaginationConfig (dict) --

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

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'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN'
            },
            'LastUpdatedTime': datetime(2015, 1, 1),
            'CreationTime': datetime(2015, 1, 1),
            'State': 'AVAILABLE'|'PENDING'|'ERROR',
            'BundleType': 'REGULAR'|'STANDBY'
        },
    ],

}

Response Structure

• (dict) --

  • Bundles (list) --

    Information about the bundles.

    • (dict) --

      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, or AMAZON 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 (dict) --

        The size of the root volume.

        • Capacity (string) --

          The size of the root volume.

      • UserStorage (dict) --

        The size of the user volume.

        • Capacity (string) --

          The size of the user volume.

      • ComputeType (dict) --

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

        • Name (string) --

          The compute type.

      • LastUpdatedTime (datetime) --

        The last time that the bundle was updated.

      • CreationTime (datetime) --

        The time when the bundle was created.

      • State (string) --

        The state of the WorkSpace bundle.

      • BundleType (string) --

        The type of WorkSpace bundle.