Skip to main content

agent_aliases

Creates, updates, deletes, gets or lists an agent_aliases resource.

Overview

Nameagent_aliases
TypeResource
Idaws.bedrock_agent.agent_aliases

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
agent_alias_idstringContains details about (pattern: <code>(\bTSTALIASID\b|[0-9a-zA-Z]+)</code>)
agent_alias_namestringThe name of the alias. (pattern: <code>([0-9a-zA-Z][_-]?){1,100}</code>)
agent_alias_statusstringThe status of the alias. (CREATING, PREPARED, FAILED, UPDATING, DELETING, DISSOCIATED)
alias_invocation_statestringThe 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. (ACCEPT_INVOCATIONS, REJECT_INVOCATIONS)
created_atstring (date-time)The time at which the alias of the agent was created.
descriptionstringThe description of the alias.
routing_configurationarrayContains details about the version of the agent with which the alias is associated.
updated_atstring (date-time)The time at which the alias was last updated.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_agent_aliasesselectagent_id, regionLists the aliases of an agent and information about each one.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
agent_idstringThe unique identifier of the agent.
regionstringAWS region (default: us-east-1)

SELECT examples

Lists the aliases of an agent and information about each one.

SELECT
agent_alias_id,
agent_alias_name,
agent_alias_status,
alias_invocation_state,
created_at,
description,
routing_configuration,
updated_at
FROM aws.bedrock_agent.agent_aliases
WHERE agent_id = '{{ agent_id }}' -- required
AND region = '{{ region }}' -- required
;