blueprints

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

Overview

Name	blueprints
Type	Resource
Id	aws.bedrock_data_automation.blueprints

Fields

The following fields are returned by SELECT queries:

get_blueprint

Name	Datatype	Description
blueprint_arn	string	ARN of a Blueprint (pattern: <code>arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})</code>)
blueprint_name	string	Name of the Blueprint (pattern: <code>[a-zA-Z0-9-_]+</code>)
blueprint_stage	string	Stage of the Blueprint (DEVELOPMENT, LIVE)
blueprint_version	string	Blueprint Version (pattern: <code>[0-9]*</code>)
creation_time	string (date-time)	Time Stamp
kms_encryption_context	object
kms_key_id	string	KMS Key Identifier (pattern: <code>[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]+</code>)
last_modified_time	string (date-time)	Time Stamp
optimization_samples	array	List of Blueprint Optimization Samples
optimization_time	string (date-time)	Time Stamp
schema	string	Schema of the blueprint
type_	string	Type (DOCUMENT, IMAGE, AUDIO, VIDEO)

list_blueprints

Name	Datatype	Description
blueprint_arn	string	ARN of a Blueprint (pattern: <code>arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})</code>)
blueprint_name	string	Name of the Blueprint (pattern: <code>[a-zA-Z0-9-_]+</code>)
blueprint_stage	string	Stage of the Blueprint (DEVELOPMENT, LIVE)
blueprint_version	string	Blueprint Version (pattern: <code>[0-9]*</code>)
creation_time	string (date-time)	Time Stamp
last_modified_time	string (date-time)	Time Stamp

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_blueprint	select	blueprint_arn, region		Gets an existing Amazon Bedrock Data Automation Blueprint
list_blueprints	select	region		Lists all existing Amazon Bedrock Data Automation Blueprints
create_blueprint	insert	region, blueprintName, type, schema		Creates an Amazon Bedrock Data Automation Blueprint
create_blueprint_version	insert	blueprint_arn, region		Creates a new version of an existing Amazon Bedrock Data Automation Blueprint
update_blueprint	update	blueprint_arn, region, schema		Updates an existing Amazon Bedrock Data Automation Blueprint
delete_blueprint	delete	blueprint_arn, region	blueprintVersion	Deletes an existing Amazon Bedrock Data Automation Blueprint
copy_blueprint_stage	exec	blueprint_arn, region, sourceStage, targetStage		Copies a Blueprint from one stage to another
invoke_blueprint_optimization_async	exec	region, blueprint, samples, outputConfiguration, dataAutomationProfileArn		Invoke an async job to perform Blueprint Optimization

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
blueprint_arn	string	Blueprint to be copied
region	string	AWS region (default: us-east-1)
blueprintVersion	string	Optional field to delete a specific Blueprint version

SELECT examples

get_blueprint

Gets an existing Amazon Bedrock Data Automation Blueprint

SELECT
blueprint_arn,
blueprint_name,
blueprint_stage,
blueprint_version,
creation_time,
kms_encryption_context,
kms_key_id,
last_modified_time,
optimization_samples,
optimization_time,
schema,
type_
FROM aws.bedrock_data_automation.blueprints
WHERE blueprint_arn = '{{ blueprint_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_blueprints

Lists all existing Amazon Bedrock Data Automation Blueprints

SELECT
blueprint_arn,
blueprint_name,
blueprint_stage,
blueprint_version,
creation_time,
last_modified_time
FROM aws.bedrock_data_automation.blueprints
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_blueprint

Creates an Amazon Bedrock Data Automation Blueprint

INSERT INTO aws.bedrock_data_automation.blueprints (
blueprintName,
type,
blueprintStage,
schema,
clientToken,
encryptionConfiguration,
tags,
region
)
SELECT 
'{{ blueprintName }}' /* required */,
'{{ type }}' /* required */,
'{{ blueprintStage }}',
'{{ schema }}' /* required */,
'{{ clientToken }}',
'{{ encryptionConfiguration }}',
'{{ tags }}',
'{{ region }}'
RETURNING
blueprint
;

create_blueprint_version

Creates a new version of an existing Amazon Bedrock Data Automation Blueprint

INSERT INTO aws.bedrock_data_automation.blueprints (
clientToken,
blueprint_arn,
region
)
SELECT 
'{{ clientToken }}',
'{{ blueprint_arn }}',
'{{ region }}'
RETURNING
blueprint
;

Manifest

# Description fields are for documentation purposes
- name: blueprints
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the blueprints resource.
  - name: blueprint_arn
    value: "{{ blueprint_arn }}"
    description: Required parameter for the blueprints resource.
  - name: blueprintName
    value: "{{ blueprintName }}"
    description: |
      Name of the Blueprint
  - name: type
    value: "{{ type }}"
    description: |
      Type
    valid_values: ['DOCUMENT', 'IMAGE', 'AUDIO', 'VIDEO']
  - name: blueprintStage
    value: "{{ blueprintStage }}"
    description: |
      Stage of the Blueprint
    valid_values: ['DEVELOPMENT', 'LIVE']
  - name: schema
    value: "{{ schema }}"
    description: |
      Schema of the blueprint
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      Client specified token used for idempotency checks
  - name: encryptionConfiguration
    description: |
      KMS Encryption Configuration
    value:
      kmsKeyId: "{{ kmsKeyId }}"
      kmsEncryptionContext: "{{ kmsEncryptionContext }}"
  - name: tags
    description: |
      List of tags
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

UPDATE examples

update_blueprint

Updates an existing Amazon Bedrock Data Automation Blueprint

UPDATE aws.bedrock_data_automation.blueprints
SET 
schema = '{{ schema }}',
blueprintStage = '{{ blueprintStage }}',
encryptionConfiguration = '{{ encryptionConfiguration }}'
WHERE 
blueprint_arn = '{{ blueprint_arn }}' --required
AND region = '{{ region }}' --required
AND schema = '{{ schema }}' --required
RETURNING
blueprint;

DELETE examples

delete_blueprint

Deletes an existing Amazon Bedrock Data Automation Blueprint

DELETE FROM aws.bedrock_data_automation.blueprints
WHERE blueprint_arn = '{{ blueprint_arn }}' --required
AND region = '{{ region }}' --required
AND blueprintVersion = '{{ blueprintVersion }}'
;

Lifecycle Methods

copy_blueprint_stage

Copies a Blueprint from one stage to another

EXEC aws.bedrock_data_automation.blueprints.copy_blueprint_stage 
@blueprint_arn='{{ blueprint_arn }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"sourceStage": "{{ sourceStage }}", 
"targetStage": "{{ targetStage }}", 
"clientToken": "{{ clientToken }}"
}'
;

invoke_blueprint_optimization_async

Invoke an async job to perform Blueprint Optimization

EXEC aws.bedrock_data_automation.blueprints.invoke_blueprint_optimization_async 
@region='{{ region }}' --required 
@@json=
'{
"blueprint": "{{ blueprint }}", 
"samples": "{{ samples }}", 
"outputConfiguration": "{{ outputConfiguration }}", 
"dataAutomationProfileArn": "{{ dataAutomationProfileArn }}", 
"encryptionConfiguration": "{{ encryptionConfiguration }}", 
"tags": "{{ tags }}"
}'
;