GetWorkflowRunCommand

Suggest an Edit

Retrieves the metadata for a given workflow run. Job run history is accessible for 90 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, GetWorkflowRunCommand } from "@aws-sdk/client-glue"; // ES Modules import
// const { GlueClient, GetWorkflowRunCommand } = require("@aws-sdk/client-glue"); // CommonJS import
const client = new GlueClient(config);
const input = { // GetWorkflowRunRequest
  Name: "STRING_VALUE", // required
  RunId: "STRING_VALUE", // required
  IncludeGraph: true || false,
};
const command = new GetWorkflowRunCommand(input);
const response = await client.send(command);
// { // GetWorkflowRunResponse
//   Run: { // WorkflowRun
//     Name: "STRING_VALUE",
//     WorkflowRunId: "STRING_VALUE",
//     PreviousRunId: "STRING_VALUE",
//     WorkflowRunProperties: { // WorkflowRunProperties
//       "<keys>": "STRING_VALUE",
//     },
//     StartedOn: new Date("TIMESTAMP"),
//     CompletedOn: new Date("TIMESTAMP"),
//     Status: "RUNNING" || "COMPLETED" || "STOPPING" || "STOPPED" || "ERROR",
//     ErrorMessage: "STRING_VALUE",
//     Statistics: { // WorkflowRunStatistics
//       TotalActions: Number("int"),
//       TimeoutActions: Number("int"),
//       FailedActions: Number("int"),
//       StoppedActions: Number("int"),
//       SucceededActions: Number("int"),
//       RunningActions: Number("int"),
//       ErroredActions: Number("int"),
//       WaitingActions: Number("int"),
//     },
//     Graph: { // WorkflowGraph
//       Nodes: [ // NodeList
//         { // Node
//           Type: "CRAWLER" || "JOB" || "TRIGGER",
//           Name: "STRING_VALUE",
//           UniqueId: "STRING_VALUE",
//           TriggerDetails: { // TriggerNodeDetails
//             Trigger: { // Trigger
//               Name: "STRING_VALUE",
//               WorkflowName: "STRING_VALUE",
//               Id: "STRING_VALUE",
//               Type: "SCHEDULED" || "CONDITIONAL" || "ON_DEMAND" || "EVENT",
//               State: "CREATING" || "CREATED" || "ACTIVATING" || "ACTIVATED" || "DEACTIVATING" || "DEACTIVATED" || "DELETING" || "UPDATING",
//               Description: "STRING_VALUE",
//               Schedule: "STRING_VALUE",
//               Actions: [ // ActionList
//                 { // Action
//                   JobName: "STRING_VALUE",
//                   Arguments: { // GenericMap
//                     "<keys>": "STRING_VALUE",
//                   },
//                   Timeout: Number("int"),
//                   SecurityConfiguration: "STRING_VALUE",
//                   NotificationProperty: { // NotificationProperty
//                     NotifyDelayAfter: Number("int"),
//                   },
//                   CrawlerName: "STRING_VALUE",
//                 },
//               ],
//               Predicate: { // Predicate
//                 Logical: "AND" || "ANY",
//                 Conditions: [ // ConditionList
//                   { // Condition
//                     LogicalOperator: "EQUALS",
//                     JobName: "STRING_VALUE",
//                     State: "STARTING" || "RUNNING" || "STOPPING" || "STOPPED" || "SUCCEEDED" || "FAILED" || "TIMEOUT" || "ERROR" || "WAITING" || "EXPIRED",
//                     CrawlerName: "STRING_VALUE",
//                     CrawlState: "RUNNING" || "CANCELLING" || "CANCELLED" || "SUCCEEDED" || "FAILED" || "ERROR",
//                   },
//                 ],
//               },
//               EventBatchingCondition: { // EventBatchingCondition
//                 BatchSize: Number("int"), // required
//                 BatchWindow: Number("int"),
//               },
//             },
//           },
//           JobDetails: { // JobNodeDetails
//             JobRuns: [ // JobRunList
//               { // 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: {
//                   "<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: {
//                   NotifyDelayAfter: Number("int"),
//                 },
//                 GlueVersion: "STRING_VALUE",
//                 DPUSeconds: Number("double"),
//                 ExecutionClass: "FLEX" || "STANDARD",
//                 MaintenanceWindow: "STRING_VALUE",
//                 ProfileName: "STRING_VALUE",
//                 StateDetail: "STRING_VALUE",
//               },
//             ],
//           },
//           CrawlerDetails: { // CrawlerNodeDetails
//             Crawls: [ // CrawlList
//               { // Crawl
//                 State: "RUNNING" || "CANCELLING" || "CANCELLED" || "SUCCEEDED" || "FAILED" || "ERROR",
//                 StartedOn: new Date("TIMESTAMP"),
//                 CompletedOn: new Date("TIMESTAMP"),
//                 ErrorMessage: "STRING_VALUE",
//                 LogGroup: "STRING_VALUE",
//                 LogStream: "STRING_VALUE",
//               },
//             ],
//           },
//         },
//       ],
//       Edges: [ // EdgeList
//         { // Edge
//           SourceId: "STRING_VALUE",
//           DestinationId: "STRING_VALUE",
//         },
//       ],
//     },
//     StartingEventBatchCondition: { // StartingEventBatchCondition
//       BatchSize: Number("int"),
//       BatchWindow: Number("int"),
//     },
//   },
// };

GetWorkflowRunCommand Input

See GetWorkflowRunCommandInput for more details

Parameter
Type
Description
Name
Required
string | undefined

Name of the workflow being run.

RunId
Required
string | undefined

The ID of the workflow run.

IncludeGraph
boolean | undefined

Specifies whether to include the workflow graph in response or not.

GetWorkflowRunCommand Output

See GetWorkflowRunCommandOutput for details

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

The requested workflow 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.