GetJobRunCommand

Retrieves the metadata for a given job run. Job run history is accessible for 365 days for your workflow and job run.

Example Syntax

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

import { GlueClient, GetJobRunCommand } from "@aws-sdk/client-glue"; // ES Modules import
// const { GlueClient, GetJobRunCommand } = require("@aws-sdk/client-glue"); // CommonJS import
const client = new GlueClient(config);
const input = { // GetJobRunRequest
  JobName: "STRING_VALUE", // required
  RunId: "STRING_VALUE", // required
  PredecessorsIncluded: true || false,
};
const command = new GetJobRunCommand(input);
const response = await client.send(command);
// { // GetJobRunResponse
//   JobRun: { // JobRun
//     Id: "STRING_VALUE",
//     Attempt: Number("int"),
//     PreviousRunId: "STRING_VALUE",
//     TriggerName: "STRING_VALUE",
//     JobName: "STRING_VALUE",
//     JobMode: "SCRIPT" || "VISUAL" || "NOTEBOOK",
//     JobRunQueuingEnabled: true || false,
//     StartedOn: new Date("TIMESTAMP"),
//     LastModifiedOn: new Date("TIMESTAMP"),
//     CompletedOn: new Date("TIMESTAMP"),
//     JobRunState: "STARTING" || "RUNNING" || "STOPPING" || "STOPPED" || "SUCCEEDED" || "FAILED" || "TIMEOUT" || "ERROR" || "WAITING" || "EXPIRED",
//     Arguments: { // GenericMap
//       "<keys>": "STRING_VALUE",
//     },
//     ErrorMessage: "STRING_VALUE",
//     PredecessorRuns: [ // PredecessorList
//       { // Predecessor
//         JobName: "STRING_VALUE",
//         RunId: "STRING_VALUE",
//       },
//     ],
//     AllocatedCapacity: Number("int"),
//     ExecutionTime: Number("int"),
//     Timeout: Number("int"),
//     MaxCapacity: Number("double"),
//     WorkerType: "Standard" || "G.1X" || "G.2X" || "G.025X" || "G.4X" || "G.8X" || "Z.2X",
//     NumberOfWorkers: Number("int"),
//     SecurityConfiguration: "STRING_VALUE",
//     LogGroupName: "STRING_VALUE",
//     NotificationProperty: { // NotificationProperty
//       NotifyDelayAfter: Number("int"),
//     },
//     GlueVersion: "STRING_VALUE",
//     DPUSeconds: Number("double"),
//     ExecutionClass: "FLEX" || "STANDARD",
//     MaintenanceWindow: "STRING_VALUE",
//     ProfileName: "STRING_VALUE",
//     StateDetail: "STRING_VALUE",
//   },
// };

GetJobRunCommand Input

See GetJobRunCommandInput for more details

Parameter
Type
Description
JobName
Required
string | undefined

Name of the job definition being run.

RunId
Required
string | undefined

The ID of the job run.

PredecessorsIncluded
boolean | undefined

True if a list of predecessor runs should be returned.

GetJobRunCommand Output

See GetJobRunCommandOutput for details

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

The requested job-run metadata.

Throws

Name
Fault
Details
EntityNotFoundException
client

A specified entity does not exist

InternalServiceException
server

An internal service error occurred.

InvalidInputException
client

The input provided was not valid.

OperationTimeoutException
client

The operation timed out.

GlueServiceException
Base exception class for all service exceptions from Glue service.