GetJobRun - Amazon DataZone

GetJobRun

The details of the job run.

Request Syntax

GET /v2/domains/domainIdentifier/jobRuns/identifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The ID of the domain.

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

Required: Yes

identifier

The ID of the job 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": number, "createdBy": "string", "details": { ... }, "domainId": "string", "endTime": number, "error": { "message": "string" }, "id": "string", "jobId": "string", "jobType": "string", "runMode": "string", "startTime": number, "status": "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 job run was created.

Type: Timestamp

createdBy

The user who created the job run.

Type: String

details

The details of the job run.

Type: JobRunDetails object

Note: This object is a Union. Only one member of this object can be specified or returned.

domainId

The ID of the domain.

Type: String

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

endTime

The timestamp of when the job run ended.

Type: Timestamp

error

The error generated if the action is not completed successfully.

Type: JobRunError object

id

The ID of the job run.

Type: String

jobId

The ID of the job run.

Type: String

jobType

The type of the job run.

Type: String

Valid Values: LINEAGE

runMode

The mode of the job run.

Type: String

Valid Values: SCHEDULED | ON_DEMAND

startTime

The timestamp of when the job run started.

Type: Timestamp

status

The status of the job run.

Type: String

Valid Values: SCHEDULED | IN_PROGRESS | SUCCESS | PARTIALLY_SUCCEEDED | FAILED | ABORTED | TIMED_OUT | CANCELED

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

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

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: