assistants

Creates, updates, deletes or gets an assistant resource or lists assistants in a region

Overview

Name	assistants
Type	Resource
Description	Definition of AWS::Wisdom::Assistant Resource Type
Id	aws.wisdom.assistants

Fields

Name	Datatype	Description
type	string
description	string
assistant_arn	string
assistant_id	string
server_side_encryption_configuration	object
tags	array
name	string
region	string	AWS region.

Methods

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

SELECT
region,
type,
description,
assistant_arn,
assistant_id,
server_side_encryption_configuration,
tags,
name
FROM aws.wisdom.assistants
WHERE region = 'us-east-1';

Gets all properties from an individual assistant.

SELECT
region,
type,
description,
assistant_arn,
assistant_id,
server_side_encryption_configuration,
tags,
name
FROM aws.wisdom.assistants
WHERE region = 'us-east-1' AND data__Identifier = '<AssistantId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.wisdom.assistants (
 Type,
 Name,
 region
)
SELECT 
'{{ Type }}',
 '{{ Name }}',
'{{ region }}';

All Properties

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

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: assistant
    props:
      - name: Type
        value: '{{ Type }}'
      - name: Description
        value: '{{ Description }}'
      - name: ServerSideEncryptionConfiguration
        value:
          KmsKeyId: '{{ KmsKeyId }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: Name
        value: '{{ Name }}'

DELETE example

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

Permissions

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

Create

kms:CreateGrant,
kms:DescribeKey,
wisdom:CreateAssistant,
wisdom:TagResource

Update

wisdom:GetAssistant

Read

wisdom:GetAssistant

List

wisdom:ListAssistants

Delete

wisdom:DeleteAssistant