class Aws::Kendra::Types::CreateQuerySuggestionsBlockListRequest

@note When making an API call, you may pass CreateQuerySuggestionsBlockListRequest

data as a hash:

    {
      index_id: "IndexId", # required
      name: "QuerySuggestionsBlockListName", # required
      description: "Description",
      source_s3_path: { # required
        bucket: "S3BucketName", # required
        key: "S3ObjectKey", # required
      },
      client_token: "ClientTokenName",
      role_arn: "RoleArn", # required
      tags: [
        {
          key: "TagKey", # required
          value: "TagValue", # required
        },
      ],
    }

@!attribute [rw] index_id

The identifier of the index you want to create a query suggestions
block list for.
@return [String]

@!attribute [rw] name

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.
@return [String]

@!attribute [rw] description

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."
@return [String]

@!attribute [rw] source_s3_path

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][1].

[1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
@return [Types::S3Path]

@!attribute [rw] client_token

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

**A suitable default value is auto-generated.** You should normally
not need to pass this option.
@return [String]

@!attribute [rw] role_arn

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 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.
@return [String]

@!attribute [rw] tags

A tag that you can assign to a block list that categorizes the block
list.
@return [Array<Types::Tag>]

@see docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockListRequest AWS API Documentation

Constants

SENSITIVE