aws_sdk_voiceid/client/
start_fraudster_registration_job.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartFraudsterRegistrationJob`](crate::operation::start_fraudster_registration_job::builders::StartFraudsterRegistrationJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`client_token(impl Into<String>)`](crate::operation::start_fraudster_registration_job::builders::StartFraudsterRegistrationJobFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_fraudster_registration_job::builders::StartFraudsterRegistrationJobFluentBuilder::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_fraudster_registration_job::builders::StartFraudsterRegistrationJobFluentBuilder::job_name) / [`set_job_name(Option<String>)`](crate::operation::start_fraudster_registration_job::builders::StartFraudsterRegistrationJobFluentBuilder::set_job_name):<br>required: **false**<br><p>The name of the new fraudster registration job.</p><br>
    ///   - [`domain_id(impl Into<String>)`](crate::operation::start_fraudster_registration_job::builders::StartFraudsterRegistrationJobFluentBuilder::domain_id) / [`set_domain_id(Option<String>)`](crate::operation::start_fraudster_registration_job::builders::StartFraudsterRegistrationJobFluentBuilder::set_domain_id):<br>required: **true**<br><p>The identifier of the domain that contains the fraudster registration job and in which the fraudsters are registered.</p><br>
    ///   - [`data_access_role_arn(impl Into<String>)`](crate::operation::start_fraudster_registration_job::builders::StartFraudsterRegistrationJobFluentBuilder::data_access_role_arn) / [`set_data_access_role_arn(Option<String>)`](crate::operation::start_fraudster_registration_job::builders::StartFraudsterRegistrationJobFluentBuilder::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 the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-fraudster-watchlist.html">Create and edit a fraudster watchlist</a> documentation for the permissions needed in this role.</p><br>
    ///   - [`registration_config(RegistrationConfig)`](crate::operation::start_fraudster_registration_job::builders::StartFraudsterRegistrationJobFluentBuilder::registration_config) / [`set_registration_config(Option<RegistrationConfig>)`](crate::operation::start_fraudster_registration_job::builders::StartFraudsterRegistrationJobFluentBuilder::set_registration_config):<br>required: **false**<br><p>The registration config containing details such as the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster.</p><br>
    ///   - [`input_data_config(InputDataConfig)`](crate::operation::start_fraudster_registration_job::builders::StartFraudsterRegistrationJobFluentBuilder::input_data_config) / [`set_input_data_config(Option<InputDataConfig>)`](crate::operation::start_fraudster_registration_job::builders::StartFraudsterRegistrationJobFluentBuilder::set_input_data_config):<br>required: **true**<br><p>The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration requests.</p><br>
    ///   - [`output_data_config(OutputDataConfig)`](crate::operation::start_fraudster_registration_job::builders::StartFraudsterRegistrationJobFluentBuilder::output_data_config) / [`set_output_data_config(Option<OutputDataConfig>)`](crate::operation::start_fraudster_registration_job::builders::StartFraudsterRegistrationJobFluentBuilder::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 [`StartFraudsterRegistrationJobOutput`](crate::operation::start_fraudster_registration_job::StartFraudsterRegistrationJobOutput) with field(s):
    ///   - [`job(Option<FraudsterRegistrationJob>)`](crate::operation::start_fraudster_registration_job::StartFraudsterRegistrationJobOutput::job): <p>Details about the started fraudster registration job.</p>
    /// - On failure, responds with [`SdkError<StartFraudsterRegistrationJobError>`](crate::operation::start_fraudster_registration_job::StartFraudsterRegistrationJobError)
    pub fn start_fraudster_registration_job(
        &self,
    ) -> crate::operation::start_fraudster_registration_job::builders::StartFraudsterRegistrationJobFluentBuilder {
        crate::operation::start_fraudster_registration_job::builders::StartFraudsterRegistrationJobFluentBuilder::new(self.handle.clone())
    }
}