CognitoIdentity / Client / list_identities

list_identities#

CognitoIdentity.Client.list_identities(**kwargs)#

Lists the identities in an identity pool.

You must use AWS Developer credentials to call this API.

Request Syntax

response = client.list_identities(
    IdentityPoolId='string',
    MaxResults=123,
    NextToken='string',
    HideDisabled=True|False
)

Parameters:

IdentityPoolId (string) –
[REQUIRED]

An identity pool ID in the format REGION:GUID.
MaxResults (integer) –
[REQUIRED]

The maximum number of identities to return.
NextToken (string) – A pagination token.
HideDisabled (boolean) – An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.

Return type:

dict

Returns:

Response Syntax

{
    'IdentityPoolId': 'string',
    'Identities': [
        {
            'IdentityId': 'string',
            'Logins': [
                'string',
            ],
            'CreationDate': datetime(2015, 1, 1),
            'LastModifiedDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –

The response to a ListIdentities request.
- IdentityPoolId (string) –
  
  An identity pool ID in the format REGION:GUID.
- Identities (list) –
  
  An object containing a set of identities and associated mappings.
  - (dict) –
    
    A description of the identity.
    - IdentityId (string) –
      
      A unique identifier in the format REGION:GUID.
    - Logins (list) –
      
      The provider names.
      - (string) –
    - CreationDate (datetime) –
      
      Date on which the identity was created.
    - LastModifiedDate (datetime) –
      
      Date on which the identity was last modified.
- NextToken (string) –
  
  A pagination token.

Exceptions

CognitoIdentity.Client.exceptions.InvalidParameterException
CognitoIdentity.Client.exceptions.ResourceNotFoundException
CognitoIdentity.Client.exceptions.NotAuthorizedException
CognitoIdentity.Client.exceptions.TooManyRequestsException
CognitoIdentity.Client.exceptions.InternalErrorException