Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1465566486.4 KB

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 Amazon Web Services GovCloud (US-West) region.

post/#X-Amz-Target=AWSKendraFrontendService.DescribeQuerySuggestionsBlockList

Headers

X-Amz-Target'AWSKendraFrontendService.DescribeQuerySuggestionsBlockList' required

Request body

IndexIdstring required

The identifier of the index for the block list.

Idstring required

The identifier of the block list you want to get information on.

Response

Success

IndexIdstring

The identifier of the index for the block list.

Idstring

The identifier of the block list.

Namestring

The name of the block list.

Descriptionstring

The description for the block list.

Status'ACTIVE' | 'CREATING' | 'DELETING' | 'UPDATING' | 'ACTIVE_BUT_UPDATE_FAILED' | 'FAILED'

The current status of the block list. When the value is <code>ACTIVE</code>, the block list is ready for use.

ErrorMessagestring

The error message containing details if there are issues processing the block list.

CreatedAtstring date-time

The Unix timestamp when a block list for query suggestions was created.

UpdatedAtstring date-time

The Unix timestamp when a block list for query suggestions was last updated.

ItemCountinteger

The current number of valid, non-empty words or phrases in the block list text file.

FileSizeBytesinteger

The current size of the block list text file in S3.

RoleArnstring
<p>The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in S3.</p> <p>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.</p>