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
POST /contact/update-participant-authentication HTTP/1.1
Content-type: application/json
{
"Code": "string",
"Error": "string",
"ErrorDescription": "string",
"InstanceId": "string",
"State": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- Code
-
The
codequery parameter provided by Cognito in theredirectUri.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
- Error
-
The
errorquery parameter provided by Cognito in theredirectUri.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^[\x20-\x21\x23-\x5B\x5D-\x7E]*$Required: No
- ErrorDescription
-
The
error_descriptionparameter provided by Cognito in theredirectUri.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^[\x20-\x21\x23-\x5B\x5D-\x7E]*$Required: No
- InstanceId
-
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
- State
-
The
statequery parameter that was provided by Cognito in theredirectUri. This will also match thestateparameter provided in theAuthenticationUrlfrom the GetAuthenticationUrl response.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403
- ConflictException
-
Operation cannot be performed at this time as there is a conflict with another operation or contact state.
HTTP Status Code: 409
- InternalServiceException
-
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500
- InvalidParameterException
-
One or more of the specified parameters are not valid.
HTTP Status Code: 400
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- ThrottlingException
-
The throttling limit has been exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
