SpeakerEnrollmentJob - Amazon Connect Voice ID

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 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

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 Voice ID, and the FraudDetectionConfig to use.

Type: EnrollmentConfig 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.

Type: FailureDetails 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 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 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 Voice ID writes the job output file; you must also include a KMS key ID to encrypt the file.

Type: OutputDataConfig object

Required: No

See Also

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