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	awscc.wisdom.ai_agents

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
a_iagent_id	string
assistant_id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	ai_agents	INSERT	AssistantId, Configuration, Type, region
delete_resource	ai_agents	DELETE	Identifier, region
update_resource	ai_agents	UPDATE	Identifier, PatchDocument, region
list_resources	ai_agents_list_only	SELECT	region
get_resource	ai_agents	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.wisdom.ai_agents
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ a_iagent_id }}|{{ assistant_id }}';

list (identifiers only)

Lists all ai_agents in a region.

SELECT
  region,
  a_iagent_id,
  assistant_id
FROM awscc.wisdom.ai_agents_list_only
WHERE
  region = '{{ region }}';

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 awscc.wisdom.ai_agents (
  AssistantId,
  Configuration,
  Type,
  region
)
SELECT
  '{{ assistant_id }}',
  '{{ configuration }}',
  '{{ type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.wisdom.ai_agents (
  AssistantId,
  Configuration,
  Description,
  Name,
  Tags,
  Type,
  region
)
SELECT
  '{{ assistant_id }}',
  '{{ configuration }}',
  '{{ description }}',
  '{{ name }}',
  '{{ tags }}',
  '{{ type }}',
  '{{ 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: ai_agent
  props:
    - name: assistant_id
      value: '{{ assistant_id }}'
    - name: configuration
      value: null
    - name: description
      value: '{{ description }}'
    - name: name
      value: '{{ name }}'
    - name: tags
      value: {}
    - name: type
      value: '{{ type }}'

UPDATE example

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

/*+ update */
UPDATE awscc.wisdom.ai_agents
SET PatchDocument = string('{{ {
    "Configuration": configuration,
    "Description": description
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ a_iagent_id }}|{{ assistant_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.wisdom.ai_agents
WHERE
  Identifier = '{{ a_iagent_id }}|{{ assistant_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 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