Skip to content

SpeakerEnrollmentJob

Source code in docs_src/capo_voice_id/types/speaker_enrollment_job.py
class SpeakerEnrollmentJob(TypedDict, closed=True):
    job_name: NotRequired["capo_voice_id.types.job_name.JobName"]
    """<p>The client-provided name for the speaker enrollment job.</p>"""
    job_id: NotRequired["capo_voice_id.types.job_id.JobId"]
    """<p>The service-generated identifier for the speaker enrollment job.</p>"""
    job_status: NotRequired[
        "capo_voice_id.types.speaker_enrollment_job_status.SpeakerEnrollmentJobStatus"
    ]
    """<p>The current status of the speaker enrollment job.</p>"""
    domain_id: NotRequired["capo_voice_id.types.domain_id.DomainId"]
    """<p>The identifier of the domain that contains the speaker enrollment job.</p>"""
    data_access_role_arn: NotRequired["capo_voice_id.types.iam_role_arn.IamRoleArn"]
    """<p>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.</p>"""
    enrollment_config: NotRequired[
        "capo_voice_id.types.enrollment_config.EnrollmentConfig"
    ]
    """<p>The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the <code>FraudDetectionConfig</code> to use.</p>"""
    input_data_config: NotRequired[
        "capo_voice_id.types.input_data_config.InputDataConfig"
    ]
    """<p>The input data config containing an S3 URI for the input manifest file that contains the list of speaker enrollment job requests.</p>"""
    output_data_config: NotRequired[
        "capo_voice_id.types.output_data_config.OutputDataConfig"
    ]
    """<p>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.</p>"""
    created_at: NotRequired["capo_voice_id.types.timestamp.Timestamp"]
    """<p>A timestamp of when the speaker enrollment job was created.</p>"""
    ended_at: NotRequired["capo_voice_id.types.timestamp.Timestamp"]
    """<p>A timestamp of when the speaker enrollment job ended. </p>"""
    failure_details: NotRequired["capo_voice_id.types.failure_details.FailureDetails"]
    """<p>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 <code>JobStatus</code> of <code>COMPLETED_WITH_ERRORS</code>. You can use the job output file to identify the individual registration requests that failed.</p>"""
    job_progress: NotRequired["capo_voice_id.types.job_progress.JobProgress"]
    """<p>Provides details on job progress. This field shows the completed percentage of registration requests listed in the input file.</p>"""

created_at instance-attribute

created_at: NotRequired[Timestamp]

A timestamp of when the speaker enrollment job was created.

data_access_role_arn instance-attribute

data_access_role_arn: NotRequired[IamRoleArn]

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.

domain_id instance-attribute

domain_id: NotRequired[DomainId]

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

ended_at instance-attribute

ended_at: NotRequired[Timestamp]

A timestamp of when the speaker enrollment job ended.

enrollment_config instance-attribute

enrollment_config: NotRequired[EnrollmentConfig]

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

failure_details instance-attribute

failure_details: NotRequired[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.

input_data_config instance-attribute

input_data_config: NotRequired[InputDataConfig]

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

job_id instance-attribute

job_id: NotRequired[JobId]

The service-generated identifier for the speaker enrollment job.

job_name instance-attribute

job_name: NotRequired[JobName]

The client-provided name for the speaker enrollment job.

job_progress instance-attribute

job_progress: NotRequired[JobProgress]

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

job_status instance-attribute

job_status: NotRequired[SpeakerEnrollmentJobStatus]

The current status of the speaker enrollment job.

output_data_config instance-attribute

output_data_config: NotRequired[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.