AgentsforBedrockRuntime / Client / list_flow_execution_events

list_flow_execution_events

AgentsforBedrockRuntime.Client.list_flow_execution_events(**kwargs)

Lists events that occurred during a flow execution. Events provide detailed information about the execution progress, including node inputs and outputs, flow inputs and outputs, condition results, and failure events.

Note

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

See also: AWS API Documentation

Request Syntax

response = client.list_flow_execution_events(
    eventType='Node'|'Flow',
    executionIdentifier='string',
    flowAliasIdentifier='string',
    flowIdentifier='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • eventType (string) –

    [REQUIRED]

    The type of events to retrieve. Specify Node for node-level events or Flow for flow-level events.

  • executionIdentifier (string) –

    [REQUIRED]

    The unique identifier of the flow execution.

  • flowAliasIdentifier (string) –

    [REQUIRED]

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

  • flowIdentifier (string) –

    [REQUIRED]

    The unique identifier of the flow.

  • maxResults (integer) – The maximum number of events to return in a single response. If more events 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.

Return type:

dict

Returns:

Response Syntax

{
    'flowExecutionEvents': [
        {
            'conditionResultEvent': {
                'nodeName': 'string',
                'satisfiedConditions': [
                    {
                        'conditionName': 'string'
                    },
                ],
                'timestamp': datetime(2015, 1, 1)
            },
            'flowFailureEvent': {
                'errorCode': 'VALIDATION'|'INTERNAL_SERVER'|'NODE_EXECUTION_FAILED',
                'errorMessage': 'string',
                'timestamp': datetime(2015, 1, 1)
            },
            'flowInputEvent': {
                'fields': [
                    {
                        'content': {
                            'document': {...}|[...]|123|123.4|'string'|True|None
                        },
                        'name': 'string'
                    },
                ],
                'nodeName': 'string',
                'timestamp': datetime(2015, 1, 1)
            },
            'flowOutputEvent': {
                'fields': [
                    {
                        'content': {
                            'document': {...}|[...]|123|123.4|'string'|True|None
                        },
                        'name': 'string'
                    },
                ],
                'nodeName': 'string',
                'timestamp': datetime(2015, 1, 1)
            },
            'nodeFailureEvent': {
                'errorCode': 'VALIDATION'|'DEPENDENCY_FAILED'|'BAD_GATEWAY'|'INTERNAL_SERVER',
                'errorMessage': 'string',
                'nodeName': 'string',
                'timestamp': datetime(2015, 1, 1)
            },
            'nodeInputEvent': {
                'fields': [
                    {
                        'content': {
                            'document': {...}|[...]|123|123.4|'string'|True|None
                        },
                        'name': 'string'
                    },
                ],
                'nodeName': 'string',
                'timestamp': datetime(2015, 1, 1)
            },
            'nodeOutputEvent': {
                'fields': [
                    {
                        'content': {
                            'document': {...}|[...]|123|123.4|'string'|True|None
                        },
                        'name': 'string'
                    },
                ],
                'nodeName': 'string',
                'timestamp': datetime(2015, 1, 1)
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • flowExecutionEvents (list) –

      A list of events that occurred during the flow execution. Events can include node inputs and outputs, flow inputs and outputs, condition results, and failure events.

      • (dict) –

        Represents an event that occurred during an flow execution. This is a union type that can contain one of several event types, such as node input and output events; flow input and output events; condition node result events, or failure events.

        Note

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

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: conditionResultEvent, flowFailureEvent, flowInputEvent, flowOutputEvent, nodeFailureEvent, nodeInputEvent, nodeOutputEvent. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

        • conditionResultEvent (dict) –

          Contains information about a condition evaluation result during the flow execution. This event is generated when a condition node in the flow evaluates its conditions.

          • nodeName (string) –

            The name of the condition node that evaluated the conditions.

          • satisfiedConditions (list) –

            A list of conditions that were satisfied during the evaluation.

            • (dict) –

              Represents a condition that was satisfied during a condition node evaluation in a flow execution.

              Note

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

              • conditionName (string) –

                The name of the condition that was satisfied.

          • timestamp (datetime) –

            The timestamp when the condition evaluation occurred.

        • flowFailureEvent (dict) –

          Contains information about a failure that occurred at the flow level during execution.

          • errorCode (string) –

            The error code that identifies the type of failure that occurred.

          • errorMessage (string) –

            A descriptive message that provides details about the failure.

          • timestamp (datetime) –

            The timestamp when the failure occurred.

        • flowInputEvent (dict) –

          Contains information about the inputs provided to the flow at the start of execution.

          • fields (list) –

            A list of input fields provided to the flow.

            • (dict) –

              Represents an input field provided to a flow during a flow execution.

              Note

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

              • content (dict) –

                The content of the input field, which can contain text or structured data.

                Note

                This is a Tagged Union structure. Only one of the following top level keys will be set: document. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

                • document (document) –

                  The document content of the field, which can contain text or structured data.

              • name (string) –

                The name of the input field as defined in the flow’s input schema.

          • nodeName (string) –

            The name of the node that receives the inputs.

          • timestamp (datetime) –

            The timestamp when the inputs are provided.

        • flowOutputEvent (dict) –

          Contains information about the outputs produced by the flow at the end of execution.

          • fields (list) –

            A list of output fields produced by the flow.

            • (dict) –

              Represents an output field produced by a flow during a flow execution.

              Note

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

              • content (dict) –

                The content of the output field, which can contain text or structured data.

                Note

                This is a Tagged Union structure. Only one of the following top level keys will be set: document. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

                • document (document) –

                  The document content of the field, which can contain text or structured data.

              • name (string) –

                The name of the output field as defined in the flow’s output schema.

          • nodeName (string) –

            The name of the node that produces the outputs.

          • timestamp (datetime) –

            The timestamp when the outputs are produced.

        • nodeFailureEvent (dict) –

          Contains information about a failure that occurred at a specific node during execution.

          • errorCode (string) –

            The error code that identifies the type of failure that occurred at the node.

          • errorMessage (string) –

            A descriptive message that provides details about the node failure.

          • nodeName (string) –

            The name of the node where the failure occurred.

          • timestamp (datetime) –

            The timestamp when the node failure occurred.

        • nodeInputEvent (dict) –

          Contains information about the inputs provided to a specific node during execution.

          • fields (list) –

            A list of input fields provided to the node.

            • (dict) –

              Represents an input field provided to a node during a flow execution.

              • content (dict) –

                The content of the input field, which can contain text or structured data.

                Note

                This is a Tagged Union structure. Only one of the following top level keys will be set: document. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

                • document (document) –

                  The document content of the field, which can contain text or structured data.

              • name (string) –

                The name of the input field as defined in the node’s input schema.

          • nodeName (string) –

            The name of the node that received the inputs.

          • timestamp (datetime) –

            The timestamp when the inputs were provided to the node.

        • nodeOutputEvent (dict) –

          Contains information about the outputs produced by a specific node during execution.

          • fields (list) –

            A list of output fields produced by the node.

            • (dict) –

              Represents an output field produced by a node during a flow execution.

              Note

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

              • content (dict) –

                The content of the output field, which can contain text or structured data.

                Note

                This is a Tagged Union structure. Only one of the following top level keys will be set: document. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

                • document (document) –

                  The document content of the field, which can contain text or structured data.

              • name (string) –

                The name of the output field as defined in the node’s output schema.

          • nodeName (string) –

            The name of the node that produced the outputs.

          • timestamp (datetime) –

            The timestamp when the outputs were produced by the node.

    • nextToken (string) –

      A token to retrieve the next set of results. This value is returned if more results are available.

Exceptions