aws_sdk_voiceid/client/
start_speaker_enrollment_job.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartSpeakerEnrollmentJob`](crate::operation::start_speaker_enrollment_job::builders::StartSpeakerEnrollmentJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`client_token(impl Into<String>)`](crate::operation::start_speaker_enrollment_job::builders::StartSpeakerEnrollmentJobFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_speaker_enrollment_job::builders::StartSpeakerEnrollmentJobFluentBuilder::set_client_token):<br>required: **false**<br><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><br>
    ///   - [`job_name(impl Into<String>)`](crate::operation::start_speaker_enrollment_job::builders::StartSpeakerEnrollmentJobFluentBuilder::job_name) / [`set_job_name(Option<String>)`](crate::operation::start_speaker_enrollment_job::builders::StartSpeakerEnrollmentJobFluentBuilder::set_job_name):<br>required: **false**<br><p>A name for your speaker enrollment job.</p><br>
    ///   - [`domain_id(impl Into<String>)`](crate::operation::start_speaker_enrollment_job::builders::StartSpeakerEnrollmentJobFluentBuilder::domain_id) / [`set_domain_id(Option<String>)`](crate::operation::start_speaker_enrollment_job::builders::StartSpeakerEnrollmentJobFluentBuilder::set_domain_id):<br>required: **true**<br><p>The identifier of the domain that contains the speaker enrollment job and in which the speakers are enrolled.</p><br>
    ///   - [`data_access_role_arn(impl Into<String>)`](crate::operation::start_speaker_enrollment_job::builders::StartSpeakerEnrollmentJobFluentBuilder::data_access_role_arn) / [`set_data_access_role_arn(Option<String>)`](crate::operation::start_speaker_enrollment_job::builders::StartSpeakerEnrollmentJobFluentBuilder::set_data_access_role_arn):<br>required: **true**<br><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><br>
    ///   - [`enrollment_config(EnrollmentConfig)`](crate::operation::start_speaker_enrollment_job::builders::StartSpeakerEnrollmentJobFluentBuilder::enrollment_config) / [`set_enrollment_config(Option<EnrollmentConfig>)`](crate::operation::start_speaker_enrollment_job::builders::StartSpeakerEnrollmentJobFluentBuilder::set_enrollment_config):<br>required: **false**<br><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><br>
    ///   - [`input_data_config(InputDataConfig)`](crate::operation::start_speaker_enrollment_job::builders::StartSpeakerEnrollmentJobFluentBuilder::input_data_config) / [`set_input_data_config(Option<InputDataConfig>)`](crate::operation::start_speaker_enrollment_job::builders::StartSpeakerEnrollmentJobFluentBuilder::set_input_data_config):<br>required: **true**<br><p>The input data config containing the S3 location for the input manifest file that contains the list of speaker enrollment requests.</p><br>
    ///   - [`output_data_config(OutputDataConfig)`](crate::operation::start_speaker_enrollment_job::builders::StartSpeakerEnrollmentJobFluentBuilder::output_data_config) / [`set_output_data_config(Option<OutputDataConfig>)`](crate::operation::start_speaker_enrollment_job::builders::StartSpeakerEnrollmentJobFluentBuilder::set_output_data_config):<br>required: **true**<br><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><br>
    /// - On success, responds with [`StartSpeakerEnrollmentJobOutput`](crate::operation::start_speaker_enrollment_job::StartSpeakerEnrollmentJobOutput) with field(s):
    ///   - [`job(Option<SpeakerEnrollmentJob>)`](crate::operation::start_speaker_enrollment_job::StartSpeakerEnrollmentJobOutput::job): <p>Details about the started speaker enrollment job.</p>
    /// - On failure, responds with [`SdkError<StartSpeakerEnrollmentJobError>`](crate::operation::start_speaker_enrollment_job::StartSpeakerEnrollmentJobError)
    pub fn start_speaker_enrollment_job(&self) -> crate::operation::start_speaker_enrollment_job::builders::StartSpeakerEnrollmentJobFluentBuilder {
        crate::operation::start_speaker_enrollment_job::builders::StartSpeakerEnrollmentJobFluentBuilder::new(self.handle.clone())
    }
}