Skip to content

create_agent_alias

Operation

create_agent_alias

create_agent_alias(request: CreateAgentAliasInput | CreateAgentAliasInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateAgentAliasInputDict]) -> CreateAgentAliasOutput

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

Parameters:

Name Type Description Default
request CreateAgentAliasInput | CreateAgentAliasInputDict | 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[CreateAgentAliasInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateAgentAliasOutput

An instance of CreateAgentAliasOutput.

create_agent_alias async

create_agent_alias(request: CreateAgentAliasInput | CreateAgentAliasInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateAgentAliasInputDict]) -> CreateAgentAliasOutput

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

Parameters:

Name Type Description Default
request CreateAgentAliasInput | CreateAgentAliasInputDict | 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[CreateAgentAliasInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateAgentAliasOutput

An instance of CreateAgentAliasOutput.

Input

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

CreateAgentAliasInputDict

Bases: TypedDict

Dictionary form of CreateAgentAliasInput.

Attributes

agent_alias_name instance-attribute
agent_alias_name: Required[str]

The name of the alias.

agent_id instance-attribute
agent_id: Required[str]

The unique identifier of the agent.

client_token instance-attribute
client_token: str | 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.

This field is autopopulated if not provided.

description instance-attribute
description: str | None

A description of the alias of the agent.

routing_configuration instance-attribute

Contains details about the routing configuration of the alias.

tags instance-attribute
tags: Mapping[str, str] | None

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

CreateAgentAliasInput dataclass

Bases: _SerdeShape

Dataclass for CreateAgentAliasInput structure.

Attributes

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

The name of the alias.

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

The unique identifier of the agent.

client_token class-attribute instance-attribute
client_token: str | 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.

This field is autopopulated if not provided.

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

A description of the alias of the agent.

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

Contains details about the routing configuration of the alias.

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

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

Output

CreateAgentAliasOutput dataclass

Bases: _SerdeShape

Dataclass for CreateAgentAliasOutput structure.

Attributes

agent_alias instance-attribute
agent_alias: AgentAlias

Contains details about the alias that was created.

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.