

***************
CognitoIdentity
***************

.. contents:: Table of Contents
   :depth: 2


======
Client
======



.. py:class:: CognitoIdentity.Client

  A low-level client representing Amazon Cognito Identity::

    
    import boto3
    
    client = boto3.client('cognito-identity')

  
  These are the available methods:
  
  *   :py:meth:`can_paginate`

  
  *   :py:meth:`create_identity_pool`

  
  *   :py:meth:`delete_identities`

  
  *   :py:meth:`delete_identity_pool`

  
  *   :py:meth:`describe_identity`

  
  *   :py:meth:`describe_identity_pool`

  
  *   :py:meth:`generate_presigned_url`

  
  *   :py:meth:`get_credentials_for_identity`

  
  *   :py:meth:`get_id`

  
  *   :py:meth:`get_identity_pool_roles`

  
  *   :py:meth:`get_open_id_token`

  
  *   :py:meth:`get_open_id_token_for_developer_identity`

  
  *   :py:meth:`get_paginator`

  
  *   :py:meth:`get_waiter`

  
  *   :py:meth:`list_identities`

  
  *   :py:meth:`list_identity_pools`

  
  *   :py:meth:`lookup_developer_identity`

  
  *   :py:meth:`merge_developer_identities`

  
  *   :py:meth:`set_identity_pool_roles`

  
  *   :py:meth:`unlink_developer_identity`

  
  *   :py:meth:`unlink_identity`

  
  *   :py:meth:`update_identity_pool`

  

  .. py:method:: can_paginate(operation_name)

        
    Check if an operation can be paginated.
    
    :type operation_name: string
    :param operation_name: The operation name.  This is the same name
        as the method name on the client.  For example, if the
        method name is ``create_foo``, and you'd normally invoke the
        operation as ``client.create_foo(**kwargs)``, if the
        ``create_foo`` operation can be paginated, you can use the
        call ``client.get_paginator("create_foo")``.
    
    :return: ``True`` if the operation can be paginated,
        ``False`` otherwise.


  .. py:method:: create_identity_pool(**kwargs)

    

    Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account. You must use AWS Developer credentials to call this API.

    

    **Request Syntax** 
    ::

      response = client.create_identity_pool(
          IdentityPoolName='string',
          AllowUnauthenticatedIdentities=True|False,
          SupportedLoginProviders={
              'string': 'string'
          },
          DeveloperProviderName='string',
          OpenIdConnectProviderARNs=[
              'string',
          ]
      )
    :type IdentityPoolName: string
    :param IdentityPoolName: **[REQUIRED]** 

      A string that you provide.

      

    
    :type AllowUnauthenticatedIdentities: boolean
    :param AllowUnauthenticatedIdentities: **[REQUIRED]** 

      TRUE if the identity pool supports unauthenticated logins.

      

    
    :type SupportedLoginProviders: dict
    :param SupportedLoginProviders: 

      Optional key:value pairs mapping provider names to provider app IDs.

      

    
      - *(string) --* 

      
        - *(string) --* 

        
  

    :type DeveloperProviderName: string
    :param DeveloperProviderName: 

      The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the ``DeveloperProviderName`` , you can use letters as well as period (``.`` ), underscore (``_`` ), and dash (``-`` ).

       

      Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.

      

    
    :type OpenIdConnectProviderARNs: list
    :param OpenIdConnectProviderARNs: 

      A list of OpendID Connect provider ARNs.

      

    
      - *(string) --* 

      
  
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'IdentityPoolId': 'string',
            'IdentityPoolName': 'string',
            'AllowUnauthenticatedIdentities': True|False,
            'SupportedLoginProviders': {
                'string': 'string'
            },
            'DeveloperProviderName': 'string',
            'OpenIdConnectProviderARNs': [
                'string',
            ]
        }
      **Response Structure** 

      

      - *(dict) --* An object representing a Cognito identity pool.
        

        - **IdentityPoolId** *(string) --* An identity pool ID in the format REGION:GUID.
        

        - **IdentityPoolName** *(string) --* 

          A string that you provide.

          
        

        - **AllowUnauthenticatedIdentities** *(boolean) --* TRUE if the identity pool supports unauthenticated logins.
        

        - **SupportedLoginProviders** *(dict) --* 

          Optional key:value pairs mapping provider names to provider app IDs.

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
        

        - **DeveloperProviderName** *(string) --* 

          The "domain" by which Cognito will refer to your users.

          
        

        - **OpenIdConnectProviderARNs** *(list) --* 

          A list of OpendID Connect provider ARNs.

          
          

          - *(string) --* 
      
    

  .. py:method:: delete_identities(**kwargs)

    

    Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.

     

    You must use AWS Developer credentials to call this API.

    

    **Request Syntax** 
    ::

      response = client.delete_identities(
          IdentityIdsToDelete=[
              'string',
          ]
      )
    :type IdentityIdsToDelete: list
    :param IdentityIdsToDelete: **[REQUIRED]** 

      A list of 1-60 identities that you want to delete.

      

    
      - *(string) --* 

      
  
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'UnprocessedIdentityIds': [
                {
                    'IdentityId': 'string',
                    'ErrorCode': 'AccessDenied'|'InternalServerError'
                },
            ]
        }
      **Response Structure** 

      

      - *(dict) --* 

        Returned in response to a successful ``DeleteIdentities`` operation.

        
        

        - **UnprocessedIdentityIds** *(list) --* 

          An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.

          
          

          - *(dict) --* 

            An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.

            
            

            - **IdentityId** *(string) --* 

              A unique identifier in the format REGION:GUID.

              
            

            - **ErrorCode** *(string) --* 

              The error code indicating the type of error that occurred.

              
        
      
    

  .. py:method:: delete_identity_pool(**kwargs)

    

    Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool.

     

    You must use AWS Developer credentials to call this API.

    

    **Request Syntax** 
    ::

      response = client.delete_identity_pool(
          IdentityPoolId='string'
      )
    :type IdentityPoolId: string
    :param IdentityPoolId: **[REQUIRED]** An identity pool ID in the format REGION:GUID.

    
    
    :returns: None

  .. py:method:: describe_identity(**kwargs)

    

    Returns metadata related to the given identity, including when the identity was created and any associated linked logins.

     

    You must use AWS Developer credentials to call this API.

    

    **Request Syntax** 
    ::

      response = client.describe_identity(
          IdentityId='string'
      )
    :type IdentityId: string
    :param IdentityId: **[REQUIRED]** 

      A unique identifier in the format REGION:GUID.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'IdentityId': 'string',
            'Logins': [
                'string',
            ],
            'CreationDate': datetime(2015, 1, 1),
            'LastModifiedDate': datetime(2015, 1, 1)
        }
      **Response Structure** 

      

      - *(dict) --* A description of the identity.
        

        - **IdentityId** *(string) --* A unique identifier in the format REGION:GUID.
        

        - **Logins** *(list) --* A set of optional name-value pairs that map provider names to provider tokens.
          

          - *(string) --* 
      
        

        - **CreationDate** *(datetime) --* 

          Date on which the identity was created.

          
        

        - **LastModifiedDate** *(datetime) --* 

          Date on which the identity was last modified.

          
    

  .. py:method:: describe_identity_pool(**kwargs)

    

    Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.

     

    You must use AWS Developer credentials to call this API.

    

    **Request Syntax** 
    ::

      response = client.describe_identity_pool(
          IdentityPoolId='string'
      )
    :type IdentityPoolId: string
    :param IdentityPoolId: **[REQUIRED]** An identity pool ID in the format REGION:GUID.

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'IdentityPoolId': 'string',
            'IdentityPoolName': 'string',
            'AllowUnauthenticatedIdentities': True|False,
            'SupportedLoginProviders': {
                'string': 'string'
            },
            'DeveloperProviderName': 'string',
            'OpenIdConnectProviderARNs': [
                'string',
            ]
        }
      **Response Structure** 

      

      - *(dict) --* An object representing a Cognito identity pool.
        

        - **IdentityPoolId** *(string) --* An identity pool ID in the format REGION:GUID.
        

        - **IdentityPoolName** *(string) --* 

          A string that you provide.

          
        

        - **AllowUnauthenticatedIdentities** *(boolean) --* TRUE if the identity pool supports unauthenticated logins.
        

        - **SupportedLoginProviders** *(dict) --* 

          Optional key:value pairs mapping provider names to provider app IDs.

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
        

        - **DeveloperProviderName** *(string) --* 

          The "domain" by which Cognito will refer to your users.

          
        

        - **OpenIdConnectProviderARNs** *(list) --* 

          A list of OpendID Connect provider ARNs.

          
          

          - *(string) --* 
      
    

  .. py:method:: generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

        
    Generate a presigned url given a client, its method, and arguments
    
    :type ClientMethod: string
    :param ClientMethod: The client method to presign for
    
    :type Params: dict
    :param Params: The parameters normally passed to
        ``ClientMethod``.
    
    :type ExpiresIn: int
    :param ExpiresIn: The number of seconds the presigned url is valid
        for. By default it expires in an hour (3600 seconds)
    
    :type HttpMethod: string
    :param HttpMethod: The http method to use on the generated url. By
        default, the http method is whatever is used in the method's model.
    
    :returns: The presigned url


  .. py:method:: get_credentials_for_identity(**kwargs)

    

    Returns credentials for the the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token.

     

    This is a public API. You do not need any credentials to call this API.

    

    **Request Syntax** 
    ::

      response = client.get_credentials_for_identity(
          IdentityId='string',
          Logins={
              'string': 'string'
          }
      )
    :type IdentityId: string
    :param IdentityId: **[REQUIRED]** 

      A unique identifier in the format REGION:GUID.

      

    
    :type Logins: dict
    :param Logins: 

      A set of optional name-value pairs that map provider names to provider tokens.

      

    
      - *(string) --* 

      
        - *(string) --* 

        
  

    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'IdentityId': 'string',
            'Credentials': {
                'AccessKeyId': 'string',
                'SecretKey': 'string',
                'SessionToken': 'string',
                'Expiration': datetime(2015, 1, 1)
            }
        }
      **Response Structure** 

      

      - *(dict) --* 

        Returned in response to a successful ``GetCredentialsForIdentity`` operation.

        
        

        - **IdentityId** *(string) --* 

          A unique identifier in the format REGION:GUID.

          
        

        - **Credentials** *(dict) --* 

          Credentials for the the provided identity ID.

          
          

          - **AccessKeyId** *(string) --* 

            The Access Key portion of the credentials.

            
          

          - **SecretKey** *(string) --* 

            The Secret Access Key portion of the credentials

            
          

          - **SessionToken** *(string) --* 

            The Session Token portion of the credentials

            
          

          - **Expiration** *(datetime) --* 

            The date at which these credentials will expire.

            
      
    

  .. py:method:: get_id(**kwargs)

    

    Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.

     

    token+";"+tokenSecret.

     

    This is a public API. You do not need any credentials to call this API.

    

    **Request Syntax** 
    ::

      response = client.get_id(
          AccountId='string',
          IdentityPoolId='string',
          Logins={
              'string': 'string'
          }
      )
    :type AccountId: string
    :param AccountId: A standard AWS account ID (9+ digits).

    
    :type IdentityPoolId: string
    :param IdentityPoolId: **[REQUIRED]** An identity pool ID in the format REGION:GUID.

    
    :type Logins: dict
    :param Logins: 

      A set of optional name-value pairs that map provider names to provider tokens.

       

      The available provider names for ``Logins`` are as follows: 

       
      * Facebook: ``graph.facebook.com``  
       
      * Google: ``accounts.google.com``  
       
      * Amazon: ``www.amazon.com``  
       
      * Twitter: ``www.twitter.com``  
       
      * Digits: ``www.digits.com``  
       

       

      

    
      - *(string) --* 

      
        - *(string) --* 

        
  

    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'IdentityId': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* Returned in response to a GetId request.
        

        - **IdentityId** *(string) --* A unique identifier in the format REGION:GUID.
    

  .. py:method:: get_identity_pool_roles(**kwargs)

    

    Gets the roles for an identity pool.

     

    You must use AWS Developer credentials to call this API.

    

    **Request Syntax** 
    ::

      response = client.get_identity_pool_roles(
          IdentityPoolId='string'
      )
    :type IdentityPoolId: string
    :param IdentityPoolId: **[REQUIRED]** 

      An identity pool ID in the format REGION:GUID.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'IdentityPoolId': 'string',
            'Roles': {
                'string': 'string'
            }
        }
      **Response Structure** 

      

      - *(dict) --* 

        Returned in response to a successful ``GetIdentityPoolRoles`` operation.

        
        

        - **IdentityPoolId** *(string) --* 

          An identity pool ID in the format REGION:GUID.

          
        

        - **Roles** *(dict) --* 

          The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
    

  .. py:method:: get_open_id_token(**kwargs)

    

    Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by  GetId . You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.

     

    The OpenId token is valid for 15 minutes.

     

    This is a public API. You do not need any credentials to call this API.

    

    **Request Syntax** 
    ::

      response = client.get_open_id_token(
          IdentityId='string',
          Logins={
              'string': 'string'
          }
      )
    :type IdentityId: string
    :param IdentityId: **[REQUIRED]** A unique identifier in the format REGION:GUID.

    
    :type Logins: dict
    :param Logins: A set of optional name-value pairs that map provider names to provider tokens. When using graph.facebook.com and www.amazon.com, supply the access_token returned from the provider's authflow. For accounts.google.com or any other OpenId Connect provider, always include the id_token.

    
      - *(string) --* 

      
        - *(string) --* 

        
  

    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'IdentityId': 'string',
            'Token': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* Returned in response to a successful GetOpenIdToken request.
        

        - **IdentityId** *(string) --* A unique identifier in the format REGION:GUID. Note that the IdentityId returned may not match the one passed on input.
        

        - **Token** *(string) --* An OpenID token, valid for 15 minutes.
    

  .. py:method:: get_open_id_token_for_developer_identity(**kwargs)

    

    Registers (or retrieves) a Cognito ``IdentityId`` and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the ``Logins`` map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users.

     

    You can use ``GetOpenIdTokenForDeveloperIdentity`` to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the ``IdentityId`` should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing ``IdentityId`` . This API will create the identity in the specified ``IdentityPoolId`` .

     

    You must use AWS Developer credentials to call this API.

    

    **Request Syntax** 
    ::

      response = client.get_open_id_token_for_developer_identity(
          IdentityPoolId='string',
          IdentityId='string',
          Logins={
              'string': 'string'
          },
          TokenDuration=123
      )
    :type IdentityPoolId: string
    :param IdentityPoolId: **[REQUIRED]** 

      An identity pool ID in the format REGION:GUID.

      

    
    :type IdentityId: string
    :param IdentityId: 

      A unique identifier in the format REGION:GUID.

      

    
    :type Logins: dict
    :param Logins: **[REQUIRED]** 

      A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax ``"developer_provider_name": "developer_user_identifier"`` . The developer provider is the "domain" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins.

      

    
      - *(string) --* 

      
        - *(string) --* 

        
  

    :type TokenDuration: integer
    :param TokenDuration: 

      The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your AWS resources for the token's duration.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'IdentityId': 'string',
            'Token': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Returned in response to a successful ``GetOpenIdTokenForDeveloperIdentity`` request.

        
        

        - **IdentityId** *(string) --* 

          A unique identifier in the format REGION:GUID.

          
        

        - **Token** *(string) --* 

          An OpenID token.

          
    

  .. py:method:: get_paginator(operation_name)

        
    Create a paginator for an operation.
    
    :type operation_name: string
    :param operation_name: The operation name.  This is the same name
        as the method name on the client.  For example, if the
        method name is ``create_foo``, and you'd normally invoke the
        operation as ``client.create_foo(**kwargs)``, if the
        ``create_foo`` operation can be paginated, you can use the
        call ``client.get_paginator("create_foo")``.
    
    :raise OperationNotPageableError: Raised if the operation is not
        pageable.  You can use the ``client.can_paginate`` method to
        check if an operation is pageable.
    
    :rtype: L{botocore.paginate.Paginator}
    :return: A paginator object.


  .. py:method:: get_waiter(waiter_name)

        


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

    

    Lists the identities in a 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
      )
    :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) --* A set of optional name-value pairs that map provider names to provider tokens.
              

              - *(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.
    

  .. py:method:: list_identity_pools(**kwargs)

    

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

     

    This is a public API. You do not need any credentials to call this API.

    

    **Request Syntax** 
    ::

      response = client.list_identity_pools(
          MaxResults=123,
          NextToken='string'
      )
    :type MaxResults: integer
    :param MaxResults: **[REQUIRED]** The maximum number of identities to return.

    
    :type NextToken: string
    :param NextToken: A pagination token.

    
    
    :rtype: 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.
    

  .. py:method:: lookup_developer_identity(**kwargs)

    

    Retrieves the ``IdentityID`` associated with a ``DeveloperUserIdentifier`` or the list of ``DeveloperUserIdentifier`` s associated with an ``IdentityId`` for an existing identity. Either ``IdentityID`` or ``DeveloperUserIdentifier`` must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, ``DeveloperUserIdentifier`` will be matched against ``IdentityID`` . If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a ``ResourceConflictException`` is thrown.

     

    You must use AWS Developer credentials to call this API.

    

    **Request Syntax** 
    ::

      response = client.lookup_developer_identity(
          IdentityPoolId='string',
          IdentityId='string',
          DeveloperUserIdentifier='string',
          MaxResults=123,
          NextToken='string'
      )
    :type IdentityPoolId: string
    :param IdentityPoolId: **[REQUIRED]** 

      An identity pool ID in the format REGION:GUID.

      

    
    :type IdentityId: string
    :param IdentityId: 

      A unique identifier in the format REGION:GUID.

      

    
    :type DeveloperUserIdentifier: string
    :param DeveloperUserIdentifier: 

      A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.

      

    
    :type MaxResults: integer
    :param MaxResults: 

      The maximum number of identities to return.

      

    
    :type NextToken: string
    :param NextToken: 

      A pagination token. The first call you make will have ``NextToken`` set to null. After that the service will return ``NextToken`` values as needed. For example, let's say you make a request with ``MaxResults`` set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'IdentityId': 'string',
            'DeveloperUserIdentifierList': [
                'string',
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Returned in response to a successful ``LookupDeveloperIdentity`` action.

        
        

        - **IdentityId** *(string) --* 

          A unique identifier in the format REGION:GUID.

          
        

        - **DeveloperUserIdentifierList** *(list) --* 

          This is the list of developer user identifiers associated with an identity ID. Cognito supports the association of multiple developer user identifiers with an identity ID.

          
          

          - *(string) --* 
      
        

        - **NextToken** *(string) --* 

          A pagination token. The first call you make will have ``NextToken`` set to null. After that the service will return ``NextToken`` values as needed. For example, let's say you make a request with ``MaxResults`` set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.

          
    

  .. py:method:: merge_developer_identities(**kwargs)

    

    Merges two users having different ``IdentityId`` s, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (``SourceUserIdentifier`` ) with the ``IdentityId`` of the ``DestinationUserIdentifier`` . Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown.

     

    You must use AWS Developer credentials to call this API.

    

    **Request Syntax** 
    ::

      response = client.merge_developer_identities(
          SourceUserIdentifier='string',
          DestinationUserIdentifier='string',
          DeveloperProviderName='string',
          IdentityPoolId='string'
      )
    :type SourceUserIdentifier: string
    :param SourceUserIdentifier: **[REQUIRED]** 

      User identifier for the source user. The value should be a ``DeveloperUserIdentifier`` .

      

    
    :type DestinationUserIdentifier: string
    :param DestinationUserIdentifier: **[REQUIRED]** 

      User identifier for the destination user. The value should be a ``DeveloperUserIdentifier`` .

      

    
    :type DeveloperProviderName: string
    :param DeveloperProviderName: **[REQUIRED]** 

      The "domain" by which Cognito will refer to your users. This is a (pseudo) domain name that you provide while creating an identity pool. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the ``DeveloperProviderName`` , you can use letters as well as period (.), underscore (_), and dash (-).

      

    
    :type IdentityPoolId: string
    :param IdentityPoolId: **[REQUIRED]** 

      An identity pool ID in the format REGION:GUID.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'IdentityId': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        Returned in response to a successful ``MergeDeveloperIdentities`` action.

        
        

        - **IdentityId** *(string) --* 

          A unique identifier in the format REGION:GUID.

          
    

  .. py:method:: set_identity_pool_roles(**kwargs)

    

    Sets the roles for an identity pool. These roles are used when making calls to ``GetCredentialsForIdentity`` action.

     

    You must use AWS Developer credentials to call this API.

    

    **Request Syntax** 
    ::

      response = client.set_identity_pool_roles(
          IdentityPoolId='string',
          Roles={
              'string': 'string'
          }
      )
    :type IdentityPoolId: string
    :param IdentityPoolId: **[REQUIRED]** 

      An identity pool ID in the format REGION:GUID.

      

    
    :type Roles: dict
    :param Roles: **[REQUIRED]** 

      The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN.

      

    
      - *(string) --* 

      
        - *(string) --* 

        
  

    
    :returns: None

  .. py:method:: unlink_developer_identity(**kwargs)

    

    Unlinks a ``DeveloperUserIdentifier`` from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible.

     

    This is a public API. You do not need any credentials to call this API.

    

    **Request Syntax** 
    ::

      response = client.unlink_developer_identity(
          IdentityId='string',
          IdentityPoolId='string',
          DeveloperProviderName='string',
          DeveloperUserIdentifier='string'
      )
    :type IdentityId: string
    :param IdentityId: **[REQUIRED]** 

      A unique identifier in the format REGION:GUID.

      

    
    :type IdentityPoolId: string
    :param IdentityPoolId: **[REQUIRED]** 

      An identity pool ID in the format REGION:GUID.

      

    
    :type DeveloperProviderName: string
    :param DeveloperProviderName: **[REQUIRED]** 

      The "domain" by which Cognito will refer to your users.

      

    
    :type DeveloperUserIdentifier: string
    :param DeveloperUserIdentifier: **[REQUIRED]** A unique ID used by your backend authentication process to identify a user.

    
    
    :returns: None

  .. py:method:: unlink_identity(**kwargs)

    

    Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.

     

    This is a public API. You do not need any credentials to call this API.

    

    **Request Syntax** 
    ::

      response = client.unlink_identity(
          IdentityId='string',
          Logins={
              'string': 'string'
          },
          LoginsToRemove=[
              'string',
          ]
      )
    :type IdentityId: string
    :param IdentityId: **[REQUIRED]** A unique identifier in the format REGION:GUID.

    
    :type Logins: dict
    :param Logins: **[REQUIRED]** A set of optional name-value pairs that map provider names to provider tokens.

    
      - *(string) --* 

      
        - *(string) --* 

        
  

    :type LoginsToRemove: list
    :param LoginsToRemove: **[REQUIRED]** Provider names to unlink from this identity.

    
      - *(string) --* 

      
  
    
    :returns: None

  .. py:method:: update_identity_pool(**kwargs)

    

    Updates a user pool.

     

    You must use AWS Developer credentials to call this API.

    

    **Request Syntax** 
    ::

      response = client.update_identity_pool(
          IdentityPoolId='string',
          IdentityPoolName='string',
          AllowUnauthenticatedIdentities=True|False,
          SupportedLoginProviders={
              'string': 'string'
          },
          DeveloperProviderName='string',
          OpenIdConnectProviderARNs=[
              'string',
          ]
      )
    :type IdentityPoolId: string
    :param IdentityPoolId: **[REQUIRED]** An identity pool ID in the format REGION:GUID.

    
    :type IdentityPoolName: string
    :param IdentityPoolName: **[REQUIRED]** 

      A string that you provide.

      

    
    :type AllowUnauthenticatedIdentities: boolean
    :param AllowUnauthenticatedIdentities: **[REQUIRED]** TRUE if the identity pool supports unauthenticated logins.

    
    :type SupportedLoginProviders: dict
    :param SupportedLoginProviders: 

      Optional key:value pairs mapping provider names to provider app IDs.

      

    
      - *(string) --* 

      
        - *(string) --* 

        
  

    :type DeveloperProviderName: string
    :param DeveloperProviderName: 

      The "domain" by which Cognito will refer to your users.

      

    
    :type OpenIdConnectProviderARNs: list
    :param OpenIdConnectProviderARNs: 

      A list of OpendID Connect provider ARNs.

      

    
      - *(string) --* 

      
  
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'IdentityPoolId': 'string',
            'IdentityPoolName': 'string',
            'AllowUnauthenticatedIdentities': True|False,
            'SupportedLoginProviders': {
                'string': 'string'
            },
            'DeveloperProviderName': 'string',
            'OpenIdConnectProviderARNs': [
                'string',
            ]
        }
      **Response Structure** 

      

      - *(dict) --* An object representing a Cognito identity pool.
        

        - **IdentityPoolId** *(string) --* An identity pool ID in the format REGION:GUID.
        

        - **IdentityPoolName** *(string) --* 

          A string that you provide.

          
        

        - **AllowUnauthenticatedIdentities** *(boolean) --* TRUE if the identity pool supports unauthenticated logins.
        

        - **SupportedLoginProviders** *(dict) --* 

          Optional key:value pairs mapping provider names to provider app IDs.

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
        

        - **DeveloperProviderName** *(string) --* 

          The "domain" by which Cognito will refer to your users.

          
        

        - **OpenIdConnectProviderARNs** *(list) --* 

          A list of OpendID Connect provider ARNs.

          
          

          - *(string) --* 
      
    