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.ConfluencePageToIndexFieldMapping

Description

Documentation

data 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.

See: newConfluencePageToIndexFieldMapping smart constructor.

Constructors

ConfluencePageToIndexFieldMapping'

Fields

dataSourceFieldName :: Maybe ConfluencePageFieldName
The name of the field in the data source.
dateFieldFormat :: Maybe Text
The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.
indexFieldName :: Maybe Text
The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

Instances

Instances details

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

newConfluencePageToIndexFieldMapping :: ConfluencePageToIndexFieldMapping Source #

Create a value of ConfluencePageToIndexFieldMapping 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:dataSourceFieldName:ConfluencePageToIndexFieldMapping', confluencePageToIndexFieldMapping_dataSourceFieldName - The name of the field in the data source.

$sel:dateFieldFormat:ConfluencePageToIndexFieldMapping', confluencePageToIndexFieldMapping_dateFieldFormat - The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

$sel:indexFieldName:ConfluencePageToIndexFieldMapping', confluencePageToIndexFieldMapping_indexFieldName - The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

confluencePageToIndexFieldMapping_dataSourceFieldName :: Lens' ConfluencePageToIndexFieldMapping (Maybe ConfluencePageFieldName) Source #

The name of the field in the data source.

confluencePageToIndexFieldMapping_dateFieldFormat :: Lens' ConfluencePageToIndexFieldMapping (Maybe Text) Source #

The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

confluencePageToIndexFieldMapping_indexFieldName :: Lens' ConfluencePageToIndexFieldMapping (Maybe Text) Source #

The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.