AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Kendra::Types::DescribeIndexResponse

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#capacity_unitsTypes::CapacityUnitsConfiguration

For enterprise edtion 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.

Returns:

#created_atTime

The Unix datetime that the index was created.

Returns:

  • (Time)

    The Unix datetime that the index was created.

#descriptionString

The description of the index.

Returns:

  • (String)

    The description of the index.

#document_metadata_configurationsArray<Types::DocumentMetadataConfiguration>

Configuration settings for any metadata applied to the documents in the index.

Returns:

#editionString

The Amazon Kendra edition used for the index. You decide the edition when you create the index.

Possible values:

  • DEVELOPER_EDITION
  • ENTERPRISE_EDITION

Returns:

  • (String)

    The Amazon Kendra edition used for the index.

#error_messageString

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

Returns:

  • (String)

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

#idString

the name of the index.

Returns:

  • (String)

    the name of the index.

#index_statisticsTypes::IndexStatistics

Provides information about the number of FAQ questions and answers and the number of text documents indexed.

Returns:

  • (Types::IndexStatistics)

    Provides information about the number of FAQ questions and answers and the number of text documents indexed.

#nameString

The name of the index.

Returns:

  • (String)

    The name of the index.

#role_arnString

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

Returns:

  • (String)

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

#server_side_encryption_configurationTypes::ServerSideEncryptionConfiguration

The identifier of the AWS KMS customer master key (CMK) used to encrypt your data. Amazon Kendra doesn\'t support asymmetric CMKs.

Returns:

#statusString

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.

Possible values:

  • CREATING
  • ACTIVE
  • DELETING
  • FAILED
  • UPDATING
  • SYSTEM_UPDATING

Returns:

  • (String)

    The current status of the index.

#updated_atTime

The Unix datetime that the index was last updated.

Returns:

  • (Time)

    The Unix datetime that the index was last updated.