WorkSpaces / Paginator / DescribeWorkspaceImages

DescribeWorkspaceImages

class WorkSpaces.Paginator.DescribeWorkspaceImages

paginator = client.get_paginator('describe_workspace_images')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ImageIds=[
        'string',
    ],
    ImageType='OWNED'|'SHARED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ImageIds (list) –

  The identifier of the image.

  • (string) –

• ImageType (string) – The type (owned or shared) of the image.

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

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'Images': [
        {
            'ImageId': 'string',
            'Name': 'string',
            'Description': 'string',
            'OperatingSystem': {
                'Type': 'WINDOWS'|'LINUX'
            },
            'State': 'AVAILABLE'|'PENDING'|'ERROR',
            'RequiredTenancy': 'DEFAULT'|'DEDICATED',
            'ErrorCode': 'string',
            'ErrorMessage': 'string',
            'Created': datetime(2015, 1, 1),
            'OwnerAccountId': 'string',
            'Updates': {
                'UpdateAvailable': True|False,
                'Description': 'string'
            }
        },
    ],

}

Response Structure

• (dict) –

  • Images (list) –

    Information about the images.

    • (dict) –

      Describes a WorkSpace image.

      • ImageId (string) –

        The identifier of the image.

      • Name (string) –

        The name of the image.

      • Description (string) –

        The description of the image.

      • OperatingSystem (dict) –

        The operating system that the image is running.

        • Type (string) –

          The operating system.

      • State (string) –

        The status of the image.

      • RequiredTenancy (string) –

        Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.

      • ErrorCode (string) –

        The error code that is returned for the image.

      • ErrorMessage (string) –

        The text of the error message that is returned for the image.

      • Created (datetime) –

        The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date of the image.

      • OwnerAccountId (string) –

        The identifier of the Amazon Web Services account that owns the image.

      • Updates (dict) –

        The updates (if any) that are available for the specified image.

        • UpdateAvailable (boolean) –

          Indicates whether updated drivers or other components are available for the specified WorkSpace image.

        • Description (string) –

          A description of whether updates for the WorkSpace image are pending or available.