flow_versions

Creates, updates, deletes or gets a flow_version resource or lists flow_versions in a region

Overview

Name	flow_versions
Type	Resource
Description	Definition of AWS::Bedrock::FlowVersion Resource Type
Id	awscc.bedrock.flow_versions

Fields

get (all properties)

Name	Datatype	Description
flow_arn	string	Arn representation of the Flow
created_at	string	Time Stamp.
▶definition	object	Flow definition
description	string	Description of the flow version
execution_role_arn	string	ARN of a IAM role
flow_id	string	Identifier for a Flow
name	string	Name for the flow
status	string	Schema Type for Flow APIs
version	string	Numerical Version.
customer_encryption_key_arn	string	A KMS key ARN
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
flow_arn	string	Arn representation of the Flow
version	string	Numerical Version.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	flow_versions	INSERT	FlowArn, region
delete_resource	flow_versions	DELETE	Identifier, region
update_resource	flow_versions	UPDATE	Identifier, PatchDocument, region
list_resources	flow_versions_list_only	SELECT	region
get_resource	flow_versions	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual flow_version.

SELECT
  region,
  flow_arn,
  created_at,
  definition,
  description,
  execution_role_arn,
  flow_id,
  name,
  status,
  version,
  customer_encryption_key_arn
FROM awscc.bedrock.flow_versions
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ flow_arn }}|{{ version }}';

list (identifiers only)

Lists all flow_versions in a region.

SELECT
  region,
  flow_arn,
  version
FROM awscc.bedrock.flow_versions_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.bedrock.flow_versions (
  FlowArn,
  region
)
SELECT
  '{{ flow_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.bedrock.flow_versions (
  FlowArn,
  Description,
  region
)
SELECT
  '{{ flow_arn }}',
  '{{ description }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: flow_version
  props:
    - name: flow_arn
      value: '{{ flow_arn }}'
    - name: description
      value: '{{ description }}'

DELETE example

/*+ delete */
DELETE FROM awscc.bedrock.flow_versions
WHERE
  Identifier = '{{ flow_arn }}|{{ version }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

bedrock:CreateFlowVersion,
bedrock:GetFlowVersion,
kms:GenerateDataKey,
kms:Decrypt,
bedrock:CreateGuardrail,
bedrock:CreateGuardrailVersion,
bedrock:GetGuardrail

Read

bedrock:GetFlowVersion,
kms:Decrypt,
bedrock:GetGuardrail

Delete

bedrock:DeleteFlowVersion,
bedrock:GetFlowVersion,
bedrock:DeleteGuardrail,
bedrock:GetGuardrail

List

bedrock:ListFlowVersions,
bedrock:ListGuardrails

Update

noservice:NoAction