Class: Aws::Kendra::Types::DataSourceToIndexFieldMapping
- Inherits:
-
Struct
- Object
- Struct
- Aws::Kendra::Types::DataSourceToIndexFieldMapping
- Defined in:
- gems/aws-sdk-kendra/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 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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#data_source_field_name ⇒ String
The name of the field in the data source.
-
#date_field_format ⇒ String
The format for date fields in the data source.
-
#index_field_name ⇒ String
The name of the index field to map to the data source field.
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.
3113 3114 3115 3116 3117 3118 3119 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3113 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.
3113 3114 3115 3116 3117 3118 3119 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3113 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.
3113 3114 3115 3116 3117 3118 3119 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3113 class DataSourceToIndexFieldMapping < Struct.new( :data_source_field_name, :date_field_format, :index_field_name) SENSITIVE = [] include Aws::Structure end |