Skip to content

Bedrock Agent  >  Structures  >  AgentAlias

AgentAlias

Structure Class

AgentAlias dataclass

Contains details about an alias of an agent.

Attributes

agent_alias_arn instance-attribute 
agent_alias_arn: str

The Amazon Resource Name (ARN) of the alias of the agent.

agent_alias_history_events class-attribute instance-attribute 
agent_alias_history_events: list[AgentAliasHistoryEvent] | None = None

Contains details about the history of the alias.

agent_alias_id instance-attribute 
agent_alias_id: str

The unique identifier of the alias of the agent.

agent_alias_name instance-attribute 
agent_alias_name: str

The name of the alias of the agent.

agent_alias_status instance-attribute 
agent_alias_status: AgentAliasStatus

The status of the alias of the agent and whether it is ready for use. The following statuses are possible:

  • CREATING -- The agent alias is being created.

  • PREPARED -- The agent alias is finished being created or updated and is ready to be invoked.

  • FAILED -- The agent alias API operation failed.

  • UPDATING -- The agent alias is being updated.

  • DELETING -- The agent alias is being deleted.

  • DISSOCIATED - The agent alias has no version associated with it.

agent_id instance-attribute 
agent_id: str

The unique identifier of the agent.

alias_invocation_state class-attribute instance-attribute 
alias_invocation_state: AliasInvocationState | None = None

The invocation state for the agent alias. If the agent alias is running, the value is ACCEPT_INVOCATIONS. If the agent alias is paused, the value is REJECT_INVOCATIONS. Use the UpdateAgentAlias operation to change the invocation state.

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.

created_at instance-attribute 
created_at: datetime

The time at which the alias of the agent was created.

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

The description of the alias of the agent.

failure_reasons class-attribute instance-attribute 
failure_reasons: list[str] | None = None

Information on the failure of Provisioned Throughput assigned to an agent alias.

routing_configuration instance-attribute 
routing_configuration: list[AgentAliasRoutingConfigurationListItem]

Contains details about the routing configuration of the alias.

updated_at instance-attribute 
updated_at: datetime

The time at which the alias was last updated.