Skip to content

Bedrock Agent Runtime  >  Operations  >  list_flow_executions

list_flow_executions

Operation

list_flow_executions 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 ListFlowExecutionsInput.

 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 ListFlowExecutionsOutput.

Input

ListFlowExecutionsInput dataclass

Dataclass for ListFlowExecutionsInput structure.

Attributes

flow_alias_identifier class-attribute instance-attribute 
flow_alias_identifier: str | None = None

The unique identifier of the flow alias to list executions for.

flow_identifier class-attribute instance-attribute 
flow_identifier: str | None = None

The unique identifier of the flow to list executions for.

max_results 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.

next_token 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

ListFlowExecutionsOutput dataclass

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 = 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 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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.