aws_sdk_entityresolution/client/

start_id_mapping_job.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartIdMappingJob`](crate::operation::start_id_mapping_job::builders::StartIdMappingJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`workflow_name(impl Into<String>)`](crate::operation::start_id_mapping_job::builders::StartIdMappingJobFluentBuilder::workflow_name) / [`set_workflow_name(Option<String>)`](crate::operation::start_id_mapping_job::builders::StartIdMappingJobFluentBuilder::set_workflow_name):<br>required: **true**<br><p>The name of the ID mapping job to be retrieved.</p><br>
    ///   - [`output_source_config(IdMappingJobOutputSource)`](crate::operation::start_id_mapping_job::builders::StartIdMappingJobFluentBuilder::output_source_config) / [`set_output_source_config(Option<Vec::<IdMappingJobOutputSource>>)`](crate::operation::start_id_mapping_job::builders::StartIdMappingJobFluentBuilder::set_output_source_config):<br>required: **false**<br><p>A list of <code>OutputSource</code> objects.</p><br>
    ///   - [`job_type(JobType)`](crate::operation::start_id_mapping_job::builders::StartIdMappingJobFluentBuilder::job_type) / [`set_job_type(Option<JobType>)`](crate::operation::start_id_mapping_job::builders::StartIdMappingJobFluentBuilder::set_job_type):<br>required: **false**<br><p>The job type for the ID mapping job.</p> <p>If the <code>jobType</code> value is set to <code>INCREMENTAL</code>, only new or changed data is processed since the last job run. This is the default value if the <code>CreateIdMappingWorkflow</code> API is configured with an <code>incrementalRunConfig</code>.</p> <p>If the <code>jobType</code> value is set to <code>BATCH</code>, all data is processed from the input source, regardless of previous job runs. This is the default value if the <code>CreateIdMappingWorkflow</code> API isn't configured with an <code>incrementalRunConfig</code>.</p> <p>If the <code>jobType</code> value is set to <code>DELETE_ONLY</code>, only deletion requests from <code>BatchDeleteUniqueIds</code> are processed.</p><br>
    /// - On success, responds with [`StartIdMappingJobOutput`](crate::operation::start_id_mapping_job::StartIdMappingJobOutput) with field(s):
    ///   - [`job_id(String)`](crate::operation::start_id_mapping_job::StartIdMappingJobOutput::job_id): <p>The ID of the job.</p>
    ///   - [`output_source_config(Option<Vec::<IdMappingJobOutputSource>>)`](crate::operation::start_id_mapping_job::StartIdMappingJobOutput::output_source_config): <p>A list of <code>OutputSource</code> objects.</p>
    ///   - [`job_type(Option<JobType>)`](crate::operation::start_id_mapping_job::StartIdMappingJobOutput::job_type): <p>The job type for the started ID mapping job.</p> <p>A value of <code>INCREMENTAL</code> indicates that only new or changed data was processed since the last job run. This is the default job type if the workflow was created with an <code>incrementalRunConfig</code>.</p> <p>A value of <code>BATCH</code> indicates that all data was processed from the input source, regardless of previous job runs. This is the default job type if the workflow wasn't created with an <code>incrementalRunConfig</code>.</p> <p>A value of <code>DELETE_ONLY</code> indicates that only deletion requests from <code>BatchDeleteUniqueIds</code> were processed.</p>
    /// - On failure, responds with [`SdkError<StartIdMappingJobError>`](crate::operation::start_id_mapping_job::StartIdMappingJobError)
    pub fn start_id_mapping_job(&self) -> crate::operation::start_id_mapping_job::builders::StartIdMappingJobFluentBuilder {
        crate::operation::start_id_mapping_job::builders::StartIdMappingJobFluentBuilder::new(self.handle.clone())
    }
}