Class: Aws::Kendra::Types::ConfluencePageConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::ConfluencePageConfiguration

Defined in:

gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

Note:

When making an API call, you may pass ConfluencePageConfiguration data as a hash:

{
  page_field_mappings: [
    {
      data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_STATUS, CREATED_DATE, DISPLAY_URL, ITEM_TYPE, LABELS, MODIFIED_DATE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
      date_field_format: "DataSourceDateFieldFormat",
      index_field_name: "IndexFieldName",
    },
  ],
}

Configuration of the page settings for the Confluence data source.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #page_field_mappings ⇒ Array<Types::ConfluencePageToIndexFieldMapping>

  Maps attributes or field names of Confluence pages to Amazon Kendra index field names.

Instance Attribute Details

#page_field_mappings ⇒ Array<Types::ConfluencePageToIndexFieldMapping>

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

If you specify the PageFieldMappings parameter, you must specify at least one field mapping.

Returns:

• (Array<Types::ConfluencePageToIndexFieldMapping>)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1999

class ConfluencePageConfiguration < Struct.new(
  :page_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end