Connect / Client / update_participant_authentication

update_participant_authentication¶

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.

Request Syntax

response = client.update_participant_authentication(
    State='string',
    InstanceId='string',
    Code='string',
    Error='string',
    ErrorDescription='string'
)

Parameters:

State (string) –
[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 response.
InstanceId (string) –
[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Code (string) – The code query parameter provided by Cognito in the redirectUri.
Error (string) – The error query parameter provided by Cognito in the redirectUri.
ErrorDescription (string) – The error_description parameter provided by Cognito in the redirectUri.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Exceptions

Connect.Client.exceptions.InvalidRequestException
Connect.Client.exceptions.InvalidParameterException
Connect.Client.exceptions.ConflictException
Connect.Client.exceptions.InternalServiceException
Connect.Client.exceptions.ThrottlingException
Connect.Client.exceptions.AccessDeniedException