# DescribeQuerySuggestionsBlockList
<a name="API_DescribeQuerySuggestionsBlockList"></a>

Gets information about a block list used for query suggestions for an index.

This is used to check the current settings that are applied to a block list.

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

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

```
{
   "Id": "string",
   "IndexId": "string"
}
```

## Request Parameters
<a name="API_DescribeQuerySuggestionsBlockList_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.

 ** [Id](#API_DescribeQuerySuggestionsBlockList_RequestSyntax) **   <a name="kendra-DescribeQuerySuggestionsBlockList-request-Id"></a>
The identifier of the block list you want to get information on.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`   
Required: Yes

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

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

```
{
   "CreatedAt": number,
   "Description": "string",
   "ErrorMessage": "string",
   "FileSizeBytes": number,
   "Id": "string",
   "IndexId": "string",
   "ItemCount": number,
   "Name": "string",
   "RoleArn": "string",
   "SourceS3Path": { 
      "Bucket": "string",
      "Key": "string"
   },
   "Status": "string",
   "UpdatedAt": number
}
```

## Response Elements
<a name="API_DescribeQuerySuggestionsBlockList_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.

 ** [CreatedAt](#API_DescribeQuerySuggestionsBlockList_ResponseSyntax) **   <a name="kendra-DescribeQuerySuggestionsBlockList-response-CreatedAt"></a>
The Unix timestamp when a block list for query suggestions was created.  
Type: Timestamp

 ** [Description](#API_DescribeQuerySuggestionsBlockList_ResponseSyntax) **   <a name="kendra-DescribeQuerySuggestionsBlockList-response-Description"></a>
The description for the block list.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `^\P{C}*$` 

 ** [ErrorMessage](#API_DescribeQuerySuggestionsBlockList_ResponseSyntax) **   <a name="kendra-DescribeQuerySuggestionsBlockList-response-ErrorMessage"></a>
The error message containing details if there are issues processing the block list.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^\P{C}*$` 

 ** [FileSizeBytes](#API_DescribeQuerySuggestionsBlockList_ResponseSyntax) **   <a name="kendra-DescribeQuerySuggestionsBlockList-response-FileSizeBytes"></a>
The current size of the block list text file in S3.  
Type: Long

 ** [Id](#API_DescribeQuerySuggestionsBlockList_ResponseSyntax) **   <a name="kendra-DescribeQuerySuggestionsBlockList-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-]*` 

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

 ** [ItemCount](#API_DescribeQuerySuggestionsBlockList_ResponseSyntax) **   <a name="kendra-DescribeQuerySuggestionsBlockList-response-ItemCount"></a>
The current number of valid, non-empty words or phrases in the block list text file.  
Type: Integer

 ** [Name](#API_DescribeQuerySuggestionsBlockList_ResponseSyntax) **   <a name="kendra-DescribeQuerySuggestionsBlockList-response-Name"></a>
The name of the block list.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*` 

 ** [RoleArn](#API_DescribeQuerySuggestionsBlockList_ResponseSyntax) **   <a name="kendra-DescribeQuerySuggestionsBlockList-response-RoleArn"></a>
The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in S3.  
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.  
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}` 

 ** [SourceS3Path](#API_DescribeQuerySuggestionsBlockList_ResponseSyntax) **   <a name="kendra-DescribeQuerySuggestionsBlockList-response-SourceS3Path"></a>
Shows the current 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

 ** [Status](#API_DescribeQuerySuggestionsBlockList_ResponseSyntax) **   <a name="kendra-DescribeQuerySuggestionsBlockList-response-Status"></a>
The current status of the block list. When the value is `ACTIVE`, the block list is ready for use.  
Type: String  
Valid Values: `ACTIVE | CREATING | DELETING | UPDATING | ACTIVE_BUT_UPDATE_FAILED | FAILED` 

 ** [UpdatedAt](#API_DescribeQuerySuggestionsBlockList_ResponseSyntax) **   <a name="kendra-DescribeQuerySuggestionsBlockList-response-UpdatedAt"></a>
The Unix timestamp when a block list for query suggestions was last updated.  
Type: Timestamp

## Errors
<a name="API_DescribeQuerySuggestionsBlockList_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

 ** 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

 ** 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_DescribeQuerySuggestionsBlockList_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/DescribeQuerySuggestionsBlockList) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/DescribeQuerySuggestionsBlockList) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/DescribeQuerySuggestionsBlockList) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/DescribeQuerySuggestionsBlockList) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/DescribeQuerySuggestionsBlockList) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/DescribeQuerySuggestionsBlockList) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/DescribeQuerySuggestionsBlockList) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/DescribeQuerySuggestionsBlockList) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/DescribeQuerySuggestionsBlockList) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/DescribeQuerySuggestionsBlockList)