CognitoIdentity / Paginator / ListIdentityPools

ListIdentityPools

class CognitoIdentity.Paginator.ListIdentityPools

paginator = client.get_paginator('list_identity_pools')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CognitoIdentity.Client.list_identity_pools().

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

{
    'IdentityPools': [
        {
            'IdentityPoolId': 'string',
            'IdentityPoolName': 'string'
        },
    ],

}

Response Structure

• (dict) –

  The result of a successful ListIdentityPools action.

  • IdentityPools (list) –

    The identity pools returned by the ListIdentityPools action.

    • (dict) –

      A description of the identity pool.

      • IdentityPoolId (string) –

        An identity pool ID in the format REGION:GUID.

      • IdentityPoolName (string) –

        A string that you provide.