ai_agents

Creates, updates, deletes or gets an ai_agent resource or lists ai_agents in a region

Overview

Name	ai_agents
Type	Resource
Description	Definition of AWS::Wisdom::AIAgent Resource Type
Id	aws.wisdom.ai_agents

Fields

Name	Datatype	Description
a_iagent_id	string
a_iagent_arn	string
assistant_id	string
assistant_arn	string
configuration	undefined
description	string
name	string
tags	object
type	string
modified_time_seconds	number
region	string	AWS region.

For more information, see AWS::Wisdom::AIAgent.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	AssistantId, Configuration, Type, 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 ai_agents in a region.

SELECT
region,
a_iagent_id,
a_iagent_arn,
assistant_id,
assistant_arn,
configuration,
description,
name,
tags,
type,
modified_time_seconds
FROM aws.wisdom.ai_agents
WHERE region = 'us-east-1';

Gets all properties from an individual ai_agent.

SELECT
region,
a_iagent_id,
a_iagent_arn,
assistant_id,
assistant_arn,
configuration,
description,
name,
tags,
type,
modified_time_seconds
FROM aws.wisdom.ai_agents
WHERE region = 'us-east-1' AND data__Identifier = '<AIAgentId>|<AssistantId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.wisdom.ai_agents (
 AssistantId,
 Configuration,
 Type,
 region
)
SELECT 
'{{ AssistantId }}',
 '{{ Configuration }}',
 '{{ Type }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.wisdom.ai_agents (
 AssistantId,
 Configuration,
 Description,
 Name,
 Tags,
 Type,
 region
)
SELECT 
 '{{ AssistantId }}',
 '{{ Configuration }}',
 '{{ Description }}',
 '{{ Name }}',
 '{{ Tags }}',
 '{{ Type }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: ai_agent
    props:
      - name: AssistantId
        value: '{{ AssistantId }}'
      - name: Configuration
        value: null
      - name: Description
        value: '{{ Description }}'
      - name: Name
        value: '{{ Name }}'
      - name: Tags
        value: {}
      - name: Type
        value: '{{ Type }}'

DELETE example

/*+ delete */
DELETE FROM aws.wisdom.ai_agents
WHERE data__Identifier = '<AIAgentId|AssistantId>'
AND region = 'us-east-1';

Permissions

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

Create

wisdom:CreateAIAgent,
wisdom:TagResource

Read

wisdom:GetAIAgent

Update

wisdom:UpdateAIAgent

Delete

wisdom:DeleteAIAgent

List

wisdom:ListAIAgents