/AWS1/CL_KNDDSCQUERYSUGGESTI01

DescribeQuerySuggestionsBlockListResponse

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_indexid TYPE /AWS1/KNDINDEXID /AWS1/KNDINDEXID

The identifier of the index for the block list.

iv_id TYPE /AWS1/KNDQUERYSUGGESTIONSBLK01 /AWS1/KNDQUERYSUGGESTIONSBLK01

The identifier of the block list.

iv_name TYPE /AWS1/KNDQUERYSUGGESTIONSBLK00 /AWS1/KNDQUERYSUGGESTIONSBLK00

The name of the block list.

iv_description TYPE /AWS1/KNDDESCRIPTION /AWS1/KNDDESCRIPTION

The description for the block list.

iv_status TYPE /AWS1/KNDQUERYSUGGESTIONSBLK02 /AWS1/KNDQUERYSUGGESTIONSBLK02

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

iv_errormessage TYPE /AWS1/KNDERRORMESSAGE /AWS1/KNDERRORMESSAGE

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

iv_createdat TYPE /AWS1/KNDTIMESTAMP /AWS1/KNDTIMESTAMP

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

iv_updatedat TYPE /AWS1/KNDTIMESTAMP /AWS1/KNDTIMESTAMP

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

io_sources3path TYPE REF TO /AWS1/CL_KNDS3PATH /AWS1/CL_KNDS3PATH

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.

iv_itemcount TYPE /AWS1/KNDINTEGER /AWS1/KNDINTEGER

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

iv_filesizebytes TYPE /AWS1/KNDLONG /AWS1/KNDLONG

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

iv_rolearn TYPE /AWS1/KNDROLEARN /AWS1/KNDROLEARN

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.

---

Queryable Attributes

IndexId

The identifier of the index for the block list.

Accessible with the following methods

Method	Description
GET_INDEXID()	Getter for INDEXID, with configurable default
ASK_INDEXID()	Getter for INDEXID w/ exceptions if field has no value
HAS_INDEXID()	Determine if INDEXID has a value

Id

The identifier of the block list.

Accessible with the following methods

Method	Description
GET_ID()	Getter for ID, with configurable default
ASK_ID()	Getter for ID w/ exceptions if field has no value
HAS_ID()	Determine if ID has a value

Name

The name of the block list.

Accessible with the following methods

Method	Description
GET_NAME()	Getter for NAME, with configurable default
ASK_NAME()	Getter for NAME w/ exceptions if field has no value
HAS_NAME()	Determine if NAME has a value

Description

The description for the block list.

Accessible with the following methods

Method	Description
GET_DESCRIPTION()	Getter for DESCRIPTION, with configurable default
ASK_DESCRIPTION()	Getter for DESCRIPTION w/ exceptions if field has no value
HAS_DESCRIPTION()	Determine if DESCRIPTION has a value

Status

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

Accessible with the following methods

Method	Description
GET_STATUS()	Getter for STATUS, with configurable default
ASK_STATUS()	Getter for STATUS w/ exceptions if field has no value
HAS_STATUS()	Determine if STATUS has a value

ErrorMessage

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

Accessible with the following methods

Method	Description
GET_ERRORMESSAGE()	Getter for ERRORMESSAGE, with configurable default
ASK_ERRORMESSAGE()	Getter for ERRORMESSAGE w/ exceptions if field has no value
HAS_ERRORMESSAGE()	Determine if ERRORMESSAGE has a value

CreatedAt

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

Accessible with the following methods

Method	Description
GET_CREATEDAT()	Getter for CREATEDAT, with configurable default
ASK_CREATEDAT()	Getter for CREATEDAT w/ exceptions if field has no value
HAS_CREATEDAT()	Determine if CREATEDAT has a value

UpdatedAt

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

Accessible with the following methods

Method	Description
GET_UPDATEDAT()	Getter for UPDATEDAT, with configurable default
ASK_UPDATEDAT()	Getter for UPDATEDAT w/ exceptions if field has no value
HAS_UPDATEDAT()	Determine if UPDATEDAT has a value

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.

Accessible with the following methods

Method	Description
GET_SOURCES3PATH()	Getter for SOURCES3PATH

ItemCount

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

Accessible with the following methods

Method	Description
GET_ITEMCOUNT()	Getter for ITEMCOUNT, with configurable default
ASK_ITEMCOUNT()	Getter for ITEMCOUNT w/ exceptions if field has no value
HAS_ITEMCOUNT()	Determine if ITEMCOUNT has a value

FileSizeBytes

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

Accessible with the following methods

Method	Description
GET_FILESIZEBYTES()	Getter for FILESIZEBYTES, with configurable default
ASK_FILESIZEBYTES()	Getter for FILESIZEBYTES w/ exceptions if field has no value
HAS_FILESIZEBYTES()	Determine if FILESIZEBYTES has a value

RoleArn

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.

Accessible with the following methods

Method	Description
GET_ROLEARN()	Getter for ROLEARN, with configurable default
ASK_ROLEARN()	Getter for ROLEARN w/ exceptions if field has no value
HAS_ROLEARN()	Determine if ROLEARN has a value