flow_executions

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

Overview

Name	flow_executions
Type	Resource
Id	aws.bedrock_agent_runtime.flow_executions

Fields

The following fields are returned by SELECT queries:

get_flow_execution

Name	Datatype	Description
ended_at	string (date-time)	The timestamp when the flow execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.
errors	array	A list of errors that occurred during the flow execution. Each error includes an error code, message, and the node where the error occurred, if applicable.
execution_arn	string	The Amazon Resource Name (ARN) that uniquely identifies the flow execution. (pattern: <code>^[a-zA-Z0-9-]{1,36}$|^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10}/execution/[a-zA-Z0-9-]{1,36})$</code>)
flow_alias_identifier	string	The unique identifier of the flow alias used for the execution. (pattern: <code>^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10})|(\bTSTALIASID\b|[0-9a-zA-Z]+)$</code>)
flow_identifier	string	The unique identifier of the flow. (pattern: <code>^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})$</code>)
flow_version	string	The version of the flow used for the execution. (pattern: <code>^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$</code>)
started_at	string (date-time)	The timestamp when the flow execution started.
status	string	The current status of the flow execution. Flow executions time out after 24 hours. (Running, Succeeded, Failed, TimedOut, Aborted)

list_flow_executions

Name	Datatype	Description
created_at	string (date-time)	The timestamp when the flow execution was created.
ended_at	string (date-time)	The timestamp when the flow execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.
execution_arn	string	The Amazon Resource Name (ARN) that uniquely identifies the flow execution. (pattern: <code>^[a-zA-Z0-9-]{1,36}$|^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10}/execution/[a-zA-Z0-9-]{1,36})$</code>)
flow_alias_identifier	string	The unique identifier of the flow alias used for the execution. (pattern: <code>^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10})|(\bTSTALIASID\b|[0-9a-zA-Z]+)$</code>)
flow_identifier	string	The unique identifier of the flow. (pattern: <code>^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})$</code>)
flow_version	string	The version of the flow used for the execution. (pattern: <code>^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$</code>)
status	string	The current status of the flow execution. Flow executions time out after 24 hours. (Running, Succeeded, Failed, TimedOut, Aborted)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_flow_execution	select	execution_identifier, flow_alias_identifier, flow_identifier, region		Retrieves details about a specific flow execution, including its status, start and end times, and any errors that occurred during execution.
list_flow_executions	select	flow_identifier, region	flowAliasIdentifier, maxResults, nextToken	Lists all executions of a flow. Results can be paginated and include summary information about each execution, such as status, start and end times, and the execution's Amazon Resource Name (ARN). Flow executions is in preview release for Amazon Bedrock and is subject to change.

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
execution_identifier	string	The unique identifier of the flow execution to retrieve.
flow_alias_identifier	string	The unique identifier of the flow alias used for the execution.
flow_identifier	string	The unique identifier of the flow to list executions for.
region	string	AWS region (default: us-east-1)
flowAliasIdentifier	string	The unique identifier of the flow alias to list executions for.
maxResults	integer	The maximum number of flow executions to return in a single response. If more executions exist than the specified maxResults value, a token is included in the response so that the remaining results can be retrieved.
nextToken	string	A token to retrieve the next set of results. This value is returned in the response if more results are available.

SELECT examples

get_flow_execution

Retrieves details about a specific flow execution, including its status, start and end times, and any errors that occurred during execution.

SELECT
ended_at,
errors,
execution_arn,
flow_alias_identifier,
flow_identifier,
flow_version,
started_at,
status
FROM aws.bedrock_agent_runtime.flow_executions
WHERE execution_identifier = '{{ execution_identifier }}' -- required
AND flow_alias_identifier = '{{ flow_alias_identifier }}' -- required
AND flow_identifier = '{{ flow_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_flow_executions

Lists all executions of a flow. Results can be paginated and include summary information about each execution, such as status, start and end times, and the execution's Amazon Resource Name (ARN). Flow executions is in preview release for Amazon Bedrock and is subject to change.

SELECT
created_at,
ended_at,
execution_arn,
flow_alias_identifier,
flow_identifier,
flow_version,
status
FROM aws.bedrock_agent_runtime.flow_executions
WHERE flow_identifier = '{{ flow_identifier }}' -- required
AND region = '{{ region }}' -- required
AND flowAliasIdentifier = '{{ flowAliasIdentifier }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;