AWS EntityResolution

{'metrics': {'uniqueRecordsLoaded': 'integer'}}

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

See also: AWS API Documentation

Request Syntax

client.get_id_mapping_job(
    workflowName='string',
    jobId='string'
)

type workflowName:

string

param workflowName:

[REQUIRED]

The name of the workflow.

type jobId:

string

param jobId:

[REQUIRED]

The ID of the job.

rtype:

dict

returns:

Response Syntax

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

Response Structure

• (dict) --

  • jobId (string) --

    The ID of the job.

  • status (string) --

    The current status of the job.

  • startTime (datetime) --

    The time at which the job was started.

  • endTime (datetime) --

    The time at which the job has finished.

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

    • totalRecordsProcessed (integer) --

      The total number of records that were processed.

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

    • uniqueRecordsLoaded (integer) --

      The number of records remaining after loading and aggregating duplicate records. Duplicates are determined by the field marked as UNIQUE_ID in your schema mapping - records sharing the same value in this field are considered duplicates. For example, if you specified "customer_id" as a UNIQUE_ID field and had three records with the same customer_id value, they would count as one unique record in this metric.

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

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