list_flow_execution_events¶
Operation¶
list_flow_execution_events
¶
list_flow_execution_events(request: ListFlowExecutionEventsInput | ListFlowExecutionEventsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListFlowExecutionEventsInputDict]) -> ListFlowExecutionEventsOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListFlowExecutionEventsInput | ListFlowExecutionEventsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ListFlowExecutionEventsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListFlowExecutionEventsOutput
|
An instance of |
list_flow_execution_events
async
¶
list_flow_execution_events(request: ListFlowExecutionEventsInput | ListFlowExecutionEventsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListFlowExecutionEventsInputDict]) -> ListFlowExecutionEventsOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListFlowExecutionEventsInput | ListFlowExecutionEventsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ListFlowExecutionEventsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListFlowExecutionEventsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListFlowExecutionEventsInputDict
¶
Bases: TypedDict
Dictionary form of ListFlowExecutionEventsInput.
Attributes¶
event_type
instance-attribute
¶
The type of events to retrieve. Specify Node for node-level events or
Flow for flow-level events.
execution_identifier
instance-attribute
¶
The unique identifier of the flow execution.
flow_alias_identifier
instance-attribute
¶
The unique identifier of the flow alias used for the execution.
flow_identifier
instance-attribute
¶
The unique identifier of the flow.
ListFlowExecutionEventsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListFlowExecutionEventsInput structure.
Attributes¶
event_type
class-attribute
instance-attribute
¶
event_type: str | None = ...
The type of events to retrieve. Specify Node for node-level events or
Flow for flow-level events.
execution_identifier
class-attribute
instance-attribute
¶
execution_identifier: str | None = ...
The unique identifier of the flow execution.
flow_alias_identifier
class-attribute
instance-attribute
¶
flow_alias_identifier: str | None = ...
The unique identifier of the flow alias used for the execution.
flow_identifier
class-attribute
instance-attribute
¶
flow_identifier: str | None = ...
The unique identifier of the flow.
Output¶
ListFlowExecutionEventsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListFlowExecutionEventsOutput structure.
Attributes¶
flow_execution_events
instance-attribute
¶
flow_execution_events: list[FlowExecutionEvent]
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.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
A token to retrieve the next set of results. This value is returned if more results are available.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.