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

var error: ErrorDetail?

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

indexArn

var indexArn: String?

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

indexId

var indexId: String?

The identifier of the Amazon Q Business index.

indexStatistics

var indexStatistics: IndexStatistics?

Provides information about the number of documents indexed.

status

var 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.

type

var type: IndexType?

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

updatedAt

var updatedAt: Instant?

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

Functions

capacityConfiguration

fun capacityConfiguration(block: IndexCapacityConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.qbusiness.model.IndexCapacityConfiguration inside the given block

error

fun error(block: ErrorDetail.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.qbusiness.model.ErrorDetail inside the given block

indexStatistics

fun indexStatistics(block: IndexStatistics.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.qbusiness.model.IndexStatistics inside the given block