flows

Creates, updates, deletes or gets a flow resource or lists flows in a region

Overview

Name	flows
Type	Resource
Description	Definition of AWS::Bedrock::Flow Resource Type
Id	aws.bedrock.flows

Fields

Name	Datatype	Description
arn	string	Arn representation of the Flow
created_at	string	Time Stamp.
definition	object	Flow definition
definition_string	string	A JSON string containing a Definition with the same schema as the Definition property of this resource
definition_s3_location	object	An Amazon S3 location.
definition_substitutions	object	When supplied with DefinitionString or DefinitionS3Location, substrings in the definition matching ${keyname} will be replaced with the associated value from this map
description	string	Description of the flow
execution_role_arn	string	ARN of a IAM role
id	string	Identifier for a Flow
name	string	Name for the flow
status	string	Schema Type for Flow APIs
updated_at	string	Time Stamp.
customer_encryption_key_arn	string	A KMS key ARN
validations	array	List of flow validations
version	string	Draft Version.
tags	object	A map of tag keys and values
test_alias_tags	object	A map of tag keys and values
region	string	AWS region.

For more information, see AWS::Bedrock::Flow.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ExecutionRoleArn, Name, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all flows in a region.

SELECT
region,
arn,
created_at,
definition,
definition_string,
definition_s3_location,
definition_substitutions,
description,
execution_role_arn,
id,
name,
status,
updated_at,
customer_encryption_key_arn,
validations,
version,
tags,
test_alias_tags
FROM aws.bedrock.flows
WHERE region = 'us-east-1';

Gets all properties from an individual flow.

SELECT
region,
arn,
created_at,
definition,
definition_string,
definition_s3_location,
definition_substitutions,
description,
execution_role_arn,
id,
name,
status,
updated_at,
customer_encryption_key_arn,
validations,
version,
tags,
test_alias_tags
FROM aws.bedrock.flows
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

Use the following StackQL query and manifest file to create a new flow resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.bedrock.flows (
 ExecutionRoleArn,
 Name,
 region
)
SELECT 
'{{ ExecutionRoleArn }}',
 '{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.bedrock.flows (
 Definition,
 DefinitionString,
 DefinitionS3Location,
 DefinitionSubstitutions,
 Description,
 ExecutionRoleArn,
 Name,
 CustomerEncryptionKeyArn,
 Tags,
 TestAliasTags,
 region
)
SELECT 
 '{{ Definition }}',
 '{{ DefinitionString }}',
 '{{ DefinitionS3Location }}',
 '{{ DefinitionSubstitutions }}',
 '{{ Description }}',
 '{{ ExecutionRoleArn }}',
 '{{ Name }}',
 '{{ CustomerEncryptionKeyArn }}',
 '{{ Tags }}',
 '{{ TestAliasTags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: flow
    props:
      - name: Definition
        value:
          Nodes:
            - Name: '{{ Name }}'
              Type: '{{ Type }}'
              Configuration: null
              Inputs:
                - Name: '{{ Name }}'
                  Type: '{{ Type }}'
                  Expression: '{{ Expression }}'
              Outputs:
                - Name: '{{ Name }}'
                  Type: null
          Connections:
            - Type: '{{ Type }}'
              Name: '{{ Name }}'
              Source: '{{ Source }}'
              Target: '{{ Target }}'
              Configuration: null
      - name: DefinitionString
        value: '{{ DefinitionString }}'
      - name: DefinitionS3Location
        value:
          URI: '{{ URI }}'
      - name: DefinitionSubstitutions
        value: {}
      - name: Description
        value: '{{ Description }}'
      - name: ExecutionRoleArn
        value: '{{ ExecutionRoleArn }}'
      - name: Name
        value: '{{ Name }}'
      - name: CustomerEncryptionKeyArn
        value: '{{ CustomerEncryptionKeyArn }}'
      - name: Tags
        value: {}
      - name: TestAliasTags
        value: null

DELETE example

/*+ delete */
DELETE FROM aws.bedrock.flows
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

To operate on the flows resource, the following permissions are required:

Create

bedrock:CreateFlow,
bedrock:GetFlow,
bedrock:PrepareFlow,
iam:PassRole,
s3:GetObject,
s3:GetObjectVersion,
bedrock:TagResource,
bedrock:ListTagsForResource,
kms:GenerateDataKey,
kms:Decrypt,
bedrock:CreateGuardrail,
bedrock:CreateGuardrailVersion,
bedrock:GetGuardrail

Read

bedrock:GetFlow,
bedrock:ListTagsForResource,
kms:Decrypt,
bedrock:GetGuardrail

Update

bedrock:UpdateFlow,
bedrock:GetFlow,
bedrock:PrepareFlow,
iam:PassRole,
s3:GetObject,
s3:GetObjectVersion,
bedrock:TagResource,
bedrock:UntagResource,
bedrock:ListTagsForResource,
kms:GenerateDataKey,
kms:Decrypt,
bedrock:UpdateGuardrail,
bedrock:GetGuardrail

Delete

bedrock:DeleteFlow,
bedrock:GetFlow,
bedrock:DeleteGuardrail,
bedrock:GetGuardrail

List

bedrock:ListFlows,
bedrock:ListGuardrails