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 = '{{ region }}' 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 = '{{ region }}';

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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

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