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(
    outputSourceConfig=[
        {
            'KMSArn': 'string',
            'outputS3Path': 'string',
            'roleArn': 'string'
        },
    ],
    workflowName='string'
)
Parameters:

  • outputSourceConfig (list) –

    A list of OutputSource objects.

    • (dict) –

      An object containing KMSArn, OutputS3Path, and RoleARN.

      • KMSArn (string) –

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

      • outputS3Path (string) – [REQUIRED]

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

      • 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.

  • workflowName (string) –

    [REQUIRED]

    The name of the ID mapping job to be retrieved.

Return type:

dict

Returns:

Response Syntax

{
    'jobId': 'string',
    'outputSourceConfig': [
        {
            'KMSArn': 'string',
            'outputS3Path': 'string',
            'roleArn': 'string'
        },
    ]
}

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.

        • KMSArn (string) –

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

        • outputS3Path (string) –

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

        • 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.

Exceptions