:doc:`Connect <../../connect>` / Client / update_participant_authentication

*********************************
update_participant_authentication
*********************************



.. py:method:: Connect.Client.update_participant_authentication(**kwargs)

  

  Instructs Amazon Connect to resume the authentication process. The subsequent actions depend on the request body contents:

   

  
  * **If a code is provided**: Connect retrieves the identity information from Amazon Cognito and imports it into Connect Customer Profiles.
   
  * **If an error is provided**: The error branch of the Authenticate Customer block is executed.
  

   

  .. note::

    

    The API returns a success response to acknowledge the request. However, the interaction and exchange of identity information occur asynchronously after the response is returned.

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateParticipantAuthentication>`_  


  **Request Syntax**
  ::

    response = client.update_participant_authentication(
        State='string',
        InstanceId='string',
        Code='string',
        Error='string',
        ErrorDescription='string'
    )
    
  :type State: string
  :param State: **[REQUIRED]** 

    The ``state`` query parameter that was provided by Cognito in the ``redirectUri``. This will also match the ``state`` parameter provided in the ``AuthenticationUrl`` from the `GetAuthenticationUrl <https://docs.aws.amazon.com/connect/latest/APIReference/API_GetAuthenticationUrl.html>`__ response.

    

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

    The identifier of the Amazon Connect instance. You can `find the instance ID <https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html>`__ in the Amazon Resource Name (ARN) of the instance.

    

  
  :type Code: string
  :param Code: 

    The ``code`` query parameter provided by Cognito in the ``redirectUri``.

    

  
  :type Error: string
  :param Error: 

    The ``error`` query parameter provided by Cognito in the ``redirectUri``.

    

  
  :type ErrorDescription: string
  :param ErrorDescription: 

    The ``error_description`` parameter provided by Cognito in the ``redirectUri``.

    

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

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`Connect.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`Connect.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`Connect.Client.exceptions.ConflictException`

  
  *   :py:class:`Connect.Client.exceptions.InternalServiceException`

  
  *   :py:class:`Connect.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Connect.Client.exceptions.AccessDeniedException`

  