Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . kendra ]

describe-query-suggestions-block-list

Description

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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-query-suggestions-block-list
--index-id <value>
--id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--index-id (string)

The identifier of the index for the block list.

--id (string)

The unique identifier of the block list.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

IndexId -> (string)

Shows the identifier of the index for the block list.

Id -> (string)

Shows the unique identifier of the block list.

Name -> (string)

Shows the name of the block list.

Description -> (string)

Shows the description for the block list.

Status -> (string)

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

ErrorMessage -> (string)

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

CreatedAt -> (timestamp)

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

UpdatedAt -> (timestamp)

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

SourceS3Path -> (structure)

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 .

Bucket -> (string)

The name of the S3 bucket that contains the file.

Key -> (string)

The name of the file.

ItemCount -> (integer)

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

FileSizeBytes -> (long)

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

RoleArn -> (string)

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.