faqs

Creates, updates, deletes or gets a faq resource or lists faqs in a region

Overview

Name	faqs
Type	Resource
Description	A Kendra FAQ resource
Id	aws.kendra.faqs

Fields

Name	Datatype	Description
id	string	Unique ID of index
index_id	string	Index ID
name	string	FAQ name
description	string	FAQ description
file_format	string	FAQ file format
s3_path	object	FAQ S3 path
role_arn	string	FAQ role ARN
tags	array	Tags for labeling the FAQ
arn	string
language_code	string	The code for a language.
region	string	AWS region.

Methods

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

SELECT
region,
id,
index_id,
name,
description,
file_format,
s3_path,
role_arn,
tags,
arn,
language_code
FROM aws.kendra.faqs
WHERE region = 'us-east-1';

Gets all properties from an individual faq.

SELECT
region,
id,
index_id,
name,
description,
file_format,
s3_path,
role_arn,
tags,
arn,
language_code
FROM aws.kendra.faqs
WHERE region = 'us-east-1' AND data__Identifier = '<Id>|<IndexId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.kendra.faqs (
 IndexId,
 Name,
 S3Path,
 RoleArn,
 region
)
SELECT 
'{{ IndexId }}',
 '{{ Name }}',
 '{{ S3Path }}',
 '{{ RoleArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.kendra.faqs (
 IndexId,
 Name,
 Description,
 FileFormat,
 S3Path,
 RoleArn,
 Tags,
 LanguageCode,
 region
)
SELECT 
 '{{ IndexId }}',
 '{{ Name }}',
 '{{ Description }}',
 '{{ FileFormat }}',
 '{{ S3Path }}',
 '{{ RoleArn }}',
 '{{ Tags }}',
 '{{ LanguageCode }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: faq
    props:
      - name: IndexId
        value: '{{ IndexId }}'
      - name: Name
        value: '{{ Name }}'
      - name: Description
        value: '{{ Description }}'
      - name: FileFormat
        value: '{{ FileFormat }}'
      - name: S3Path
        value:
          Bucket: '{{ Bucket }}'
          Key: '{{ Key }}'
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: LanguageCode
        value: '{{ LanguageCode }}'

DELETE example

/*+ delete */
DELETE FROM aws.kendra.faqs
WHERE data__Identifier = '<Id|IndexId>'
AND region = 'us-east-1';

Permissions

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

Create

kendra:CreateFaq,
kendra:DescribeFaq,
iam:PassRole,
kendra:ListTagsForResource,
kendra:TagResource

Update

kendra:ListTagsForResource,
kendra:UntagResource,
kendra:TagResource

Read

kendra:DescribeFaq,
kendra:ListTagsForResource

Delete

kendra:DeleteFaq,
kendra:DescribeFaq

List

kendra:ListFaqs