# CreateQuerySuggestionsBlockList
<a name="API_CreateQuerySuggestionsBlockList"></a>

**Note**  
Amazon Kendra will no longer be open to new customers starting on July 30, 2026. If you would like to use the service, please sign up prior to July 30. For capabilities similar to Amazon Kendra, explore Amazon Bedrock Knowledge Bases. [Learn more](https://docs.aws.amazon.com/kendra/latest/dg/kendra-availability-change.html).

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](https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).

 `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](https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#query-suggestions-blocklist).

## Request Syntax
<a name="API_CreateQuerySuggestionsBlockList_RequestSyntax"></a>

```
{
   "ClientToken": "{{string}}",
   "Description": "{{string}}",
   "IndexId": "{{string}}",
   "Name": "{{string}}",
   "RoleArn": "{{string}}",
   "SourceS3Path": { 
      "Bucket": "{{string}}",
      "Key": "{{string}}"
   },
   "Tags": [ 
      { 
         "Key": "{{string}}",
         "Value": "{{string}}"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateQuerySuggestionsBlockList_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreateQuerySuggestionsBlockList_RequestSyntax) **   <a name="kendra-CreateQuerySuggestionsBlockList-request-ClientToken"></a>
A token that you provide to identify the request to create a query suggestions block list.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [Description](#API_CreateQuerySuggestionsBlockList_RequestSyntax) **   <a name="kendra-CreateQuerySuggestionsBlockList-request-Description"></a>
A 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."  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `^\P{C}*$`   
Required: No

 ** [IndexId](#API_CreateQuerySuggestionsBlockList_RequestSyntax) **   <a name="kendra-CreateQuerySuggestionsBlockList-request-IndexId"></a>
The identifier of the index you want to create a query suggestions block list for.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`   
Required: Yes

 ** [Name](#API_CreateQuerySuggestionsBlockList_RequestSyntax) **   <a name="kendra-CreateQuerySuggestionsBlockList-request-Name"></a>
A name for the block list.  
For example, the name 'offensive-words', which includes all offensive words that could appear in user queries and need to be blocked from suggestions.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*`   
Required: Yes

 ** [RoleArn](#API_CreateQuerySuggestionsBlockList_RequestSyntax) **   <a name="kendra-CreateQuerySuggestionsBlockList-request-RoleArn"></a>
The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the block list text file. For more information, see [IAM access roles for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1284.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [SourceS3Path](#API_CreateQuerySuggestionsBlockList_RequestSyntax) **   <a name="kendra-CreateQuerySuggestionsBlockList-request-SourceS3Path"></a>
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](https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).  
Type: [S3Path](API_S3Path.md) object  
Required: Yes

 ** [Tags](#API_CreateQuerySuggestionsBlockList_RequestSyntax) **   <a name="kendra-CreateQuerySuggestionsBlockList-request-Tags"></a>
A list of key-value pairs that identify or categorize the block list. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: \_ . : / = \+ - @.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

## Response Syntax
<a name="API_CreateQuerySuggestionsBlockList_ResponseSyntax"></a>

```
{
   "Id": "string"
}
```

## Response Elements
<a name="API_CreateQuerySuggestionsBlockList_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Id](#API_CreateQuerySuggestionsBlockList_ResponseSyntax) **   <a name="kendra-CreateQuerySuggestionsBlockList-response-Id"></a>
The identifier of the block list.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*` 

## Errors
<a name="API_CreateQuerySuggestionsBlockList_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 400

 ** ConflictException **   
A conflict occurred with the request. Please fix any inconsistences with your resources and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.  
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
You have exceeded the set limits for your Amazon Kendra service. Please see [Quotas](https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) for more information, or contact [Support](http://aws.amazon.com/contact-us/) to inquire about an increase of limits.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please reduce the number of requests and try again.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.  
HTTP Status Code: 400

## See Also
<a name="API_CreateQuerySuggestionsBlockList_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kendra-2019-02-03/CreateQuerySuggestionsBlockList) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/CreateQuerySuggestionsBlockList) 
+  [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/CreateQuerySuggestionsBlockList) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/CreateQuerySuggestionsBlockList) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/CreateQuerySuggestionsBlockList) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/CreateQuerySuggestionsBlockList) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/CreateQuerySuggestionsBlockList) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/CreateQuerySuggestionsBlockList) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/CreateQuerySuggestionsBlockList) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/CreateQuerySuggestionsBlockList)