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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#crawl_attachmentsBoolean

TRUE to index attachments to service catalog items.

Returns:

  • (Boolean)


9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
# File 'gems/aws-sdk-kendra/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_nameString

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

Returns:

  • (String)


9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
# File 'gems/aws-sdk-kendra/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_nameString

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

Returns:

  • (String)


9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
# File 'gems/aws-sdk-kendra/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_patternsArray<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>)


9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
# File 'gems/aws-sdk-kendra/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_mappingsArray<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.



9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
# File 'gems/aws-sdk-kendra/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_patternsArray<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>)


9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
# File 'gems/aws-sdk-kendra/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