StartDataSourceRun - Amazon DataZone
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

StartDataSourceRun

Start the run of the specified data source in Amazon DataZone.

Request Syntax

POST /v2/domains/domainIdentifier/data-sources/dataSourceIdentifier/runs HTTP/1.1
Content-type: application/json

{
   "clientToken": "string"
}

URI Request Parameters

The request uses the following URI parameters.

dataSourceIdentifier

The identifier of the data source.

Pattern: ^[a-zA-Z0-9_-]{1,36}$

Required: Yes

domainIdentifier

The identifier of the Amazon DataZone domain in which to start a data source run.

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

Type: String

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "createdAt": "string",
   "dataSourceConfigurationSnapshot": "string",
   "dataSourceId": "string",
   "domainId": "string",
   "errorMessage": { 
      "errorDetail": "string",
      "errorType": "string"
   },
   "id": "string",
   "projectId": "string",
   "runStatisticsForAssets": { 
      "added": number,
      "failed": number,
      "skipped": number,
      "unchanged": number,
      "updated": number
   },
   "startedAt": "string",
   "status": "string",
   "stoppedAt": "string",
   "type": "string",
   "updatedAt": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

createdAt

The timestamp of when data source run was created.

Type: Timestamp

dataSourceConfigurationSnapshot

The configuration snapshot of the data source that is being run.

Type: String

dataSourceId

The identifier of the data source.

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

domainId

The identifier of the Amazon DataZone domain in which to start a data source run.

Type: String

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

errorMessage

Specifies the error message that is returned if the operation cannot be successfully completed.

Type: DataSourceErrorMessage object

id

The identifier of the data source run.

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

projectId

The identifier of the project.

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

runStatisticsForAssets

Specifies run statistics for assets.

Type: RunStatisticsForAssets object

startedAt

The timestamp of when the data source run was started.

Type: Timestamp

status

The status of the data source run.

Type: String

Valid Values: REQUESTED | RUNNING | FAILED | PARTIALLY_SUCCEEDED | SUCCESS

stoppedAt

The timestamp of when the data source run was stopped.

Type: Timestamp

type

The type of the data source run.

Type: String

Valid Values: PRIORITIZED | SCHEDULED

updatedAt

The timestamp of when the data source run was updated.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

There is a conflict while performing this action.

HTTP Status Code: 409

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found.

HTTP Status Code: 404

ServiceQuotaExceededException

The request has exceeded the specified service quota.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: