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

Description

Documentation

data SalesforceStandardKnowledgeArticleTypeConfiguration Source #

Provides the configuration information for standard Salesforce knowledge articles.

See: newSalesforceStandardKnowledgeArticleTypeConfiguration smart constructor.

Constructors

SalesforceStandardKnowledgeArticleTypeConfiguration'

Fields

documentTitleFieldName :: Maybe Text
The name of the field that contains the document title.
fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
Maps attributes or field names of the 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.
documentDataFieldName :: Text
The name of the field that contains the document data to index.

Instances

Instances details

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

newSalesforceStandardKnowledgeArticleTypeConfiguration Source #

Arguments

:: Text	`$sel:documentDataFieldName:SalesforceStandardKnowledgeArticleTypeConfiguration'`
-> SalesforceStandardKnowledgeArticleTypeConfiguration

Create a value of SalesforceStandardKnowledgeArticleTypeConfiguration 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:SalesforceStandardKnowledgeArticleTypeConfiguration', salesforceStandardKnowledgeArticleTypeConfiguration_documentTitleFieldName - The name of the field that contains the document title.

$sel:fieldMappings:SalesforceStandardKnowledgeArticleTypeConfiguration', salesforceStandardKnowledgeArticleTypeConfiguration_fieldMappings - Maps attributes or field names of the 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:documentDataFieldName:SalesforceStandardKnowledgeArticleTypeConfiguration', salesforceStandardKnowledgeArticleTypeConfiguration_documentDataFieldName - The name of the field that contains the document data to index.

salesforceStandardKnowledgeArticleTypeConfiguration_documentTitleFieldName :: Lens' SalesforceStandardKnowledgeArticleTypeConfiguration (Maybe Text) Source #

The name of the field that contains the document title.

salesforceStandardKnowledgeArticleTypeConfiguration_fieldMappings :: Lens' SalesforceStandardKnowledgeArticleTypeConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

Maps attributes or field names of the 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.

salesforceStandardKnowledgeArticleTypeConfiguration_documentDataFieldName :: Lens' SalesforceStandardKnowledgeArticleTypeConfiguration Text Source #

The name of the field that contains the document data to index.