execution_flow_snapshots
Creates, updates, deletes, gets or lists an execution_flow_snapshots resource.
Overview
| Name | execution_flow_snapshots |
| Type | Resource |
| Id | aws.bedrock_agent_runtime.execution_flow_snapshots |
Fields
The following fields are returned by SELECT queries:
- get_execution_flow_snapshot
| Name | Datatype | Description |
|---|---|---|
customer_encryption_key_arn | string | The Amazon Resource Name (ARN) of the customer managed KMS key that's used to encrypt the flow snapshot. (pattern: <code>^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$</code>) |
definition | string | The flow definition used for the flow execution, including the nodes, connections, and configuration at the time when the execution started. The definition returns as a string that follows the structure of a FlowDefinition object. |
execution_role_arn | string | The Amazon Resource Name (ARN) of the IAM service role that's used by the flow execution. (pattern: <code>^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+$</code>) |
flow_alias_identifier | string | The unique identifier of the flow alias used for the flow 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 flow execution. (pattern: <code>^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_execution_flow_snapshot | select | execution_identifier, flow_alias_identifier, flow_identifier, region | Retrieves the flow definition snapshot used for a flow execution. The snapshot represents the flow metadata and definition as it existed at the time the execution was started. Note that even if the flow is edited after an execution starts, the snapshot connected to the execution remains unchanged. 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. |
flow_alias_identifier | string | The unique identifier of the flow alias used for the flow execution. |
flow_identifier | string | The unique identifier of the flow. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_execution_flow_snapshot
Retrieves the flow definition snapshot used for a flow execution. The snapshot represents the flow metadata and definition as it existed at the time the execution was started. Note that even if the flow is edited after an execution starts, the snapshot connected to the execution remains unchanged. Flow executions is in preview release for Amazon Bedrock and is subject to change.
SELECT
customer_encryption_key_arn,
definition,
execution_role_arn,
flow_alias_identifier,
flow_identifier,
flow_version
FROM aws.bedrock_agent_runtime.execution_flow_snapshots
WHERE execution_identifier = '{{ execution_identifier }}' -- required
AND flow_alias_identifier = '{{ flow_alias_identifier }}' -- required
AND flow_identifier = '{{ flow_identifier }}' -- required
AND region = '{{ region }}' -- required
;