OptOutSpeaker - Amazon Voice ID

OptOutSpeaker

This is used to opt-out speakers who don’t want their voice used for voice biometrics purposes. This API doesn’t require the speaker to be present in the VoiceID system and a non-present speaker can be opted-out. VoiceID will perpetuate the opt-out status and reject future enrollment requests for this speaker.

Request Syntax

{ "DomainId": "string", "SpeakerId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DomainId

The identifier of the domain containing the speaker.

Type: String

Length Constraints: Fixed length of 22.

Pattern: ^[a-zA-Z0-9]{22}$

Required: Yes

SpeakerId

The identifier of the speaker you want opted-out.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^(id#[a-zA-Z0-9]{22}|[a-zA-Z0-9][a-zA-Z0-9_-]*)$

Required: Yes

Response Syntax

{ "Speaker": { "CreatedAt": number, "CustomerSpeakerId": "string", "DomainId": "string", "GeneratedSpeakerId": "string", "Status": "string", "UpdatedAt": number } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Speaker

Information about the opted-out speaker.

Type: Speaker object

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. Check the error message and try again.

HTTP Status Code: 400

ConflictException

The request failed due to a conflict. Check the ConflictType and error message for more details.

HTTP Status Code: 400

InternalServerException

There was an unknown internal error when processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found. Check the ResourceType and error message for more details.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.

HTTP Status Code: 400

ValidationException

The request failed one or more validations; check the error message and try again.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: