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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kendra/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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#change_detecting_columns ⇒ Array<String>

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

Returns:

  • (Array<String>) 


784
785
786
787
788
789
790
791
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 784

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

#document_data_column_name ⇒ String

The column that contains the contents of the document.

Returns:

  • (String) 


784
785
786
787
788
789
790
791
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 784

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

#document_id_column_name ⇒ String

The column that provides the document's unique identifier.

Returns:

  • (String) 


784
785
786
787
788
789
790
791
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 784

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

#document_title_column_name ⇒ String

The column that contains the title of the document.

Returns:

  • (String) 


784
785
786
787
788
789
790
791
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 784

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

#field_mappings ⇒ Array<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.

Returns:



784
785
786
787
788
789
790
791
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 784

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