:doc:`CognitoIdentity <../../cognito-identity>` / Client / list_identities

***************
list_identities
***************



.. py:method:: CognitoIdentity.Client.list_identities(**kwargs)

  

  Lists the identities in an identity pool.

   

  You must use Amazon Web Services developer credentials to call this operation.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cognito-identity-2014-06-30/ListIdentities>`_  


  **Request Syntax**
  ::

    response = client.list_identities(
        IdentityPoolId='string',
        MaxResults=123,
        NextToken='string',
        HideDisabled=True|False
    )
    
  :type IdentityPoolId: string
  :param IdentityPoolId: **[REQUIRED]** 

    An identity pool ID in the format REGION:GUID.

    

  
  :type MaxResults: integer
  :param MaxResults: **[REQUIRED]** 

    The maximum number of identities to return.

    

  
  :type NextToken: string
  :param NextToken: 

    A pagination token.

    

  
  :type HideDisabled: boolean
  :param HideDisabled: 

    An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.

    

  
  
  :rtype: 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**
  
  *   :py:class:`CognitoIdentity.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`CognitoIdentity.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`CognitoIdentity.Client.exceptions.NotAuthorizedException`

  
  *   :py:class:`CognitoIdentity.Client.exceptions.TooManyRequestsException`

  
  *   :py:class:`CognitoIdentity.Client.exceptions.InternalErrorException`

  