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.

error

val error: ErrorDetail?

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

indexArn

val indexArn: String?

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

indexId

val indexId: String?

The identifier of the Amazon Q index.

indexStatistics

val indexStatistics: IndexStatistics?

Provides information about the number of documents indexed.

status

val status: IndexStatus?

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.

updatedAt

val updatedAt: Instant?

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

Functions

copy

inline fun copy(block: GetIndexResponse.Builder.() -> Unit = {}): GetIndexResponse

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String