knowledge_bases

Creates, updates, deletes or gets a knowledge_base resource or lists knowledge_bases in a region

Overview

Name	knowledge_bases
Type	Resource
Description	Definition of AWS::Wisdom::KnowledgeBase Resource Type
Id	aws.wisdom.knowledge_bases

Fields

Name	Datatype	Description
description	string
knowledge_base_arn	string
knowledge_base_id	string
knowledge_base_type	string
name	string
rendering_configuration	object
server_side_encryption_configuration	object
source_configuration	object
tags	array
region	string	AWS region.

Methods

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

SELECT
region,
description,
knowledge_base_arn,
knowledge_base_id,
knowledge_base_type,
name,
rendering_configuration,
server_side_encryption_configuration,
source_configuration,
tags
FROM aws.wisdom.knowledge_bases
WHERE region = 'us-east-1';

Gets all properties from an individual knowledge_base.

SELECT
region,
description,
knowledge_base_arn,
knowledge_base_id,
knowledge_base_type,
name,
rendering_configuration,
server_side_encryption_configuration,
source_configuration,
tags
FROM aws.wisdom.knowledge_bases
WHERE region = 'us-east-1' AND data__Identifier = '<KnowledgeBaseId>';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO aws.wisdom.knowledge_bases (
 Description,
 KnowledgeBaseType,
 Name,
 RenderingConfiguration,
 ServerSideEncryptionConfiguration,
 SourceConfiguration,
 Tags,
 region
)
SELECT 
 '{{ Description }}',
 '{{ KnowledgeBaseType }}',
 '{{ Name }}',
 '{{ RenderingConfiguration }}',
 '{{ ServerSideEncryptionConfiguration }}',
 '{{ SourceConfiguration }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: knowledge_base
    props:
      - name: Description
        value: '{{ Description }}'
      - name: KnowledgeBaseType
        value: '{{ KnowledgeBaseType }}'
      - name: Name
        value: '{{ Name }}'
      - name: RenderingConfiguration
        value:
          TemplateUri: '{{ TemplateUri }}'
      - name: ServerSideEncryptionConfiguration
        value:
          KmsKeyId: '{{ KmsKeyId }}'
      - name: SourceConfiguration
        value:
          AppIntegrations:
            ObjectFields:
              - '{{ ObjectFields[0] }}'
            AppIntegrationArn: '{{ AppIntegrationArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

appflow:CreateFlow,
appflow:DeleteFlow,
appflow:StartFlow,
appflow:TagResource,
appflow:UseConnectorProfile,
app-integrations:CreateDataIntegrationAssociation,
app-integrations:GetDataIntegration,
kms:DescribeKey,
kms:CreateGrant,
kms:ListGrants,
wisdom:CreateKnowledgeBase,
wisdom:TagResource

Update

wisdom:GetKnowledgeBase

Delete

appflow:DeleteFlow,
appflow:StopFlow,
app-integrations:DeleteDataIntegrationAssociation,
wisdom:DeleteKnowledgeBase

List

wisdom:ListKnowledgeBases

Read

wisdom:GetKnowledgeBase