CloudFront / Paginator / ListInvalidations

ListInvalidations

class CloudFront.Paginator.ListInvalidations

paginator = client.get_paginator('list_invalidations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudFront.Client.list_invalidations().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• DistributionId (string) –

  [REQUIRED]

  The distribution’s ID.

• 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

{
    'InvalidationList': {
        'Marker': 'string',
        'NextMarker': 'string',
        'MaxItems': 123,
        'IsTruncated': True|False,
        'Quantity': 123,
        'Items': [
            {
                'Id': 'string',
                'CreateTime': datetime(2015, 1, 1),
                'Status': 'string'
            },
        ]
    },
    'NextToken': 'string'
}

Response Structure

• (dict) –

  The returned result of the corresponding request.

  • InvalidationList (dict) –

    Information about invalidation batches.

    • Marker (string) –

      The value that you provided for the Marker request parameter.

    • NextMarker (string) –

      If IsTruncated is true, this element is present and contains the value that you can use for the Marker request parameter to continue listing your invalidation batches where they left off.

    • MaxItems (integer) –

      The value that you provided for the MaxItems request parameter.

    • IsTruncated (boolean) –

      A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list.

    • Quantity (integer) –

      The number of invalidation batches that were created by the current Amazon Web Services account.

    • Items (list) –

      A complex type that contains one InvalidationSummary element for each invalidation batch created by the current Amazon Web Services account.

      • (dict) –

        A summary of an invalidation request.

        • Id (string) –

          The unique ID for an invalidation request.

        • CreateTime (datetime) –

          The time that an invalidation request was created.

        • Status (string) –

          The status of an invalidation request.

  • NextToken (string) –

    A token to resume pagination.