Class: Aws::Kendra::Types::DataSourceToIndexFieldMapping

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

Overview

Maps attributes or field names of the documents synced from the data source to Amazon Kendra index field names. You can set up field mappings for each data source when calling [CreateDataSource] or

UpdateDataSource][2

API. To create custom fields, use the

‘UpdateIndex` API to first create an index field and then map to the data source field. For more information, see [Mapping data source fields].

[1]: docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html [2]: docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateDataSource.html [3]: docs.aws.amazon.com/kendra/latest/dg/field-mapping.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_source_field_name ⇒ String

The name of the field in the data source. You must first create the index field using the ‘UpdateIndex` API.

Returns:

  • (String) 


3146
3147
3148
3149
3150
3151
3152
 
# File 'lib/aws-sdk-kendra/types.rb', line 3146

class DataSourceToIndexFieldMapping < Struct.new(
  :data_source_field_name,
  :date_field_format,
  :index_field_name)
  SENSITIVE = []
  include Aws::Structure
end

#date_field_format ⇒ String

The format for date fields in the data source. If the field specified in ‘DataSourceFieldName` is a date field, you must specify the date format. If the field is not a date field, an exception is thrown.

Returns:

  • (String) 


3146
3147
3148
3149
3150
3151
3152
 
# File 'lib/aws-sdk-kendra/types.rb', line 3146

class DataSourceToIndexFieldMapping < Struct.new(
  :data_source_field_name,
  :date_field_format,
  :index_field_name)
  SENSITIVE = []
  include Aws::Structure
end

#index_field_name ⇒ String

The name of the index field to map to the data source field. The index field type must match the data source field type.

Returns:

  • (String) 


3146
3147
3148
3149
3150
3151
3152
 
# File 'lib/aws-sdk-kendra/types.rb', line 3146

class DataSourceToIndexFieldMapping < Struct.new(
  :data_source_field_name,
  :date_field_format,
  :index_field_name)
  SENSITIVE = []
  include Aws::Structure
end