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

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

Overview

Summary information on the configuration of 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)


6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
# File 'lib/aws-sdk-kendra/types.rb', line 6516

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)


6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
# File 'lib/aws-sdk-kendra/types.rb', line 6516

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

#idString

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

Returns:

  • (String)


6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
# File 'lib/aws-sdk-kendra/types.rb', line 6516

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)


6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
# File 'lib/aws-sdk-kendra/types.rb', line 6516

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)


6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
# File 'lib/aws-sdk-kendra/types.rb', line 6516

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.

Returns:

  • (Time)


6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
# File 'lib/aws-sdk-kendra/types.rb', line 6516

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