Skip to content

delete_flow_alias

Operation

delete_flow_alias

delete_flow_alias(request: DeleteFlowAliasInput | DeleteFlowAliasInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteFlowAliasInputDict]) -> DeleteFlowAliasOutput

Deletes an alias of a flow.

Parameters:

Name Type Description Default
request DeleteFlowAliasInput | DeleteFlowAliasInputDict | 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[DeleteFlowAliasInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteFlowAliasOutput

An instance of DeleteFlowAliasOutput.

delete_flow_alias async

delete_flow_alias(request: DeleteFlowAliasInput | DeleteFlowAliasInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteFlowAliasInputDict]) -> DeleteFlowAliasOutput

Deletes an alias of a flow.

Parameters:

Name Type Description Default
request DeleteFlowAliasInput | DeleteFlowAliasInputDict | 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[DeleteFlowAliasInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteFlowAliasOutput

An instance of DeleteFlowAliasOutput.

Input

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

DeleteFlowAliasInputDict

Bases: TypedDict

Dictionary form of DeleteFlowAliasInput.

Attributes

alias_identifier instance-attribute
alias_identifier: Required[str]

The unique identifier of the alias to be deleted.

flow_identifier instance-attribute
flow_identifier: Required[str]

The unique identifier of the flow that the alias belongs to.

DeleteFlowAliasInput dataclass

Bases: _SerdeShape

Dataclass for DeleteFlowAliasInput structure.

Attributes

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

The unique identifier of the alias to be deleted.

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

The unique identifier of the flow that the alias belongs to.

Output

DeleteFlowAliasOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteFlowAliasOutput structure.

Attributes

flow_id instance-attribute
flow_id: str

The unique identifier of the flow that the alias belongs to.

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.