View a markdown version of this page

AWS::Kendra::QuerySuggestionsBlockList - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Kendra::QuerySuggestionsBlockList

Note

Amazon Kendra is no longer open to new customers. For capabilities similar to Amazon Kendra, explore Amazon Bedrock Knowledge Bases. Learn more.

Creates a block list to exlcude certain queries from suggestions.

Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion.

You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line.

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

CreateQuerySuggestionsBlockList is currently not supported in the AWS GovCloud (US-West) region.

For an example of creating a block list for query suggestions using the Python SDK, see Query suggestions block list.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Kendra::QuerySuggestionsBlockList",
  "Properties" : {
      "Description" : String,
      "IndexId" : String,
      "Name" : String,
      "RoleArn" : String,
      "SourceS3Path" : S3Path,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Kendra::QuerySuggestionsBlockList
Properties:
  Description: String
  IndexId: String
  Name: String
  RoleArn: String
  SourceS3Path: 
    S3Path
  Tags: 
    - Tag

Properties

Description

Property description not available.

Required: No

Type: String

Pattern: ^\P{C}*$

Minimum: 0

Maximum: 1000

Update requires: No interruption

IndexId

Property description not available.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$

Minimum: 36

Maximum: 36

Update requires: Replacement

Name

The name of the block list.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

Minimum: 1

Maximum: 100

Update requires: No interruption

RoleArn

Property description not available.

Required: Yes

Type: String

Pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$

Minimum: 0

Maximum: 1284

Update requires: No interruption

SourceS3Path

Information required to find a specific file in an Amazon S3 bucket.

Required: Yes

Type: S3Path

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

Property description not available.

Id

The identifier of a block list.