class Aws::Kendra::Types::ServiceNowServiceCatalogConfiguration

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

@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
        },
      ],
    }

@!attribute [rw] crawl_attachments

Indicates whether Amazon Kendra should crawl attachments to the
service catalog items.
@return [Boolean]

@!attribute [rw] include_attachment_file_patterns

A list of regular expression patterns. Documents that match the
patterns are included in the index. Documents that don't match the
patterns are excluded from the index. If a document matches both an
exclusion pattern and an inclusion pattern, the document is not
included in the index.

The regex is applied to the file name of the attachment.
@return [Array<String>]

@!attribute [rw] exclude_attachment_file_patterns

A list of regular expression patterns. Documents that match the
patterns are excluded from the index. Documents that don't match
the patterns are included in the index. If a document matches both
an exclusion pattern and an inclusion pattern, the document is not
included in the index.

The regex is applied to the file name of the attachment.
@return [Array<String>]

@!attribute [rw] document_data_field_name

The name of the ServiceNow field that is mapped to the index
document contents field in the Amazon Kendra index.
@return [String]

@!attribute [rw] document_title_field_name

The name of the ServiceNow field that is mapped to the index
document title field.
@return [String]

@!attribute [rw] field_mappings

Mapping between ServiceNow fields and Amazon Kendra index fields.
You must create the index field before you map the field.
@return [Array<Types::DataSourceToIndexFieldMapping>]

@see docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowServiceCatalogConfiguration AWS API Documentation

Constants

SENSITIVE