Class: Aws::Kendra::Types::SalesforceStandardObjectConfiguration

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 SalesforceStandardObjectConfiguration data as a hash:

{
  name: "ACCOUNT", # required, accepts ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK, USER
  document_data_field_name: "DataSourceFieldName", # required
  document_title_field_name: "DataSourceFieldName",
  field_mappings: [
    {
      data_source_field_name: "DataSourceFieldName", # required
      date_field_format: "DataSourceDateFieldFormat",
      index_field_name: "IndexFieldName", # required
    },
  ],
}

Provides the configuration information for indexing a single standard object.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document_data_field_nameString

The name of the field in the standard object table that contains the document contents.

Returns:

  • (String)


11456
11457
11458
11459
11460
11461
11462
11463
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 11456

class SalesforceStandardObjectConfiguration < Struct.new(
  :name,
  :document_data_field_name,
  :document_title_field_name,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#document_title_field_nameString

The name of the field in the standard object table that contains the document title.

Returns:

  • (String)


11456
11457
11458
11459
11460
11461
11462
11463
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 11456

class SalesforceStandardObjectConfiguration < Struct.new(
  :name,
  :document_data_field_name,
  :document_title_field_name,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#field_mappingsArray<Types::DataSourceToIndexFieldMapping>

Maps attributes or field names of the standard object to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.



11456
11457
11458
11459
11460
11461
11462
11463
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 11456

class SalesforceStandardObjectConfiguration < Struct.new(
  :name,
  :document_data_field_name,
  :document_title_field_name,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the standard object.

Returns:

  • (String)


11456
11457
11458
11459
11460
11461
11462
11463
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 11456

class SalesforceStandardObjectConfiguration < Struct.new(
  :name,
  :document_data_field_name,
  :document_title_field_name,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end