CancelParticipantAuthenticationCommand

Suggest an Edit

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

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ConnectParticipantClient, CancelParticipantAuthenticationCommand } from "@aws-sdk/client-connectparticipant"; // ES Modules import
// const { ConnectParticipantClient, CancelParticipantAuthenticationCommand } = require("@aws-sdk/client-connectparticipant"); // CommonJS import
const client = new ConnectParticipantClient(config);
const input = { // CancelParticipantAuthenticationRequest
  SessionId: "STRING_VALUE", // required
  ConnectionToken: "STRING_VALUE", // required
};
const command = new CancelParticipantAuthenticationCommand(input);
const response = await client.send(command);
// {};

CancelParticipantAuthenticationCommand Input

See CancelParticipantAuthenticationCommandInput for more details

Parameter
Type
Description
ConnectionToken
Required
string | undefined

The authentication token associated with the participant's connection.

SessionId
Required
string | undefined

The sessionId provided in the authenticationInitiated event.

CancelParticipantAuthenticationCommand Output

See CancelParticipantAuthenticationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

This exception occurs when there is an internal failure in the Amazon Connect service.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints specified by Amazon Connect.

ConnectParticipantServiceException
Base exception class for all service exceptions from ConnectParticipant service.