Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetIdMappingJob

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

Request Syntax


GET /idmappingworkflows/workflowName/jobs/jobId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

jobId

The ID of the job.

Pattern: [a-f0-9]{32}

Required: Yes

workflowName

The name of the workflow.

Pattern: [a-zA-Z_0-9-=+/]*$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idmappingworkflow/[a-zA-Z_0-9-]{1,255})

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "endTime": number,
   "errorDetails": { 
      "errorMessage": "string"
   },
   "jobId": "string",
   "jobType": "string",
   "metrics": { 
      "deleteRecordsProcessed": number,
      "inputRecords": number,
      "mappedRecordsRemoved": number,
      "mappedSourceRecordsRemoved": number,
      "mappedTargetRecordsRemoved": number,
      "newMappedRecords": number,
      "newMappedSourceRecords": number,
      "newMappedTargetRecords": number,
      "newUniqueRecordsLoaded": number,
      "recordsNotProcessed": number,
      "totalMappedRecords": number,
      "totalMappedSourceRecords": number,
      "totalMappedTargetRecords": number,
      "totalRecordsProcessed": number,
      "uniqueRecordsLoaded": number
   },
   "outputSourceConfig": [ 
      { 
         "KMSArn": "string",
         "outputS3Path": "string",
         "roleArn": "string"
      }
   ],
   "startTime": number,
   "status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

endTime

The time at which the job has finished.

Type: Timestamp

errorDetails

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

Type: ErrorDetails object

jobId

The ID of the job.

Type: String

Pattern: [a-f0-9]{32}

jobType

The job type of the ID mapping job.

A value of INCREMENTAL indicates that only new or changed data was processed since the last job run. This is the default job type if the workflow was created with an incrementalRunConfig.

A value of BATCH indicates that all data was processed from the input source, regardless of previous job runs. This is the default job type if the workflow wasn't created with an incrementalRunConfig.

A value of DELETE_ONLY indicates that only deletion requests from BatchDeleteUniqueIds were processed.

Type: String

Valid Values: BATCH | INCREMENTAL | DELETE_ONLY

metrics