workflow_runs

Creates, updates, deletes, gets or lists a workflow_runs resource.

Overview

Name	workflow_runs
Type	Resource
Id	aws.glue.workflow_runs

Fields

The following fields are returned by SELECT queries:

get_workflow_run

Name	Datatype	Description
completed_on	string (date-time)	The date and time when the workflow run completed.
error_message	string	This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow: foo."
graph	object	The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
name	string	Name of the workflow that was run. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
previous_run_id	string	The ID of the previous workflow run. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
started_on	string (date-time)	The date and time when the workflow run was started.
starting_event_batch_condition	object	The batch condition that started the workflow run.
statistics	object	The statistics of the run.
status	string	The status of the workflow run. (RUNNING, COMPLETED, STOPPING, STOPPED, ERROR)
workflow_run_id	string	The ID of this workflow run. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
workflow_run_properties	object	The workflow run properties which were set during the run.

get_workflow_runs

Name	Datatype	Description
completed_on	string (date-time)	The date and time when the workflow run completed.
error_message	string	This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow: foo."
graph	object	The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
name	string	Name of the workflow that was run. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
previous_run_id	string	The ID of the previous workflow run. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
started_on	string (date-time)	The date and time when the workflow run was started.
starting_event_batch_condition	object	The batch condition that started the workflow run.
statistics	object	The statistics of the run.
status	string	The status of the workflow run. (RUNNING, COMPLETED, STOPPING, STOPPED, ERROR)
workflow_run_id	string	The ID of this workflow run. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
workflow_run_properties	object	The workflow run properties which were set during the run.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_workflow_run	select	region		Retrieves the metadata for a given workflow run. Job run history is accessible for 90 days for your workflow and job run.
get_workflow_runs	select	region		Retrieves metadata for all runs of a given workflow.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_workflow_run

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

SELECT
completed_on,
error_message,
graph,
name,
previous_run_id,
started_on,
starting_event_batch_condition,
statistics,
status,
workflow_run_id,
workflow_run_properties
FROM aws.glue.workflow_runs
WHERE region = '{{ region }}' -- required
;

get_workflow_runs

Retrieves metadata for all runs of a given workflow.

SELECT
completed_on,
error_message,
graph,
name,
previous_run_id,
started_on,
starting_event_batch_condition,
statistics,
status,
workflow_run_id,
workflow_run_properties
FROM aws.glue.workflow_runs
WHERE region = '{{ region }}' -- required
;