GetIdMappingJob
Gets 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",
"metrics": {
"inputRecords": number,
"recordsNotProcessed": number,
"totalMappedRecords": number,
"totalMappedSourceRecords": number,
"totalMappedTargetRecords": number,
"totalRecordsProcessed": 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}$ - metrics
-
Metrics associated with the execution, specifically total records processed, unique IDs generated, and records the execution skipped.
Type: IdMappingJobMetrics object
- outputSourceConfig
-
A list of
OutputSourceobjects.Type: Array of IdMappingJobOutputSource objects
Array Members: Fixed number of 1 item.
- startTime
-
The time at which the job was started.
Type: Timestamp
- status
-
The current status of the job.
Type: String
Valid Values:
RUNNING | SUCCEEDED | FAILED | QUEUED
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
This exception occurs when there is an internal failure in the AWS Entity Resolution service.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource could not be found.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by AWS Entity Resolution.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
