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.

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,
        'totalRecordsProcessed': 123
    },
    '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 input records.
  - recordsNotProcessed (integer) –
    
    The total number of records that did not get processed.
  - totalRecordsProcessed (integer) –
    
    The total number of records processed.
- startTime (datetime) –
  
  The time at which the job was started.
- status (string) –
  
  The current status of the job.

Exceptions

EntityResolution.Client.exceptions.ThrottlingException
EntityResolution.Client.exceptions.InternalServerException
EntityResolution.Client.exceptions.ResourceNotFoundException
EntityResolution.Client.exceptions.AccessDeniedException
EntityResolution.Client.exceptions.ValidationException