list_flow_executions¶
Operation¶
async
¶
list_flow_executions(input: ListFlowExecutionsInput, plugins: list[Plugin] | None = None) -> ListFlowExecutionsOutput
Lists all executions of a flow. Results can be paginated and include summary information about each execution, such as status, start and end times, and the execution's Amazon Resource Name (ARN).
Note
Flow executions is in preview release for Amazon Bedrock and is subject to change.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListFlowExecutionsInput
|
An instance of |
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 |
|---|---|
ListFlowExecutionsOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for ListFlowExecutionsInput structure.
Attributes¶
class-attribute
instance-attribute
¶
flow_alias_identifier: str | None = None
The unique identifier of the flow alias to list executions for.
class-attribute
instance-attribute
¶
flow_identifier: str | None = None
The unique identifier of the flow to list executions for.
class-attribute
instance-attribute
¶
max_results: int | None = None
The maximum number of flow executions to return in a single response. If
more executions exist than the specified maxResults value, a token is
included in the response so that the remaining results can be retrieved.
class-attribute
instance-attribute
¶
next_token: str | None = None
A token to retrieve the next set of results. This value is returned in the response if more results are available.
Output¶
dataclass
¶
Dataclass for ListFlowExecutionsOutput structure.
Attributes¶
instance-attribute
¶
flow_execution_summaries: list[FlowExecutionSummary]
A list of flow execution summaries. Each summary includes the execution ARN, flow identifier, flow alias identifier, flow version, status, and timestamps.
class-attribute
instance-attribute
¶
next_token: str | None = None
A token to retrieve the next set of results. This value is returned if more results are available.