CloudFront / Client / list_invalidations

list_invalidations

CloudFront.Client.list_invalidations(**kwargs)

Lists invalidation batches.

See also: AWS API Documentation

Request Syntax

response = client.list_invalidations(
    DistributionId='string',
    Marker='string',
    MaxItems='string'
)

Parameters:

• DistributionId (string) –

  [REQUIRED]

  The distribution’s ID.

• Marker (string) – Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set Marker to the value of the NextMarker from the current page’s response. This value is the same as the ID of the last invalidation batch on that page.

• MaxItems (string) – The maximum number of invalidation batches that you want in the response body.

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'
            },
        ]
    }
}

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.

Exceptions

• CloudFront.Client.exceptions.InvalidArgument

• CloudFront.Client.exceptions.NoSuchDistribution

• CloudFront.Client.exceptions.AccessDenied