list_flow_executions¶
Operation¶
list_flow_executions
¶
list_flow_executions(request: ListFlowExecutionsInput | ListFlowExecutionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListFlowExecutionsInputDict]) -> 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 |
|---|---|---|---|
request
|
ListFlowExecutionsInput | ListFlowExecutionsInputDict | 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[ListFlowExecutionsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListFlowExecutionsOutput
|
An instance of |
list_flow_executions
async
¶
list_flow_executions(request: ListFlowExecutionsInput | ListFlowExecutionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListFlowExecutionsInputDict]) -> 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 |
|---|---|---|---|
request
|
ListFlowExecutionsInput | ListFlowExecutionsInputDict | 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[ListFlowExecutionsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListFlowExecutionsOutput
|
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.
ListFlowExecutionsInputDict
¶
Bases: TypedDict
Dictionary form of ListFlowExecutionsInput.
Attributes¶
flow_alias_identifier
instance-attribute
¶
flow_alias_identifier: str | None
The unique identifier of the flow alias to list executions for.
flow_identifier
instance-attribute
¶
The unique identifier of the flow to list executions for.
ListFlowExecutionsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListFlowExecutionsInput structure.
Attributes¶
flow_alias_identifier
class-attribute
instance-attribute
¶
flow_alias_identifier: str | None = ...
The unique identifier of the flow alias to list executions for.
flow_identifier
class-attribute
instance-attribute
¶
flow_identifier: str | None = ...
The unique identifier of the flow to list executions for.
Output¶
ListFlowExecutionsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListFlowExecutionsOutput structure.
Attributes¶
flow_execution_summaries
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.
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.