ListDataSourceRunActivitiesCommand

Suggest an Edit

Lists data source run activities.

Example Syntax

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

import { DataZoneClient, ListDataSourceRunActivitiesCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, ListDataSourceRunActivitiesCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // ListDataSourceRunActivitiesInput
  domainIdentifier: "STRING_VALUE", // required
  identifier: "STRING_VALUE", // required
  status: "FAILED" || "PUBLISHING_FAILED" || "SUCCEEDED_CREATED" || "SUCCEEDED_UPDATED" || "SKIPPED_ALREADY_IMPORTED" || "SKIPPED_ARCHIVED" || "SKIPPED_NO_ACCESS" || "UNCHANGED",
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new ListDataSourceRunActivitiesCommand(input);
const response = await client.send(command);
// { // ListDataSourceRunActivitiesOutput
//   items: [ // DataSourceRunActivities // required
//     { // DataSourceRunActivity
//       database: "STRING_VALUE", // required
//       dataSourceRunId: "STRING_VALUE", // required
//       technicalName: "STRING_VALUE", // required
//       dataAssetStatus: "FAILED" || "PUBLISHING_FAILED" || "SUCCEEDED_CREATED" || "SUCCEEDED_UPDATED" || "SKIPPED_ALREADY_IMPORTED" || "SKIPPED_ARCHIVED" || "SKIPPED_NO_ACCESS" || "UNCHANGED", // required
//       projectId: "STRING_VALUE", // required
//       dataAssetId: "STRING_VALUE",
//       technicalDescription: "STRING_VALUE",
//       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",
//       },
//       lineageSummary: { // LineageInfo
//         eventId: "STRING_VALUE",
//         eventStatus: "REQUESTED" || "PROCESSING" || "SUCCESS" || "FAILED",
//         errorMessage: "STRING_VALUE",
//       },
//       createdAt: new Date("TIMESTAMP"), // required
//       updatedAt: new Date("TIMESTAMP"), // required
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListDataSourceRunActivitiesCommand Input

See ListDataSourceRunActivitiesCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The identifier of the Amazon DataZone domain in which to list data source run activities.

identifier
Required
string | undefined

The identifier of the data source run.

maxResults
number | undefined

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

nextToken
string | undefined

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

status
DataAssetActivityStatus | undefined

The status of the data source run.

ListDataSourceRunActivitiesCommand Output

See ListDataSourceRunActivitiesCommandOutput for details

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

The results of the ListDataSourceRunActivities action.

nextToken
string | undefined

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

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.