Skip to content

Bedrock Agent  >  Operations  >  delete_agent_alias

delete_agent_alias

Operation

delete_agent_alias async

delete_agent_alias(input: DeleteAgentAliasInput, plugins: list[Plugin] | None = None) -> DeleteAgentAliasOutput

Deletes an alias of an agent.

Parameters:

Name Type Description Default
input DeleteAgentAliasInput

An instance of DeleteAgentAliasInput.

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
DeleteAgentAliasOutput

An instance of DeleteAgentAliasOutput.

Input

DeleteAgentAliasInput dataclass

Dataclass for DeleteAgentAliasInput structure.

Attributes

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

The unique identifier of the alias to delete.

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

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

Output

DeleteAgentAliasOutput dataclass

Dataclass for DeleteAgentAliasOutput structure.

Attributes

agent_alias_id instance-attribute
agent_alias_id: str

The unique identifier of the alias that was deleted.

agent_alias_status instance-attribute
agent_alias_status: AgentAliasStatus

The status of the alias.

agent_id instance-attribute
agent_id: str

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