ServerSideEncryptionConfiguration
The configuration containing information about the customer-managed KMS Key used for encrypting customer data.
Contents
KmsKeyId
The identifier of the KMS Key you want VoiceID to use to encrypt your data.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
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
Speaker
Speaker
Contains all the information about a speaker.
Contents
CreatedAt
A timestamp showing when the Speaker is created.
Type: Timestamp Required: No CustomerSpeakerId
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
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
The service-generated identifier for the speaker.
Type: String
Length Constraints: Fixed length of 25.
Pattern: ^id#[a-zA-Z0-9]{22}$
Required: No Status
The current status of the speaker.
Type: String
Valid Values: ENROLLED | EXPIRED | OPTED_OUT | PENDING Required: No
UpdatedAt
A timestamp showing the speaker's last update.
See Also
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
SpeakerEnrollmentJob
SpeakerEnrollmentJob
Contains all the information about a speaker enrollment job.
Contents
CreatedAt
A timestamp showing the creation of the speaker enrollment job.
Type: Timestamp Required: No DataAccessRoleArn
The IAM role Amazon Resource Name (ARN) that grants VoiceID permissions to read input and write output files in your S3 buckets.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: ^arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+$
Required: No DomainId
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 timestamp showing when the speaker enrollment job ended.
Type: Timestamp Required: No EnrollmentConfig
The configuration that defines the action to take when the speaker is already enrolled in VoiceID, and the FraudDetectionConfig to use.
Type: EnrollmentConfig (p. 70) object Required: No
FailureDetails
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.
Contents
Type: FailureDetails (p. 72) object Required: No
InputDataConfig
The input data config containing an S3 URI for the input manifest file that contains the list of speaker enrollment job requests.
Type: InputDataConfig (p. 83) object Required: No
JobId
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
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
Provides details on job progress. This field shows the completed percentage of registration requests listed in the input file.
Type: JobProgress (p. 84) object Required: No
JobStatus
The current status of the speaker enrollment job.
Type: String
Valid Values: SUBMITTED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | FAILED
Required: No OutputDataConfig
The output data config containing the S3 location where VoiceID writes the job output file; you must also include a KMS Key ID to encrypt the file.
Type: OutputDataConfig (p. 86) object Required: No
See Also
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
SpeakerEnrollmentJobSummary
SpeakerEnrollmentJobSummary
Contains a summary of information about a speaker enrollment job.
Contents
CreatedAt
A timestamp showing the creation time of the speaker enrollment job.
Type: Timestamp Required: No DomainId
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 timestamp showing when the speaker enrollment job ended.
Type: Timestamp Required: No FailureDetails
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 (p. 72) object Required: No
JobId
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
The client-provided name for the speaker enrollment job.
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 JobProgress
Provides details regarding job progress. This field shows the completed percentage of enrollment requests listed in the input file.
Type: JobProgress (p. 84) object Required: No
JobStatus
The current status of the speaker enrollment job.
Type: String
Valid Values: SUBMITTED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | FAILED
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
SpeakerSummary
SpeakerSummary
Contains a summary of information about a speaker.
Contents
CreatedAt
A timestamp showing the speaker's creation time.
Type: Timestamp Required: No CustomerSpeakerId
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
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
The service-generated identifier for the speaker.
Type: String
Length Constraints: Fixed length of 25.
Pattern: ^id#[a-zA-Z0-9]{22}$
Required: No Status
The current status of the speaker.
Type: String
Valid Values: ENROLLED | EXPIRED | OPTED_OUT | PENDING Required: No
UpdatedAt
A timestamp showing the speaker's last update.
See Also
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
Tag
Tag
A tag that can be assigned to a VoiceID resource.
Contents
Key
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
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
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