Class: Aws::Kendra::Types::SalesforceChatterFeedConfiguration

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

{
  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
    },
  ],
  include_filter_types: ["ACTIVE_USER"], # accepts ACTIVE_USER, STANDARD_USER
}

Defines configuration for syncing a Salesforce chatter feed. The contents of the object comes from the Salesforce FeedItem table.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document_data_field_nameString

The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the `Body` column.

Returns:

  • (String)

4959
4960
4961
4962
4963
4964
4965
4966
# File 'lib/aws-sdk-kendra/types.rb', line 4959

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

#document_title_field_nameString

The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the `Title` collumn.

Returns:

  • (String)

4959
4960
4961
4962
4963
4964
4965
4966
# File 'lib/aws-sdk-kendra/types.rb', line 4959

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

#field_mappingsArray<Types::DataSourceToIndexFieldMapping>

Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.


4959
4960
4961
4962
4963
4964
4965
4966
# File 'lib/aws-sdk-kendra/types.rb', line 4959

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

#include_filter_typesArray<String>

Filters the documents in the feed based on status of the user. When you specify `ACTIVE_USERS` only documents from users who have an active account are indexed. When you specify `STANDARD_USER` only documents for Salesforce standard users are documented. You can specify both.

Returns:

  • (Array<String>)

4959
4960
4961
4962
4963
4964
4965
4966
# File 'lib/aws-sdk-kendra/types.rb', line 4959

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