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

Description

Documentation

data ConfluenceAttachmentToIndexFieldMapping Source #

Maps attributes or field names of Confluence attachments 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 Confuence data source field names must exist in your Confluence custom metadata.

See: newConfluenceAttachmentToIndexFieldMapping smart constructor.

Constructors

ConfluenceAttachmentToIndexFieldMapping'

Fields

dataSourceFieldName :: Maybe ConfluenceAttachmentFieldName
The name of the field in the data source.
You must first create the index field using the UpdateIndex API.
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 ConfluenceAttachmentToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping Methods parseJSON :: Value -> Parser ConfluenceAttachmentToIndexFieldMapping # parseJSONList :: Value -> Parser [ConfluenceAttachmentToIndexFieldMapping] #
ToJSON ConfluenceAttachmentToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping Methods toJSON :: ConfluenceAttachmentToIndexFieldMapping -> Value # toEncoding :: ConfluenceAttachmentToIndexFieldMapping -> Encoding # toJSONList :: [ConfluenceAttachmentToIndexFieldMapping] -> Value # toEncodingList :: [ConfluenceAttachmentToIndexFieldMapping] -> Encoding #
Generic ConfluenceAttachmentToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping Associated Types type Rep ConfluenceAttachmentToIndexFieldMapping :: Type -> Type # Methods from :: ConfluenceAttachmentToIndexFieldMapping -> Rep ConfluenceAttachmentToIndexFieldMapping x # to :: Rep ConfluenceAttachmentToIndexFieldMapping x -> ConfluenceAttachmentToIndexFieldMapping #
Read ConfluenceAttachmentToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping Methods readsPrec :: Int -> ReadS ConfluenceAttachmentToIndexFieldMapping # readList :: ReadS [ConfluenceAttachmentToIndexFieldMapping] # readPrec :: ReadPrec ConfluenceAttachmentToIndexFieldMapping # readListPrec :: ReadPrec [ConfluenceAttachmentToIndexFieldMapping] #
Show ConfluenceAttachmentToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping Methods showsPrec :: Int -> ConfluenceAttachmentToIndexFieldMapping -> ShowS # show :: ConfluenceAttachmentToIndexFieldMapping -> String # showList :: [ConfluenceAttachmentToIndexFieldMapping] -> ShowS #
NFData ConfluenceAttachmentToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping Methods rnf :: ConfluenceAttachmentToIndexFieldMapping -> () #
Eq ConfluenceAttachmentToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping Methods (==) :: ConfluenceAttachmentToIndexFieldMapping -> ConfluenceAttachmentToIndexFieldMapping -> Bool # (/=) :: ConfluenceAttachmentToIndexFieldMapping -> ConfluenceAttachmentToIndexFieldMapping -> Bool #
Hashable ConfluenceAttachmentToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping Methods hashWithSalt :: Int -> ConfluenceAttachmentToIndexFieldMapping -> Int # hash :: ConfluenceAttachmentToIndexFieldMapping -> Int #
type Rep ConfluenceAttachmentToIndexFieldMapping Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping type Rep ConfluenceAttachmentToIndexFieldMapping = D1 ('MetaData "ConfluenceAttachmentToIndexFieldMapping" "Amazonka.Kendra.Types.ConfluenceAttachmentToIndexFieldMapping" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConfluenceAttachmentToIndexFieldMapping'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataSourceFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluenceAttachmentFieldName)) :: (S1 ('MetaSel ('Just "dateFieldFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "indexFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newConfluenceAttachmentToIndexFieldMapping :: ConfluenceAttachmentToIndexFieldMapping Source #

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

You must first create the index field using the UpdateIndex API.

$sel:dateFieldFormat:ConfluenceAttachmentToIndexFieldMapping', confluenceAttachmentToIndexFieldMapping_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:ConfluenceAttachmentToIndexFieldMapping', confluenceAttachmentToIndexFieldMapping_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.

confluenceAttachmentToIndexFieldMapping_dataSourceFieldName :: Lens' ConfluenceAttachmentToIndexFieldMapping (Maybe ConfluenceAttachmentFieldName) Source #

The name of the field in the data source.

You must first create the index field using the UpdateIndex API.

confluenceAttachmentToIndexFieldMapping_dateFieldFormat :: Lens' ConfluenceAttachmentToIndexFieldMapping (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.

confluenceAttachmentToIndexFieldMapping_indexFieldName :: Lens' ConfluenceAttachmentToIndexFieldMapping (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.