imagebuilder / Paginator / ListImagePackages

ListImagePackages

class imagebuilder.Paginator.ListImagePackages

paginator = client.get_paginator('list_image_packages')

paginate(**kwargs)

Creates an iterator that will paginate through responses from imagebuilder.Client.list_image_packages().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• imageBuildVersionArn (string) –

  [REQUIRED]

  Filter results for the ListImagePackages request by the Image Build Version ARN

• 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

{
    'requestId': 'string',
    'imagePackageList': [
        {
            'packageName': 'string',
            'packageVersion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • requestId (string) –

    The request ID that uniquely identifies this request.

  • imagePackageList (list) –

    The list of Image Packages returned in the response.

    • (dict) –

      A software package that’s installed on top of the base image to create a customized image.

      • packageName (string) –

        The name of the package that’s reported to the operating system package manager.

      • packageVersion (string) –

        The version of the package that’s reported to the operating system package manager.

  • NextToken (string) –

    A token to resume pagination.