Skip to content

StartSpeakerEnrollmentJobRequest

Source code in docs_src/capo_voice_id/types/start_speaker_enrollment_job_request.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class StartSpeakerEnrollmentJobRequest(TypedDict, closed=True):
    client_token: NotRequired[
        "capo_voice_id.types.client_token_string.ClientTokenString"
    ]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>"""
    job_name: NotRequired["capo_voice_id.types.job_name.JobName"]
    """<p>A name for your speaker enrollment job.</p>"""
    domain_id: "capo_voice_id.types.domain_id.DomainId"
    """<p>The identifier of the domain that contains the speaker enrollment job and in which the speakers are enrolled. </p>"""
    data_access_role_arn: "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. Refer to <a href="https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-batch-enrollment.html">Batch enrollment using audio data from prior calls</a> for the permissions needed in this role.</p>"""
    enrollment_config: NotRequired[
        "capo_voice_id.types.enrollment_config.EnrollmentConfig"
    ]
    """<p>The enrollment config that contains details such as the action to take when a speaker is already enrolled in Voice ID or when a speaker is identified as a fraudster.</p>"""
    input_data_config: "capo_voice_id.types.input_data_config.InputDataConfig"
    """<p>The input data config containing the S3 location for the input manifest file that contains the list of speaker enrollment requests.</p>"""
    output_data_config: "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>"""

client_token instance-attribute 

client_token: NotRequired[ClientTokenString]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

data_access_role_arn instance-attribute 

data_access_role_arn: 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. Refer to Batch enrollment using audio data from prior calls for the permissions needed in this role.

domain_id instance-attribute 

domain_id: DomainId

The identifier of the domain that contains the speaker enrollment job and in which the speakers are enrolled.

enrollment_config instance-attribute 

enrollment_config: NotRequired[EnrollmentConfig]

The enrollment config that contains details such as the action to take when a speaker is already enrolled in Voice ID or when a speaker is identified as a fraudster.

input_data_config instance-attribute 

input_data_config: InputDataConfig

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

job_name instance-attribute 

job_name: NotRequired[JobName]

A name for your speaker enrollment job.

output_data_config instance-attribute 

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