ListMatchingJobsCommand

Suggest an Edit

Lists all jobs for a given workflow.

Example Syntax

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

import { EntityResolutionClient, ListMatchingJobsCommand } from "@aws-sdk/client-entityresolution"; // ES Modules import
// const { EntityResolutionClient, ListMatchingJobsCommand } = require("@aws-sdk/client-entityresolution"); // CommonJS import
const client = new EntityResolutionClient(config);
const input = { // ListMatchingJobsInput
  workflowName: "STRING_VALUE", // required
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new ListMatchingJobsCommand(input);
const response = await client.send(command);
// { // ListMatchingJobsOutput
//   jobs: [ // JobList
//     { // JobSummary
//       jobId: "STRING_VALUE", // required
//       status: "RUNNING" || "SUCCEEDED" || "FAILED" || "QUEUED", // required
//       startTime: new Date("TIMESTAMP"), // required
//       endTime: new Date("TIMESTAMP"),
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListMatchingJobsCommand Input

See ListMatchingJobsCommandInput for more details

Parameter
Type
Description
workflowName
Required
string | undefined

The name of the workflow to be retrieved.

maxResults
number | undefined

The maximum number of objects returned per page.

nextToken
string | undefined

The pagination token from the previous API call.

ListMatchingJobsCommand Output

See ListMatchingJobsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
jobs
JobSummary[] | undefined

A list of JobSummary objects, each of which contain the ID, status, start time, and end time of a job.

nextToken
string | undefined

The pagination token from the previous API call.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

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.