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

Description

Synopsis

Documentation

data SalesforceKnowledgeArticleConfiguration Source #

Provides the configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both

See: newSalesforceKnowledgeArticleConfiguration smart constructor.

Constructors

SalesforceKnowledgeArticleConfiguration'

Fields

customKnowledgeArticleTypeConfigurations :: Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)
Configuration information for custom Salesforce knowledge articles.
standardKnowledgeArticleTypeConfiguration :: Maybe SalesforceStandardKnowledgeArticleTypeConfiguration
Configuration information for standard Salesforce knowledge articles.
includedStates :: NonEmpty SalesforceKnowledgeArticleState
Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.

Instances

Instances details

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

newSalesforceKnowledgeArticleConfiguration Source #

Arguments

:: NonEmpty SalesforceKnowledgeArticleState	`$sel:includedStates:SalesforceKnowledgeArticleConfiguration'`
-> SalesforceKnowledgeArticleConfiguration

Create a value of SalesforceKnowledgeArticleConfiguration 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:customKnowledgeArticleTypeConfigurations:SalesforceKnowledgeArticleConfiguration', salesforceKnowledgeArticleConfiguration_customKnowledgeArticleTypeConfigurations - Configuration information for custom Salesforce knowledge articles.

$sel:standardKnowledgeArticleTypeConfiguration:SalesforceKnowledgeArticleConfiguration', salesforceKnowledgeArticleConfiguration_standardKnowledgeArticleTypeConfiguration - Configuration information for standard Salesforce knowledge articles.

$sel:includedStates:SalesforceKnowledgeArticleConfiguration', salesforceKnowledgeArticleConfiguration_includedStates - Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.

salesforceKnowledgeArticleConfiguration_customKnowledgeArticleTypeConfigurations :: Lens' SalesforceKnowledgeArticleConfiguration (Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)) Source #

Configuration information for custom Salesforce knowledge articles.

salesforceKnowledgeArticleConfiguration_standardKnowledgeArticleTypeConfiguration :: Lens' SalesforceKnowledgeArticleConfiguration (Maybe SalesforceStandardKnowledgeArticleTypeConfiguration) Source #

Configuration information for standard Salesforce knowledge articles.

salesforceKnowledgeArticleConfiguration_includedStates :: Lens' SalesforceKnowledgeArticleConfiguration (NonEmpty SalesforceKnowledgeArticleState) Source #

Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.