Documentation

Contains all the information about a speaker enrollment job.

See: newSpeakerEnrollmentJob smart constructor.

Create a value of SpeakerEnrollmentJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:failureDetails:SpeakerEnrollmentJob', speakerEnrollmentJob_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.

$sel:jobId:SpeakerEnrollmentJob', speakerEnrollmentJob_jobId - The service-generated identifier for the speaker enrollment job.

$sel:createdAt:SpeakerEnrollmentJob', speakerEnrollmentJob_createdAt - A timestamp showing the creation of the speaker enrollment job.

$sel:jobName:SpeakerEnrollmentJob', speakerEnrollmentJob_jobName - The client-provided name for the speaker enrollment job.

$sel:endedAt:SpeakerEnrollmentJob', speakerEnrollmentJob_endedAt - A timestamp showing when the speaker enrollment job ended.

$sel:enrollmentConfig:SpeakerEnrollmentJob', speakerEnrollmentJob_enrollmentConfig - The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the FraudDetectionConfig to use.

$sel:inputDataConfig:SpeakerEnrollmentJob', speakerEnrollmentJob_inputDataConfig - The input data config containing an S3 URI for the input manifest file that contains the list of speaker enrollment job requests.

$sel:jobProgress:SpeakerEnrollmentJob', speakerEnrollmentJob_jobProgress - Provides details on job progress. This field shows the completed percentage of registration requests listed in the input file.

$sel:outputDataConfig:SpeakerEnrollmentJob', speakerEnrollmentJob_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.

$sel:dataAccessRoleArn:SpeakerEnrollmentJob', speakerEnrollmentJob_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.

$sel:domainId:SpeakerEnrollmentJob', speakerEnrollmentJob_domainId - The identifier of the domain that contains the speaker enrollment job.

$sel:jobStatus:SpeakerEnrollmentJob', speakerEnrollmentJob_jobStatus - The current status of the speaker enrollment job.

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.

The service-generated identifier for the speaker enrollment job.

A timestamp showing the creation of the speaker enrollment job.

The client-provided name for the speaker enrollment job.

A timestamp showing when the speaker enrollment job ended.

The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the FraudDetectionConfig to use.

The input data config containing an S3 URI for the input manifest file that contains the list of speaker enrollment job requests.

Provides details on job progress. This field shows the completed percentage of registration requests listed in the input file.

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.

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.

The identifier of the domain that contains the speaker enrollment job.

The current status of the speaker enrollment job.