ListJobRunsCommand

Suggest an Edit

Lists job runs.

Example Syntax

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

import { DataZoneClient, ListJobRunsCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, ListJobRunsCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // ListJobRunsInput
  domainIdentifier: "STRING_VALUE", // required
  jobIdentifier: "STRING_VALUE", // required
  status: "SCHEDULED" || "IN_PROGRESS" || "SUCCESS" || "PARTIALLY_SUCCEEDED" || "FAILED" || "ABORTED" || "TIMED_OUT" || "CANCELED",
  sortOrder: "ASCENDING" || "DESCENDING",
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new ListJobRunsCommand(input);
const response = await client.send(command);
// { // ListJobRunsOutput
//   items: [ // JobRunSummaries
//     { // JobRunSummary
//       domainId: "STRING_VALUE",
//       jobId: "STRING_VALUE",
//       jobType: "LINEAGE",
//       runId: "STRING_VALUE",
//       runMode: "SCHEDULED" || "ON_DEMAND",
//       status: "SCHEDULED" || "IN_PROGRESS" || "SUCCESS" || "PARTIALLY_SUCCEEDED" || "FAILED" || "ABORTED" || "TIMED_OUT" || "CANCELED",
//       error: { // JobRunError
//         message: "STRING_VALUE", // required
//       },
//       createdBy: "STRING_VALUE",
//       createdAt: new Date("TIMESTAMP"),
//       startTime: new Date("TIMESTAMP"),
//       endTime: new Date("TIMESTAMP"),
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListJobRunsCommand Input

See ListJobRunsCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the domain where you want to list job runs.

jobIdentifier
Required
string | undefined

The ID of the job run.

maxResults
number | undefined

The maximum number of job runs to return in a single call to ListJobRuns. When the number of job runs to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListJobRuns to list the next set of job runs.

nextToken
string | undefined

When the number of job runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of job runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListJobRuns to list the next set of job runs.

sortOrder
SortOrder | undefined

Specifies the order in which job runs are to be sorted.

status
JobRunStatus | undefined

The status of a job run.

ListJobRunsCommand Output

See ListJobRunsCommandOutput for details

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

The results of the ListJobRuns action.

nextToken
string | undefined

When the number of job runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of job runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListJobRuns to list the next set of job runs.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException
client

The specified resource cannot be found.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException
client

You do not have permission to perform this action.

DataZoneServiceException
Base exception class for all service exceptions from DataZone service.