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

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 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
    },
  ],
}

Specifies confguration 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)

5367
5368
5369
5370
5371
5372
5373
5374
# File 'lib/aws-sdk-kendra/types.rb', line 5367

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 titleB.

Returns:

  • (String)

5367
5368
5369
5370
5371
5372
5373
5374
# File 'lib/aws-sdk-kendra/types.rb', line 5367

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

#field_mappingsArray<Types::DataSourceToIndexFieldMapping>

One or more objects that map fields in the standard object to Amazon Kendra index fields. The index field must exist before you can map a Salesforce field to it.


5367
5368
5369
5370
5371
5372
5373
5374
# File 'lib/aws-sdk-kendra/types.rb', line 5367

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)

5367
5368
5369
5370
5371
5372
5373
5374
# File 'lib/aws-sdk-kendra/types.rb', line 5367

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