# Amazon Voice ID
<a name="API_Operations_Amazon_Voice_ID"></a>

The following actions are supported by Amazon Voice ID:
+  [AssociateFraudster](API_connect-voice-id_AssociateFraudster.md) 
+  [CreateDomain](API_connect-voice-id_CreateDomain.md) 
+  [CreateWatchlist](API_connect-voice-id_CreateWatchlist.md) 
+  [DeleteDomain](API_connect-voice-id_DeleteDomain.md) 
+  [DeleteFraudster](API_connect-voice-id_DeleteFraudster.md) 
+  [DeleteSpeaker](API_connect-voice-id_DeleteSpeaker.md) 
+  [DeleteWatchlist](API_connect-voice-id_DeleteWatchlist.md) 
+  [DescribeDomain](API_connect-voice-id_DescribeDomain.md) 
+  [DescribeFraudster](API_connect-voice-id_DescribeFraudster.md) 
+  [DescribeFraudsterRegistrationJob](API_connect-voice-id_DescribeFraudsterRegistrationJob.md) 
+  [DescribeSpeaker](API_connect-voice-id_DescribeSpeaker.md) 
+  [DescribeSpeakerEnrollmentJob](API_connect-voice-id_DescribeSpeakerEnrollmentJob.md) 
+  [DescribeWatchlist](API_connect-voice-id_DescribeWatchlist.md) 
+  [DisassociateFraudster](API_connect-voice-id_DisassociateFraudster.md) 
+  [EvaluateSession](API_connect-voice-id_EvaluateSession.md) 
+  [ListDomains](API_connect-voice-id_ListDomains.md) 
+  [ListFraudsterRegistrationJobs](API_connect-voice-id_ListFraudsterRegistrationJobs.md) 
+  [ListFraudsters](API_connect-voice-id_ListFraudsters.md) 
+  [ListSpeakerEnrollmentJobs](API_connect-voice-id_ListSpeakerEnrollmentJobs.md) 
+  [ListSpeakers](API_connect-voice-id_ListSpeakers.md) 
+  [ListTagsForResource](API_connect-voice-id_ListTagsForResource.md) 
+  [ListWatchlists](API_connect-voice-id_ListWatchlists.md) 
+  [OptOutSpeaker](API_connect-voice-id_OptOutSpeaker.md) 
+  [StartFraudsterRegistrationJob](API_connect-voice-id_StartFraudsterRegistrationJob.md) 
+  [StartSpeakerEnrollmentJob](API_connect-voice-id_StartSpeakerEnrollmentJob.md) 
+  [TagResource](API_connect-voice-id_TagResource.md) 
+  [UntagResource](API_connect-voice-id_UntagResource.md) 
+  [UpdateDomain](API_connect-voice-id_UpdateDomain.md) 
+  [UpdateWatchlist](API_connect-voice-id_UpdateWatchlist.md) 

# AssociateFraudster
<a name="API_connect-voice-id_AssociateFraudster"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Associates the fraudsters with the watchlist specified in the same domain. 

## Request Syntax
<a name="API_connect-voice-id_AssociateFraudster_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "FraudsterId": "string",
   "WatchlistId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_AssociateFraudster_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_AssociateFraudster_RequestSyntax) **   <a name="connect-connect-voice-id_AssociateFraudster-request-DomainId"></a>
The identifier of the domain that contains the fraudster.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [FraudsterId](#API_connect-voice-id_AssociateFraudster_RequestSyntax) **   <a name="connect-connect-voice-id_AssociateFraudster-request-FraudsterId"></a>
The identifier of the fraudster to be associated with the watchlist.  
Type: String  
Length Constraints: Fixed length of 25.  
Pattern: `id#[a-zA-Z0-9]{22}`   
Required: Yes

 ** [WatchlistId](#API_connect-voice-id_AssociateFraudster_RequestSyntax) **   <a name="connect-connect-voice-id_AssociateFraudster-request-WatchlistId"></a>
The identifier of the watchlist you want to associate with the fraudster.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_AssociateFraudster_ResponseSyntax"></a>

```
{
   "Fraudster": { 
      "CreatedAt": number,
      "DomainId": "string",
      "GeneratedFraudsterId": "string",
      "WatchlistIds": [ "string" ]
   }
}
```

## Response Elements
<a name="API_connect-voice-id_AssociateFraudster_ResponseElements"></a>

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

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

 ** [Fraudster](#API_connect-voice-id_AssociateFraudster_ResponseSyntax) **   <a name="connect-connect-voice-id_AssociateFraudster-response-Fraudster"></a>
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).
Contains all the information about a fraudster.  
Type: [Fraudster](API_connect-voice-id_Fraudster.md) object

## Errors
<a name="API_connect-voice-id_AssociateFraudster_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** 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.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The request exceeded the service quota. Refer to [Voice ID Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) and try your request again.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_AssociateFraudster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/AssociateFraudster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/AssociateFraudster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/AssociateFraudster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/AssociateFraudster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/AssociateFraudster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/AssociateFraudster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/AssociateFraudster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/AssociateFraudster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/AssociateFraudster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/AssociateFraudster) 

# CreateDomain
<a name="API_connect-voice-id_CreateDomain"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints. Every domain is created with a default watchlist that fraudsters can be a part of.

## Request Syntax
<a name="API_connect-voice-id_CreateDomain_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "Description": "string",
   "Name": "string",
   "ServerSideEncryptionConfiguration": { 
      "KmsKeyId": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_connect-voice-id_CreateDomain_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ClientToken](#API_connect-voice-id_CreateDomain_RequestSyntax) **   <a name="connect-connect-voice-id_CreateDomain-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-_]+`   
Required: No

 ** [Description](#API_connect-voice-id_CreateDomain_RequestSyntax) **   <a name="connect-connect-voice-id_CreateDomain-request-Description"></a>
A brief description of this domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)`   
Required: No

 ** [Name](#API_connect-voice-id_CreateDomain_RequestSyntax) **   <a name="connect-connect-voice-id_CreateDomain-request-Name"></a>
The name of the domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [ServerSideEncryptionConfiguration](#API_connect-voice-id_CreateDomain_RequestSyntax) **   <a name="connect-connect-voice-id_CreateDomain-request-ServerSideEncryptionConfiguration"></a>
The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side encryption of your data. Refer to [ Amazon Connect Voice ID encryption at rest](https://docs.aws.amazon.com/connect/latest/adminguide/encryption-at-rest.html#encryption-at-rest-voiceid) for more details on how the KMS key is used.   
Type: [ServerSideEncryptionConfiguration](API_connect-voice-id_ServerSideEncryptionConfiguration.md) object  
Required: Yes

 ** [Tags](#API_connect-voice-id_CreateDomain_RequestSyntax) **   <a name="connect-connect-voice-id_CreateDomain-request-Tags"></a>
A list of tags you want added to the domain.  
Type: Array of [Tag](API_connect-voice-id_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

## Response Syntax
<a name="API_connect-voice-id_CreateDomain_ResponseSyntax"></a>

```
{
   "Domain": { 
      "Arn": "string",
      "CreatedAt": number,
      "Description": "string",
      "DomainId": "string",
      "DomainStatus": "string",
      "Name": "string",
      "ServerSideEncryptionConfiguration": { 
         "KmsKeyId": "string"
      },
      "ServerSideEncryptionUpdateDetails": { 
         "Message": "string",
         "OldKmsKeyId": "string",
         "UpdateStatus": "string"
      },
      "UpdatedAt": number,
      "WatchlistDetails": { 
         "DefaultWatchlistId": "string"
      }
   }
}
```

## Response Elements
<a name="API_connect-voice-id_CreateDomain_ResponseElements"></a>

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

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

 ** [Domain](#API_connect-voice-id_CreateDomain_ResponseSyntax) **   <a name="connect-connect-voice-id_CreateDomain-response-Domain"></a>
Information about the newly created domain.  
Type: [Domain](API_connect-voice-id_Domain.md) object

## Errors
<a name="API_connect-voice-id_CreateDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** 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.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The request exceeded the service quota. Refer to [Voice ID Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) and try your request again.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_CreateDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/CreateDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/CreateDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/CreateDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/CreateDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/CreateDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/CreateDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/CreateDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/CreateDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/CreateDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/CreateDomain) 

# CreateWatchlist
<a name="API_connect-voice-id_CreateWatchlist"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Creates a watchlist that fraudsters can be a part of.

## Request Syntax
<a name="API_connect-voice-id_CreateWatchlist_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "Description": "string",
   "DomainId": "string",
   "Name": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_CreateWatchlist_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ClientToken](#API_connect-voice-id_CreateWatchlist_RequestSyntax) **   <a name="connect-connect-voice-id_CreateWatchlist-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-_]+`   
Required: No

 ** [Description](#API_connect-voice-id_CreateWatchlist_RequestSyntax) **   <a name="connect-connect-voice-id_CreateWatchlist-request-Description"></a>
A brief description of this watchlist.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)`   
Required: No

 ** [DomainId](#API_connect-voice-id_CreateWatchlist_RequestSyntax) **   <a name="connect-connect-voice-id_CreateWatchlist-request-DomainId"></a>
The identifier of the domain that contains the watchlist.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [Name](#API_connect-voice-id_CreateWatchlist_RequestSyntax) **   <a name="connect-connect-voice-id_CreateWatchlist-request-Name"></a>
The name of the watchlist.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_CreateWatchlist_ResponseSyntax"></a>

```
{
   "Watchlist": { 
      "CreatedAt": number,
      "DefaultWatchlist": boolean,
      "Description": "string",
      "DomainId": "string",
      "Name": "string",
      "UpdatedAt": number,
      "WatchlistId": "string"
   }
}
```

## Response Elements
<a name="API_connect-voice-id_CreateWatchlist_ResponseElements"></a>

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

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

 ** [Watchlist](#API_connect-voice-id_CreateWatchlist_ResponseSyntax) **   <a name="connect-connect-voice-id_CreateWatchlist-response-Watchlist"></a>
Information about the newly created watchlist.  
Type: [Watchlist](API_connect-voice-id_Watchlist.md) object

## Errors
<a name="API_connect-voice-id_CreateWatchlist_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** 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.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The request exceeded the service quota. Refer to [Voice ID Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) and try your request again.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_CreateWatchlist_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/CreateWatchlist) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/CreateWatchlist) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/CreateWatchlist) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/CreateWatchlist) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/CreateWatchlist) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/CreateWatchlist) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/CreateWatchlist) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/CreateWatchlist) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/CreateWatchlist) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/CreateWatchlist) 

# DeleteDomain
<a name="API_connect-voice-id_DeleteDomain"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Deletes the specified domain from Voice ID.

## Request Syntax
<a name="API_connect-voice-id_DeleteDomain_RequestSyntax"></a>

```
{
   "DomainId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_DeleteDomain_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_DeleteDomain_RequestSyntax) **   <a name="connect-connect-voice-id_DeleteDomain-request-DomainId"></a>
The identifier of the domain you want to delete.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

## Response Elements
<a name="API_connect-voice-id_DeleteDomain_ResponseElements"></a>

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

## Errors
<a name="API_connect-voice-id_DeleteDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** 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.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_DeleteDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/DeleteDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/DeleteDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/DeleteDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/DeleteDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/DeleteDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/DeleteDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/DeleteDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/DeleteDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/DeleteDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/DeleteDomain) 

# DeleteFraudster
<a name="API_connect-voice-id_DeleteFraudster"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Deletes the specified fraudster from Voice ID. This action disassociates the fraudster from any watchlists it is a part of.

## Request Syntax
<a name="API_connect-voice-id_DeleteFraudster_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "FraudsterId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_DeleteFraudster_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_DeleteFraudster_RequestSyntax) **   <a name="connect-connect-voice-id_DeleteFraudster-request-DomainId"></a>
The identifier of the domain that contains the fraudster.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [FraudsterId](#API_connect-voice-id_DeleteFraudster_RequestSyntax) **   <a name="connect-connect-voice-id_DeleteFraudster-request-FraudsterId"></a>
The identifier of the fraudster you want to delete.  
Type: String  
Length Constraints: Fixed length of 25.  
Pattern: `id#[a-zA-Z0-9]{22}`   
Required: Yes

## Response Elements
<a name="API_connect-voice-id_DeleteFraudster_ResponseElements"></a>

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

## Errors
<a name="API_connect-voice-id_DeleteFraudster_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** 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.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_DeleteFraudster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/DeleteFraudster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/DeleteFraudster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/DeleteFraudster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/DeleteFraudster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/DeleteFraudster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/DeleteFraudster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/DeleteFraudster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/DeleteFraudster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/DeleteFraudster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/DeleteFraudster) 

# DeleteSpeaker
<a name="API_connect-voice-id_DeleteSpeaker"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Deletes the specified speaker from Voice ID.

## Request Syntax
<a name="API_connect-voice-id_DeleteSpeaker_RequestSyntax"></a>

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

## Request Parameters
<a name="API_connect-voice-id_DeleteSpeaker_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_DeleteSpeaker_RequestSyntax) **   <a name="connect-connect-voice-id_DeleteSpeaker-request-DomainId"></a>
The identifier of the domain that contains the speaker.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [SpeakerId](#API_connect-voice-id_DeleteSpeaker_RequestSyntax) **   <a name="connect-connect-voice-id_DeleteSpeaker-request-SpeakerId"></a>
The identifier of the speaker you want to delete.  
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 Elements
<a name="API_connect-voice-id_DeleteSpeaker_ResponseElements"></a>

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

## Errors
<a name="API_connect-voice-id_DeleteSpeaker_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** 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.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_DeleteSpeaker_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/DeleteSpeaker) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/DeleteSpeaker) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/DeleteSpeaker) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/DeleteSpeaker) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/DeleteSpeaker) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/DeleteSpeaker) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/DeleteSpeaker) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/DeleteSpeaker) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/DeleteSpeaker) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/DeleteSpeaker) 

# DeleteWatchlist
<a name="API_connect-voice-id_DeleteWatchlist"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Deletes the specified watchlist from Voice ID. This API throws an exception when there are fraudsters in the watchlist that you are trying to delete. You must delete the fraudsters, and then delete the watchlist. Every domain has a default watchlist which cannot be deleted. 

## Request Syntax
<a name="API_connect-voice-id_DeleteWatchlist_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "WatchlistId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_DeleteWatchlist_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_DeleteWatchlist_RequestSyntax) **   <a name="connect-connect-voice-id_DeleteWatchlist-request-DomainId"></a>
The identifier of the domain that contains the watchlist.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [WatchlistId](#API_connect-voice-id_DeleteWatchlist_RequestSyntax) **   <a name="connect-connect-voice-id_DeleteWatchlist-request-WatchlistId"></a>
The identifier of the watchlist to be deleted.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

## Response Elements
<a name="API_connect-voice-id_DeleteWatchlist_ResponseElements"></a>

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

## Errors
<a name="API_connect-voice-id_DeleteWatchlist_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** 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.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_DeleteWatchlist_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/DeleteWatchlist) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/DeleteWatchlist) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/DeleteWatchlist) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/DeleteWatchlist) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/DeleteWatchlist) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/DeleteWatchlist) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/DeleteWatchlist) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/DeleteWatchlist) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/DeleteWatchlist) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/DeleteWatchlist) 

# DescribeDomain
<a name="API_connect-voice-id_DescribeDomain"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Describes the specified domain.

## Request Syntax
<a name="API_connect-voice-id_DescribeDomain_RequestSyntax"></a>

```
{
   "DomainId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_DescribeDomain_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_DescribeDomain_RequestSyntax) **   <a name="connect-connect-voice-id_DescribeDomain-request-DomainId"></a>
The identifier of the domain that you are describing.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_DescribeDomain_ResponseSyntax"></a>

```
{
   "Domain": { 
      "Arn": "string",
      "CreatedAt": number,
      "Description": "string",
      "DomainId": "string",
      "DomainStatus": "string",
      "Name": "string",
      "ServerSideEncryptionConfiguration": { 
         "KmsKeyId": "string"
      },
      "ServerSideEncryptionUpdateDetails": { 
         "Message": "string",
         "OldKmsKeyId": "string",
         "UpdateStatus": "string"
      },
      "UpdatedAt": number,
      "WatchlistDetails": { 
         "DefaultWatchlistId": "string"
      }
   }
}
```

## Response Elements
<a name="API_connect-voice-id_DescribeDomain_ResponseElements"></a>

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

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

 ** [Domain](#API_connect-voice-id_DescribeDomain_ResponseSyntax) **   <a name="connect-connect-voice-id_DescribeDomain-response-Domain"></a>
Information about the specified domain.  
Type: [Domain](API_connect-voice-id_Domain.md) object

## Errors
<a name="API_connect-voice-id_DescribeDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_DescribeDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/DescribeDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/DescribeDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/DescribeDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/DescribeDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/DescribeDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/DescribeDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/DescribeDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/DescribeDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/DescribeDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/DescribeDomain) 

# DescribeFraudster
<a name="API_connect-voice-id_DescribeFraudster"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Describes the specified fraudster.

## Request Syntax
<a name="API_connect-voice-id_DescribeFraudster_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "FraudsterId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_DescribeFraudster_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_DescribeFraudster_RequestSyntax) **   <a name="connect-connect-voice-id_DescribeFraudster-request-DomainId"></a>
The identifier of the domain that contains the fraudster.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [FraudsterId](#API_connect-voice-id_DescribeFraudster_RequestSyntax) **   <a name="connect-connect-voice-id_DescribeFraudster-request-FraudsterId"></a>
The identifier of the fraudster you are describing.  
Type: String  
Length Constraints: Fixed length of 25.  
Pattern: `id#[a-zA-Z0-9]{22}`   
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_DescribeFraudster_ResponseSyntax"></a>

```
{
   "Fraudster": { 
      "CreatedAt": number,
      "DomainId": "string",
      "GeneratedFraudsterId": "string",
      "WatchlistIds": [ "string" ]
   }
}
```

## Response Elements
<a name="API_connect-voice-id_DescribeFraudster_ResponseElements"></a>

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

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

 ** [Fraudster](#API_connect-voice-id_DescribeFraudster_ResponseSyntax) **   <a name="connect-connect-voice-id_DescribeFraudster-response-Fraudster"></a>
Information about the specified fraudster.  
Type: [Fraudster](API_connect-voice-id_Fraudster.md) object

## Errors
<a name="API_connect-voice-id_DescribeFraudster_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_DescribeFraudster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/DescribeFraudster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/DescribeFraudster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/DescribeFraudster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/DescribeFraudster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/DescribeFraudster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/DescribeFraudster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/DescribeFraudster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/DescribeFraudster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/DescribeFraudster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/DescribeFraudster) 

# DescribeFraudsterRegistrationJob
<a name="API_connect-voice-id_DescribeFraudsterRegistrationJob"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Describes the specified fraudster registration job.

## Request Syntax
<a name="API_connect-voice-id_DescribeFraudsterRegistrationJob_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "JobId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_DescribeFraudsterRegistrationJob_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_DescribeFraudsterRegistrationJob_RequestSyntax) **   <a name="connect-connect-voice-id_DescribeFraudsterRegistrationJob-request-DomainId"></a>
The identifier of the domain that contains the fraudster registration job.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [JobId](#API_connect-voice-id_DescribeFraudsterRegistrationJob_RequestSyntax) **   <a name="connect-connect-voice-id_DescribeFraudsterRegistrationJob-request-JobId"></a>
The identifier of the fraudster registration job you are describing.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_DescribeFraudsterRegistrationJob_ResponseSyntax"></a>

```
{
   "Job": { 
      "CreatedAt": number,
      "DataAccessRoleArn": "string",
      "DomainId": "string",
      "EndedAt": number,
      "FailureDetails": { 
         "Message": "string",
         "StatusCode": number
      },
      "InputDataConfig": { 
         "S3Uri": "string"
      },
      "JobId": "string",
      "JobName": "string",
      "JobProgress": { 
         "PercentComplete": number
      },
      "JobStatus": "string",
      "OutputDataConfig": { 
         "KmsKeyId": "string",
         "S3Uri": "string"
      },
      "RegistrationConfig": { 
         "DuplicateRegistrationAction": "string",
         "FraudsterSimilarityThreshold": number,
         "WatchlistIds": [ "string" ]
      }
   }
}
```

## Response Elements
<a name="API_connect-voice-id_DescribeFraudsterRegistrationJob_ResponseElements"></a>

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

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

 ** [Job](#API_connect-voice-id_DescribeFraudsterRegistrationJob_ResponseSyntax) **   <a name="connect-connect-voice-id_DescribeFraudsterRegistrationJob-response-Job"></a>
Contains details about the specified fraudster registration job.  
Type: [FraudsterRegistrationJob](API_connect-voice-id_FraudsterRegistrationJob.md) object

## Errors
<a name="API_connect-voice-id_DescribeFraudsterRegistrationJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_DescribeFraudsterRegistrationJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/DescribeFraudsterRegistrationJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/DescribeFraudsterRegistrationJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/DescribeFraudsterRegistrationJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/DescribeFraudsterRegistrationJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/DescribeFraudsterRegistrationJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/DescribeFraudsterRegistrationJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/DescribeFraudsterRegistrationJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/DescribeFraudsterRegistrationJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/DescribeFraudsterRegistrationJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/DescribeFraudsterRegistrationJob) 

# DescribeSpeaker
<a name="API_connect-voice-id_DescribeSpeaker"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Describes the specified speaker.

## Request Syntax
<a name="API_connect-voice-id_DescribeSpeaker_RequestSyntax"></a>

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

## Request Parameters
<a name="API_connect-voice-id_DescribeSpeaker_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_DescribeSpeaker_RequestSyntax) **   <a name="connect-connect-voice-id_DescribeSpeaker-request-DomainId"></a>
The identifier of the domain that contains the speaker.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [SpeakerId](#API_connect-voice-id_DescribeSpeaker_RequestSyntax) **   <a name="connect-connect-voice-id_DescribeSpeaker-request-SpeakerId"></a>
The identifier of the speaker you are describing.  
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
<a name="API_connect-voice-id_DescribeSpeaker_ResponseSyntax"></a>

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

## Response Elements
<a name="API_connect-voice-id_DescribeSpeaker_ResponseElements"></a>

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](#API_connect-voice-id_DescribeSpeaker_ResponseSyntax) **   <a name="connect-connect-voice-id_DescribeSpeaker-response-Speaker"></a>
Information about the specified speaker.  
Type: [Speaker](API_connect-voice-id_Speaker.md) object

## Errors
<a name="API_connect-voice-id_DescribeSpeaker_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_DescribeSpeaker_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/DescribeSpeaker) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/DescribeSpeaker) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/DescribeSpeaker) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/DescribeSpeaker) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/DescribeSpeaker) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/DescribeSpeaker) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/DescribeSpeaker) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/DescribeSpeaker) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/DescribeSpeaker) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/DescribeSpeaker) 

# DescribeSpeakerEnrollmentJob
<a name="API_connect-voice-id_DescribeSpeakerEnrollmentJob"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Describes the specified speaker enrollment job.

## Request Syntax
<a name="API_connect-voice-id_DescribeSpeakerEnrollmentJob_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "JobId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_DescribeSpeakerEnrollmentJob_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_DescribeSpeakerEnrollmentJob_RequestSyntax) **   <a name="connect-connect-voice-id_DescribeSpeakerEnrollmentJob-request-DomainId"></a>
The identifier of the domain that contains the speaker enrollment job.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [JobId](#API_connect-voice-id_DescribeSpeakerEnrollmentJob_RequestSyntax) **   <a name="connect-connect-voice-id_DescribeSpeakerEnrollmentJob-request-JobId"></a>
The identifier of the speaker enrollment job you are describing.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_DescribeSpeakerEnrollmentJob_ResponseSyntax"></a>

```
{
   "Job": { 
      "CreatedAt": number,
      "DataAccessRoleArn": "string",
      "DomainId": "string",
      "EndedAt": number,
      "EnrollmentConfig": { 
         "ExistingEnrollmentAction": "string",
         "FraudDetectionConfig": { 
            "FraudDetectionAction": "string",
            "RiskThreshold": number,
            "WatchlistIds": [ "string" ]
         }
      },
      "FailureDetails": { 
         "Message": "string",
         "StatusCode": number
      },
      "InputDataConfig": { 
         "S3Uri": "string"
      },
      "JobId": "string",
      "JobName": "string",
      "JobProgress": { 
         "PercentComplete": number
      },
      "JobStatus": "string",
      "OutputDataConfig": { 
         "KmsKeyId": "string",
         "S3Uri": "string"
      }
   }
}
```

## Response Elements
<a name="API_connect-voice-id_DescribeSpeakerEnrollmentJob_ResponseElements"></a>

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

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

 ** [Job](#API_connect-voice-id_DescribeSpeakerEnrollmentJob_ResponseSyntax) **   <a name="connect-connect-voice-id_DescribeSpeakerEnrollmentJob-response-Job"></a>
Contains details about the specified speaker enrollment job.  
Type: [SpeakerEnrollmentJob](API_connect-voice-id_SpeakerEnrollmentJob.md) object

## Errors
<a name="API_connect-voice-id_DescribeSpeakerEnrollmentJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_DescribeSpeakerEnrollmentJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/DescribeSpeakerEnrollmentJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/DescribeSpeakerEnrollmentJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/DescribeSpeakerEnrollmentJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/DescribeSpeakerEnrollmentJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/DescribeSpeakerEnrollmentJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/DescribeSpeakerEnrollmentJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/DescribeSpeakerEnrollmentJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/DescribeSpeakerEnrollmentJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/DescribeSpeakerEnrollmentJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/DescribeSpeakerEnrollmentJob) 

# DescribeWatchlist
<a name="API_connect-voice-id_DescribeWatchlist"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Describes the specified watchlist.

## Request Syntax
<a name="API_connect-voice-id_DescribeWatchlist_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "WatchlistId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_DescribeWatchlist_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_DescribeWatchlist_RequestSyntax) **   <a name="connect-connect-voice-id_DescribeWatchlist-request-DomainId"></a>
The identifier of the domain that contains the watchlist.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [WatchlistId](#API_connect-voice-id_DescribeWatchlist_RequestSyntax) **   <a name="connect-connect-voice-id_DescribeWatchlist-request-WatchlistId"></a>
The identifier of the watchlist that you are describing.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_DescribeWatchlist_ResponseSyntax"></a>

```
{
   "Watchlist": { 
      "CreatedAt": number,
      "DefaultWatchlist": boolean,
      "Description": "string",
      "DomainId": "string",
      "Name": "string",
      "UpdatedAt": number,
      "WatchlistId": "string"
   }
}
```

## Response Elements
<a name="API_connect-voice-id_DescribeWatchlist_ResponseElements"></a>

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

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

 ** [Watchlist](#API_connect-voice-id_DescribeWatchlist_ResponseSyntax) **   <a name="connect-connect-voice-id_DescribeWatchlist-response-Watchlist"></a>
Information about the specified watchlist.  
Type: [Watchlist](API_connect-voice-id_Watchlist.md) object

## Errors
<a name="API_connect-voice-id_DescribeWatchlist_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_DescribeWatchlist_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/DescribeWatchlist) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/DescribeWatchlist) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/DescribeWatchlist) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/DescribeWatchlist) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/DescribeWatchlist) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/DescribeWatchlist) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/DescribeWatchlist) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/DescribeWatchlist) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/DescribeWatchlist) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/DescribeWatchlist) 

# DisassociateFraudster
<a name="API_connect-voice-id_DisassociateFraudster"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Disassociates the fraudsters from the watchlist specified. Voice ID always expects a fraudster to be a part of at least one watchlist. If you try to disassociate a fraudster from its only watchlist, a `ValidationException` is thrown. 

## Request Syntax
<a name="API_connect-voice-id_DisassociateFraudster_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "FraudsterId": "string",
   "WatchlistId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_DisassociateFraudster_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_DisassociateFraudster_RequestSyntax) **   <a name="connect-connect-voice-id_DisassociateFraudster-request-DomainId"></a>
The identifier of the domain that contains the fraudster.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [FraudsterId](#API_connect-voice-id_DisassociateFraudster_RequestSyntax) **   <a name="connect-connect-voice-id_DisassociateFraudster-request-FraudsterId"></a>
The identifier of the fraudster to be disassociated from the watchlist.  
Type: String  
Length Constraints: Fixed length of 25.  
Pattern: `id#[a-zA-Z0-9]{22}`   
Required: Yes

 ** [WatchlistId](#API_connect-voice-id_DisassociateFraudster_RequestSyntax) **   <a name="connect-connect-voice-id_DisassociateFraudster-request-WatchlistId"></a>
The identifier of the watchlist that you want to disassociate from the fraudster.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_DisassociateFraudster_ResponseSyntax"></a>

```
{
   "Fraudster": { 
      "CreatedAt": number,
      "DomainId": "string",
      "GeneratedFraudsterId": "string",
      "WatchlistIds": [ "string" ]
   }
}
```

## Response Elements
<a name="API_connect-voice-id_DisassociateFraudster_ResponseElements"></a>

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

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

 ** [Fraudster](#API_connect-voice-id_DisassociateFraudster_ResponseSyntax) **   <a name="connect-connect-voice-id_DisassociateFraudster-response-Fraudster"></a>
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).
Contains all the information about a fraudster.  
Type: [Fraudster](API_connect-voice-id_Fraudster.md) object

## Errors
<a name="API_connect-voice-id_DisassociateFraudster_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** 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.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_DisassociateFraudster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/DisassociateFraudster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/DisassociateFraudster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/DisassociateFraudster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/DisassociateFraudster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/DisassociateFraudster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/DisassociateFraudster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/DisassociateFraudster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/DisassociateFraudster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/DisassociateFraudster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/DisassociateFraudster) 

# EvaluateSession
<a name="API_connect-voice-id_EvaluateSession"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.

## Request Syntax
<a name="API_connect-voice-id_EvaluateSession_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "SessionNameOrId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_EvaluateSession_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_EvaluateSession_RequestSyntax) **   <a name="connect-connect-voice-id_EvaluateSession-request-DomainId"></a>
The identifier of the domain where the session started.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [SessionNameOrId](#API_connect-voice-id_EvaluateSession_RequestSyntax) **   <a name="connect-connect-voice-id_EvaluateSession-request-SessionNameOrId"></a>
The session identifier, or name of the session, that you want to evaluate. In Voice ID integration, this is the Contact-Id.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Pattern: `(id#[a-zA-Z0-9]{22}|[a-zA-Z0-9][a-zA-Z0-9_-]*)`   
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_EvaluateSession_ResponseSyntax"></a>

```
{
   "AuthenticationResult": { 
      "AudioAggregationEndedAt": number,
      "AudioAggregationStartedAt": number,
      "AuthenticationResultId": "string",
      "Configuration": { 
         "AcceptanceThreshold": number
      },
      "CustomerSpeakerId": "string",
      "Decision": "string",
      "GeneratedSpeakerId": "string",
      "Score": number
   },
   "DomainId": "string",
   "FraudDetectionResult": { 
      "AudioAggregationEndedAt": number,
      "AudioAggregationStartedAt": number,
      "Configuration": { 
         "RiskThreshold": number,
         "WatchlistId": "string"
      },
      "Decision": "string",
      "FraudDetectionResultId": "string",
      "Reasons": [ "string" ],
      "RiskDetails": { 
         "KnownFraudsterRisk": { 
            "GeneratedFraudsterId": "string",
            "RiskScore": number
         },
         "VoiceSpoofingRisk": { 
            "RiskScore": number
         }
      }
   },
   "SessionId": "string",
   "SessionName": "string",
   "StreamingStatus": "string"
}
```

## Response Elements
<a name="API_connect-voice-id_EvaluateSession_ResponseElements"></a>

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

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

 ** [AuthenticationResult](#API_connect-voice-id_EvaluateSession_ResponseSyntax) **   <a name="connect-connect-voice-id_EvaluateSession-response-AuthenticationResult"></a>
Details resulting from the authentication process, such as authentication decision and authentication score.  
Type: [AuthenticationResult](API_connect-voice-id_AuthenticationResult.md) object

 ** [DomainId](#API_connect-voice-id_EvaluateSession_ResponseSyntax) **   <a name="connect-connect-voice-id_EvaluateSession-response-DomainId"></a>
The identifier of the domain that contains the session.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}` 

 ** [FraudDetectionResult](#API_connect-voice-id_EvaluateSession_ResponseSyntax) **   <a name="connect-connect-voice-id_EvaluateSession-response-FraudDetectionResult"></a>
Details resulting from the fraud detection process, such as fraud detection decision and risk score.  
Type: [FraudDetectionResult](API_connect-voice-id_FraudDetectionResult.md) object

 ** [SessionId](#API_connect-voice-id_EvaluateSession_ResponseSyntax) **   <a name="connect-connect-voice-id_EvaluateSession-response-SessionId"></a>
The service-generated identifier of the session.  
Type: String  
Length Constraints: Fixed length of 25.  
Pattern: `id#[a-zA-Z0-9]{22}` 

 ** [SessionName](#API_connect-voice-id_EvaluateSession_ResponseSyntax) **   <a name="connect-connect-voice-id_EvaluateSession-response-SessionName"></a>
The client-provided name of the session.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*` 

 ** [StreamingStatus](#API_connect-voice-id_EvaluateSession_ResponseSyntax) **   <a name="connect-connect-voice-id_EvaluateSession-response-StreamingStatus"></a>
The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is `NOT_ENOUGH_SPEECH`. In this situation, if the `StreamingStatus` is `ONGOING/PENDING_CONFIGURATION`, it can mean that the client should call the API again later, after Voice ID has enough audio to produce a result. If the decision remains `NOT_ENOUGH_SPEECH` even after `StreamingStatus` is `ENDED`, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.  
Type: String  
Valid Values: `PENDING_CONFIGURATION | ONGOING | ENDED` 

## Errors
<a name="API_connect-voice-id_EvaluateSession_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** 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.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_EvaluateSession_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/EvaluateSession) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/EvaluateSession) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/EvaluateSession) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/EvaluateSession) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/EvaluateSession) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/EvaluateSession) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/EvaluateSession) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/EvaluateSession) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/EvaluateSession) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/EvaluateSession) 

# ListDomains
<a name="API_connect-voice-id_ListDomains"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Lists all the domains in the AWS account. 

## Request Syntax
<a name="API_connect-voice-id_ListDomains_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_ListDomains_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_connect-voice-id_ListDomains_RequestSyntax) **   <a name="connect-connect-voice-id_ListDomains-request-MaxResults"></a>
The maximum number of results that are returned per call. You can use `NextToken` to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 10.  
Required: No

 ** [NextToken](#API_connect-voice-id_ListDomains_RequestSyntax) **   <a name="connect-connect-voice-id_ListDomains-request-NextToken"></a>
If `NextToken` is returned, there are more results available. The value of `NextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

## Response Syntax
<a name="API_connect-voice-id_ListDomains_ResponseSyntax"></a>

```
{
   "DomainSummaries": [ 
      { 
         "Arn": "string",
         "CreatedAt": number,
         "Description": "string",
         "DomainId": "string",
         "DomainStatus": "string",
         "Name": "string",
         "ServerSideEncryptionConfiguration": { 
            "KmsKeyId": "string"
         },
         "ServerSideEncryptionUpdateDetails": { 
            "Message": "string",
            "OldKmsKeyId": "string",
            "UpdateStatus": "string"
         },
         "UpdatedAt": number,
         "WatchlistDetails": { 
            "DefaultWatchlistId": "string"
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-voice-id_ListDomains_ResponseElements"></a>

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

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

 ** [DomainSummaries](#API_connect-voice-id_ListDomains_ResponseSyntax) **   <a name="connect-connect-voice-id_ListDomains-response-DomainSummaries"></a>
A list containing details about each domain in the AWS account.  
Type: Array of [DomainSummary](API_connect-voice-id_DomainSummary.md) objects

 ** [NextToken](#API_connect-voice-id_ListDomains_ResponseSyntax) **   <a name="connect-connect-voice-id_ListDomains-response-NextToken"></a>
If `NextToken` is returned, there are more results available. The value of `NextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.  
Type: String  
Length Constraints: Minimum length of 1.

## Errors
<a name="API_connect-voice-id_ListDomains_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_ListDomains_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/ListDomains) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/ListDomains) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/ListDomains) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/ListDomains) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/ListDomains) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/ListDomains) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/ListDomains) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/ListDomains) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/ListDomains) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/ListDomains) 

# ListFraudsterRegistrationJobs
<a name="API_connect-voice-id_ListFraudsterRegistrationJobs"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Lists all the fraudster registration jobs in the domain with the given `JobStatus`. If `JobStatus` is not provided, this lists all fraudster registration jobs in the given domain. 

## Request Syntax
<a name="API_connect-voice-id_ListFraudsterRegistrationJobs_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "JobStatus": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_ListFraudsterRegistrationJobs_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_ListFraudsterRegistrationJobs_RequestSyntax) **   <a name="connect-connect-voice-id_ListFraudsterRegistrationJobs-request-DomainId"></a>
The identifier of the domain that contains the fraudster registration Jobs.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [JobStatus](#API_connect-voice-id_ListFraudsterRegistrationJobs_RequestSyntax) **   <a name="connect-connect-voice-id_ListFraudsterRegistrationJobs-request-JobStatus"></a>
Provides the status of your fraudster registration job.  
Type: String  
Valid Values: `SUBMITTED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | FAILED`   
Required: No

 ** [MaxResults](#API_connect-voice-id_ListFraudsterRegistrationJobs_RequestSyntax) **   <a name="connect-connect-voice-id_ListFraudsterRegistrationJobs-request-MaxResults"></a>
The maximum number of results that are returned per call. You can use `NextToken` to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_connect-voice-id_ListFraudsterRegistrationJobs_RequestSyntax) **   <a name="connect-connect-voice-id_ListFraudsterRegistrationJobs-request-NextToken"></a>
If `NextToken` is returned, there are more results available. The value of `NextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

## Response Syntax
<a name="API_connect-voice-id_ListFraudsterRegistrationJobs_ResponseSyntax"></a>

```
{
   "JobSummaries": [ 
      { 
         "CreatedAt": number,
         "DomainId": "string",
         "EndedAt": number,
         "FailureDetails": { 
            "Message": "string",
            "StatusCode": number
         },
         "JobId": "string",
         "JobName": "string",
         "JobProgress": { 
            "PercentComplete": number
         },
         "JobStatus": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-voice-id_ListFraudsterRegistrationJobs_ResponseElements"></a>

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

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

 ** [JobSummaries](#API_connect-voice-id_ListFraudsterRegistrationJobs_ResponseSyntax) **   <a name="connect-connect-voice-id_ListFraudsterRegistrationJobs-response-JobSummaries"></a>
A list containing details about each specified fraudster registration job.  
Type: Array of [FraudsterRegistrationJobSummary](API_connect-voice-id_FraudsterRegistrationJobSummary.md) objects

 ** [NextToken](#API_connect-voice-id_ListFraudsterRegistrationJobs_ResponseSyntax) **   <a name="connect-connect-voice-id_ListFraudsterRegistrationJobs-response-NextToken"></a>
If `NextToken` is returned, there are more results available. The value of `NextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.  
Type: String  
Length Constraints: Minimum length of 1.

## Errors
<a name="API_connect-voice-id_ListFraudsterRegistrationJobs_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_ListFraudsterRegistrationJobs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/ListFraudsterRegistrationJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/ListFraudsterRegistrationJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/ListFraudsterRegistrationJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/ListFraudsterRegistrationJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/ListFraudsterRegistrationJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/ListFraudsterRegistrationJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/ListFraudsterRegistrationJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/ListFraudsterRegistrationJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/ListFraudsterRegistrationJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/ListFraudsterRegistrationJobs) 

# ListFraudsters
<a name="API_connect-voice-id_ListFraudsters"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Lists all fraudsters in a specified watchlist or domain.

## Request Syntax
<a name="API_connect-voice-id_ListFraudsters_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "WatchlistId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_ListFraudsters_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_ListFraudsters_RequestSyntax) **   <a name="connect-connect-voice-id_ListFraudsters-request-DomainId"></a>
The identifier of the domain.   
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [MaxResults](#API_connect-voice-id_ListFraudsters_RequestSyntax) **   <a name="connect-connect-voice-id_ListFraudsters-request-MaxResults"></a>
The maximum number of results that are returned per call. You can use `NextToken` to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_connect-voice-id_ListFraudsters_RequestSyntax) **   <a name="connect-connect-voice-id_ListFraudsters-request-NextToken"></a>
If `NextToken` is returned, there are more results available. The value of `NextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

 ** [WatchlistId](#API_connect-voice-id_ListFraudsters_RequestSyntax) **   <a name="connect-connect-voice-id_ListFraudsters-request-WatchlistId"></a>
The identifier of the watchlist. If provided, all fraudsters in the watchlist are listed. If not provided, all fraudsters in the domain are listed.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: No

## Response Syntax
<a name="API_connect-voice-id_ListFraudsters_ResponseSyntax"></a>

```
{
   "FraudsterSummaries": [ 
      { 
         "CreatedAt": number,
         "DomainId": "string",
         "GeneratedFraudsterId": "string",
         "WatchlistIds": [ "string" ]
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-voice-id_ListFraudsters_ResponseElements"></a>

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

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

 ** [FraudsterSummaries](#API_connect-voice-id_ListFraudsters_ResponseSyntax) **   <a name="connect-connect-voice-id_ListFraudsters-response-FraudsterSummaries"></a>
A list that contains details about each fraudster in the AWS account.   
Type: Array of [FraudsterSummary](API_connect-voice-id_FraudsterSummary.md) objects

 ** [NextToken](#API_connect-voice-id_ListFraudsters_ResponseSyntax) **   <a name="connect-connect-voice-id_ListFraudsters-response-NextToken"></a>
If `NextToken` is returned, there are more results available. The value of `NextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.   
Type: String  
Length Constraints: Minimum length of 1.

## Errors
<a name="API_connect-voice-id_ListFraudsters_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_ListFraudsters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/ListFraudsters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/ListFraudsters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/ListFraudsters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/ListFraudsters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/ListFraudsters) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/ListFraudsters) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/ListFraudsters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/ListFraudsters) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/ListFraudsters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/ListFraudsters) 

# ListSpeakerEnrollmentJobs
<a name="API_connect-voice-id_ListSpeakerEnrollmentJobs"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Lists all the speaker enrollment jobs in the domain with the specified `JobStatus`. If `JobStatus` is not provided, this lists all jobs with all possible speaker enrollment job statuses.

## Request Syntax
<a name="API_connect-voice-id_ListSpeakerEnrollmentJobs_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "JobStatus": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_ListSpeakerEnrollmentJobs_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_ListSpeakerEnrollmentJobs_RequestSyntax) **   <a name="connect-connect-voice-id_ListSpeakerEnrollmentJobs-request-DomainId"></a>
The identifier of the domain that contains the speaker enrollment jobs.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [JobStatus](#API_connect-voice-id_ListSpeakerEnrollmentJobs_RequestSyntax) **   <a name="connect-connect-voice-id_ListSpeakerEnrollmentJobs-request-JobStatus"></a>
Provides the status of your speaker enrollment Job.  
Type: String  
Valid Values: `SUBMITTED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | FAILED`   
Required: No

 ** [MaxResults](#API_connect-voice-id_ListSpeakerEnrollmentJobs_RequestSyntax) **   <a name="connect-connect-voice-id_ListSpeakerEnrollmentJobs-request-MaxResults"></a>
The maximum number of results that are returned per call. You can use `NextToken` to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_connect-voice-id_ListSpeakerEnrollmentJobs_RequestSyntax) **   <a name="connect-connect-voice-id_ListSpeakerEnrollmentJobs-request-NextToken"></a>
If `NextToken` is returned, there are more results available. The value of `NextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

## Response Syntax
<a name="API_connect-voice-id_ListSpeakerEnrollmentJobs_ResponseSyntax"></a>

```
{
   "JobSummaries": [ 
      { 
         "CreatedAt": number,
         "DomainId": "string",
         "EndedAt": number,
         "FailureDetails": { 
            "Message": "string",
            "StatusCode": number
         },
         "JobId": "string",
         "JobName": "string",
         "JobProgress": { 
            "PercentComplete": number
         },
         "JobStatus": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-voice-id_ListSpeakerEnrollmentJobs_ResponseElements"></a>

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

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

 ** [JobSummaries](#API_connect-voice-id_ListSpeakerEnrollmentJobs_ResponseSyntax) **   <a name="connect-connect-voice-id_ListSpeakerEnrollmentJobs-response-JobSummaries"></a>
A list containing details about each specified speaker enrollment job.  
Type: Array of [SpeakerEnrollmentJobSummary](API_connect-voice-id_SpeakerEnrollmentJobSummary.md) objects

 ** [NextToken](#API_connect-voice-id_ListSpeakerEnrollmentJobs_ResponseSyntax) **   <a name="connect-connect-voice-id_ListSpeakerEnrollmentJobs-response-NextToken"></a>
If `NextToken` is returned, there are more results available. The value of `NextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.   
Type: String  
Length Constraints: Minimum length of 1.

## Errors
<a name="API_connect-voice-id_ListSpeakerEnrollmentJobs_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_ListSpeakerEnrollmentJobs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/ListSpeakerEnrollmentJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/ListSpeakerEnrollmentJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/ListSpeakerEnrollmentJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/ListSpeakerEnrollmentJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/ListSpeakerEnrollmentJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/ListSpeakerEnrollmentJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/ListSpeakerEnrollmentJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/ListSpeakerEnrollmentJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/ListSpeakerEnrollmentJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/ListSpeakerEnrollmentJobs) 

# ListSpeakers
<a name="API_connect-voice-id_ListSpeakers"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Lists all speakers in a specified domain.

## Request Syntax
<a name="API_connect-voice-id_ListSpeakers_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_ListSpeakers_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_ListSpeakers_RequestSyntax) **   <a name="connect-connect-voice-id_ListSpeakers-request-DomainId"></a>
The identifier of the domain.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [MaxResults](#API_connect-voice-id_ListSpeakers_RequestSyntax) **   <a name="connect-connect-voice-id_ListSpeakers-request-MaxResults"></a>
The maximum number of results that are returned per call. You can use `NextToken` to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_connect-voice-id_ListSpeakers_RequestSyntax) **   <a name="connect-connect-voice-id_ListSpeakers-request-NextToken"></a>
If `NextToken` is returned, there are more results available. The value of `NextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

## Response Syntax
<a name="API_connect-voice-id_ListSpeakers_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "SpeakerSummaries": [ 
      { 
         "CreatedAt": number,
         "CustomerSpeakerId": "string",
         "DomainId": "string",
         "GeneratedSpeakerId": "string",
         "LastAccessedAt": number,
         "Status": "string",
         "UpdatedAt": number
      }
   ]
}
```

## Response Elements
<a name="API_connect-voice-id_ListSpeakers_ResponseElements"></a>

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

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

 ** [NextToken](#API_connect-voice-id_ListSpeakers_ResponseSyntax) **   <a name="connect-connect-voice-id_ListSpeakers-response-NextToken"></a>
If `NextToken` is returned, there are more results available. The value of `NextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.   
Type: String  
Length Constraints: Minimum length of 1.

 ** [SpeakerSummaries](#API_connect-voice-id_ListSpeakers_ResponseSyntax) **   <a name="connect-connect-voice-id_ListSpeakers-response-SpeakerSummaries"></a>
A list containing details about each speaker in the AWS account.   
Type: Array of [SpeakerSummary](API_connect-voice-id_SpeakerSummary.md) objects

## Errors
<a name="API_connect-voice-id_ListSpeakers_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_ListSpeakers_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/ListSpeakers) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/ListSpeakers) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/ListSpeakers) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/ListSpeakers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/ListSpeakers) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/ListSpeakers) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/ListSpeakers) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/ListSpeakers) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/ListSpeakers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/ListSpeakers) 

# ListTagsForResource
<a name="API_connect-voice-id_ListTagsForResource"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Lists all tags associated with a specified Voice ID resource.

## Request Syntax
<a name="API_connect-voice-id_ListTagsForResource_RequestSyntax"></a>

```
{
   "ResourceArn": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_ListTagsForResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceArn](#API_connect-voice-id_ListTagsForResource_RequestSyntax) **   <a name="connect-connect-voice-id_ListTagsForResource-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the Voice ID resource for which you want to list the tags.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:aws(-[^:]+)?:voiceid.+:[0-9]{12}:domain/[a-zA-Z0-9]{22}`   
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_ListTagsForResource_ResponseSyntax"></a>

```
{
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-voice-id_ListTagsForResource_ResponseElements"></a>

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

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

 ** [Tags](#API_connect-voice-id_ListTagsForResource_ResponseSyntax) **   <a name="connect-connect-voice-id_ListTagsForResource-response-Tags"></a>
The list of tags associated with the specified resource.  
Type: Array of [Tag](API_connect-voice-id_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.

## Errors
<a name="API_connect-voice-id_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/ListTagsForResource) 

# ListWatchlists
<a name="API_connect-voice-id_ListWatchlists"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Lists all watchlists in a specified domain.

## Request Syntax
<a name="API_connect-voice-id_ListWatchlists_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_ListWatchlists_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_ListWatchlists_RequestSyntax) **   <a name="connect-connect-voice-id_ListWatchlists-request-DomainId"></a>
The identifier of the domain.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [MaxResults](#API_connect-voice-id_ListWatchlists_RequestSyntax) **   <a name="connect-connect-voice-id_ListWatchlists-request-MaxResults"></a>
The maximum number of results that are returned per call. You can use `NextToken` to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_connect-voice-id_ListWatchlists_RequestSyntax) **   <a name="connect-connect-voice-id_ListWatchlists-request-NextToken"></a>
If `NextToken` is returned, there are more results available. The value of `NextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

## Response Syntax
<a name="API_connect-voice-id_ListWatchlists_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "WatchlistSummaries": [ 
      { 
         "CreatedAt": number,
         "DefaultWatchlist": boolean,
         "Description": "string",
         "DomainId": "string",
         "Name": "string",
         "UpdatedAt": number,
         "WatchlistId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-voice-id_ListWatchlists_ResponseElements"></a>

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

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

 ** [NextToken](#API_connect-voice-id_ListWatchlists_ResponseSyntax) **   <a name="connect-connect-voice-id_ListWatchlists-response-NextToken"></a>
If `NextToken` is returned, there are more results available. The value of `NextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.   
Type: String  
Length Constraints: Minimum length of 1.

 ** [WatchlistSummaries](#API_connect-voice-id_ListWatchlists_ResponseSyntax) **   <a name="connect-connect-voice-id_ListWatchlists-response-WatchlistSummaries"></a>
A list that contains details about each watchlist in the AWS account.   
Type: Array of [WatchlistSummary](API_connect-voice-id_WatchlistSummary.md) objects

## Errors
<a name="API_connect-voice-id_ListWatchlists_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_ListWatchlists_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/ListWatchlists) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/ListWatchlists) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/ListWatchlists) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/ListWatchlists) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/ListWatchlists) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/ListWatchlists) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/ListWatchlists) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/ListWatchlists) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/ListWatchlists) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/ListWatchlists) 

# OptOutSpeaker
<a name="API_connect-voice-id_OptOutSpeaker"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Opts out a speaker from Voice ID. A speaker can be opted out regardless of whether or not they already exist in Voice ID. If they don't yet exist, a new speaker is created in an opted out state. If they already exist, their existing status is overridden and they are opted out. Enrollment and evaluation authentication requests are rejected for opted out speakers, and opted out speakers have no voice embeddings stored in Voice ID.

## Request Syntax
<a name="API_connect-voice-id_OptOutSpeaker_RequestSyntax"></a>

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

## Request Parameters
<a name="API_connect-voice-id_OptOutSpeaker_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_OptOutSpeaker_RequestSyntax) **   <a name="connect-connect-voice-id_OptOutSpeaker-request-DomainId"></a>
The identifier of the domain that contains the speaker.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [SpeakerId](#API_connect-voice-id_OptOutSpeaker_RequestSyntax) **   <a name="connect-connect-voice-id_OptOutSpeaker-request-SpeakerId"></a>
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
<a name="API_connect-voice-id_OptOutSpeaker_ResponseSyntax"></a>

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

## Response Elements
<a name="API_connect-voice-id_OptOutSpeaker_ResponseElements"></a>

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](#API_connect-voice-id_OptOutSpeaker_ResponseSyntax) **   <a name="connect-connect-voice-id_OptOutSpeaker-response-Speaker"></a>
Details about the opted-out speaker.  
Type: [Speaker](API_connect-voice-id_Speaker.md) object

## Errors
<a name="API_connect-voice-id_OptOutSpeaker_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** 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.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The request exceeded the service quota. Refer to [Voice ID Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) and try your request again.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_OptOutSpeaker_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/OptOutSpeaker) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/OptOutSpeaker) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/OptOutSpeaker) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/OptOutSpeaker) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/OptOutSpeaker) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/OptOutSpeaker) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/OptOutSpeaker) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/OptOutSpeaker) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/OptOutSpeaker) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/OptOutSpeaker) 

# StartFraudsterRegistrationJob
<a name="API_connect-voice-id_StartFraudsterRegistrationJob"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Starts a new batch fraudster registration job using provided details.

## Request Syntax
<a name="API_connect-voice-id_StartFraudsterRegistrationJob_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "DataAccessRoleArn": "string",
   "DomainId": "string",
   "InputDataConfig": { 
      "S3Uri": "string"
   },
   "JobName": "string",
   "OutputDataConfig": { 
      "KmsKeyId": "string",
      "S3Uri": "string"
   },
   "RegistrationConfig": { 
      "DuplicateRegistrationAction": "string",
      "FraudsterSimilarityThreshold": number,
      "WatchlistIds": [ "string" ]
   }
}
```

## Request Parameters
<a name="API_connect-voice-id_StartFraudsterRegistrationJob_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ClientToken](#API_connect-voice-id_StartFraudsterRegistrationJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartFraudsterRegistrationJob-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-_]+`   
Required: No

 ** [DataAccessRoleArn](#API_connect-voice-id_StartFraudsterRegistrationJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartFraudsterRegistrationJob-request-DataAccessRoleArn"></a>
The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets to read the input manifest file and write the Job output file. Refer to the [Create and edit a fraudster watchlist](https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-fraudster-watchlist.html) documentation for the permissions needed in this role.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+`   
Required: Yes

 ** [DomainId](#API_connect-voice-id_StartFraudsterRegistrationJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartFraudsterRegistrationJob-request-DomainId"></a>
The identifier of the domain that contains the fraudster registration job and in which the fraudsters are registered.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [InputDataConfig](#API_connect-voice-id_StartFraudsterRegistrationJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartFraudsterRegistrationJob-request-InputDataConfig"></a>
The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration requests.  
Type: [InputDataConfig](API_connect-voice-id_InputDataConfig.md) object  
Required: Yes

 ** [JobName](#API_connect-voice-id_StartFraudsterRegistrationJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartFraudsterRegistrationJob-request-JobName"></a>
The name of the new fraudster registration job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: No

 ** [OutputDataConfig](#API_connect-voice-id_StartFraudsterRegistrationJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartFraudsterRegistrationJob-request-OutputDataConfig"></a>
The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS key ID to encrypt the file.  
Type: [OutputDataConfig](API_connect-voice-id_OutputDataConfig.md) object  
Required: Yes

 ** [RegistrationConfig](#API_connect-voice-id_StartFraudsterRegistrationJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartFraudsterRegistrationJob-request-RegistrationConfig"></a>
The registration config containing details such as the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster.   
Type: [RegistrationConfig](API_connect-voice-id_RegistrationConfig.md) object  
Required: No

## Response Syntax
<a name="API_connect-voice-id_StartFraudsterRegistrationJob_ResponseSyntax"></a>

```
{
   "Job": { 
      "CreatedAt": number,
      "DataAccessRoleArn": "string",
      "DomainId": "string",
      "EndedAt": number,
      "FailureDetails": { 
         "Message": "string",
         "StatusCode": number
      },
      "InputDataConfig": { 
         "S3Uri": "string"
      },
      "JobId": "string",
      "JobName": "string",
      "JobProgress": { 
         "PercentComplete": number
      },
      "JobStatus": "string",
      "OutputDataConfig": { 
         "KmsKeyId": "string",
         "S3Uri": "string"
      },
      "RegistrationConfig": { 
         "DuplicateRegistrationAction": "string",
         "FraudsterSimilarityThreshold": number,
         "WatchlistIds": [ "string" ]
      }
   }
}
```

## Response Elements
<a name="API_connect-voice-id_StartFraudsterRegistrationJob_ResponseElements"></a>

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

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

 ** [Job](#API_connect-voice-id_StartFraudsterRegistrationJob_ResponseSyntax) **   <a name="connect-connect-voice-id_StartFraudsterRegistrationJob-response-Job"></a>
Details about the started fraudster registration job.  
Type: [FraudsterRegistrationJob](API_connect-voice-id_FraudsterRegistrationJob.md) object

## Errors
<a name="API_connect-voice-id_StartFraudsterRegistrationJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** 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.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The request exceeded the service quota. Refer to [Voice ID Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) and try your request again.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_StartFraudsterRegistrationJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/StartFraudsterRegistrationJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/StartFraudsterRegistrationJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/StartFraudsterRegistrationJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/StartFraudsterRegistrationJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/StartFraudsterRegistrationJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/StartFraudsterRegistrationJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/StartFraudsterRegistrationJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/StartFraudsterRegistrationJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/StartFraudsterRegistrationJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/StartFraudsterRegistrationJob) 

# StartSpeakerEnrollmentJob
<a name="API_connect-voice-id_StartSpeakerEnrollmentJob"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Starts a new batch speaker enrollment job using specified details.

## Request Syntax
<a name="API_connect-voice-id_StartSpeakerEnrollmentJob_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "DataAccessRoleArn": "string",
   "DomainId": "string",
   "EnrollmentConfig": { 
      "ExistingEnrollmentAction": "string",
      "FraudDetectionConfig": { 
         "FraudDetectionAction": "string",
         "RiskThreshold": number,
         "WatchlistIds": [ "string" ]
      }
   },
   "InputDataConfig": { 
      "S3Uri": "string"
   },
   "JobName": "string",
   "OutputDataConfig": { 
      "KmsKeyId": "string",
      "S3Uri": "string"
   }
}
```

## Request Parameters
<a name="API_connect-voice-id_StartSpeakerEnrollmentJob_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ClientToken](#API_connect-voice-id_StartSpeakerEnrollmentJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartSpeakerEnrollmentJob-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-_]+`   
Required: No

 ** [DataAccessRoleArn](#API_connect-voice-id_StartSpeakerEnrollmentJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartSpeakerEnrollmentJob-request-DataAccessRoleArn"></a>
The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets to read the input manifest file and write the job output file. Refer to [Batch enrollment using audio data from prior calls](https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-batch-enrollment.html) for the permissions needed in this role.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+`   
Required: Yes

 ** [DomainId](#API_connect-voice-id_StartSpeakerEnrollmentJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartSpeakerEnrollmentJob-request-DomainId"></a>
The identifier of the domain that contains the speaker enrollment job and in which the speakers are enrolled.   
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [EnrollmentConfig](#API_connect-voice-id_StartSpeakerEnrollmentJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartSpeakerEnrollmentJob-request-EnrollmentConfig"></a>
The enrollment config that contains details such as the action to take when a speaker is already enrolled in Voice ID or when a speaker is identified as a fraudster.  
Type: [EnrollmentConfig](API_connect-voice-id_EnrollmentConfig.md) object  
Required: No

 ** [InputDataConfig](#API_connect-voice-id_StartSpeakerEnrollmentJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartSpeakerEnrollmentJob-request-InputDataConfig"></a>
The input data config containing the S3 location for the input manifest file that contains the list of speaker enrollment requests.  
Type: [InputDataConfig](API_connect-voice-id_InputDataConfig.md) object  
Required: Yes

 ** [JobName](#API_connect-voice-id_StartSpeakerEnrollmentJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartSpeakerEnrollmentJob-request-JobName"></a>
A name for your speaker enrollment job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: No

 ** [OutputDataConfig](#API_connect-voice-id_StartSpeakerEnrollmentJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartSpeakerEnrollmentJob-request-OutputDataConfig"></a>
The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS key ID to encrypt the file.  
Type: [OutputDataConfig](API_connect-voice-id_OutputDataConfig.md) object  
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_StartSpeakerEnrollmentJob_ResponseSyntax"></a>

```
{
   "Job": { 
      "CreatedAt": number,
      "DataAccessRoleArn": "string",
      "DomainId": "string",
      "EndedAt": number,
      "EnrollmentConfig": { 
         "ExistingEnrollmentAction": "string",
         "FraudDetectionConfig": { 
            "FraudDetectionAction": "string",
            "RiskThreshold": number,
            "WatchlistIds": [ "string" ]
         }
      },
      "FailureDetails": { 
         "Message": "string",
         "StatusCode": number
      },
      "InputDataConfig": { 
         "S3Uri": "string"
      },
      "JobId": "string",
      "JobName": "string",
      "JobProgress": { 
         "PercentComplete": number
      },
      "JobStatus": "string",
      "OutputDataConfig": { 
         "KmsKeyId": "string",
         "S3Uri": "string"
      }
   }
}
```

## Response Elements
<a name="API_connect-voice-id_StartSpeakerEnrollmentJob_ResponseElements"></a>

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

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

 ** [Job](#API_connect-voice-id_StartSpeakerEnrollmentJob_ResponseSyntax) **   <a name="connect-connect-voice-id_StartSpeakerEnrollmentJob-response-Job"></a>
Details about the started speaker enrollment job.  
Type: [SpeakerEnrollmentJob](API_connect-voice-id_SpeakerEnrollmentJob.md) object

## Errors
<a name="API_connect-voice-id_StartSpeakerEnrollmentJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** 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.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The request exceeded the service quota. Refer to [Voice ID Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) and try your request again.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_StartSpeakerEnrollmentJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/StartSpeakerEnrollmentJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/StartSpeakerEnrollmentJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/StartSpeakerEnrollmentJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/StartSpeakerEnrollmentJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/StartSpeakerEnrollmentJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/StartSpeakerEnrollmentJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/StartSpeakerEnrollmentJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/StartSpeakerEnrollmentJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/StartSpeakerEnrollmentJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/StartSpeakerEnrollmentJob) 

# TagResource
<a name="API_connect-voice-id_TagResource"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Tags a Voice ID resource with the provided list of tags.

## Request Syntax
<a name="API_connect-voice-id_TagResource_RequestSyntax"></a>

```
{
   "ResourceArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_connect-voice-id_TagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceArn](#API_connect-voice-id_TagResource_RequestSyntax) **   <a name="connect-connect-voice-id_TagResource-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the Voice ID resource you want to tag.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:aws(-[^:]+)?:voiceid.+:[0-9]{12}:domain/[a-zA-Z0-9]{22}`   
Required: Yes

 ** [Tags](#API_connect-voice-id_TagResource_RequestSyntax) **   <a name="connect-connect-voice-id_TagResource-request-Tags"></a>
The list of tags to assign to the specified resource.  
Type: Array of [Tag](API_connect-voice-id_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: Yes

## Response Elements
<a name="API_connect-voice-id_TagResource_ResponseElements"></a>

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

## Errors
<a name="API_connect-voice-id_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** 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.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/TagResource) 

# UntagResource
<a name="API_connect-voice-id_UntagResource"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Removes specified tags from a specified Amazon Connect Voice ID resource.

## Request Syntax
<a name="API_connect-voice-id_UntagResource_RequestSyntax"></a>

```
{
   "ResourceArn": "string",
   "TagKeys": [ "string" ]
}
```

## Request Parameters
<a name="API_connect-voice-id_UntagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceArn](#API_connect-voice-id_UntagResource_RequestSyntax) **   <a name="connect-connect-voice-id_UntagResource-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the Voice ID resource you want to remove tags from.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:aws(-[^:]+)?:voiceid.+:[0-9]{12}:domain/[a-zA-Z0-9]{22}`   
Required: Yes

 ** [TagKeys](#API_connect-voice-id_UntagResource_RequestSyntax) **   <a name="connect-connect-voice-id_UntagResource-request-TagKeys"></a>
The list of tag keys you want to remove from the specified resource.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`   
Required: Yes

## Response Elements
<a name="API_connect-voice-id_UntagResource_ResponseElements"></a>

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

## Errors
<a name="API_connect-voice-id_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** 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.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/UntagResource) 

# UpdateDomain
<a name="API_connect-voice-id_UpdateDomain"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Updates the specified domain. This API has clobber behavior, and clears and replaces all attributes. If an optional field, such as 'Description' is not provided, it is removed from the domain.

## Request Syntax
<a name="API_connect-voice-id_UpdateDomain_RequestSyntax"></a>

```
{
   "Description": "string",
   "DomainId": "string",
   "Name": "string",
   "ServerSideEncryptionConfiguration": { 
      "KmsKeyId": "string"
   }
}
```

## Request Parameters
<a name="API_connect-voice-id_UpdateDomain_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Description](#API_connect-voice-id_UpdateDomain_RequestSyntax) **   <a name="connect-connect-voice-id_UpdateDomain-request-Description"></a>
A brief description about this domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)`   
Required: No

 ** [DomainId](#API_connect-voice-id_UpdateDomain_RequestSyntax) **   <a name="connect-connect-voice-id_UpdateDomain-request-DomainId"></a>
The identifier of the domain to be updated.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [Name](#API_connect-voice-id_UpdateDomain_RequestSyntax) **   <a name="connect-connect-voice-id_UpdateDomain-request-Name"></a>
The name of the domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [ServerSideEncryptionConfiguration](#API_connect-voice-id_UpdateDomain_RequestSyntax) **   <a name="connect-connect-voice-id_UpdateDomain-request-ServerSideEncryptionConfiguration"></a>
The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side encryption of your data. Changing the domain's associated KMS key immediately triggers an asynchronous process to remove dependency on the old KMS key, such that the domain's data can only be accessed using the new KMS key. The domain's `ServerSideEncryptionUpdateDetails` contains the details for this process.  
Type: [ServerSideEncryptionConfiguration](API_connect-voice-id_ServerSideEncryptionConfiguration.md) object  
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_UpdateDomain_ResponseSyntax"></a>

```
{
   "Domain": { 
      "Arn": "string",
      "CreatedAt": number,
      "Description": "string",
      "DomainId": "string",
      "DomainStatus": "string",
      "Name": "string",
      "ServerSideEncryptionConfiguration": { 
         "KmsKeyId": "string"
      },
      "ServerSideEncryptionUpdateDetails": { 
         "Message": "string",
         "OldKmsKeyId": "string",
         "UpdateStatus": "string"
      },
      "UpdatedAt": number,
      "WatchlistDetails": { 
         "DefaultWatchlistId": "string"
      }
   }
}
```

## Response Elements
<a name="API_connect-voice-id_UpdateDomain_ResponseElements"></a>

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

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

 ** [Domain](#API_connect-voice-id_UpdateDomain_ResponseSyntax) **   <a name="connect-connect-voice-id_UpdateDomain-response-Domain"></a>
Details about the updated domain  
Type: [Domain](API_connect-voice-id_Domain.md) object

## Errors
<a name="API_connect-voice-id_UpdateDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** 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.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_UpdateDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/UpdateDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/UpdateDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/UpdateDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/UpdateDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/UpdateDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/UpdateDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/UpdateDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/UpdateDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/UpdateDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/UpdateDomain) 

# UpdateWatchlist
<a name="API_connect-voice-id_UpdateWatchlist"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Updates the specified watchlist. Every domain has a default watchlist which cannot be updated. 

## Request Syntax
<a name="API_connect-voice-id_UpdateWatchlist_RequestSyntax"></a>

```
{
   "Description": "string",
   "DomainId": "string",
   "Name": "string",
   "WatchlistId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_UpdateWatchlist_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Description](#API_connect-voice-id_UpdateWatchlist_RequestSyntax) **   <a name="connect-connect-voice-id_UpdateWatchlist-request-Description"></a>
A brief description about this watchlist.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)`   
Required: No

 ** [DomainId](#API_connect-voice-id_UpdateWatchlist_RequestSyntax) **   <a name="connect-connect-voice-id_UpdateWatchlist-request-DomainId"></a>
The identifier of the domain that contains the watchlist.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [Name](#API_connect-voice-id_UpdateWatchlist_RequestSyntax) **   <a name="connect-connect-voice-id_UpdateWatchlist-request-Name"></a>
The name of the watchlist.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: No

 ** [WatchlistId](#API_connect-voice-id_UpdateWatchlist_RequestSyntax) **   <a name="connect-connect-voice-id_UpdateWatchlist-request-WatchlistId"></a>
The identifier of the watchlist to be updated.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_UpdateWatchlist_ResponseSyntax"></a>

```
{
   "Watchlist": { 
      "CreatedAt": number,
      "DefaultWatchlist": boolean,
      "Description": "string",
      "DomainId": "string",
      "Name": "string",
      "UpdatedAt": number,
      "WatchlistId": "string"
   }
}
```

## Response Elements
<a name="API_connect-voice-id_UpdateWatchlist_ResponseElements"></a>

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

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

 ** [Watchlist](#API_connect-voice-id_UpdateWatchlist_ResponseSyntax) **   <a name="connect-connect-voice-id_UpdateWatchlist-response-Watchlist"></a>
Details about the updated watchlist.  
Type: [Watchlist](API_connect-voice-id_Watchlist.md) object

## Errors
<a name="API_connect-voice-id_UpdateWatchlist_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** 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.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_UpdateWatchlist_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/UpdateWatchlist) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/UpdateWatchlist) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/UpdateWatchlist) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/UpdateWatchlist) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/UpdateWatchlist) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/UpdateWatchlist) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/UpdateWatchlist) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/UpdateWatchlist) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/UpdateWatchlist) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/UpdateWatchlist)