flow_alias

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

Overview

Name	flow_alias
Type	Resource
Id	aws.bedrock_agent.flow_alias

Fields

The following fields are returned by SELECT queries:

get_flow_alias

Name	Datatype	Description
id	string	The unique identifier of the alias of the flow. (pattern: <code>(TSTALIASID|[0-9a-zA-Z]{10})</code>)
name	string	The name of the alias. (pattern: <code>([0-9a-zA-Z][_-]?){1,100}</code>)
arn	string	The Amazon Resource Name (ARN) of the flow. (pattern: <code>arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/(TSTALIASID|[0-9a-zA-Z]{10})</code>)
concurrency_configuration	object	Determines how multiple nodes in a flow can run in parallel. Running nodes concurrently can improve your flow's performance.
created_at	string (date-time)	The time at which the flow was created.
description	string	The description of the flow.
flow_id	string	The unique identifier of the flow that the alias belongs to. (pattern: <code>[0-9a-zA-Z]{10}</code>)
routing_configuration	array	Contains information about the version that the alias is mapped to.
updated_at	string (date-time)	The time at which the alias was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_flow_alias	select	flow_identifier, alias_identifier, region		Retrieves information about a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
create_flow_alias	insert	flow_identifier, region, name, routingConfiguration		Creates an alias of a flow for deployment. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
update_flow_alias	update	flow_identifier, alias_identifier, region, name, routingConfiguration		Modifies the alias of a flow. Include both fields that you want to keep and ones that you want to change. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
delete_flow_alias	delete	flow_identifier, alias_identifier, region		Deletes an alias of a flow.

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
alias_identifier	string	The unique identifier of the alias to be deleted.
flow_identifier	string	The unique identifier of the flow that the alias belongs to.
region	string	AWS region (default: us-east-1)

SELECT examples

get_flow_alias

Retrieves information about a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

SELECT
id,
name,
arn,
concurrency_configuration,
created_at,
description,
flow_id,
routing_configuration,
updated_at
FROM aws.bedrock_agent.flow_alias
WHERE flow_identifier = '{{ flow_identifier }}' -- required
AND alias_identifier = '{{ alias_identifier }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_flow_alias

Creates an alias of a flow for deployment. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

INSERT INTO aws.bedrock_agent.flow_alias (
name,
description,
routingConfiguration,
concurrencyConfiguration,
clientToken,
tags,
flow_identifier,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ routingConfiguration }}' /* required */,
'{{ concurrencyConfiguration }}',
'{{ clientToken }}',
'{{ tags }}',
'{{ flow_identifier }}',
'{{ region }}'
RETURNING
id,
name,
arn,
concurrency_configuration,
created_at,
description,
flow_id,
routing_configuration,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: flow_alias
props:
  - name: flow_identifier
    value: "{{ flow_identifier }}"
    description: Required parameter for the flow_alias resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the flow_alias resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: routingConfiguration
    value:
      - flowVersion: "{{ flowVersion }}"
  - name: concurrencyConfiguration
    description: |
      Determines how multiple nodes in a flow can run in parallel. Running nodes concurrently can improve your flow's performance.
    value:
      type_: "{{ type_ }}"
      maxConcurrency: {{ maxConcurrency }}
  - name: clientToken
    value: "{{ clientToken }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_flow_alias

Modifies the alias of a flow. Include both fields that you want to keep and ones that you want to change. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

UPDATE aws.bedrock_agent.flow_alias
SET 
name = '{{ name }}',
description = '{{ description }}',
routingConfiguration = '{{ routingConfiguration }}',
concurrencyConfiguration = '{{ concurrencyConfiguration }}'
WHERE 
flow_identifier = '{{ flow_identifier }}' --required
AND alias_identifier = '{{ alias_identifier }}' --required
AND region = '{{ region }}' --required
AND name = '{{ name }}' --required
AND routingConfiguration = '{{ routingConfiguration }}' --required
RETURNING
id,
name,
arn,
concurrency_configuration,
created_at,
description,
flow_id,
routing_configuration,
updated_at;

DELETE examples

delete_flow_alias

Deletes an alias of a flow.

DELETE FROM aws.bedrock_agent.flow_alias
WHERE flow_identifier = '{{ flow_identifier }}' --required
AND alias_identifier = '{{ alias_identifier }}' --required
AND region = '{{ region }}' --required
;