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

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
assistant_id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	assistants	INSERT	Name, Type, region
delete_resource	assistants	DELETE	Identifier, region
update_resource	assistants	UPDATE	Identifier, PatchDocument, region
list_resources	assistants_list_only	SELECT	region
get_resource	assistants	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual assistant.

SELECT
  region,
  type,
  description,
  assistant_arn,
  assistant_id,
  server_side_encryption_configuration,
  tags,
  name
FROM awscc.wisdom.assistants
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ assistant_id }}';

list (identifiers only)

Lists all assistants in a region.

SELECT
  region,
  assistant_id
FROM awscc.wisdom.assistants_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.wisdom.assistants (
  Type,
  Description,
  ServerSideEncryptionConfiguration,
  Tags,
  Name,
  region
)
SELECT
  '{{ type }}',
  '{{ description }}',
  '{{ server_side_encryption_configuration }}',
  '{{ 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: server_side_encryption_configuration
        value:
          kms_key_id: '{{ kms_key_id }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: name
        value: '{{ name }}'

DELETE example

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