StartMatchingJobCommand

Suggest an Edit

Starts the MatchingJob of a workflow. The workflow must have previously been created using the CreateMatchingWorkflow endpoint.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EntityResolutionClient, StartMatchingJobCommand } from "@aws-sdk/client-entityresolution"; // ES Modules import
// const { EntityResolutionClient, StartMatchingJobCommand } = require("@aws-sdk/client-entityresolution"); // CommonJS import
const client = new EntityResolutionClient(config);
const input = { // StartMatchingJobInput
  workflowName: "STRING_VALUE", // required
};
const command = new StartMatchingJobCommand(input);
const response = await client.send(command);
// { // StartMatchingJobOutput
//   jobId: "STRING_VALUE", // required
// };

StartMatchingJobCommand Input

See StartMatchingJobCommandInput for more details

Parameter
Type
Description
workflowName
Required
string | undefined

The name of the matching job to be retrieved.

StartMatchingJobCommand Output

See StartMatchingJobCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
jobId
Required
string | undefined

The ID of the job.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ConflictException
client

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.

ExceedsLimitException
client

The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded.

InternalServerException
server

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException
client

The resource could not be found.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints specified by Entity Resolution.

EntityResolutionServiceException
Base exception class for all service exceptions from EntityResolution service.