GetIndexResponse
Types
Properties
The identifier of the Amazon Q Business application associated with the index.
The storage capacity units chosen for your Amazon Q Business index.
The description for the Amazon Q Business index.
The name of the Amazon Q Business index.
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.
When the Status
field value is FAILED
, the ErrorMessage
field contains a message that explains why.
Provides information about the number of documents indexed.
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.