GetIndexResult

data class GetIndexResult(val capacityConfiguration: IndexCapacityConfiguration? = null, val createdAt: String? = null, val description: String? = null, val displayName: String? = null, val documentAttributeConfigurations: List<IndexDocumentAttributeConfiguration>? = null, val indexArn: String? = null, val indexId: String? = null, val indexStatistics: IndexStatistics? = null, val status: IndexStatus? = null, val tags: List<Tag>? = null, val updatedAt: String? = null)

Constructors

Link copied to clipboard
constructor(capacityConfiguration: IndexCapacityConfiguration? = null, createdAt: String? = null, description: String? = null, displayName: String? = null, documentAttributeConfigurations: List<IndexDocumentAttributeConfiguration>? = null, indexArn: String? = null, indexId: String? = null, indexStatistics: IndexStatistics? = null, status: IndexStatus? = null, tags: List<Tag>? = null, updatedAt: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.

Link copied to clipboard
val createdAt: String? = null

The Unix timestamp when the index was created.

Link copied to clipboard
val description: String? = null

A description for the Amazon Q Business index.

Link copied to clipboard
val displayName: String? = null

The name of the index.

Link copied to clipboard

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

Link copied to clipboard
val indexArn: String? = null

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

Link copied to clipboard
val indexId: String? = null

The identifier for the index.

Link copied to clipboard
Link copied to clipboard
val status: IndexStatus? = null

The current status of the index. When the status is ACTIVE , the index is ready.

Link copied to clipboard
val tags: List<Tag>? = null

A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Link copied to clipboard
val updatedAt: String? = null

The Unix timestamp when the index was last updated.