ListDataSourceRunsCommand

Suggest an Edit

Lists data source runs in Amazon DataZone.

Example Syntax

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

import { DataZoneClient, ListDataSourceRunsCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, ListDataSourceRunsCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // ListDataSourceRunsInput
  domainIdentifier: "STRING_VALUE", // required
  dataSourceIdentifier: "STRING_VALUE", // required
  status: "REQUESTED" || "RUNNING" || "FAILED" || "PARTIALLY_SUCCEEDED" || "SUCCESS",
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new ListDataSourceRunsCommand(input);
const response = await client.send(command);
// { // ListDataSourceRunsOutput
//   items: [ // DataSourceRunSummaries // required
//     { // DataSourceRunSummary
//       id: "STRING_VALUE", // required
//       dataSourceId: "STRING_VALUE", // required
//       type: "PRIORITIZED" || "SCHEDULED", // required
//       status: "REQUESTED" || "RUNNING" || "FAILED" || "PARTIALLY_SUCCEEDED" || "SUCCESS", // required
//       projectId: "STRING_VALUE", // required
//       runStatisticsForAssets: { // RunStatisticsForAssets
//         added: Number("int"),
//         updated: Number("int"),
//         unchanged: Number("int"),
//         skipped: Number("int"),
//         failed: Number("int"),
//       },
//       errorMessage: { // DataSourceErrorMessage
//         errorType: "ACCESS_DENIED_EXCEPTION" || "CONFLICT_EXCEPTION" || "INTERNAL_SERVER_EXCEPTION" || "RESOURCE_NOT_FOUND_EXCEPTION" || "SERVICE_QUOTA_EXCEEDED_EXCEPTION" || "THROTTLING_EXCEPTION" || "VALIDATION_EXCEPTION", // required
//         errorDetail: "STRING_VALUE",
//       },
//       createdAt: new Date("TIMESTAMP"), // required
//       updatedAt: new Date("TIMESTAMP"), // required
//       startedAt: new Date("TIMESTAMP"),
//       stoppedAt: new Date("TIMESTAMP"),
//       lineageSummary: { // DataSourceRunLineageSummary
//         importStatus: "IN_PROGRESS" || "SUCCESS" || "FAILED" || "PARTIALLY_SUCCEEDED",
//       },
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListDataSourceRunsCommand Input

See ListDataSourceRunsCommandInput for more details

Parameter
Type
Description
dataSourceIdentifier
Required
string | undefined

The identifier of the data source.

domainIdentifier
Required
string | undefined

The identifier of the Amazon DataZone domain in which to invoke the ListDataSourceRuns action.

maxResults
number | undefined

The maximum number of runs to return in a single call to ListDataSourceRuns. When the number of 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 ListDataSourceRuns to list the next set of runs.

nextToken
string | undefined

When the number of 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 runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataSourceRuns to list the next set of runs.

status
DataSourceRunStatus | undefined

The status of the data source.

ListDataSourceRunsCommand Output

See ListDataSourceRunsCommandOutput for details

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

The results of the ListDataSourceRuns action.

nextToken
string | undefined

When the number of 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 runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataSourceRuns to list the next set of runs.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ConflictException
client

There is a conflict while performing this action.

InternalServerException
server

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

ResourceNotFoundException
client

The specified resource cannot be found.

ServiceQuotaExceededException
client

The request has exceeded the specified service quota.

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.