Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kendra.Types.ConfluencePageConfiguration

Description

Synopsis

Documentation

data ConfluencePageConfiguration Source #

Configuration of the page settings for the Confluence data source.

See: newConfluencePageConfiguration smart constructor.

Constructors

ConfluencePageConfiguration'

Fields

pageFieldMappings :: Maybe (NonEmpty ConfluencePageToIndexFieldMapping)
Maps attributes or field names of Confluence pages 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 PageFieldMappings parameter, you must specify at least one field mapping.

Instances

Instances details

FromJSON ConfluencePageConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration Methods parseJSON :: Value -> Parser ConfluencePageConfiguration # parseJSONList :: Value -> Parser [ConfluencePageConfiguration] #
ToJSON ConfluencePageConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration Methods toJSON :: ConfluencePageConfiguration -> Value # toEncoding :: ConfluencePageConfiguration -> Encoding # toJSONList :: [ConfluencePageConfiguration] -> Value # toEncodingList :: [ConfluencePageConfiguration] -> Encoding #
Generic ConfluencePageConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration Associated Types type Rep ConfluencePageConfiguration :: Type -> Type # Methods from :: ConfluencePageConfiguration -> Rep ConfluencePageConfiguration x # to :: Rep ConfluencePageConfiguration x -> ConfluencePageConfiguration #
Read ConfluencePageConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration Methods readsPrec :: Int -> ReadS ConfluencePageConfiguration # readList :: ReadS [ConfluencePageConfiguration] # readPrec :: ReadPrec ConfluencePageConfiguration # readListPrec :: ReadPrec [ConfluencePageConfiguration] #
Show ConfluencePageConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration Methods showsPrec :: Int -> ConfluencePageConfiguration -> ShowS # show :: ConfluencePageConfiguration -> String # showList :: [ConfluencePageConfiguration] -> ShowS #
NFData ConfluencePageConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration Methods rnf :: ConfluencePageConfiguration -> () #
Eq ConfluencePageConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration Methods (==) :: ConfluencePageConfiguration -> ConfluencePageConfiguration -> Bool # (/=) :: ConfluencePageConfiguration -> ConfluencePageConfiguration -> Bool #
Hashable ConfluencePageConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration Methods hashWithSalt :: Int -> ConfluencePageConfiguration -> Int # hash :: ConfluencePageConfiguration -> Int #
type Rep ConfluencePageConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluencePageConfiguration type Rep ConfluencePageConfiguration = D1 ('MetaData "ConfluencePageConfiguration" "Amazonka.Kendra.Types.ConfluencePageConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConfluencePageConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pageFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ConfluencePageToIndexFieldMapping)))))

newConfluencePageConfiguration :: ConfluencePageConfiguration Source #

Create a value of ConfluencePageConfiguration 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:pageFieldMappings:ConfluencePageConfiguration', confluencePageConfiguration_pageFieldMappings - Maps attributes or field names of Confluence pages 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 PageFieldMappings parameter, you must specify at least one field mapping.

confluencePageConfiguration_pageFieldMappings :: Lens' ConfluencePageConfiguration (Maybe (NonEmpty ConfluencePageToIndexFieldMapping)) Source #

Maps attributes or field names of Confluence pages 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 PageFieldMappings parameter, you must specify at least one field mapping.