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

The following data types are supported by Amazon Voice ID:
+  [AuthenticationConfiguration](API_connect-voice-id_AuthenticationConfiguration.md) 
+  [AuthenticationResult](API_connect-voice-id_AuthenticationResult.md) 
+  [Domain](API_connect-voice-id_Domain.md) 
+  [DomainSummary](API_connect-voice-id_DomainSummary.md) 
+  [EnrollmentConfig](API_connect-voice-id_EnrollmentConfig.md) 
+  [EnrollmentJobFraudDetectionConfig](API_connect-voice-id_EnrollmentJobFraudDetectionConfig.md) 
+  [FailureDetails](API_connect-voice-id_FailureDetails.md) 
+  [FraudDetectionConfiguration](API_connect-voice-id_FraudDetectionConfiguration.md) 
+  [FraudDetectionResult](API_connect-voice-id_FraudDetectionResult.md) 
+  [FraudRiskDetails](API_connect-voice-id_FraudRiskDetails.md) 
+  [Fraudster](API_connect-voice-id_Fraudster.md) 
+  [FraudsterRegistrationJob](API_connect-voice-id_FraudsterRegistrationJob.md) 
+  [FraudsterRegistrationJobSummary](API_connect-voice-id_FraudsterRegistrationJobSummary.md) 
+  [FraudsterSummary](API_connect-voice-id_FraudsterSummary.md) 
+  [InputDataConfig](API_connect-voice-id_InputDataConfig.md) 
+  [JobProgress](API_connect-voice-id_JobProgress.md) 
+  [KnownFraudsterRisk](API_connect-voice-id_KnownFraudsterRisk.md) 
+  [OutputDataConfig](API_connect-voice-id_OutputDataConfig.md) 
+  [RegistrationConfig](API_connect-voice-id_RegistrationConfig.md) 
+  [ServerSideEncryptionConfiguration](API_connect-voice-id_ServerSideEncryptionConfiguration.md) 
+  [ServerSideEncryptionUpdateDetails](API_connect-voice-id_ServerSideEncryptionUpdateDetails.md) 
+  [Speaker](API_connect-voice-id_Speaker.md) 
+  [SpeakerEnrollmentJob](API_connect-voice-id_SpeakerEnrollmentJob.md) 
+  [SpeakerEnrollmentJobSummary](API_connect-voice-id_SpeakerEnrollmentJobSummary.md) 
+  [SpeakerSummary](API_connect-voice-id_SpeakerSummary.md) 
+  [Tag](API_connect-voice-id_Tag.md) 
+  [VoiceSpoofingRisk](API_connect-voice-id_VoiceSpoofingRisk.md) 
+  [Watchlist](API_connect-voice-id_Watchlist.md) 
+  [WatchlistDetails](API_connect-voice-id_WatchlistDetails.md) 
+  [WatchlistSummary](API_connect-voice-id_WatchlistSummary.md) 

# AuthenticationConfiguration
<a name="API_connect-voice-id_AuthenticationConfiguration"></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).

The configuration used to authenticate a speaker during a session.

## Contents
<a name="API_connect-voice-id_AuthenticationConfiguration_Contents"></a>

 ** AcceptanceThreshold **   <a name="connect-Type-connect-voice-id_AuthenticationConfiguration-AcceptanceThreshold"></a>
The minimum threshold needed to successfully authenticate a speaker.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: Yes

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/AuthenticationConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/AuthenticationConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/AuthenticationConfiguration) 

# AuthenticationResult
<a name="API_connect-voice-id_AuthenticationResult"></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).

The authentication result produced by Voice ID, processed against the current session state and streamed audio of the speaker.

## Contents
<a name="API_connect-voice-id_AuthenticationResult_Contents"></a>

 ** AudioAggregationEndedAt **   <a name="connect-Type-connect-voice-id_AuthenticationResult-AudioAggregationEndedAt"></a>
A timestamp of when audio aggregation ended for this authentication result.  
Type: Timestamp  
Required: No

 ** AudioAggregationStartedAt **   <a name="connect-Type-connect-voice-id_AuthenticationResult-AudioAggregationStartedAt"></a>
A timestamp of when audio aggregation started for this authentication result.  
Type: Timestamp  
Required: No

 ** AuthenticationResultId **   <a name="connect-Type-connect-voice-id_AuthenticationResult-AuthenticationResultId"></a>
The unique identifier for this authentication result. Because there can be multiple authentications for a given session, this field helps to identify if the returned result is from a previous streaming activity or a new result. Note that in absence of any new streaming activity, `AcceptanceThreshold` changes, or `SpeakerId` changes, Voice ID always returns cached Authentication Result for this API.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: No

 ** Configuration **   <a name="connect-Type-connect-voice-id_AuthenticationResult-Configuration"></a>
The `AuthenticationConfiguration` used to generate this authentication result.  
Type: [AuthenticationConfiguration](API_connect-voice-id_AuthenticationConfiguration.md) object  
Required: No

 ** CustomerSpeakerId **   <a name="connect-Type-connect-voice-id_AuthenticationResult-CustomerSpeakerId"></a>
The client-provided identifier for the speaker whose authentication result is produced. Only present if a `SpeakerId` is provided for the session.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: No

 ** Decision **   <a name="connect-Type-connect-voice-id_AuthenticationResult-Decision"></a>
The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.  
Type: String  
Valid Values: `ACCEPT | REJECT | NOT_ENOUGH_SPEECH | SPEAKER_NOT_ENROLLED | SPEAKER_OPTED_OUT | SPEAKER_ID_NOT_PROVIDED | SPEAKER_EXPIRED`   
Required: No

 ** GeneratedSpeakerId **   <a name="connect-Type-connect-voice-id_AuthenticationResult-GeneratedSpeakerId"></a>
The service-generated identifier for the speaker whose authentication result is produced.  
Type: String  
Length Constraints: Fixed length of 25.  
Pattern: `id#[a-zA-Z0-9]{22}`   
Required: No

 ** Score **   <a name="connect-Type-connect-voice-id_AuthenticationResult-Score"></a>
The authentication score for the speaker whose authentication result is produced. This value is only present if the authentication decision is either `ACCEPT` or `REJECT`.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/AuthenticationResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/AuthenticationResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/AuthenticationResult) 

# Domain
<a name="API_connect-voice-id_Domain"></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).

Contains all the information about a domain.

## Contents
<a name="API_connect-voice-id_Domain_Contents"></a>

 ** Arn **   <a name="connect-Type-connect-voice-id_Domain-Arn"></a>
The Amazon Resource Name (ARN) for the domain.  
Type: String  
Pattern: `arn:aws(-[^:]+)?:voiceid.+:[0-9]{12}:domain/[a-zA-Z0-9]{22}`   
Required: No

 ** CreatedAt **   <a name="connect-Type-connect-voice-id_Domain-CreatedAt"></a>
The timestamp of when the domain was created.  
Type: Timestamp  
Required: No

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

 ** DomainId **   <a name="connect-Type-connect-voice-id_Domain-DomainId"></a>
The identifier of the domain.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: No

 ** DomainStatus **   <a name="connect-Type-connect-voice-id_Domain-DomainStatus"></a>
The current status of the domain.  
Type: String  
Valid Values: `ACTIVE | PENDING | SUSPENDED`   
Required: No

 ** Name **   <a name="connect-Type-connect-voice-id_Domain-Name"></a>
The name for the domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: No

 ** ServerSideEncryptionConfiguration **   <a name="connect-Type-connect-voice-id_Domain-ServerSideEncryptionConfiguration"></a>
The server-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data.  
Type: [ServerSideEncryptionConfiguration](API_connect-voice-id_ServerSideEncryptionConfiguration.md) object  
Required: No

 ** ServerSideEncryptionUpdateDetails **   <a name="connect-Type-connect-voice-id_Domain-ServerSideEncryptionUpdateDetails"></a>
Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain's data can only be accessed using the new KMS key.  
Type: [ServerSideEncryptionUpdateDetails](API_connect-voice-id_ServerSideEncryptionUpdateDetails.md) object  
Required: No

 ** UpdatedAt **   <a name="connect-Type-connect-voice-id_Domain-UpdatedAt"></a>
The timestamp of when the domain was last update.  
Type: Timestamp  
Required: No

 ** WatchlistDetails **   <a name="connect-Type-connect-voice-id_Domain-WatchlistDetails"></a>
The watchlist details of a domain. Contains the default watchlist ID of the domain.  
Type: [WatchlistDetails](API_connect-voice-id_WatchlistDetails.md) object  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/Domain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/Domain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/Domain) 

# DomainSummary
<a name="API_connect-voice-id_DomainSummary"></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).

Contains a summary of information about a domain.

## Contents
<a name="API_connect-voice-id_DomainSummary_Contents"></a>

 ** Arn **   <a name="connect-Type-connect-voice-id_DomainSummary-Arn"></a>
The Amazon Resource Name (ARN) for the domain.  
Type: String  
Pattern: `arn:aws(-[^:]+)?:voiceid.+:[0-9]{12}:domain/[a-zA-Z0-9]{22}`   
Required: No

 ** CreatedAt **   <a name="connect-Type-connect-voice-id_DomainSummary-CreatedAt"></a>
The timestamp of when the domain was created.  
Type: Timestamp  
Required: No

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

 ** DomainId **   <a name="connect-Type-connect-voice-id_DomainSummary-DomainId"></a>
The identifier of the domain.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: No

 ** DomainStatus **   <a name="connect-Type-connect-voice-id_DomainSummary-DomainStatus"></a>
The current status of the domain.  
Type: String  
Valid Values: `ACTIVE | PENDING | SUSPENDED`   
Required: No

 ** Name **   <a name="connect-Type-connect-voice-id_DomainSummary-Name"></a>
The client-provided name for the domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: No

 ** ServerSideEncryptionConfiguration **   <a name="connect-Type-connect-voice-id_DomainSummary-ServerSideEncryptionConfiguration"></a>
The server-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data.  
Type: [ServerSideEncryptionConfiguration](API_connect-voice-id_ServerSideEncryptionConfiguration.md) object  
Required: No

 ** ServerSideEncryptionUpdateDetails **   <a name="connect-Type-connect-voice-id_DomainSummary-ServerSideEncryptionUpdateDetails"></a>
Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain's data can only be accessed using the new KMS key.  
Type: [ServerSideEncryptionUpdateDetails](API_connect-voice-id_ServerSideEncryptionUpdateDetails.md) object  
Required: No

 ** UpdatedAt **   <a name="connect-Type-connect-voice-id_DomainSummary-UpdatedAt"></a>
The timestamp of when the domain was last updated.  
Type: Timestamp  
Required: No

 ** WatchlistDetails **   <a name="connect-Type-connect-voice-id_DomainSummary-WatchlistDetails"></a>
Provides information about `watchlistDetails` and `DefaultWatchlistID`.   
Type: [WatchlistDetails](API_connect-voice-id_WatchlistDetails.md) object  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/DomainSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/DomainSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/DomainSummary) 

# EnrollmentConfig
<a name="API_connect-voice-id_EnrollmentConfig"></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).

Contains configurations defining enrollment behavior for the batch job.

## Contents
<a name="API_connect-voice-id_EnrollmentConfig_Contents"></a>

 ** ExistingEnrollmentAction **   <a name="connect-Type-connect-voice-id_EnrollmentConfig-ExistingEnrollmentAction"></a>
 The action to take when the specified speaker is already enrolled in the specified domain. The default value is `SKIP`, which skips the enrollment for the existing speaker. Setting the value to `OVERWRITE` replaces the existing voice prints and enrollment audio stored for that speaker with new data generated from the latest audio.  
Type: String  
Valid Values: `SKIP | OVERWRITE`   
Required: No

 ** FraudDetectionConfig **   <a name="connect-Type-connect-voice-id_EnrollmentConfig-FraudDetectionConfig"></a>
The fraud detection configuration to use for the speaker enrollment job.  
Type: [EnrollmentJobFraudDetectionConfig](API_connect-voice-id_EnrollmentJobFraudDetectionConfig.md) object  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/EnrollmentConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/EnrollmentConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/EnrollmentConfig) 

# EnrollmentJobFraudDetectionConfig
<a name="API_connect-voice-id_EnrollmentJobFraudDetectionConfig"></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).

The fraud detection configuration to be used during the batch speaker enrollment job.

## Contents
<a name="API_connect-voice-id_EnrollmentJobFraudDetectionConfig_Contents"></a>

 ** FraudDetectionAction **   <a name="connect-Type-connect-voice-id_EnrollmentJobFraudDetectionConfig-FraudDetectionAction"></a>
The action to take when the given speaker is flagged by the fraud detection system. The default value is `FAIL`, which fails the speaker enrollment. Changing this value to `IGNORE` results in the speaker being enrolled even if they are flagged by the fraud detection system.  
Type: String  
Valid Values: `IGNORE | FAIL`   
Required: No

 ** RiskThreshold **   <a name="connect-Type-connect-voice-id_EnrollmentJobFraudDetectionConfig-RiskThreshold"></a>
Threshold value for determining whether the speaker is a high risk to be fraudulent. If the detected risk score calculated by Voice ID is greater than or equal to the threshold, the speaker is considered a fraudster.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** WatchlistIds **   <a name="connect-Type-connect-voice-id_EnrollmentJobFraudDetectionConfig-WatchlistIds"></a>
The identifier of watchlists against which fraud detection is performed.   
Type: Array of strings  
Array Members: Fixed number of 1 item.  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/EnrollmentJobFraudDetectionConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/EnrollmentJobFraudDetectionConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/EnrollmentJobFraudDetectionConfig) 

# FailureDetails
<a name="API_connect-voice-id_FailureDetails"></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).

Contains error details for a failed batch job.

## Contents
<a name="API_connect-voice-id_FailureDetails_Contents"></a>

 ** Message **   <a name="connect-Type-connect-voice-id_FailureDetails-Message"></a>
A description of the error that caused the batch job failure.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** StatusCode **   <a name="connect-Type-connect-voice-id_FailureDetails-StatusCode"></a>
An HTTP status code representing the nature of the error.  
Type: Integer  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/FailureDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/FailureDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/FailureDetails) 

# FraudDetectionConfiguration
<a name="API_connect-voice-id_FraudDetectionConfiguration"></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).

The configuration used for performing fraud detection over a speaker during a session.

## Contents
<a name="API_connect-voice-id_FraudDetectionConfiguration_Contents"></a>

 ** RiskThreshold **   <a name="connect-Type-connect-voice-id_FraudDetectionConfiguration-RiskThreshold"></a>
Threshold value for determining whether the speaker is a fraudster. If the detected risk score calculated by Voice ID is higher than the threshold, the speaker is considered a fraudster.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** WatchlistId **   <a name="connect-Type-connect-voice-id_FraudDetectionConfiguration-WatchlistId"></a>
The identifier of the watchlist against which fraud detection is performed.   
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/FraudDetectionConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/FraudDetectionConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/FraudDetectionConfiguration) 

# FraudDetectionResult
<a name="API_connect-voice-id_FraudDetectionResult"></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).

The fraud detection result produced by Voice ID, processed against the current session state and streamed audio of the speaker.

## Contents
<a name="API_connect-voice-id_FraudDetectionResult_Contents"></a>

 ** AudioAggregationEndedAt **   <a name="connect-Type-connect-voice-id_FraudDetectionResult-AudioAggregationEndedAt"></a>
A timestamp of when audio aggregation ended for this fraud detection result.  
Type: Timestamp  
Required: No

 ** AudioAggregationStartedAt **   <a name="connect-Type-connect-voice-id_FraudDetectionResult-AudioAggregationStartedAt"></a>
A timestamp of when audio aggregation started for this fraud detection result.  
Type: Timestamp  
Required: No

 ** Configuration **   <a name="connect-Type-connect-voice-id_FraudDetectionResult-Configuration"></a>
The `FraudDetectionConfiguration` used to generate this fraud detection result.  
Type: [FraudDetectionConfiguration](API_connect-voice-id_FraudDetectionConfiguration.md) object  
Required: No

 ** Decision **   <a name="connect-Type-connect-voice-id_FraudDetectionResult-Decision"></a>
The fraud detection decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.  
Type: String  
Valid Values: `HIGH_RISK | LOW_RISK | NOT_ENOUGH_SPEECH`   
Required: No

 ** FraudDetectionResultId **   <a name="connect-Type-connect-voice-id_FraudDetectionResult-FraudDetectionResultId"></a>
The unique identifier for this fraud detection result. Given there can be multiple fraud detections for a given session, this field helps in identifying if the returned result is from previous streaming activity or a new result. Note that in the absence of any new streaming activity or risk threshold changes, Voice ID always returns cached Fraud Detection result for this API.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: No

 ** Reasons **   <a name="connect-Type-connect-voice-id_FraudDetectionResult-Reasons"></a>
The reason speaker was flagged by the fraud detection system. This is only be populated if fraud detection Decision is `HIGH_RISK`, and the following possible values: `KNOWN_FRAUDSTER` and `VOICE_SPOOFING`.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 3 items.  
Valid Values: `KNOWN_FRAUDSTER | VOICE_SPOOFING`   
Required: No

 ** RiskDetails **   <a name="connect-Type-connect-voice-id_FraudDetectionResult-RiskDetails"></a>
Details about each risk analyzed for this speaker. Currently, this contains KnownFraudsterRisk and VoiceSpoofingRisk details.  
Type: [FraudRiskDetails](API_connect-voice-id_FraudRiskDetails.md) object  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/FraudDetectionResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/FraudDetectionResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/FraudDetectionResult) 

# FraudRiskDetails
<a name="API_connect-voice-id_FraudRiskDetails"></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).

Details regarding various fraud risk analyses performed against the current session state and streamed audio of the speaker.

## Contents
<a name="API_connect-voice-id_FraudRiskDetails_Contents"></a>

 ** KnownFraudsterRisk **   <a name="connect-Type-connect-voice-id_FraudRiskDetails-KnownFraudsterRisk"></a>
The details resulting from 'Known Fraudster Risk' analysis of the speaker.  
Type: [KnownFraudsterRisk](API_connect-voice-id_KnownFraudsterRisk.md) object  
Required: Yes

 ** VoiceSpoofingRisk **   <a name="connect-Type-connect-voice-id_FraudRiskDetails-VoiceSpoofingRisk"></a>
The details resulting from 'Voice Spoofing Risk' analysis of the speaker.  
Type: [VoiceSpoofingRisk](API_connect-voice-id_VoiceSpoofingRisk.md) object  
Required: Yes

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/FraudRiskDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/FraudRiskDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/FraudRiskDetails) 

# Fraudster
<a name="API_connect-voice-id_Fraudster"></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).

Contains all the information about a fraudster.

## Contents
<a name="API_connect-voice-id_Fraudster_Contents"></a>

 ** CreatedAt **   <a name="connect-Type-connect-voice-id_Fraudster-CreatedAt"></a>
The timestamp of when Voice ID identified the fraudster.  
Type: Timestamp  
Required: No

 ** DomainId **   <a name="connect-Type-connect-voice-id_Fraudster-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: No

 ** GeneratedFraudsterId **   <a name="connect-Type-connect-voice-id_Fraudster-GeneratedFraudsterId"></a>
The service-generated identifier for the fraudster.  
Type: String  
Length Constraints: Fixed length of 25.  
Pattern: `id#[a-zA-Z0-9]{22}`   
Required: No

 ** WatchlistIds **   <a name="connect-Type-connect-voice-id_Fraudster-WatchlistIds"></a>
The identifier of the watchlists the fraudster is a part of.  
Type: Array of strings  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/Fraudster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/Fraudster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/Fraudster) 

# FraudsterRegistrationJob
<a name="API_connect-voice-id_FraudsterRegistrationJob"></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).

Contains all the information about a fraudster registration job.

## Contents
<a name="API_connect-voice-id_FraudsterRegistrationJob_Contents"></a>

 ** CreatedAt **   <a name="connect-Type-connect-voice-id_FraudsterRegistrationJob-CreatedAt"></a>
A timestamp of when the fraudster registration job was created.  
Type: Timestamp  
Required: No

 ** DataAccessRoleArn **   <a name="connect-Type-connect-voice-id_FraudsterRegistrationJob-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.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+`   
Required: No

 ** DomainId **   <a name="connect-Type-connect-voice-id_FraudsterRegistrationJob-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: No

 ** EndedAt **   <a name="connect-Type-connect-voice-id_FraudsterRegistrationJob-EndedAt"></a>
A timestamp of when the fraudster registration job ended.  
Type: Timestamp  
Required: No

 ** FailureDetails **   <a name="connect-Type-connect-voice-id_FraudsterRegistrationJob-FailureDetails"></a>
Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn't fail; it is completed with a `JobStatus` of `COMPLETED_WITH_ERRORS`. You can use the job output file to identify the individual registration requests that failed.  
Type: [FailureDetails](API_connect-voice-id_FailureDetails.md) object  
Required: No

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

 ** JobId **   <a name="connect-Type-connect-voice-id_FraudsterRegistrationJob-JobId"></a>
The service-generated identifier for the fraudster registration job.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: No

 ** JobName **   <a name="connect-Type-connect-voice-id_FraudsterRegistrationJob-JobName"></a>
The client-provided name for the 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

 ** JobProgress **   <a name="connect-Type-connect-voice-id_FraudsterRegistrationJob-JobProgress"></a>
Shows the completed percentage of registration requests listed in the input file.  
Type: [JobProgress](API_connect-voice-id_JobProgress.md) object  
Required: No

 ** JobStatus **   <a name="connect-Type-connect-voice-id_FraudsterRegistrationJob-JobStatus"></a>
The current status of the fraudster registration job.  
Type: String  
Valid Values: `SUBMITTED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | FAILED`   
Required: No

 ** OutputDataConfig **   <a name="connect-Type-connect-voice-id_FraudsterRegistrationJob-OutputDataConfig"></a>
The output data config containing the S3 location where you want Voice ID to write your job output file; you must also include a KMS key ID in order to encrypt the file.  
Type: [OutputDataConfig](API_connect-voice-id_OutputDataConfig.md) object  
Required: No

 ** RegistrationConfig **   <a name="connect-Type-connect-voice-id_FraudsterRegistrationJob-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

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/FraudsterRegistrationJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/FraudsterRegistrationJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/FraudsterRegistrationJob) 

# FraudsterRegistrationJobSummary
<a name="API_connect-voice-id_FraudsterRegistrationJobSummary"></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).

Contains a summary of information about a fraudster registration job.

## Contents
<a name="API_connect-voice-id_FraudsterRegistrationJobSummary_Contents"></a>

 ** CreatedAt **   <a name="connect-Type-connect-voice-id_FraudsterRegistrationJobSummary-CreatedAt"></a>
A timestamp of when the fraudster registration job was created.   
Type: Timestamp  
Required: No

 ** DomainId **   <a name="connect-Type-connect-voice-id_FraudsterRegistrationJobSummary-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: No

 ** EndedAt **   <a name="connect-Type-connect-voice-id_FraudsterRegistrationJobSummary-EndedAt"></a>
A timestamp of when the fraudster registration job ended.  
Type: Timestamp  
Required: No

 ** FailureDetails **   <a name="connect-Type-connect-voice-id_FraudsterRegistrationJobSummary-FailureDetails"></a>
Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn't fail; it is completed with a `JobStatus` of `COMPLETED_WITH_ERRORS`. You can use the job output file to identify the individual registration requests that failed.  
Type: [FailureDetails](API_connect-voice-id_FailureDetails.md) object  
Required: No

 ** JobId **   <a name="connect-Type-connect-voice-id_FraudsterRegistrationJobSummary-JobId"></a>
The service-generated identifier for the fraudster registration job.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: No

 ** JobName **   <a name="connect-Type-connect-voice-id_FraudsterRegistrationJobSummary-JobName"></a>
The client-provided name for the 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

 ** JobProgress **   <a name="connect-Type-connect-voice-id_FraudsterRegistrationJobSummary-JobProgress"></a>
Shows the completed percentage of registration requests listed in the input file.  
Type: [JobProgress](API_connect-voice-id_JobProgress.md) object  
Required: No

 ** JobStatus **   <a name="connect-Type-connect-voice-id_FraudsterRegistrationJobSummary-JobStatus"></a>
The current status of the fraudster registration job.  
Type: String  
Valid Values: `SUBMITTED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | FAILED`   
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/FraudsterRegistrationJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/FraudsterRegistrationJobSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/FraudsterRegistrationJobSummary) 

# FraudsterSummary
<a name="API_connect-voice-id_FraudsterSummary"></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).

Contains a summary of information about a fraudster. 

## Contents
<a name="API_connect-voice-id_FraudsterSummary_Contents"></a>

 ** CreatedAt **   <a name="connect-Type-connect-voice-id_FraudsterSummary-CreatedAt"></a>
The timestamp of when the fraudster summary was created.  
Type: Timestamp  
Required: No

 ** DomainId **   <a name="connect-Type-connect-voice-id_FraudsterSummary-DomainId"></a>
The identifier of the domain that contains the fraudster summary.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: No

 ** GeneratedFraudsterId **   <a name="connect-Type-connect-voice-id_FraudsterSummary-GeneratedFraudsterId"></a>
The service-generated identifier for the fraudster.  
Type: String  
Length Constraints: Fixed length of 25.  
Pattern: `id#[a-zA-Z0-9]{22}`   
Required: No

 ** WatchlistIds **   <a name="connect-Type-connect-voice-id_FraudsterSummary-WatchlistIds"></a>
The identifier of the watchlists the fraudster is a part of.  
Type: Array of strings  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/FraudsterSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/FraudsterSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/FraudsterSummary) 

# InputDataConfig
<a name="API_connect-voice-id_InputDataConfig"></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).

The configuration containing input file information for a batch job.

## Contents
<a name="API_connect-voice-id_InputDataConfig_Contents"></a>

 ** S3Uri **   <a name="connect-Type-connect-voice-id_InputDataConfig-S3Uri"></a>
The S3 location for the input manifest file that contains the list of individual enrollment or registration job requests.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?`   
Required: Yes

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/InputDataConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/InputDataConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/InputDataConfig) 

# JobProgress
<a name="API_connect-voice-id_JobProgress"></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).

Indicates the completion progress for a batch job.

## Contents
<a name="API_connect-voice-id_JobProgress_Contents"></a>

 ** PercentComplete **   <a name="connect-Type-connect-voice-id_JobProgress-PercentComplete"></a>
Shows the completed percentage of enrollment or registration requests listed in the input file.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/JobProgress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/JobProgress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/JobProgress) 

# KnownFraudsterRisk
<a name="API_connect-voice-id_KnownFraudsterRisk"></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).

Contains details produced as a result of performing known fraudster risk analysis on a speaker.

## Contents
<a name="API_connect-voice-id_KnownFraudsterRisk_Contents"></a>

 ** RiskScore **   <a name="connect-Type-connect-voice-id_KnownFraudsterRisk-RiskScore"></a>
The score indicating the likelihood the speaker is a known fraudster.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: Yes

 ** GeneratedFraudsterId **   <a name="connect-Type-connect-voice-id_KnownFraudsterRisk-GeneratedFraudsterId"></a>
The identifier of the fraudster that is the closest match to the speaker. If there are no fraudsters registered in a given domain, or if there are no fraudsters with a non-zero RiskScore, this value is `null`.  
Type: String  
Length Constraints: Fixed length of 25.  
Pattern: `id#[a-zA-Z0-9]{22}`   
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/KnownFraudsterRisk) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/KnownFraudsterRisk) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/KnownFraudsterRisk) 

# OutputDataConfig
<a name="API_connect-voice-id_OutputDataConfig"></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).

The configuration containing output file information for a batch job.

## Contents
<a name="API_connect-voice-id_OutputDataConfig_Contents"></a>

 ** S3Uri **   <a name="connect-Type-connect-voice-id_OutputDataConfig-S3Uri"></a>
The S3 path of the folder where Voice ID writes the job output file. It has a `*.out` extension. For example, if the input file name is `input-file.json` and the output folder path is `s3://output-bucket/output-folder`, the full output file path is `s3://output-bucket/output-folder/job-Id/input-file.json.out`.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?`   
Required: Yes

 ** KmsKeyId **   <a name="connect-Type-connect-voice-id_OutputDataConfig-KmsKeyId"></a>
The identifier of the KMS key you want Voice ID to use to encrypt the output file of a speaker enrollment job/fraudster registration job.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/OutputDataConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/OutputDataConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/OutputDataConfig) 

# RegistrationConfig
<a name="API_connect-voice-id_RegistrationConfig"></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).

The registration configuration to be used during the batch fraudster registration job.

## Contents
<a name="API_connect-voice-id_RegistrationConfig_Contents"></a>

 ** DuplicateRegistrationAction **   <a name="connect-Type-connect-voice-id_RegistrationConfig-DuplicateRegistrationAction"></a>
The action to take when a fraudster is identified as a duplicate. The default action is `SKIP`, which skips registering the duplicate fraudster. Setting the value to `REGISTER_AS_NEW` always registers a new fraudster into the specified domain.  
Type: String  
Valid Values: `SKIP | REGISTER_AS_NEW`   
Required: No

 ** FraudsterSimilarityThreshold **   <a name="connect-Type-connect-voice-id_RegistrationConfig-FraudsterSimilarityThreshold"></a>
The minimum similarity score between the new and old fraudsters in order to consider the new fraudster a duplicate.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** WatchlistIds **   <a name="connect-Type-connect-voice-id_RegistrationConfig-WatchlistIds"></a>
The identifiers of watchlists that a fraudster is registered to. If a watchlist isn't provided, the fraudsters are registered to the default watchlist.   
Type: Array of strings  
Array Members: Fixed number of 1 item.  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/RegistrationConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/RegistrationConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/RegistrationConfig) 

# ServerSideEncryptionConfiguration
<a name="API_connect-voice-id_ServerSideEncryptionConfiguration"></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).

The configuration containing information about the customer managed key used for encrypting customer data.

## Contents
<a name="API_connect-voice-id_ServerSideEncryptionConfiguration_Contents"></a>

 ** KmsKeyId **   <a name="connect-Type-connect-voice-id_ServerSideEncryptionConfiguration-KmsKeyId"></a>
The identifier of the KMS key to use to encrypt data stored by Voice ID. Voice ID doesn't support asymmetric customer managed keys.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/ServerSideEncryptionConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/ServerSideEncryptionConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/ServerSideEncryptionConfiguration) 

# ServerSideEncryptionUpdateDetails
<a name="API_connect-voice-id_ServerSideEncryptionUpdateDetails"></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).

Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain’s data can only be accessed using the new KMS key.

## Contents
<a name="API_connect-voice-id_ServerSideEncryptionUpdateDetails_Contents"></a>

 ** Message **   <a name="connect-Type-connect-voice-id_ServerSideEncryptionUpdateDetails-Message"></a>
Message explaining the current UpdateStatus. When the UpdateStatus is FAILED, this message explains the cause of the failure.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** OldKmsKeyId **   <a name="connect-Type-connect-voice-id_ServerSideEncryptionUpdateDetails-OldKmsKeyId"></a>
The previous KMS key ID the domain was encrypted with, before ServerSideEncryptionConfiguration was updated to a new KMS key ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** UpdateStatus **   <a name="connect-Type-connect-voice-id_ServerSideEncryptionUpdateDetails-UpdateStatus"></a>
Status of the server-side encryption update. During an update, if there is an issue with the domain's current or old KMS key ID, such as an inaccessible or disabled key, then the status is FAILED. In order to resolve this, the key needs to be made accessible, and then an UpdateDomain call with the existing server-side encryption configuration will re-attempt this update process.  
Type: String  
Valid Values: `IN_PROGRESS | COMPLETED | FAILED`   
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/ServerSideEncryptionUpdateDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/ServerSideEncryptionUpdateDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/ServerSideEncryptionUpdateDetails) 

# Speaker
<a name="API_connect-voice-id_Speaker"></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).

Contains all the information about a speaker.

## Contents
<a name="API_connect-voice-id_Speaker_Contents"></a>

 ** CreatedAt **   <a name="connect-Type-connect-voice-id_Speaker-CreatedAt"></a>
A timestamp of when the speaker was created.   
Type: Timestamp  
Required: No

 ** CustomerSpeakerId **   <a name="connect-Type-connect-voice-id_Speaker-CustomerSpeakerId"></a>
The client-provided identifier for the speaker.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: No

 ** DomainId **   <a name="connect-Type-connect-voice-id_Speaker-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: No

 ** GeneratedSpeakerId **   <a name="connect-Type-connect-voice-id_Speaker-GeneratedSpeakerId"></a>
The service-generated identifier for the speaker.  
Type: String  
Length Constraints: Fixed length of 25.  
Pattern: `id#[a-zA-Z0-9]{22}`   
Required: No

 ** LastAccessedAt **   <a name="connect-Type-connect-voice-id_Speaker-LastAccessedAt"></a>
The timestamp of when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.  
Type: Timestamp  
Required: No

 ** Status **   <a name="connect-Type-connect-voice-id_Speaker-Status"></a>
The current status of the speaker.  
Type: String  
Valid Values: `ENROLLED | EXPIRED | OPTED_OUT | PENDING`   
Required: No

 ** UpdatedAt **   <a name="connect-Type-connect-voice-id_Speaker-UpdatedAt"></a>
A timestamp of the speaker's last update.  
Type: Timestamp  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/Speaker) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/Speaker) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/Speaker) 

# SpeakerEnrollmentJob
<a name="API_connect-voice-id_SpeakerEnrollmentJob"></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).

Contains all the information about a speaker enrollment job.

## Contents
<a name="API_connect-voice-id_SpeakerEnrollmentJob_Contents"></a>

 ** CreatedAt **   <a name="connect-Type-connect-voice-id_SpeakerEnrollmentJob-CreatedAt"></a>
A timestamp of when the speaker enrollment job was created.  
Type: Timestamp  
Required: No

 ** DataAccessRoleArn **   <a name="connect-Type-connect-voice-id_SpeakerEnrollmentJob-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.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+`   
Required: No

 ** DomainId **   <a name="connect-Type-connect-voice-id_SpeakerEnrollmentJob-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: No

 ** EndedAt **   <a name="connect-Type-connect-voice-id_SpeakerEnrollmentJob-EndedAt"></a>
A timestamp of when the speaker enrollment job ended.   
Type: Timestamp  
Required: No

 ** EnrollmentConfig **   <a name="connect-Type-connect-voice-id_SpeakerEnrollmentJob-EnrollmentConfig"></a>
The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the `FraudDetectionConfig` to use.  
Type: [EnrollmentConfig](API_connect-voice-id_EnrollmentConfig.md) object  
Required: No

 ** FailureDetails **   <a name="connect-Type-connect-voice-id_SpeakerEnrollmentJob-FailureDetails"></a>
Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn't fail; it is completed with a `JobStatus` of `COMPLETED_WITH_ERRORS`. You can use the job output file to identify the individual registration requests that failed.  
Type: [FailureDetails](API_connect-voice-id_FailureDetails.md) object  
Required: No

 ** InputDataConfig **   <a name="connect-Type-connect-voice-id_SpeakerEnrollmentJob-InputDataConfig"></a>
The input data config containing an S3 URI for the input manifest file that contains the list of speaker enrollment job requests.  
Type: [InputDataConfig](API_connect-voice-id_InputDataConfig.md) object  
Required: No

 ** JobId **   <a name="connect-Type-connect-voice-id_SpeakerEnrollmentJob-JobId"></a>
The service-generated identifier for the speaker enrollment job.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: No

 ** JobName **   <a name="connect-Type-connect-voice-id_SpeakerEnrollmentJob-JobName"></a>
The client-provided name for the 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

 ** JobProgress **   <a name="connect-Type-connect-voice-id_SpeakerEnrollmentJob-JobProgress"></a>
Provides details on job progress. This field shows the completed percentage of registration requests listed in the input file.  
Type: [JobProgress](API_connect-voice-id_JobProgress.md) object  
Required: No

 ** JobStatus **   <a name="connect-Type-connect-voice-id_SpeakerEnrollmentJob-JobStatus"></a>
The current status of the speaker enrollment job.  
Type: String  
Valid Values: `SUBMITTED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | FAILED`   
Required: No

 ** OutputDataConfig **   <a name="connect-Type-connect-voice-id_SpeakerEnrollmentJob-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: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/SpeakerEnrollmentJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/SpeakerEnrollmentJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/SpeakerEnrollmentJob) 

# SpeakerEnrollmentJobSummary
<a name="API_connect-voice-id_SpeakerEnrollmentJobSummary"></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).

Contains a summary of information about a speaker enrollment job.

## Contents
<a name="API_connect-voice-id_SpeakerEnrollmentJobSummary_Contents"></a>

 ** CreatedAt **   <a name="connect-Type-connect-voice-id_SpeakerEnrollmentJobSummary-CreatedAt"></a>
A timestamp of when of the speaker enrollment job was created.  
Type: Timestamp  
Required: No

 ** DomainId **   <a name="connect-Type-connect-voice-id_SpeakerEnrollmentJobSummary-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: No

 ** EndedAt **   <a name="connect-Type-connect-voice-id_SpeakerEnrollmentJobSummary-EndedAt"></a>
A timestamp of when the speaker enrollment job ended.  
Type: Timestamp  
Required: No

 ** FailureDetails **   <a name="connect-Type-connect-voice-id_SpeakerEnrollmentJobSummary-FailureDetails"></a>
Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn't fail; it is completed with a `JobStatus` of `COMPLETED_WITH_ERRORS`. You can use the job output file to identify the individual registration requests that failed.  
Type: [FailureDetails](API_connect-voice-id_FailureDetails.md) object  
Required: No

 ** JobId **   <a name="connect-Type-connect-voice-id_SpeakerEnrollmentJobSummary-JobId"></a>
The service-generated identifier for the speaker enrollment job.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: No

 ** JobName **   <a name="connect-Type-connect-voice-id_SpeakerEnrollmentJobSummary-JobName"></a>
The client-provided name for the 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

 ** JobProgress **   <a name="connect-Type-connect-voice-id_SpeakerEnrollmentJobSummary-JobProgress"></a>
Provides details regarding job progress. This field shows the completed percentage of enrollment requests listed in the input file.  
Type: [JobProgress](API_connect-voice-id_JobProgress.md) object  
Required: No

 ** JobStatus **   <a name="connect-Type-connect-voice-id_SpeakerEnrollmentJobSummary-JobStatus"></a>
The current status of the speaker enrollment job.  
Type: String  
Valid Values: `SUBMITTED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | FAILED`   
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/SpeakerEnrollmentJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/SpeakerEnrollmentJobSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/SpeakerEnrollmentJobSummary) 

# SpeakerSummary
<a name="API_connect-voice-id_SpeakerSummary"></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).

Contains a summary of information about a speaker.

## Contents
<a name="API_connect-voice-id_SpeakerSummary_Contents"></a>

 ** CreatedAt **   <a name="connect-Type-connect-voice-id_SpeakerSummary-CreatedAt"></a>
A timestamp showing the speaker's creation time.   
Type: Timestamp  
Required: No

 ** CustomerSpeakerId **   <a name="connect-Type-connect-voice-id_SpeakerSummary-CustomerSpeakerId"></a>
The client-provided identifier for the speaker.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: No

 ** DomainId **   <a name="connect-Type-connect-voice-id_SpeakerSummary-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: No

 ** GeneratedSpeakerId **   <a name="connect-Type-connect-voice-id_SpeakerSummary-GeneratedSpeakerId"></a>
The service-generated identifier for the speaker.   
Type: String  
Length Constraints: Fixed length of 25.  
Pattern: `id#[a-zA-Z0-9]{22}`   
Required: No

 ** LastAccessedAt **   <a name="connect-Type-connect-voice-id_SpeakerSummary-LastAccessedAt"></a>
The timestamp when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.  
Type: Timestamp  
Required: No

 ** Status **   <a name="connect-Type-connect-voice-id_SpeakerSummary-Status"></a>
The current status of the speaker.  
Type: String  
Valid Values: `ENROLLED | EXPIRED | OPTED_OUT | PENDING`   
Required: No

 ** UpdatedAt **   <a name="connect-Type-connect-voice-id_SpeakerSummary-UpdatedAt"></a>
A timestamp showing the speaker's last update.  
Type: Timestamp  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/SpeakerSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/SpeakerSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/SpeakerSummary) 

# Tag
<a name="API_connect-voice-id_Tag"></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).

The tags used to organize, track, or control access for this resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.

## Contents
<a name="API_connect-voice-id_Tag_Contents"></a>

 ** Key **   <a name="connect-Type-connect-voice-id_Tag-Key"></a>
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag 'Department':'Sales', the key is 'Department'.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`   
Required: Yes

 ** Value **   <a name="connect-Type-connect-voice-id_Tag-Value"></a>
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag 'Department':'Sales', the value is 'Sales'.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`   
Required: Yes

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/Tag) 

# VoiceSpoofingRisk
<a name="API_connect-voice-id_VoiceSpoofingRisk"></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).

The details resulting from 'Voice Spoofing Risk' analysis of the speaker.

## Contents
<a name="API_connect-voice-id_VoiceSpoofingRisk_Contents"></a>

 ** RiskScore **   <a name="connect-Type-connect-voice-id_VoiceSpoofingRisk-RiskScore"></a>
The score indicating the likelihood of speaker’s voice being spoofed.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: Yes

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/VoiceSpoofingRisk) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/VoiceSpoofingRisk) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/VoiceSpoofingRisk) 

# Watchlist
<a name="API_connect-voice-id_Watchlist"></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).

Contains all the information about a watchlist.

## Contents
<a name="API_connect-voice-id_Watchlist_Contents"></a>

 ** CreatedAt **   <a name="connect-Type-connect-voice-id_Watchlist-CreatedAt"></a>
The timestamp of when the watchlist was created.  
Type: Timestamp  
Required: No

 ** DefaultWatchlist **   <a name="connect-Type-connect-voice-id_Watchlist-DefaultWatchlist"></a>
Whether the specified watchlist is the default watchlist of a domain.  
Type: Boolean  
Required: No

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

 ** DomainId **   <a name="connect-Type-connect-voice-id_Watchlist-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: No

 ** Name **   <a name="connect-Type-connect-voice-id_Watchlist-Name"></a>
The name for 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

 ** UpdatedAt **   <a name="connect-Type-connect-voice-id_Watchlist-UpdatedAt"></a>
The timestamp of when the watchlist was updated.  
Type: Timestamp  
Required: No

 ** WatchlistId **   <a name="connect-Type-connect-voice-id_Watchlist-WatchlistId"></a>
The identifier of the watchlist.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/Watchlist) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/Watchlist) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/Watchlist) 

# WatchlistDetails
<a name="API_connect-voice-id_WatchlistDetails"></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).

Details of the watchlists in a domain.

## Contents
<a name="API_connect-voice-id_WatchlistDetails_Contents"></a>

 ** DefaultWatchlistId **   <a name="connect-Type-connect-voice-id_WatchlistDetails-DefaultWatchlistId"></a>
The identifier of the default watchlist.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/WatchlistDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/WatchlistDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/WatchlistDetails) 

# WatchlistSummary
<a name="API_connect-voice-id_WatchlistSummary"></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).

Contains a summary of information about a watchlist.

## Contents
<a name="API_connect-voice-id_WatchlistSummary_Contents"></a>

 ** CreatedAt **   <a name="connect-Type-connect-voice-id_WatchlistSummary-CreatedAt"></a>
The timestamp of when the watchlist was created.  
Type: Timestamp  
Required: No

 ** DefaultWatchlist **   <a name="connect-Type-connect-voice-id_WatchlistSummary-DefaultWatchlist"></a>
Whether the specified watchlist is the default watchlist of a domain.  
Type: Boolean  
Required: No

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

 ** DomainId **   <a name="connect-Type-connect-voice-id_WatchlistSummary-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: No

 ** Name **   <a name="connect-Type-connect-voice-id_WatchlistSummary-Name"></a>
The name for 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

 ** UpdatedAt **   <a name="connect-Type-connect-voice-id_WatchlistSummary-UpdatedAt"></a>
The timestamp of when the watchlist was last updated.  
Type: Timestamp  
Required: No

 ** WatchlistId **   <a name="connect-Type-connect-voice-id_WatchlistSummary-WatchlistId"></a>
The identifier of the watchlist.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/WatchlistSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/WatchlistSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/WatchlistSummary)