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

Class: Aws::Kendra::Types::IndexConfigurationSummary

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

Overview

A summary of information about an index.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#created_at ⇒ Time

The Unix timestamp when the index was created.

Returns:

  • (Time) —

    The Unix timestamp when the index was created.

#edition ⇒ String

Indicates whether the index is a enterprise edition index or a developer edition index.

Possible values:

  • DEVELOPER_EDITION
  • ENTERPRISE_EDITION

Returns:

  • (String) —

    Indicates whether the index is a enterprise edition index or a developer edition index.

#id ⇒ String

A unique identifier for the index. Use this to identify the index when you are using operations such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.

Returns:

  • (String) —

    A unique identifier for the index.

#name ⇒ String

The name of the index.

Returns:

  • (String) —

    The name of the index.

#status ⇒ String

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

Possible values:

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

Returns:

  • (String) —

    The current status of the index.

#updated_at ⇒ Time

The Unix timestamp when the index was last updated by the UpdateIndex operation.

Returns:

  • (Time) —

    The Unix timestamp when the index was last updated by the UpdateIndex operation.