AuthenticationConfiguration
The configuration used to authenticate a speaker.
Contents
AcceptanceThreshold
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
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AuthenticationResult
AuthenticationResult
Contains information produced as a result of authenticating the speaker.
Contents
AudioAggregationEndedAt
A timestamp indicating when audio aggregation ended for this authentication result.
Type: Timestamp Required: No
AudioAggregationStartedAt
A timestamp indicating when audio aggregation started for this authentication result.
Type: Timestamp Required: No AuthenticationResultId
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, VoiceId always returns cached results for this API.
Type: String
Length Constraints: Fixed length of 22.
Pattern: ^[a-zA-Z0-9]{22}$
Required: No Configuration
The AuthenticationConfiguration used to generate this authentication result.
Type: AuthenticationConfiguration (p. 63) object Required: No
CustomerSpeakerId
The client-provided identifier for the speaker whose authentication result is produced.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$
Required: No Decision
The decision produced by VoiceID as a result of the authentication process.
Type: String
See Also
Valid Values: ACCEPT | REJECT | NOT_ENOUGH_SPEECH | SPEAKER_NOT_ENROLLED | SPEAKER_OPTED_OUT | SPEAKER_ID_NOT_PROVIDED
Required: No GeneratedSpeakerId
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
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
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Domain
Domain
Contains all the information about a domain.
Contents
Arn
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
The timestamp at which the domain is created.
Type: Timestamp Required: No Description
The client-provided 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
The service-generated identifier for the domain.
Type: String
Length Constraints: Fixed length of 22.
Pattern: ^[a-zA-Z0-9]{22}$
Required: No DomainStatus
The current status of the domain.
Type: String
Valid Values: ACTIVE | PENDING | SUSPENDED Required: No
Name
The client-provided name for the domain.
Type: String
See Also
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$
Required: No
ServerSideEncryptionConfiguration
The server-side encryption configuration containing the KMS Key Identifier you want VoiceID to use to encrypt your data.
Type: ServerSideEncryptionConfiguration (p. 88) object Required: No
UpdatedAt
The timestamp showing the domain's last update.
Type: Timestamp Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DomainSummary
DomainSummary
Contains a summary of information about a domain.
Contents
Arn
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
The timestamp showing when the domain is created.
Type: Timestamp Required: No Description
The client-provided 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
The service-generated identifier for the domain.
Type: String
Length Constraints: Fixed length of 22.
Pattern: ^[a-zA-Z0-9]{22}$
Required: No DomainStatus
The current status of the domain.
Type: String
Valid Values: ACTIVE | PENDING | SUSPENDED Required: No
Name
The client-provided name for the domain.
Type: String
See Also
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$
Required: No
ServerSideEncryptionConfiguration
The server-side encryption configuration containing the KMS Key Identifier you want VoiceID to use to encrypt your data..
Type: ServerSideEncryptionConfiguration (p. 88) object Required: No
UpdatedAt
The timestamp showing the domain's last update.
Type: Timestamp Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
EnrollmentConfig
EnrollmentConfig
The configuration defining the action to take when the speaker is already enrolled in VoiceID, and the FraudDetectionConfig to use during a batch speaker enrollment Job.
Contents
ExistingEnrollmentAction
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
The fraud detection configuration to use for the speaker enrollment job.
Type: EnrollmentJobFraudDetectionConfig (p. 71) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
EnrollmentJobFraudDetectionConfig
EnrollmentJobFraudDetectionConfig
The configuration defining the action to take when a speaker is identified as a fraudser during a batch speaker enrollment job, and the risk threshold to use for identification.
Contents
FraudDetectionAction
The action to take when VoideID identifies the specified speaker as a fraudster. 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 identified as a fraudster.
Type: String
Valid Values: IGNORE | FAIL Required: No
RiskThreshold
The threshold value for determining whether the speaker is a fraudster. If the detected risk score calculated by VoiceID 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
FailureDetails
FailureDetails
Contains error details for a failed batch job.
Contents
Message
A description of the error that caused the batch job failure.
Type: String
Length Constraints: Minimum length of 1.
Required: No StatusCode
An HTTP status code representing the nature of the error.
Type: Integer Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3