DescribeQuerySuggestionsBlockList - Amazon Kendra

DescribeQuerySuggestionsBlockList

Describes 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

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

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Id

The unique identifier of the block list.

Type: String

Length Constraints: Fixed length of 36.

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

Required: Yes

IndexId

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

{ "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

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

Shows the date-time a block list for query suggestions was created.

Type: Timestamp

Description

Shows the description for the block list.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Pattern: ^\P{C}*$

ErrorMessage

Shows the error message with details when there are issues in processing the block list.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^\P{C}*$

FileSizeBytes

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

Type: Long

Id

Shows the unique identifier of the block list.

Type: String

Length Constraints: Fixed length of 36.

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

IndexId

Shows 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

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

Type: Integer

Name

Shows 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

Shows the current 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 1. 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

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.

Type: S3Path object

Status

Shows whether the current status of the block list is ACTIVE or INACTIVE.

Type: String

Valid Values: ACTIVE | CREATING | DELETING | UPDATING | ACTIVE_BUT_UPDATE_FAILED | FAILED

UpdatedAt

Shows the date-time a block list for query suggestions was last updated.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

HTTP Status Code: 400

InternalServerException

HTTP Status Code: 500

ResourceNotFoundException

HTTP Status Code: 400

ThrottlingException

HTTP Status Code: 400

ValidationException

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: