CreateQuerySuggestionsBlockListRequest

import type { CreateQuerySuggestionsBlockListRequest } from "https://aws-api.deno.dev/v0.4/services/kendra.ts?docs=full";

interface CreateQuerySuggestionsBlockListRequest {

ClientToken?: string | null;

Description?: string | null;

IndexId: string;

Name: string;

RoleArn: string;

SourceS3Path: S3Path;

Tags?: Tag[] | null;

}

§Properties

ClientToken?: string | null

[src]

A token that you provide to identify the request to create a query suggestions block list.

Description?: string | null

[src]

A user-friendly description for the block list.

For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."

IndexId: string

[src]

The identifier of the index you want to create a query suggestions block list for.

Name: string

[src]

A user friendly name for the block list.

For example, the block list named 'offensive-words' includes all offensive words that could appear in user queries and need to be blocked from suggestions.

RoleArn: string

[src]

The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.

You need permissions to the role ARN (Amazon Web Services Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

SourceS3Path: S3Path

[src]

The S3 path to your block list text file in your S3 bucket.

Each block word or phrase should be on a separate line in a text file.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

Tags?: Tag[] | null

[src]

A tag that you can assign to a block list that categorizes the block list.