GetIndexResult

data class GetIndexResult(val arn: String? = null, val capacityUnits: IndexCapacityUnitsConfiguration? = null, val description: String? = null, val documentMetadataConfigurations: List<IndexDocumentMetadataConfiguration>? = null, val id: String? = null, val name: String? = null, val roleArn: String? = null, val tags: List<Tag>? = null, val userContextPolicy: IndexUserContextPolicy? = null, val userTokenConfigurations: List<IndexUserTokenConfiguration>? = null)

Constructors

Link copied to clipboard
constructor(arn: String? = null, capacityUnits: IndexCapacityUnitsConfiguration? = null, description: String? = null, documentMetadataConfigurations: List<IndexDocumentMetadataConfiguration>? = null, id: String? = null, name: String? = null, roleArn: String? = null, tags: List<Tag>? = null, userContextPolicy: IndexUserContextPolicy? = null, userTokenConfigurations: List<IndexUserTokenConfiguration>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String? = null

The Amazon Resource Name (ARN) of the index. For example: arn:aws:kendra:us-west-2:111122223333:index/0123456789abcdef .

Link copied to clipboard
Link copied to clipboard
val description: String? = null

A description for the index

Link copied to clipboard

Document metadata configurations

Link copied to clipboard
val id: String? = null

The identifier for the index. For example: f4aeaa10-8056-4b2c-a343-522ca0f41234 .

Link copied to clipboard
val name: String? = null

The name of the index.

Link copied to clipboard
val roleArn: String? = null

An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

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

Tags for labeling the index

Link copied to clipboard

The user context policy. ATTRIBUTE_FILTER

Link copied to clipboard

Defines the type of user token used for the index.