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	awscc.bedrock.agent_aliases

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
agent_alias_id	string	Id for an Agent Alias generated at the server side.
agent_id	string	Identifier for a resource.
region	string	AWS region.

For more information, see AWS::Bedrock::AgentAlias.

Methods

Name	Resource	Accessible by	Required Params
create_resource	agent_aliases	INSERT	AgentAliasName, AgentId, region
delete_resource	agent_aliases	DELETE	Identifier, region
update_resource	agent_aliases	UPDATE	Identifier, PatchDocument, region
list_resources	agent_aliases_list_only	SELECT	region
get_resource	agent_aliases	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.bedrock.agent_aliases
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ agent_id }}|{{ agent_alias_id }}';

list (identifiers only)

Lists all agent_aliases in a region.

SELECT
  region,
  agent_id,
  agent_alias_id
FROM awscc.bedrock.agent_aliases_list_only
WHERE
  region = '{{ region }}';

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 awscc.bedrock.agent_aliases (
  AgentAliasName,
  AgentId,
  region
)
SELECT
  '{{ agent_alias_name }}',
  '{{ agent_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.bedrock.agent_aliases (
  AgentAliasName,
  AgentId,
  Description,
  RoutingConfiguration,
  Tags,
  region
)
SELECT
  '{{ agent_alias_name }}',
  '{{ agent_id }}',
  '{{ description }}',
  '{{ routing_configuration }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: agent_alias
  props:
    - name: agent_alias_name
      value: '{{ agent_alias_name }}'
    - name: agent_id
      value: '{{ agent_id }}'
    - name: description
      value: '{{ description }}'
    - name: routing_configuration
      value:
        - agent_version: '{{ agent_version }}'
    - name: tags
      value: {}

UPDATE example

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

/*+ update */
UPDATE awscc.bedrock.agent_aliases
SET PatchDocument = string('{{ {
    "AgentAliasName": agent_alias_name,
    "Description": description,
    "RoutingConfiguration": routing_configuration,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ agent_id }}|{{ agent_alias_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.bedrock.agent_aliases
WHERE
  Identifier = '{{ agent_id }}|{{ agent_alias_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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