Class: Aws::Kendra::Types::ColumnConfiguration

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

Overview

Note:

When making an API call, you may pass ColumnConfiguration data as a hash:

{
  document_id_column_name: "ColumnName", # required
  document_data_column_name: "ColumnName", # required
  document_title_column_name: "ColumnName",
  field_mappings: [
    {
      data_source_field_name: "DataSourceFieldName", # required
      date_field_format: "DataSourceDateFieldFormat",
      index_field_name: "IndexFieldName", # required
    },
  ],
  change_detecting_columns: ["ColumnName"], # required
}

Provides information about how Amazon Kendra should use the columns of a database in an index.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#change_detecting_columnsArray<String>

One to five columns that indicate when a document in the database has changed.

Returns:

  • (Array<String>)

805
806
807
808
809
810
811
812
813
# File 'lib/aws-sdk-kendra/types.rb', line 805

class ColumnConfiguration < Struct.new(
  :document_id_column_name,
  :document_data_column_name,
  :document_title_column_name,
  :field_mappings,
  :change_detecting_columns)
  SENSITIVE = []
  include Aws::Structure
end

#document_data_column_nameString

The column that contains the contents of the document.

Returns:

  • (String)

805
806
807
808
809
810
811
812
813
# File 'lib/aws-sdk-kendra/types.rb', line 805

class ColumnConfiguration < Struct.new(
  :document_id_column_name,
  :document_data_column_name,
  :document_title_column_name,
  :field_mappings,
  :change_detecting_columns)
  SENSITIVE = []
  include Aws::Structure
end

#document_id_column_nameString

The column that provides the document's unique identifier.

Returns:

  • (String)

805
806
807
808
809
810
811
812
813
# File 'lib/aws-sdk-kendra/types.rb', line 805

class ColumnConfiguration < Struct.new(
  :document_id_column_name,
  :document_data_column_name,
  :document_title_column_name,
  :field_mappings,
  :change_detecting_columns)
  SENSITIVE = []
  include Aws::Structure
end

#document_title_column_nameString

The column that contains the title of the document.

Returns:

  • (String)

805
806
807
808
809
810
811
812
813
# File 'lib/aws-sdk-kendra/types.rb', line 805

class ColumnConfiguration < Struct.new(
  :document_id_column_name,
  :document_data_column_name,
  :document_title_column_name,
  :field_mappings,
  :change_detecting_columns)
  SENSITIVE = []
  include Aws::Structure
end

#field_mappingsArray<Types::DataSourceToIndexFieldMapping>

An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex operation.


805
806
807
808
809
810
811
812
813
# File 'lib/aws-sdk-kendra/types.rb', line 805

class ColumnConfiguration < Struct.new(
  :document_id_column_name,
  :document_data_column_name,
  :document_title_column_name,
  :field_mappings,
  :change_detecting_columns)
  SENSITIVE = []
  include Aws::Structure
end