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

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::IndexConfigurationSummary

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

A summary of information about an index.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created_at ⇒ 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.

• #id ⇒ String

  A unique identifier for the index.

• #name ⇒ String

  The name of the index.

• #status ⇒ String

  The current status of the index.

• #updated_at ⇒ Time

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

Instance Attribute Details

#created_at ⇒ Time

The Unix timestamp when the index was created.

Returns:

• (Time)

# File 'lib/aws-sdk-kendra/types.rb', line 3738

class IndexConfigurationSummary < Struct.new(
  :name,
  :id,
  :edition,
  :created_at,
  :updated_at,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#edition ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 3738

class IndexConfigurationSummary < Struct.new(
  :name,
  :id,
  :edition,
  :created_at,
  :updated_at,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-kendra/types.rb', line 3738

class IndexConfigurationSummary < Struct.new(
  :name,
  :id,
  :edition,
  :created_at,
  :updated_at,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the index.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 3738

class IndexConfigurationSummary < Struct.new(
  :name,
  :id,
  :edition,
  :created_at,
  :updated_at,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 3738

class IndexConfigurationSummary < Struct.new(
  :name,
  :id,
  :edition,
  :created_at,
  :updated_at,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-kendra/types.rb', line 3738

class IndexConfigurationSummary < Struct.new(
  :name,
  :id,
  :edition,
  :created_at,
  :updated_at,
  :status)
  SENSITIVE = []
  include Aws::Structure
end