blueprints

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

Overview

Name	blueprints
Type	Resource
Id	aws.glue.blueprints

Fields

The following fields are returned by SELECT queries:

batch_get_blueprints

Name	Datatype	Description
blueprints	array	Returns a list of blueprint as a Blueprints object.
missing_blueprints	array	Returns a list of BlueprintNames that were not found.

get_blueprint

Name	Datatype	Description
blueprint_location	string	Specifies the path in Amazon S3 where the blueprint is published.
blueprint_service_location	string	Specifies a path in Amazon S3 where the blueprint is copied when you call CreateBlueprint/UpdateBlueprint to register the blueprint in Glue.
created_on	string (date-time)	The date and time the blueprint was registered.
description	string	The description of the blueprint.
error_message	string	An error message.
last_active_definition	object	When there are multiple versions of a blueprint and the latest version has some errors, this attribute indicates the last successful blueprint definition that is available with the service.
last_modified_on	string (date-time)	The date and time the blueprint was last modified.
name	string	The name of the blueprint. (pattern: <code>[.-_A-Za-z0-9]+</code>)
parameter_spec	string	A JSON string that indicates the list of parameter specifications for the blueprint.
status	string	The status of the blueprint registration. Creating — The blueprint registration is in progress. Active — The blueprint has been successfully registered. Updating — An update to the blueprint registration is in progress. Failed — The blueprint registration failed. (CREATING, ACTIVE, UPDATING, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
batch_get_blueprints	select	region		Retrieves information about a list of blueprints.
get_blueprint	select	region		Retrieves the details of a blueprint.
create_blueprint	insert	region, BlueprintLocation		Registers a blueprint with Glue.
update_blueprint	update	region, BlueprintLocation		Updates a registered blueprint.
delete_blueprint	delete	region		Deletes an existing blueprint.
list_blueprints	exec	region		Lists all the blueprint names in an account.
start_blueprint_run	exec	region, BlueprintName, RoleArn		Starts a new run of the 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

batch_get_blueprints

Retrieves information about a list of blueprints.

SELECT
blueprints,
missing_blueprints
FROM aws.glue.blueprints
WHERE region = '{{ region }}' -- required
;

get_blueprint

Retrieves the details of a blueprint.

SELECT
blueprint_location,
blueprint_service_location,
created_on,
description,
error_message,
last_active_definition,
last_modified_on,
name,
parameter_spec,
status
FROM aws.glue.blueprints
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_blueprint

Registers a blueprint with Glue.

INSERT INTO aws.glue.blueprints (
Name,
Description,
BlueprintLocation,
Tags,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ BlueprintLocation }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
name
;

Manifest

# Description fields are for documentation purposes
- name: blueprints
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the blueprints resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      The name of the blueprint.
  - name: Description
    value: "{{ Description }}"
    description: |
      A description of the blueprint.
  - name: BlueprintLocation
    value: "{{ BlueprintLocation }}"
    description: |
      Specifies a path in Amazon S3 where the blueprint is published.
  - name: Tags
    value: "{{ Tags }}"
    description: |
      The tags to be applied to this blueprint.

UPDATE examples

update_blueprint

Updates a registered blueprint.

UPDATE aws.glue.blueprints
SET 
Name = '{{ Name }}',
Description = '{{ Description }}',
BlueprintLocation = '{{ BlueprintLocation }}'
WHERE 
region = '{{ region }}' --required
AND BlueprintLocation = '{{ BlueprintLocation }}' --required
RETURNING
name;

DELETE examples

delete_blueprint

Deletes an existing blueprint.

DELETE FROM aws.glue.blueprints
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

list_blueprints

Lists all the blueprint names in an account.

EXEC aws.glue.blueprints.list_blueprints 
@region='{{ region }}' --required 
@@json=
'{
"NextToken": "{{ NextToken }}", 
"MaxResults": {{ MaxResults }}, 
"Tags": "{{ Tags }}"
}'
;

start_blueprint_run

Starts a new run of the specified blueprint.

EXEC aws.glue.blueprints.start_blueprint_run 
@region='{{ region }}' --required 
@@json=
'{
"BlueprintName": "{{ BlueprintName }}", 
"Parameters": "{{ Parameters }}", 
"RoleArn": "{{ RoleArn }}"
}'
;