EntityResolution / Client / get_id_mapping_job

get_id_mapping_job#

EntityResolution.Client.get_id_mapping_job(**kwargs)#

Gets the status, metrics, and errors (if there are any) that are associated with a job.

See also: AWS API Documentation

Request Syntax

response = client.get_id_mapping_job(
    jobId='string',
    workflowName='string'
)
Parameters:

  • jobId (string) –

    [REQUIRED]

    The ID of the job.

  • workflowName (string) –

    [REQUIRED]

    The name of the workflow.

Return type:

dict

Returns:

Response Syntax

{
    'endTime': datetime(2015, 1, 1),
    'errorDetails': {
        'errorMessage': 'string'
    },
    'jobId': 'string',
    'metrics': {
        'inputRecords': 123,
        'recordsNotProcessed': 123,
        'totalMappedRecords': 123,
        'totalMappedSourceRecords': 123,
        'totalMappedTargetRecords': 123,
        'totalRecordsProcessed': 123
    },
    'outputSourceConfig': [
        {
            'KMSArn': 'string',
            'outputS3Path': 'string',
            'roleArn': 'string'
        },
    ],
    'startTime': datetime(2015, 1, 1),
    'status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'QUEUED'
}

Response Structure

  • (dict) –

    • endTime (datetime) –

      The time at which the job has finished.

    • errorDetails (dict) –

      An object containing an error message, if there was an error.

      • errorMessage (string) –

        The error message from the job, if there is one.

    • jobId (string) –

      The ID of the job.

    • metrics (dict) –

      Metrics associated with the execution, specifically total records processed, unique IDs generated, and records the execution skipped.

      • inputRecords (integer) –

        The total number of records that were input for processing.

      • recordsNotProcessed (integer) –

        The total number of records that did not get processed.

      • totalMappedRecords (integer) –

        The total number of records that were mapped.

      • totalMappedSourceRecords (integer) –

        The total number of mapped source records.

      • totalMappedTargetRecords (integer) –

        The total number of distinct mapped target records.

      • totalRecordsProcessed (integer) –

        The total number of records that were processed.

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

    • startTime (datetime) –

      The time at which the job was started.

    • status (string) –

      The current status of the job.

Exceptions