StartMatchingJob
Starts the MatchingJob of a workflow. The workflow must have previously
been created using the CreateMatchingWorkflow endpoint.
Request Syntax
POST /matchingworkflows/workflowName/jobs HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- workflowName
-
The name of the matching job to be retrieved.
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
{
"jobId": "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.
- jobId
-
The ID of the job.
Type: String
Pattern:
[a-f0-9]{32}
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
- ConflictException
-
The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc.
HTTP Status Code: 400
- ExceedsLimitException
-
The request was rejected because it attempted to create resources beyond the current AWS Entity Resolution account limits. The error message describes the limit exceeded.
HTTP Status Code: 402
- 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:
