Skip to content

delete_flow_version

Operation

delete_flow_version

delete_flow_version(request: DeleteFlowVersionInput | DeleteFlowVersionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteFlowVersionInputDict]) -> DeleteFlowVersionOutput

Deletes a version of a flow.

Parameters:

Name Type Description Default
request DeleteFlowVersionInput | DeleteFlowVersionInputDict | 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[DeleteFlowVersionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteFlowVersionOutput

An instance of DeleteFlowVersionOutput.

delete_flow_version async

delete_flow_version(request: DeleteFlowVersionInput | DeleteFlowVersionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteFlowVersionInputDict]) -> DeleteFlowVersionOutput

Deletes a version of a flow.

Parameters:

Name Type Description Default
request DeleteFlowVersionInput | DeleteFlowVersionInputDict | 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[DeleteFlowVersionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteFlowVersionOutput

An instance of DeleteFlowVersionOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DeleteFlowVersionInputDict

Bases: TypedDict

Dictionary form of DeleteFlowVersionInput.

Attributes

flow_identifier instance-attribute
flow_identifier: Required[str]

The unique identifier of the flow whose version that you want to delete

flow_version instance-attribute
flow_version: Required[str]

The version of the flow that you want to delete.

skip_resource_in_use_check instance-attribute
skip_resource_in_use_check: bool | None

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.

DeleteFlowVersionInput dataclass

Bases: _SerdeShape

Dataclass for DeleteFlowVersionInput structure.

Attributes

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

The unique identifier of the flow whose version that you want to delete

flow_version class-attribute instance-attribute
flow_version: str | None = ...

The version of the flow that you want to delete.

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

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

DeleteFlowVersionOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteFlowVersionOutput structure.

Attributes

id instance-attribute
id: str

The unique identifier of the flow.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.

version instance-attribute
version: str

The version of the flow being deleted.