EntityResolution / Client / get_matching_job

get_matching_job

EntityResolution.Client.get_matching_job(**kwargs)

Returns 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_matching_job(
    workflowName='string',
    jobId='string'
)
Parameters:

  • workflowName (string) –

    [REQUIRED]

    The name of the workflow.

  • jobId (string) –

    [REQUIRED]

    The ID of the job.

Return type:

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,
        'deleteRecordsProcessed': 123,
        'matchIDs': 123
    },
    'errorDetails': {
        'errorMessage': 'string'
    },
    'outputSourceConfig': [
        {
            'roleArn': 'string',
            'outputS3Path': 'string',
            'KMSArn': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • jobId (string) –

      The unique identifier of the matching 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 input records.

      • totalRecordsProcessed (integer) –

        The total number of records processed.

      • recordsNotProcessed (integer) –

        The total number of records that did not get processed.

      • deleteRecordsProcessed (integer) –

        The number of records processed that were marked for deletion ( DELETE = True) in the input file. This metric tracks records flagged for removal during the job execution.

      • matchIDs (integer) –

        The total number of ``matchID``s generated.

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

Exceptions