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

Description

Synopsis

Documentation

data SalesforceCustomKnowledgeArticleTypeConfiguration Source #

Provides the configuration information for indexing Salesforce custom articles.

See: newSalesforceCustomKnowledgeArticleTypeConfiguration smart constructor.

Constructors

SalesforceCustomKnowledgeArticleTypeConfiguration'

Fields

documentTitleFieldName :: Maybe Text
The name of the field in the custom knowledge article that contains the document title.
fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.
name :: Text
The name of the configuration.
documentDataFieldName :: Text
The name of the field in the custom knowledge article that contains the document data to index.

Instances

Instances details

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

newSalesforceCustomKnowledgeArticleTypeConfiguration Source #

Arguments

:: Text	`$sel:name:SalesforceCustomKnowledgeArticleTypeConfiguration'`
-> Text	`$sel:documentDataFieldName:SalesforceCustomKnowledgeArticleTypeConfiguration'`
-> SalesforceCustomKnowledgeArticleTypeConfiguration

Create a value of SalesforceCustomKnowledgeArticleTypeConfiguration 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:documentTitleFieldName:SalesforceCustomKnowledgeArticleTypeConfiguration', salesforceCustomKnowledgeArticleTypeConfiguration_documentTitleFieldName - The name of the field in the custom knowledge article that contains the document title.

$sel:fieldMappings:SalesforceCustomKnowledgeArticleTypeConfiguration', salesforceCustomKnowledgeArticleTypeConfiguration_fieldMappings - Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.

$sel:name:SalesforceCustomKnowledgeArticleTypeConfiguration', salesforceCustomKnowledgeArticleTypeConfiguration_name - The name of the configuration.

$sel:documentDataFieldName:SalesforceCustomKnowledgeArticleTypeConfiguration', salesforceCustomKnowledgeArticleTypeConfiguration_documentDataFieldName - The name of the field in the custom knowledge article that contains the document data to index.

salesforceCustomKnowledgeArticleTypeConfiguration_documentTitleFieldName :: Lens' SalesforceCustomKnowledgeArticleTypeConfiguration (Maybe Text) Source #

The name of the field in the custom knowledge article that contains the document title.

salesforceCustomKnowledgeArticleTypeConfiguration_fieldMappings :: Lens' SalesforceCustomKnowledgeArticleTypeConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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

salesforceCustomKnowledgeArticleTypeConfiguration_name :: Lens' SalesforceCustomKnowledgeArticleTypeConfiguration Text Source #

The name of the configuration.

salesforceCustomKnowledgeArticleTypeConfiguration_documentDataFieldName :: Lens' SalesforceCustomKnowledgeArticleTypeConfiguration Text Source #

The name of the field in the custom knowledge article that contains the document data to index.