DescribeIndexResponse

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A query or document storage capacity of zero indicates that the index is using the default capacity. For more information on the default capacity for an index and adjusting this, see Adjusting capacity.

Link copied to clipboard

The Unix timestamp when the index was created.

Link copied to clipboard

The description for the index.

Link copied to clipboard

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

Link copied to clipboard

The Amazon Kendra edition used for the index. You decide the edition when you create the index.

Link copied to clipboard

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

Link copied to clipboard
val id: String?

The identifier of the index.

Link copied to clipboard

Provides information about the number of FAQ questions and answers and the number of text documents indexed.

Link copied to clipboard
val name: String?

The name of the index.

Link copied to clipboard

The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon Cloudwatch logs.

Link copied to clipboard

The identifier of the KMScustomer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.

Link copied to clipboard

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.

Link copied to clipboard

The Unix when the index was last updated.

Link copied to clipboard

The user context policy for the Amazon Kendra index.

Link copied to clipboard

Whether you have enabled the configuration for fetching access levels of groups and users from an IAM Identity Center identity source.

Link copied to clipboard

The user token configuration for the Amazon Kendra index.

Functions

Link copied to clipboard
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String