UpdateParticipantAuthenticationCommand

Suggest an Edit

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.

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.

Example Syntax

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

import { ConnectClient, UpdateParticipantAuthenticationCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, UpdateParticipantAuthenticationCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // UpdateParticipantAuthenticationRequest
  State: "STRING_VALUE", // required
  InstanceId: "STRING_VALUE", // required
  Code: "STRING_VALUE",
  Error: "STRING_VALUE",
  ErrorDescription: "STRING_VALUE",
};
const command = new UpdateParticipantAuthenticationCommand(input);
const response = await client.send(command);
// {};

UpdateParticipantAuthenticationCommand Input

See UpdateParticipantAuthenticationCommandInput for more details

Parameter
Type
Description
InstanceId
Required
string | undefined

The identifier of the Amazon Connect instance. You can find the instance ID  in the Amazon Resource Name (ARN) of the instance.

State
Required
string | undefined

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.

Code
string | undefined

The code query parameter provided by Cognito in the redirectUri.

Error
string | undefined

The error query parameter provided by Cognito in the redirectUri.

ErrorDescription
string | undefined

The error_description parameter provided by Cognito in the redirectUri.

UpdateParticipantAuthenticationCommand Output

See UpdateParticipantAuthenticationCommandOutput for details

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

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient permissions to perform this action.

ConflictException
client

Operation cannot be performed at this time as there is a conflict with another operation or contact state.

InternalServiceException
server

Request processing failed because of an error or failure with the service.

InvalidParameterException
client

One or more of the specified parameters are not valid.

InvalidRequestException
client

The request is not valid.

ThrottlingException
client

The throttling limit has been exceeded.

ConnectServiceException
Base exception class for all service exceptions from Connect service.