amazonka-kendra-2.0: Amazon KendraFrontendService SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Kendra.Types.ConfluenceBlogConfiguration

Description

 
Synopsis

Documentation

data ConfluenceBlogConfiguration Source #

Configuration of blog settings for the Confluence data source. Blogs are always indexed unless filtered from the index by the ExclusionPatterns or InclusionPatterns fields in the ConfluenceConfiguration object.

See: newConfluenceBlogConfiguration smart constructor.

Constructors

ConfluenceBlogConfiguration' 

Fields

  • blogFieldMappings :: Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)

    Maps attributes or field names of Confluence blogs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata.

    If you specify the BlogFieldMappings parameter, you must specify at least one field mapping.

Instances

Instances details
FromJSON ConfluenceBlogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration

ToJSON ConfluenceBlogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration

Generic ConfluenceBlogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration

Associated Types

type Rep ConfluenceBlogConfiguration :: Type -> Type #

Read ConfluenceBlogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration

Show ConfluenceBlogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration

NFData ConfluenceBlogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration

Eq ConfluenceBlogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration

Hashable ConfluenceBlogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration

type Rep ConfluenceBlogConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.ConfluenceBlogConfiguration

type Rep ConfluenceBlogConfiguration = D1 ('MetaData "ConfluenceBlogConfiguration" "Amazonka.Kendra.Types.ConfluenceBlogConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConfluenceBlogConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "blogFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)))))

newConfluenceBlogConfiguration :: ConfluenceBlogConfiguration Source #

Create a value of ConfluenceBlogConfiguration 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:blogFieldMappings:ConfluenceBlogConfiguration', confluenceBlogConfiguration_blogFieldMappings - Maps attributes or field names of Confluence blogs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata.

If you specify the BlogFieldMappings parameter, you must specify at least one field mapping.

confluenceBlogConfiguration_blogFieldMappings :: Lens' ConfluenceBlogConfiguration (Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)) Source #

Maps attributes or field names of Confluence blogs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata.

If you specify the BlogFieldMappings parameter, you must specify at least one field mapping.