EntityResolution / Client / start_id_mapping_job

start_id_mapping_job

EntityResolution.Client.start_id_mapping_job(**kwargs)

Starts the IdMappingJob of a workflow. The workflow must have previously been created using the CreateIdMappingWorkflow endpoint.

See also: AWS API Documentation

Request Syntax

response = client.start_id_mapping_job(
    workflowName='string',
    outputSourceConfig=[
        {
            'roleArn': 'string',
            'outputS3Path': 'string',
            'KMSArn': 'string'
        },
    ],
    jobType='BATCH'|'INCREMENTAL'|'DELETE_ONLY'
)
Parameters:

  • workflowName (string) –

    [REQUIRED]

    The name of the ID mapping job to be retrieved.

  • outputSourceConfig (list) –

    A list of OutputSource objects.

    • (dict) –

      An object containing KMSArn, outputS3Path, and roleARN.

      • roleArn (string) – [REQUIRED]

        The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf as part of workflow execution.

      • outputS3Path (string) – [REQUIRED]

        The S3 path to which Entity Resolution will write the output table.

      • KMSArn (string) –

        Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.

  • jobType (string) –

    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.

Return type:

dict

Returns:

Response Syntax

{
    'jobId': 'string',
    'outputSourceConfig': [
        {
            'roleArn': 'string',
            'outputS3Path': 'string',
            'KMSArn': 'string'
        },
    ],
    'jobType': 'BATCH'|'INCREMENTAL'|'DELETE_ONLY'
}

Response Structure

  • (dict) –

    • jobId (string) –

      The ID of the job.

    • outputSourceConfig (list) –

      A list of OutputSource objects.

      • (dict) –

        An object containing KMSArn, outputS3Path, and roleARN.

        • roleArn (string) –

          The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf as part of workflow execution.

        • outputS3Path (string) –

          The S3 path to which Entity Resolution will write the output table.

        • KMSArn (string) –

          Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.

    • jobType (string) –

      The job type for the started ID mapping job.

      A value of INCREMENTAL 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 incrementalRunConfig.

      A value of BATCH 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 incrementalRunConfig.

      A value of DELETE_ONLY indicates that only deletion requests from BatchDeleteUniqueIds were processed.

Exceptions