class Aws::Kendra::Types::DescribeIndexResponse

@!attribute [rw] name

The name of the index.
@return [String]

@!attribute [rw] id

The name of the index.
@return [String]

@!attribute [rw] edition

The Amazon Kendra edition used for the index. You decide the edition
when you create the index.
@return [String]

@!attribute [rw] role_arn

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

@!attribute [rw] server_side_encryption_configuration

The identifier of the KMScustomer master key (CMK) used to encrypt
your data. Amazon Kendra doesn't support asymmetric CMKs.
@return [Types::ServerSideEncryptionConfiguration]

@!attribute [rw] status

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.
@return [String]

@!attribute [rw] description

The description of the index.
@return [String]

@!attribute [rw] created_at

The Unix datetime that the index was created.
@return [Time]

@!attribute [rw] updated_at

The Unix datetime that the index was last updated.
@return [Time]

@!attribute [rw] document_metadata_configurations

Configuration settings for any metadata applied to the documents in
the index.
@return [Array<Types::DocumentMetadataConfiguration>]

@!attribute [rw] index_statistics

Provides information about the number of FAQ questions and answers
and the number of text documents indexed.
@return [Types::IndexStatistics]

@!attribute [rw] error_message

When th e`Status` field value is `FAILED`, the `ErrorMessage` field
contains a message that explains why.
@return [String]

@!attribute [rw] capacity_units

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 0 for the query capacity or the
storage capacity indicates that the index is using the default
capacity for the index.
@return [Types::CapacityUnitsConfiguration]

@!attribute [rw] user_token_configurations

The user token configuration for the Amazon Kendra index.
@return [Array<Types::UserTokenConfiguration>]

@!attribute [rw] user_context_policy

The user context policy for the Amazon Kendra index.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndexResponse AWS API Documentation

Constants

SENSITIVE