- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
StartDataSourceRunCommand
Start the run of the specified data source in Amazon DataZone.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DataZoneClient, StartDataSourceRunCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, StartDataSourceRunCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // StartDataSourceRunInput
domainIdentifier: "STRING_VALUE", // required
dataSourceIdentifier: "STRING_VALUE", // required
clientToken: "STRING_VALUE",
};
const command = new StartDataSourceRunCommand(input);
const response = await client.send(command);
// { // StartDataSourceRunOutput
// domainId: "STRING_VALUE", // required
// dataSourceId: "STRING_VALUE", // required
// id: "STRING_VALUE", // required
// projectId: "STRING_VALUE", // required
// status: "REQUESTED" || "RUNNING" || "FAILED" || "PARTIALLY_SUCCEEDED" || "SUCCESS", // required
// type: "PRIORITIZED" || "SCHEDULED", // required
// dataSourceConfigurationSnapshot: "STRING_VALUE",
// 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"),
// };
StartDataSourceRunCommand Input
Parameter | Type | Description |
---|
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 start a data source run. |
clientToken | string | undefined | A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. |
StartDataSourceRunCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
createdAt Required | Date | undefined | The timestamp of when data source run was created. |
dataSourceId Required | string | undefined | The identifier of the data source. |
domainId Required | string | undefined | The identifier of the Amazon DataZone domain in which to start a data source run. |
id Required | string | undefined | The identifier of the data source run. |
projectId Required | string | undefined | The identifier of the project. |
status Required | DataSourceRunStatus | undefined | The status of the data source run. |
type Required | DataSourceRunType | undefined | The type of the data source run. |
updatedAt Required | Date | undefined | The timestamp of when the data source run was updated. |
dataSourceConfigurationSnapshot | string | undefined | The configuration snapshot of the data source that is being run. |
errorMessage | DataSourceErrorMessage | undefined | Specifies the error message that is returned if the operation cannot be successfully completed. |
runStatisticsForAssets | RunStatisticsForAssets | undefined | Specifies run statistics for assets. |
startedAt | Date | undefined | The timestamp of when the data source run was started. |
stoppedAt | Date | undefined | The timestamp of when the data source run was stopped. |
Throws
Name | Fault | Details |
---|
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. |