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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

A summary of information about an index.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#created_atTime

The Unix timestamp when the index was created.

Returns:

  • (Time)

3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
# 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

#editionString

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

Returns:

  • (String)

3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
# 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

#idString

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)

3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
# 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

#nameString

The name of the index.

Returns:

  • (String)

3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
# 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

#statusString

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

Returns:

  • (String)

3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
# 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_atTime

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

Returns:

  • (Time)

3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
# 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