Bedrock Agent Runtime  >  Operations  >  stop_flow_execution

stop_flow_execution

Operation

stop_flow_execution async

stop_flow_execution(input: StopFlowExecutionInput, plugins: list[Plugin] | None = None) -> StopFlowExecutionOutput

Stops an Amazon Bedrock flow's execution. This operation prevents further processing of the flow and changes the execution status to Aborted.

Parameters:

Name	Type	Description	Default
input	StopFlowExecutionInput	An instance of StopFlowExecutionInput.	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
StopFlowExecutionOutput	An instance of StopFlowExecutionOutput.

Input

StopFlowExecutionInput dataclass

Dataclass for StopFlowExecutionInput structure.

Attributes

execution_identifier class-attribute instance-attribute

execution_identifier: str | None = None

The unique identifier of the flow execution to stop.

flow_alias_identifier class-attribute instance-attribute

flow_alias_identifier: str | None = None

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

flow_identifier class-attribute instance-attribute

flow_identifier: str | None = None

The unique identifier of the flow.

Output

StopFlowExecutionOutput dataclass

Dataclass for StopFlowExecutionOutput structure.

Attributes

execution_arn class-attribute instance-attribute

execution_arn: str | None = None

The Amazon Resource Name (ARN) that uniquely identifies the flow execution that was stopped.

status instance-attribute

status: FlowExecutionStatus

The updated status of the flow execution after the stop request. This will typically be ABORTED if the execution was successfully stopped.