Skip to content

Bedrock Agent  >  Operations  >  delete_flow

delete_flow

Operation

delete_flow async

delete_flow(input: DeleteFlowInput, plugins: list[Plugin] | None = None) -> DeleteFlowOutput

Deletes a flow.

Parameters:

Name Type Description Default
input DeleteFlowInput

An instance of DeleteFlowInput.

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
DeleteFlowOutput

An instance of DeleteFlowOutput.

Input

DeleteFlowInput dataclass

Dataclass for DeleteFlowInput structure.

Attributes

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

The unique identifier of the flow.

skip_resource_in_use_check class-attribute instance-attribute
skip_resource_in_use_check: bool = False

By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

Output

DeleteFlowOutput dataclass

Dataclass for DeleteFlowOutput structure.

Attributes

id instance-attribute
id: str

The unique identifier of the flow.