Skip to content

StartIdMappingJobInput

Source code in docs_src/capo_entityresolution/types/start_id_mapping_job_input.py 
13
14
15
16
17
18
19
20
21
class StartIdMappingJobInput(TypedDict, closed=True):
    workflow_name: "capo_entityresolution.types.entity_name_or_id_mapping_workflow_arn.EntityNameOrIdMappingWorkflowArn"
    """<p>The name of the ID mapping job to be retrieved.</p>"""
    output_source_config: NotRequired[
        "capo_entityresolution.types.id_mapping_job_output_source_config.IdMappingJobOutputSourceConfig"
    ]
    """<p>A list of <code>OutputSource</code> objects.</p>"""
    job_type: NotRequired["capo_entityresolution.types.job_type.JobType"]
    """<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>"""

job_type instance-attribute 

job_type: NotRequired[JobType]

The job type for the ID mapping job.

If the jobType value is set to INCREMENTAL, only new or changed data is processed since the last job run. This is the default value if the CreateIdMappingWorkflow API is configured with an incrementalRunConfig.

If the jobType value is set to BATCH, all data is processed from the input source, regardless of previous job runs. This is the default value if the CreateIdMappingWorkflow API isn't configured with an incrementalRunConfig.

If the jobType value is set to DELETE_ONLY, only deletion requests from BatchDeleteUniqueIds are processed.

output_source_config instance-attribute 

output_source_config: NotRequired[IdMappingJobOutputSourceConfig]

A list of OutputSource objects.

workflow_name instance-attribute 

workflow_name: EntityNameOrIdMappingWorkflowArn

The name of the ID mapping job to be retrieved.