AgentsforBedrockRuntime / Client / get_flow_execution

get_flow_execution

AgentsforBedrockRuntime.Client.get_flow_execution(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

  • flowIdentifier (string) –

    [REQUIRED]

    The unique identifier of the flow.

  • flowAliasIdentifier (string) –

    [REQUIRED]

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

  • executionIdentifier (string) –

    [REQUIRED]

    The unique identifier of the flow execution to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'executionArn': 'string',
    'status': 'Running'|'Succeeded'|'Failed'|'TimedOut'|'Aborted',
    'startedAt': datetime(2015, 1, 1),
    'endedAt': datetime(2015, 1, 1),
    'errors': [
        {
            'nodeName': 'string',
            'error': 'ExecutionTimedOut',
            'message': 'string'
        },
    ],
    'flowAliasIdentifier': 'string',
    'flowIdentifier': 'string',
    'flowVersion': 'string'
}

Response Structure

  • (dict) –

    • executionArn (string) –

      The Amazon Resource Name (ARN) that uniquely identifies the flow execution.

    • status (string) –

      The current status of the flow execution.

      Flow executions time out after 24 hours.

    • startedAt (datetime) –

      The timestamp when the flow execution started.

    • endedAt (datetime) –

      The timestamp when the flow execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.

    • errors (list) –

      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.

      • (dict) –

        Contains information about an error that occurred during an flow execution.

        Note

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

        • nodeName (string) –

          The name of the node in the flow where the error occurred (if applicable).

        • error (string) –

          The error code for the type of error that occurred.

        • message (string) –

          A descriptive message that provides details about the error.

    • flowAliasIdentifier (string) –

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

    • flowIdentifier (string) –

      The unique identifier of the flow.

    • flowVersion (string) –

      The version of the flow used for the execution.

Exceptions