Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration

Documentation

data ServiceNowKnowledgeArticleConfiguration

Provides the configuration information for crawling knowledge articles in the ServiceNow site.

See: newServiceNowKnowledgeArticleConfiguration smart constructor.

Constructors

ServiceNowKnowledgeArticleConfiguration'

Fields

• crawlAttachments :: Maybe Bool

  TRUE to index attachments to knowledge articles.

• documentTitleFieldName :: Maybe Text

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

• excludeAttachmentFilePatterns :: Maybe [Text]

  A list of regular expression patterns to exclude certain attachments of knowledge articles 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 field specified in the PatternTargetField.

• fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)

  Maps attributes or field names of knoweldge articles 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.

• filterQuery :: Maybe Text

  A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.

  The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query.

• includeAttachmentFilePatterns :: Maybe [Text]

  A list of regular expression patterns to include certain attachments of knowledge articles 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 field specified in the PatternTargetField.

• documentDataFieldName :: Text

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

Instances

FromJSON ServiceNowKnowledgeArticleConfiguration

Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration

Methods

parseJSON :: Value -> Parser ServiceNowKnowledgeArticleConfiguration

parseJSONList :: Value -> Parser [ServiceNowKnowledgeArticleConfiguration]

ToJSON ServiceNowKnowledgeArticleConfiguration

Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration

Methods

toJSON :: ServiceNowKnowledgeArticleConfiguration -> Value

toEncoding :: ServiceNowKnowledgeArticleConfiguration -> Encoding

toJSONList :: [ServiceNowKnowledgeArticleConfiguration] -> Value

toEncodingList :: [ServiceNowKnowledgeArticleConfiguration] -> Encoding

Generic ServiceNowKnowledgeArticleConfiguration

Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration

Associated Types

type Rep ServiceNowKnowledgeArticleConfiguration :: Type -> Type

Methods

from :: ServiceNowKnowledgeArticleConfiguration -> Rep ServiceNowKnowledgeArticleConfiguration x

to :: Rep ServiceNowKnowledgeArticleConfiguration x -> ServiceNowKnowledgeArticleConfiguration

Read ServiceNowKnowledgeArticleConfiguration

Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration

Methods

readsPrec :: Int -> ReadS ServiceNowKnowledgeArticleConfiguration

readList :: ReadS [ServiceNowKnowledgeArticleConfiguration]

readPrec :: ReadPrec ServiceNowKnowledgeArticleConfiguration

readListPrec :: ReadPrec [ServiceNowKnowledgeArticleConfiguration]

Show ServiceNowKnowledgeArticleConfiguration

Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration

Methods

showsPrec :: Int -> ServiceNowKnowledgeArticleConfiguration -> ShowS

show :: ServiceNowKnowledgeArticleConfiguration -> String

showList :: [ServiceNowKnowledgeArticleConfiguration] -> ShowS

NFData ServiceNowKnowledgeArticleConfiguration

Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration

Methods

rnf :: ServiceNowKnowledgeArticleConfiguration -> ()

Eq ServiceNowKnowledgeArticleConfiguration

Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration

Methods

(==) :: ServiceNowKnowledgeArticleConfiguration -> ServiceNowKnowledgeArticleConfiguration -> Bool

(/=) :: ServiceNowKnowledgeArticleConfiguration -> ServiceNowKnowledgeArticleConfiguration -> Bool

Hashable ServiceNowKnowledgeArticleConfiguration

Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration

Methods

hashWithSalt :: Int -> ServiceNowKnowledgeArticleConfiguration -> Int

hash :: ServiceNowKnowledgeArticleConfiguration -> Int

type Rep ServiceNowKnowledgeArticleConfiguration

Defined in Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration

type Rep ServiceNowKnowledgeArticleConfiguration = D1 ('MetaData "ServiceNowKnowledgeArticleConfiguration" "Amazonka.Kendra.Types.ServiceNowKnowledgeArticleConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ServiceNowKnowledgeArticleConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "crawlAttachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "documentTitleFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "excludeAttachmentFilePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: S1 ('MetaSel ('Just "filterQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "includeAttachmentFilePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "documentDataFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newServiceNowKnowledgeArticleConfiguration

Arguments

:: Text

$sel:documentDataFieldName:ServiceNowKnowledgeArticleConfiguration'

-> ServiceNowKnowledgeArticleConfiguration

Create a value of ServiceNowKnowledgeArticleConfiguration 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:ServiceNowKnowledgeArticleConfiguration', serviceNowKnowledgeArticleConfiguration_crawlAttachments - TRUE to index attachments to knowledge articles.

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

$sel:excludeAttachmentFilePatterns:ServiceNowKnowledgeArticleConfiguration', serviceNowKnowledgeArticleConfiguration_excludeAttachmentFilePatterns - A list of regular expression patterns to exclude certain attachments of knowledge articles 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 field specified in the PatternTargetField.

$sel:fieldMappings:ServiceNowKnowledgeArticleConfiguration', serviceNowKnowledgeArticleConfiguration_fieldMappings - Maps attributes or field names of knoweldge articles 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:filterQuery:ServiceNowKnowledgeArticleConfiguration', serviceNowKnowledgeArticleConfiguration_filterQuery - A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.

The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query.

$sel:includeAttachmentFilePatterns:ServiceNowKnowledgeArticleConfiguration', serviceNowKnowledgeArticleConfiguration_includeAttachmentFilePatterns - A list of regular expression patterns to include certain attachments of knowledge articles 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 field specified in the PatternTargetField.

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

serviceNowKnowledgeArticleConfiguration_crawlAttachments :: Lens' ServiceNowKnowledgeArticleConfiguration (Maybe Bool)

TRUE to index attachments to knowledge articles.

serviceNowKnowledgeArticleConfiguration_documentTitleFieldName :: Lens' ServiceNowKnowledgeArticleConfiguration (Maybe Text)

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

serviceNowKnowledgeArticleConfiguration_excludeAttachmentFilePatterns :: Lens' ServiceNowKnowledgeArticleConfiguration (Maybe [Text])

A list of regular expression patterns to exclude certain attachments of knowledge articles 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 field specified in the PatternTargetField.

serviceNowKnowledgeArticleConfiguration_fieldMappings :: Lens' ServiceNowKnowledgeArticleConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))

Maps attributes or field names of knoweldge articles 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.

serviceNowKnowledgeArticleConfiguration_filterQuery :: Lens' ServiceNowKnowledgeArticleConfiguration (Maybe Text)

A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.

The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query.

serviceNowKnowledgeArticleConfiguration_includeAttachmentFilePatterns :: Lens' ServiceNowKnowledgeArticleConfiguration (Maybe [Text])

A list of regular expression patterns to include certain attachments of knowledge articles 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 field specified in the PatternTargetField.

serviceNowKnowledgeArticleConfiguration_documentDataFieldName :: Lens' ServiceNowKnowledgeArticleConfiguration Text

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