Snowball / Paginator / ListCompatibleImages

ListCompatibleImages

class Snowball.Paginator.ListCompatibleImages

paginator = client.get_paginator('list_compatible_images')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Snowball.Client.list_compatible_images().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

{
    'CompatibleImages': [
        {
            'AmiId': 'string',
            'Name': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • CompatibleImages (list) –

    A JSON-formatted object that describes a compatible AMI, including the ID and name for a Snow device AMI.

    • (dict) –

      A JSON-formatted object that describes a compatible Amazon Machine Image (AMI), including the ID and name for a Snow device AMI. This AMI is compatible with the device’s physical hardware requirements, and it should be able to be run in an SBE1 instance on the device.

      • AmiId (string) –

        The unique identifier for an individual Snow device AMI.

      • Name (string) –

        The optional name of a compatible image.