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

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

Overview

Note:

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

{
  crawl_attachments: false,
  include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
  exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
  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 configuration information for crawling service catalog items in the ServiceNow site

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#crawl_attachmentsBoolean

Indicates whether Amazon Kendra should crawl attachments to the service catalog items.

Returns:

  • (Boolean)

5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
# File 'lib/aws-sdk-kendra/types.rb', line 5663

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)

5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
# File 'lib/aws-sdk-kendra/types.rb', line 5663

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)

5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
# File 'lib/aws-sdk-kendra/types.rb', line 5663

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>

Determines the types of file attachments that are excluded from the index.

Returns:

  • (Array<String>)

5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
# File 'lib/aws-sdk-kendra/types.rb', line 5663

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>

Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.


5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
# File 'lib/aws-sdk-kendra/types.rb', line 5663

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>

Determines the types of file attachments that are included in the index.

Returns:

  • (Array<String>)

5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
# File 'lib/aws-sdk-kendra/types.rb', line 5663

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