CloudFront / Paginator / ListCloudFrontOriginAccessIdentities

ListCloudFrontOriginAccessIdentities

class CloudFront.Paginator.ListCloudFrontOriginAccessIdentities

paginator = client.get_paginator('list_cloud_front_origin_access_identities')

paginate(**kwargs)

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

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

{
    'CloudFrontOriginAccessIdentityList': {
        'Marker': 'string',
        'NextMarker': 'string',
        'MaxItems': 123,
        'IsTruncated': True|False,
        'Quantity': 123,
        'Items': [
            {
                'Id': 'string',
                'S3CanonicalUserId': 'string',
                'Comment': 'string'
            },
        ]
    },
    'NextToken': 'string'
}

Response Structure

• (dict) –

  The returned result of the corresponding request.

  • CloudFrontOriginAccessIdentityList (dict) –

    The CloudFrontOriginAccessIdentityList type.

    • Marker (string) –

      Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page’s response (which is also the ID of the last identity on that page).

    • NextMarker (string) –

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

    • MaxItems (integer) –

      The maximum number of origin access identities you want in the response body.

    • IsTruncated (boolean) –

      A flag that indicates whether more origin access identities 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 items in the list.

    • Quantity (integer) –

      The number of CloudFront origin access identities that were created by the current Amazon Web Services account.

    • Items (list) –

      A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current Amazon Web Services account.

      • (dict) –

        Summary of the information about a CloudFront origin access identity.

        • Id (string) –

          The ID for the origin access identity. For example: E74FTE3AJFJ256A.

        • S3CanonicalUserId (string) –

          The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.

        • Comment (string) –

          The comment for this origin access identity, as originally specified when created.

  • NextToken (string) –

    A token to resume pagination.