Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetDataSourceRun

Gets an Amazon DataZone data source run.

Request Syntax


GET /v2/domains/domainIdentifier/data-source-runs/identifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The ID of the domain in which this data source run was performed.

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

Required: Yes

identifier

The ID of the data source run.

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

Required: Yes

Request Body

The request does not have a request body.

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 the data source run was created.

Type: Timestamp

dataSourceConfigurationSnapshot

The configuration snapshot of the data source run.

Type: String

dataSourceId

The ID of the data source for this data source run.

Type: String

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

domainId

The ID of the domain in which this data source run was performed.

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 ID of the data source run.

Type: String

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

projectId

The ID of the project in which this data source run occured.

Type: String

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

runStatisticsForAssets

The asset statistics from this data source run.

Type: RunStatisticsForAssets object

startedAt

The timestamp of when this data source run started.

Type: Timestamp

status

The status of this data source run.

Type: String

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

stoppedAt

The timestamp of when this data source run stopped.

Type: Timestamp

type

The type of this data source run.

Type: String

Valid Values: PRIORITIZED | SCHEDULED

updatedAt

The timestamp of when this 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