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

GetMatchingJob

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

Request Syntax


GET /matchingworkflows/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.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z_0-9-]*

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": { 
      "deleteRecordsProcessed": number,
      "inputRecords": number,
      "matchIDs": number,
      "recordsNotProcessed": 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 unique identifier of the matching 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: JobMetrics object

outputSourceConfig

A list of OutputSource objects.

Type: Array of JobOutputSource 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 couldn't 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