AgentsforBedrockRuntime / Client / get_execution_flow_snapshot

get_execution_flow_snapshot

AgentsforBedrockRuntime.Client.get_execution_flow_snapshot(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_execution_flow_snapshot(
    executionIdentifier='string',
    flowAliasIdentifier='string',
    flowIdentifier='string'
)
Parameters:

  • executionIdentifier (string) –

    [REQUIRED]

    The unique identifier of the flow execution.

  • flowAliasIdentifier (string) –

    [REQUIRED]

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

  • flowIdentifier (string) –

    [REQUIRED]

    The unique identifier of the flow.

Return type:

dict

Returns:

Response Syntax

{
    'customerEncryptionKeyArn': 'string',
    'definition': 'string',
    'executionRoleArn': 'string',
    'flowAliasIdentifier': 'string',
    'flowIdentifier': 'string',
    'flowVersion': 'string'
}

Response Structure

  • (dict) –

    • customerEncryptionKeyArn (string) –

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

    • 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.

    • executionRoleArn (string) –

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

    • flowAliasIdentifier (string) –

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

    • flowIdentifier (string) –

      The unique identifier of the flow.

    • flowVersion (string) –

      The version of the flow used for the flow execution.

Exceptions