Skip to content

Bedrock Agent Runtime  >  Operations  >  get_execution_flow_snapshot

get_execution_flow_snapshot

Operation

get_execution_flow_snapshot async

get_execution_flow_snapshot(input: GetExecutionFlowSnapshotInput, plugins: list[Plugin] | None = None) -> GetExecutionFlowSnapshotOutput

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.

Note

Flow executions is in preview release for Amazon Bedrock and is subject to change.

Parameters:

Name Type Description Default
input GetExecutionFlowSnapshotInput

An instance of GetExecutionFlowSnapshotInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
GetExecutionFlowSnapshotOutput

An instance of GetExecutionFlowSnapshotOutput.

Input

GetExecutionFlowSnapshotInput dataclass

Dataclass for GetExecutionFlowSnapshotInput structure.

Attributes

execution_identifier class-attribute instance-attribute
execution_identifier: str | None = None

The unique identifier of the flow execution.

flow_alias_identifier class-attribute instance-attribute
flow_alias_identifier: str | None = None

The unique identifier of the flow alias used for the flow execution.

flow_identifier class-attribute instance-attribute
flow_identifier: str | None = None

The unique identifier of the flow.

Output

GetExecutionFlowSnapshotOutput dataclass

Dataclass for GetExecutionFlowSnapshotOutput structure.

Attributes

customer_encryption_key_arn class-attribute instance-attribute
customer_encryption_key_arn: str | None = None

The Amazon Resource Name (ARN) of the customer managed KMS key that's used to encrypt the flow snapshot.

definition instance-attribute
definition: str

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 instance-attribute
execution_role_arn: str

The Amazon Resource Name (ARN) of the IAM service role that's used by the flow execution.

flow_alias_identifier instance-attribute
flow_alias_identifier: str

The unique identifier of the flow alias used for the flow execution.

flow_identifier instance-attribute
flow_identifier: str

The unique identifier of the flow.

flow_version instance-attribute
flow_version: str

The version of the flow used for the flow execution.