CognitoIdentity / Client / list_identity_pools

list_identity_pools#

CognitoIdentity.Client.list_identity_pools(**kwargs)#

Lists all of the Cognito identity pools registered for your account.

You must use AWS Developer credentials to call this API.

See also: AWS API Documentation

Request Syntax

response = client.list_identity_pools(
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • MaxResults (integer) –

    [REQUIRED]

    The maximum number of identities to return.

  • NextToken (string) – A pagination token.

Return type:

dict

Returns:

Response Syntax

{
    'IdentityPools': [
        {
            'IdentityPoolId': 'string',
            'IdentityPoolName': 'string'
        },
    ],
    'NextToken': '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.

    • NextToken (string) –

      A pagination token.

Exceptions