GetJobRunCommand

Suggest an Edit

The details of the job run.

Example Syntax

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

import { DataZoneClient, GetJobRunCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, GetJobRunCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // GetJobRunInput
  domainIdentifier: "STRING_VALUE", // required
  identifier: "STRING_VALUE", // required
};
const command = new GetJobRunCommand(input);
const response = await client.send(command);
// { // GetJobRunOutput
//   domainId: "STRING_VALUE",
//   id: "STRING_VALUE",
//   jobId: "STRING_VALUE",
//   jobType: "LINEAGE",
//   runMode: "SCHEDULED" || "ON_DEMAND",
//   details: { // JobRunDetails Union: only one key present
//     lineageRunDetails: { // LineageRunDetails
//       sqlQueryRunDetails: { // LineageSqlQueryRunDetails
//         queryStartTime: new Date("TIMESTAMP"),
//         queryEndTime: new Date("TIMESTAMP"),
//         totalQueriesProcessed: Number("int"),
//         numQueriesFailed: Number("int"),
//         errorMessages: [ // FailedQueryProcessingErrorMessages
//           "STRING_VALUE",
//         ],
//       },
//     },
//   },
//   status: "SCHEDULED" || "IN_PROGRESS" || "SUCCESS" || "PARTIALLY_SUCCEEDED" || "FAILED" || "ABORTED" || "TIMED_OUT" || "CANCELED",
//   error: { // JobRunError
//     message: "STRING_VALUE", // required
//   },
//   createdBy: "STRING_VALUE",
//   createdAt: new Date("TIMESTAMP"),
//   startTime: new Date("TIMESTAMP"),
//   endTime: new Date("TIMESTAMP"),
// };

GetJobRunCommand Input

See GetJobRunCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the domain.

identifier
Required
string | undefined

The ID of the job run.

GetJobRunCommand Output

See GetJobRunCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
createdAt
Date | undefined

The timestamp of when the job run was created.

createdBy
string | undefined

The user who created the job run.

details
JobRunDetails | undefined

The details of the job run.

domainId
string | undefined

The ID of the domain.

endTime
Date | undefined

The timestamp of when the job run ended.

error
JobRunError | undefined

The error generated if the action is not completed successfully.

id
string | undefined

The ID of the job run.

jobId
string | undefined

The ID of the job run.

jobType
JobType | undefined

The type of the job run.

runMode
JobRunMode | undefined

The mode of the job run.

startTime
Date | undefined

The timestamp of when the job run started.

status
JobRunStatus | undefined

The status of the job run.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

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

ResourceNotFoundException
client

The specified resource cannot be found.

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.