AWS Glue
Web API Reference (API Version 2017-03-31)

GetWorkflowRuns

Retrieves metadata for all runs of a given workflow.

Request Syntax

{ "IncludeGraph": boolean, "MaxResults": number, "Name": "string", "NextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

IncludeGraph

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

Type: Boolean

Required: No

MaxResults

The maximum number of workflow runs to be included in the response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

Name

Name of the workflow whose metadata of runs should be returned.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

NextToken

The maximum size of the response.

Type: String

Required: No

Response Syntax

{ "NextToken": "string", "Runs": [ { "CompletedOn": number, "Graph": { "Edges": [ { "DestinationId": "string", "SourceId": "string" } ], "Nodes": [ { "CrawlerDetails": { "Crawls": [ { "CompletedOn": number, "ErrorMessage": "string", "LogGroup": "string", "LogStream": "string", "StartedOn": number, "State": "string" } ] }, "JobDetails": { "JobRuns": [ { "AllocatedCapacity": number, "Arguments": { "string" : "string" }, "Attempt": number, "CompletedOn": number, "ErrorMessage": "string", "ExecutionTime": number, "GlueVersion": "string", "Id": "string", "JobName": "string", "JobRunState": "string", "LastModifiedOn": number, "LogGroupName": "string", "MaxCapacity": number, "NotificationProperty": { "NotifyDelayAfter": number }, "NumberOfWorkers": number, "PredecessorRuns": [ { "JobName": "string", "RunId": "string" } ], "PreviousRunId": "string", "SecurityConfiguration": "string", "StartedOn": number, "Timeout": number, "TriggerName": "string", "WorkerType": "string" } ] }, "Name": "string", "TriggerDetails": { "Trigger": { "Actions": [ { "Arguments": { "string" : "string" }, "CrawlerName": "string", "JobName": "string", "NotificationProperty": { "NotifyDelayAfter": number }, "SecurityConfiguration": "string", "Timeout": number } ], "Description": "string", "Id": "string", "Name": "string", "Predicate": { "Conditions": [ { "CrawlerName": "string", "CrawlState": "string", "JobName": "string", "LogicalOperator": "string", "State": "string" } ], "Logical": "string" }, "Schedule": "string", "State": "string", "Type": "string", "WorkflowName": "string" } }, "Type": "string", "UniqueId": "string" } ] }, "Name": "string", "StartedOn": number, "Statistics": { "FailedActions": number, "RunningActions": number, "StoppedActions": number, "SucceededActions": number, "TimeoutActions": number, "TotalActions": number }, "Status": "string", "WorkflowRunId": "string", "WorkflowRunProperties": { "string" : "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.

NextToken

A continuation token, if not all requested workflow runs have been returned.

Type: String

Runs

A list of workflow run metadata objects.

Type: Array of WorkflowRun objects

Array Members: Minimum number of 1 item. Maximum number of 1000 items.

Errors

For information about the errors that are common to all actions, see Common Errors.

EntityNotFoundException

A specified entity does not exist

HTTP Status Code: 400

InternalServiceException

An internal service error occurred.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: