blueprint_runs

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

Overview

Name	blueprint_runs
Type	Resource
Id	aws.glue.blueprint_runs

Fields

The following fields are returned by SELECT queries:

get_blueprint_run

Name	Datatype	Description
blueprint_name	string	The name of the blueprint. (pattern: <code>[.-_A-Za-z0-9]+</code>)
completed_on	string (date-time)	The date and time that the blueprint run completed.
error_message	string	Indicates any errors that are seen while running the blueprint.
parameters	string	The blueprint parameters as a string. You will have to provide a value for each key that is required from the parameter spec that is defined in the Blueprint$ParameterSpec.
role_arn	string	The role ARN. This role will be assumed by the Glue service and will be used to create the workflow and other entities of a workflow. (pattern: <code>arn:aws[^:]:iam::[0-9]:role/.+</code>)
rollback_error_message	string	If there are any errors while creating the entities of a workflow, we try to roll back the created entities until that point and delete them. This attribute indicates the errors seen while trying to delete the entities that are created.
run_id	string	The run ID for this blueprint run. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)
started_on	string (date-time)	The date and time that the blueprint run started.
state	string	The state of the blueprint run. Possible values are: Running — The blueprint run is in progress. Succeeded — The blueprint run completed successfully. Failed — The blueprint run failed and rollback is complete. Rolling Back — The blueprint run failed and rollback is in progress. (RUNNING, SUCCEEDED, FAILED, ROLLING_BACK)
workflow_name	string	The name of a workflow that is created as a result of a successful blueprint run. If a blueprint run has an error, there will not be a workflow created. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*</code>)

get_blueprint_runs

Name	Datatype	Description
blueprint_runs	array	Returns a list of BlueprintRun objects.
next_token	string	A continuation token, if not all blueprint runs have been returned.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_blueprint_run	select	region		Retrieves the details of a blueprint run.
get_blueprint_runs	select	region		Retrieves the details of blueprint runs for a specified blueprint.

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_blueprint_run

Retrieves the details of a blueprint run.

SELECT
blueprint_name,
completed_on,
error_message,
parameters,
role_arn,
rollback_error_message,
run_id,
started_on,
state,
workflow_name
FROM aws.glue.blueprint_runs
WHERE region = '{{ region }}' -- required
;

get_blueprint_runs

Retrieves the details of blueprint runs for a specified blueprint.

SELECT
blueprint_runs,
next_token
FROM aws.glue.blueprint_runs
WHERE region = '{{ region }}' -- required
;