[ aws . kendra ]

describe-query-suggestions-block-list

Description

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.

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 | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--index-id (string)

The identifier of the index for the block list.

--id (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

IndexId -> (string)

The identifier of the index for the block list.

Id -> (string)

The identifier of the block list.

Name -> (string)

The name of the block list.

Description -> (string)

The description for the block list.

Status -> (string)

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

ErrorMessage -> (string)

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

CreatedAt -> (timestamp)

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

UpdatedAt -> (timestamp)

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)

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

FileSizeBytes -> (long)

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

RoleArn -> (string)

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.