Documentation

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

See: newServiceNowServiceCatalogConfiguration smart constructor.

Create a value of ServiceNowServiceCatalogConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:crawlAttachments:ServiceNowServiceCatalogConfiguration', serviceNowServiceCatalogConfiguration_crawlAttachments - TRUE to index attachments to service catalog items.

$sel:documentTitleFieldName:ServiceNowServiceCatalogConfiguration', serviceNowServiceCatalogConfiguration_documentTitleFieldName - The name of the ServiceNow field that is mapped to the index document title field.

$sel:excludeAttachmentFilePatterns:ServiceNowServiceCatalogConfiguration', serviceNowServiceCatalogConfiguration_excludeAttachmentFilePatterns - 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.

$sel:fieldMappings:ServiceNowServiceCatalogConfiguration', serviceNowServiceCatalogConfiguration_fieldMappings - 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.

$sel:includeAttachmentFilePatterns:ServiceNowServiceCatalogConfiguration', serviceNowServiceCatalogConfiguration_includeAttachmentFilePatterns - 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.

$sel:documentDataFieldName:ServiceNowServiceCatalogConfiguration', serviceNowServiceCatalogConfiguration_documentDataFieldName - The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

TRUE to index attachments to service catalog items.

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

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.

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.

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.

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