Class: Aws::Kendra::Types::SalesforceKnowledgeArticleConfiguration

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

{
  included_states: ["DRAFT"], # required, accepts DRAFT, PUBLISHED, ARCHIVED
  standard_knowledge_article_type_configuration: {
    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
      },
    ],
  },
  custom_knowledge_article_type_configurations: [
    {
      name: "SalesforceCustomKnowledgeArticleTypeName", # required
      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 the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#custom_knowledge_article_type_configurations ⇒ Array<Types::SalesforceCustomKnowledgeArticleTypeConfiguration>

Configuration information for custom Salesforce knowledge articles.

Returns:



11147
11148
11149
11150
11151
11152
11153
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 11147

class SalesforceKnowledgeArticleConfiguration < Struct.new(
  :included_states,
  :standard_knowledge_article_type_configuration,
  :custom_knowledge_article_type_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#included_states ⇒ Array<String>

Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.

Returns:

  • (Array<String>) 


11147
11148
11149
11150
11151
11152
11153
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 11147

class SalesforceKnowledgeArticleConfiguration < Struct.new(
  :included_states,
  :standard_knowledge_article_type_configuration,
  :custom_knowledge_article_type_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#standard_knowledge_article_type_configuration ⇒ Types::SalesforceStandardKnowledgeArticleTypeConfiguration

Configuration information for standard Salesforce knowledge articles.

Returns:



11147
11148
11149
11150
11151
11152
11153
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 11147

class SalesforceKnowledgeArticleConfiguration < Struct.new(
  :included_states,
  :standard_knowledge_article_type_configuration,
  :custom_knowledge_article_type_configurations)
  SENSITIVE = []
  include Aws::Structure
end