Skip to content

Bedrock Agent  >  Operations  >  get_agent_alias

get_agent_alias

Operation

get_agent_alias async

get_agent_alias(input: GetAgentAliasInput, plugins: list[Plugin] | None = None) -> GetAgentAliasOutput

Gets information about an alias of an agent.

Parameters:

Name Type Description Default
input GetAgentAliasInput

An instance of GetAgentAliasInput.

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
GetAgentAliasOutput

An instance of GetAgentAliasOutput.

Input

GetAgentAliasInput dataclass

Dataclass for GetAgentAliasInput structure.

Attributes

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

The unique identifier of the alias for which to get information.

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

The unique identifier of the agent to which the alias to get information belongs.

Output

GetAgentAliasOutput dataclass

Dataclass for GetAgentAliasOutput structure.

Attributes

agent_alias instance-attribute
agent_alias: AgentAlias

Contains information about the alias.