imagebuilder / Paginator / ListDistributionConfigurations

ListDistributionConfigurations

class imagebuilder.Paginator.ListDistributionConfigurations

paginator = client.get_paginator('list_distribution_configurations')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• filters (list) –

  You can filter on name to streamline results.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    • name (string) –

      The name of the filter. Filter names are case-sensitive.

    • values (list) –

      The filter values. Filter values are case-sensitive.

      • (string) –

• 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',
    'distributionConfigurationSummaryList': [
        {
            'arn': 'string',
            'name': 'string',
            'description': 'string',
            'dateCreated': 'string',
            'dateUpdated': 'string',
            'tags': {
                'string': 'string'
            },
            'regions': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • requestId (string) –

    The request ID that uniquely identifies this request.

  • distributionConfigurationSummaryList (list) –

    The list of distributions.

    • (dict) –

      A high-level overview of a distribution configuration.

      • arn (string) –

        The Amazon Resource Name (ARN) of the distribution configuration.

      • name (string) –

        The name of the distribution configuration.

      • description (string) –

        The description of the distribution configuration.

      • dateCreated (string) –

        The date on which the distribution configuration was created.

      • dateUpdated (string) –

        The date on which the distribution configuration was updated.

      • tags (dict) –

        The tags associated with the distribution configuration.

        • (string) –

          • (string) –

      • regions (list) –

        A list of Regions where the container image is distributed to.

        • (string) –

  • NextToken (string) –

    A token to resume pagination.