ConnectParticipant / Client / cancel_participant_authentication

cancel_participant_authentication

ConnectParticipant.Client.cancel_participant_authentication(**kwargs)

Cancels the authentication session. The opted out branch of the Authenticate Customer flow block will be taken.

Note

The current supported channel is chat. This API is not supported for Apple Messages for Business, WhatsApp, or SMS chats.

Note

ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

See also: AWS API Documentation

Request Syntax

response = client.cancel_participant_authentication(
    SessionId='string',
    ConnectionToken='string'
)
Parameters:

  • SessionId (string) –

    [REQUIRED]

    The sessionId provided in the authenticationInitiated event.

  • ConnectionToken (string) –

    [REQUIRED]

    The authentication token associated with the participant’s connection.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions