assistant_associations

Creates, updates, deletes or gets an assistant_association resource or lists assistant_associations in a region

Overview

Name	assistant_associations
Type	Resource
Description	Definition of AWS::Wisdom::AssistantAssociation Resource Type
Id	awscc.wisdom.assistant_associations

Fields

get (all properties)

Name	Datatype	Description
assistant_association_arn	string
assistant_arn	string
assistant_association_id	string
assistant_id	string
▶association	object
association_type	string
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
assistant_association_id	string
assistant_id	string
▶association	object
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	assistant_associations	INSERT	Association, AssociationType, AssistantId, region
delete_resource	assistant_associations	DELETE	Identifier, region
update_resource	assistant_associations	UPDATE	Identifier, PatchDocument, region
list_resources	assistant_associations_list_only	SELECT	region
get_resource	assistant_associations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual assistant_association.

SELECT
  region,
  assistant_association_arn,
  assistant_arn,
  assistant_association_id,
  assistant_id,
  association,
  association_type,
  tags
FROM awscc.wisdom.assistant_associations
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ assistant_association_id }}|{{ assistant_id }}';

list (identifiers only)

Lists all assistant_associations in a region.

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

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.wisdom.assistant_associations (
  AssistantId,
  Association,
  AssociationType,
  region
)
SELECT
  '{{ assistant_id }}',
  '{{ association }}',
  '{{ association_type }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.wisdom.assistant_associations (
  AssistantId,
  Association,
  AssociationType,
  Tags,
  region
)
SELECT
  '{{ assistant_id }}',
  '{{ association }}',
  '{{ association_type }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: assistant_association
    props:
      - name: assistant_id
        value: '{{ assistant_id }}'
      - name: association
        value:
          knowledge_base_id: '{{ knowledge_base_id }}'
      - name: association_type
        value: '{{ association_type }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.wisdom.assistant_associations
WHERE
  Identifier = '{{ assistant_association_id }}|{{ assistant_id }}' AND
  region = 'us-east-1';

Permissions

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

Create

wisdom:CreateAssistantAssociation,
wisdom:TagResource

Update

wisdom:GetAssistantAssociation

Read

wisdom:GetAssistantAssociation

List

wisdom:ListAssistantAssociations

Delete

wisdom:DeleteAssistantAssociation