/AWS1/CL_QQBGETINDEXRESPONSE

GetIndexResponse

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_applicationid TYPE /AWS1/QQBAPPLICATIONID /AWS1/QQBAPPLICATIONID

The identifier of the Amazon Q Business application associated with the index.

iv_indexid TYPE /AWS1/QQBINDEXID /AWS1/QQBINDEXID

The identifier of the Amazon Q Business index.

iv_displayname TYPE /AWS1/QQBINDEXNAME /AWS1/QQBINDEXNAME

The name of the Amazon Q Business index.

iv_indexarn TYPE /AWS1/QQBINDEXARN /AWS1/QQBINDEXARN

The Amazon Resource Name (ARN) of the Amazon Q Business index.

iv_status TYPE /AWS1/QQBINDEXSTATUS /AWS1/QQBINDEXSTATUS

The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

iv_type TYPE /AWS1/QQBINDEXTYPE /AWS1/QQBINDEXTYPE

The type of index attached to your Amazon Q Business application.

iv_description TYPE /AWS1/QQBDESCRIPTION /AWS1/QQBDESCRIPTION

The description for the Amazon Q Business index.

iv_createdat TYPE /AWS1/QQBTIMESTAMP /AWS1/QQBTIMESTAMP

The Unix timestamp when the Amazon Q Business index was created.

iv_updatedat TYPE /AWS1/QQBTIMESTAMP /AWS1/QQBTIMESTAMP

The Unix timestamp when the Amazon Q Business index was last updated.

io_capacityconfiguration TYPE REF TO /AWS1/CL_QQBINDEXCAPACITYCONF /AWS1/CL_QQBINDEXCAPACITYCONF

The storage capacity units chosen for your Amazon Q Business index.

it_documentattributeconfs TYPE /AWS1/CL_QQBDOCUMENTATTRCONF=>TT_DOCUMENTATTRIBUTECONFS TT_DOCUMENTATTRIBUTECONFS

Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

io_error TYPE REF TO /AWS1/CL_QQBERRORDETAIL /AWS1/CL_QQBERRORDETAIL

When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

io_indexstatistics TYPE REF TO /AWS1/CL_QQBINDEXSTATISTICS /AWS1/CL_QQBINDEXSTATISTICS

Provides information about the number of documents indexed.

---

Queryable Attributes

applicationId

The identifier of the Amazon Q Business application associated with the index.

Accessible with the following methods

Method	Description
GET_APPLICATIONID()	Getter for APPLICATIONID, with configurable default
ASK_APPLICATIONID()	Getter for APPLICATIONID w/ exceptions if field has no value
HAS_APPLICATIONID()	Determine if APPLICATIONID has a value

indexId

The identifier of the Amazon Q Business index.

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

displayName

The name of the Amazon Q Business index.

Accessible with the following methods

Method	Description
GET_DISPLAYNAME()	Getter for DISPLAYNAME, with configurable default
ASK_DISPLAYNAME()	Getter for DISPLAYNAME w/ exceptions if field has no value
HAS_DISPLAYNAME()	Determine if DISPLAYNAME has a value

indexArn

The Amazon Resource Name (ARN) of the Amazon Q Business index.

Accessible with the following methods

Method	Description
GET_INDEXARN()	Getter for INDEXARN, with configurable default
ASK_INDEXARN()	Getter for INDEXARN w/ exceptions if field has no value
HAS_INDEXARN()	Determine if INDEXARN has a value

status

The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

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

type

The type of index attached to your Amazon Q Business application.

Accessible with the following methods

Method	Description
GET_TYPE()	Getter for TYPE, with configurable default
ASK_TYPE()	Getter for TYPE w/ exceptions if field has no value
HAS_TYPE()	Determine if TYPE has a value

description

The description for the Amazon Q Business index.

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

createdAt

The Unix timestamp when the Amazon Q Business index 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 the Amazon Q Business index 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

capacityConfiguration

The storage capacity units chosen for your Amazon Q Business index.

Accessible with the following methods

Method	Description
GET_CAPACITYCONFIGURATION()	Getter for CAPACITYCONFIGURATION

documentAttributeConfigurations

Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

Accessible with the following methods

Method	Description
GET_DOCUMENTATTRIBUTECONFS()	Getter for DOCUMENTATTRIBUTECONFS, with configurable default
ASK_DOCUMENTATTRIBUTECONFS()	Getter for DOCUMENTATTRIBUTECONFS w/ exceptions if field has
HAS_DOCUMENTATTRIBUTECONFS()	Determine if DOCUMENTATTRIBUTECONFS has a value

error

When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

Accessible with the following methods

Method	Description
GET_ERROR()	Getter for ERROR

indexStatistics

Provides information about the number of documents indexed.

Accessible with the following methods

Method	Description
GET_INDEXSTATISTICS()	Getter for INDEXSTATISTICS