You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SalesforceKnowledgeArticleConfiguration as input to an Aws::Client method, you can use a vanilla 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
        },
      ],
    },
  ],
}

Specifies configuration information for the knowlege 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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#custom_knowledge_article_type_configurations ⇒ Array<Types::SalesforceCustomKnowledgeArticleTypeConfiguration>

Provides configuration information for custom Salesforce knowledge articles.

Returns:

#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>) —

    Specifies the document states that should be included when Amazon Kendra indexes knowledge articles.

#standard_knowledge_article_type_configuration ⇒ Types::SalesforceStandardKnowledgeArticleTypeConfiguration

Provides configuration information for standard Salesforce knowledge articles.

Returns: