agent_aliases

Creates, updates, deletes or gets an agent_alias resource or lists agent_aliases in a region

Overview

Name	agent_aliases
Type	Resource
Description	Definition of AWS::Bedrock::AgentAlias Resource Type
Id	aws.bedrock.agent_aliases

Fields

Name	Datatype	Description
agent_alias_arn	string	Arn representation of the Agent Alias.
agent_alias_history_events	array	The list of history events for an alias for an Agent.
agent_alias_id	string	Id for an Agent Alias generated at the server side.
agent_alias_name	string	Name for a resource.
agent_alias_status	string	The statuses an Agent Alias can be in.
agent_id	string	Identifier for a resource.
created_at	string	Time Stamp.
description	string	Description of the Resource.
routing_configuration	array	Routing configuration for an Agent alias.
tags	object	A map of tag keys and values
updated_at	string	Time Stamp.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	AgentAliasName, AgentId, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all agent_aliases in a region.

SELECT
region,
agent_alias_arn,
agent_alias_history_events,
agent_alias_id,
agent_alias_name,
agent_alias_status,
agent_id,
created_at,
description,
routing_configuration,
tags,
updated_at
FROM aws.bedrock.agent_aliases
WHERE region = 'us-east-1';

Gets all properties from an individual agent_alias.

SELECT
region,
agent_alias_arn,
agent_alias_history_events,
agent_alias_id,
agent_alias_name,
agent_alias_status,
agent_id,
created_at,
description,
routing_configuration,
tags,
updated_at
FROM aws.bedrock.agent_aliases
WHERE region = 'us-east-1' AND data__Identifier = '<AgentId>|<AgentAliasId>';

INSERT example

Use the following StackQL query and manifest file to create a new agent_alias resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.bedrock.agent_aliases (
 AgentAliasName,
 AgentId,
 region
)
SELECT 
'{{ AgentAliasName }}',
 '{{ AgentId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.bedrock.agent_aliases (
 AgentAliasName,
 AgentId,
 Description,
 RoutingConfiguration,
 Tags,
 region
)
SELECT 
 '{{ AgentAliasName }}',
 '{{ AgentId }}',
 '{{ Description }}',
 '{{ RoutingConfiguration }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: agent_alias
    props:
      - name: AgentAliasName
        value: '{{ AgentAliasName }}'
      - name: AgentId
        value: '{{ AgentId }}'
      - name: Description
        value: '{{ Description }}'
      - name: RoutingConfiguration
        value:
          - AgentVersion: '{{ AgentVersion }}'
      - name: Tags
        value: {}

DELETE example

/*+ delete */
DELETE FROM aws.bedrock.agent_aliases
WHERE data__Identifier = '<AgentId|AgentAliasId>'
AND region = 'us-east-1';

Permissions

To operate on the agent_aliases resource, the following permissions are required:

Create

bedrock:PrepareAgent,
bedrock:GetAgent,
bedrock:CreateAgentAlias,
bedrock:TagResource,
bedrock:GetAgentAlias,
bedrock:ListTagsForResource

Read

bedrock:GetAgentAlias,
bedrock:ListTagsForResource

Update

bedrock:PrepareAgent,
bedrock:GetAgent,
bedrock:UpdateAgentAlias,
bedrock:TagResource,
bedrock:UntagResource,
bedrock:GetAgentAlias,
bedrock:ListTagsForResource

Delete

bedrock:DeleteAgentAlias

List

bedrock:ListAgentAliases