Skip to content

CloudFormation  >  Operations  >  remove_alias

remove_alias

Operation

remove_alias async

remove_alias(request: RemoveAliasInput | RemoveAliasInputDict, /, *, plugins: list[Plugin] | None = None) -> RemoveAliasOutput
remove_alias(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[RemoveAliasInputDict]) -> RemoveAliasOutput

Removes an alias from a stack. After the alias is removed successfully, it can no longer be used to reference the stack in API calls.

Parameters:

Name Type Description Default
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
RemoveAliasOutput

An instance of RemoveAliasOutput.

Input

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

Model

RemoveAliasInput dataclass

Bases: _SerdeShape

The input for the RemoveAlias action.

Attributes
alias_name class-attribute instance-attribute
alias_name: str | None = ...

The alias name to remove.

Dictionaries

RemoveAliasInputDict

Bases: TypedDict

Dictionary form of RemoveAliasInput.

Attributes
alias_name instance-attribute
alias_name: Required[str]

The alias name to remove.

Output

RemoveAliasOutput dataclass

Bases: _SerdeShape

Dataclass for RemoveAliasOutput structure.

Attributes

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.