Skip to content

Bedrock Agent  >  Operations  >  create_agent_alias

create_agent_alias

Operation

create_agent_alias async

create_agent_alias(input: CreateAgentAliasInput, plugins: list[Plugin] | None = None) -> CreateAgentAliasOutput

Creates an alias of an agent that can be used to deploy the agent.

Parameters:

Name Type Description Default
input CreateAgentAliasInput

An instance of CreateAgentAliasInput.

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
CreateAgentAliasOutput

An instance of CreateAgentAliasOutput.

Input

CreateAgentAliasInput dataclass

Dataclass for CreateAgentAliasInput structure.

Attributes

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

The name of the alias.

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

The unique identifier of the agent.

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

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

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

A description of the alias of the agent.

routing_configuration class-attribute instance-attribute
routing_configuration: list[AgentAliasRoutingConfigurationListItem] | None = None

Contains details about the routing configuration of the alias.

tags class-attribute instance-attribute
tags: dict[str, str] | None = None

Any tags that you want to attach to the alias of the agent.

Output

CreateAgentAliasOutput dataclass

Dataclass for CreateAgentAliasOutput structure.

Attributes

agent_alias instance-attribute
agent_alias: AgentAlias

Contains details about the alias that was created.