Class: Aws::Kendra::Types::ServiceNowServiceCatalogConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::ServiceNowServiceCatalogConfiguration

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

Provides the configuration information for crawling service catalog items in the ServiceNow site

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #crawl_attachments ⇒ Boolean

  ‘TRUE` to index attachments to service catalog items.

• #document_data_field_name ⇒ String

  The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

• #document_title_field_name ⇒ String

  The name of the ServiceNow field that is mapped to the index document title field.

• #exclude_attachment_file_patterns ⇒ Array<String>

  A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow.

• #field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

  Maps attributes or field names of catalogs to Amazon Kendra index field names.

• #include_attachment_file_patterns ⇒ Array<String>

  A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow.

Instance Attribute Details

#crawl_attachments ⇒ Boolean

‘TRUE` to index attachments to service catalog items.

Returns:

• (Boolean)

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

class ServiceNowServiceCatalogConfiguration < Struct.new(
  :crawl_attachments,
  :include_attachment_file_patterns,
  :exclude_attachment_file_patterns,
  :document_data_field_name,
  :document_title_field_name,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#document_data_field_name ⇒ String

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

Returns:

• (String)

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

class ServiceNowServiceCatalogConfiguration < Struct.new(
  :crawl_attachments,
  :include_attachment_file_patterns,
  :exclude_attachment_file_patterns,
  :document_data_field_name,
  :document_title_field_name,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#document_title_field_name ⇒ String

The name of the ServiceNow field that is mapped to the index document title field.

Returns:

• (String)

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

class ServiceNowServiceCatalogConfiguration < Struct.new(
  :crawl_attachments,
  :include_attachment_file_patterns,
  :exclude_attachment_file_patterns,
  :document_data_field_name,
  :document_title_field_name,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#exclude_attachment_file_patterns ⇒ Array<String>

A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow. Item that match the patterns are excluded from the index. Items that don’t match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn’t included in the index.

The regex is applied to the file name of the attachment.

Returns:

• (Array<String>)

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

class ServiceNowServiceCatalogConfiguration < Struct.new(
  :crawl_attachments,
  :include_attachment_file_patterns,
  :exclude_attachment_file_patterns,
  :document_data_field_name,
  :document_title_field_name,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

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

[1]: docs.aws.amazon.com/kendra/latest/dg/field-mapping.html

Returns:

• (Array<Types::DataSourceToIndexFieldMapping>)

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

class ServiceNowServiceCatalogConfiguration < Struct.new(
  :crawl_attachments,
  :include_attachment_file_patterns,
  :exclude_attachment_file_patterns,
  :document_data_field_name,
  :document_title_field_name,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#include_attachment_file_patterns ⇒ Array<String>

A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow. Item that match the patterns are included in the index. Items that don’t match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn’t included in the index.

The regex is applied to the file name of the attachment.

Returns:

• (Array<String>)

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

class ServiceNowServiceCatalogConfiguration < Struct.new(
  :crawl_attachments,
  :include_attachment_file_patterns,
  :exclude_attachment_file_patterns,
  :document_data_field_name,
  :document_title_field_name,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end