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

Description

Synopsis

Documentation

data SalesforceStandardObjectConfiguration Source #

Provides the configuration information for indexing a single standard object.

See: newSalesforceStandardObjectConfiguration smart constructor.

Constructors

SalesforceStandardObjectConfiguration'

Fields

documentTitleFieldName :: Maybe Text
The name of the field in the standard object table that contains the document title.
fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
Maps attributes or field names of the standard object 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 :: SalesforceStandardObjectName
The name of the standard object.
documentDataFieldName :: Text
The name of the field in the standard object table that contains the document contents.

Instances

Instances details

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

newSalesforceStandardObjectConfiguration Source #

Arguments

:: SalesforceStandardObjectName	`$sel:name:SalesforceStandardObjectConfiguration'`
-> Text	`$sel:documentDataFieldName:SalesforceStandardObjectConfiguration'`
-> SalesforceStandardObjectConfiguration

Create a value of SalesforceStandardObjectConfiguration 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:SalesforceStandardObjectConfiguration', salesforceStandardObjectConfiguration_documentTitleFieldName - The name of the field in the standard object table that contains the document title.

$sel:fieldMappings:SalesforceStandardObjectConfiguration', salesforceStandardObjectConfiguration_fieldMappings - Maps attributes or field names of the standard object 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:SalesforceStandardObjectConfiguration', salesforceStandardObjectConfiguration_name - The name of the standard object.

$sel:documentDataFieldName:SalesforceStandardObjectConfiguration', salesforceStandardObjectConfiguration_documentDataFieldName - The name of the field in the standard object table that contains the document contents.

salesforceStandardObjectConfiguration_documentTitleFieldName :: Lens' SalesforceStandardObjectConfiguration (Maybe Text) Source #

The name of the field in the standard object table that contains the document title.

salesforceStandardObjectConfiguration_fieldMappings :: Lens' SalesforceStandardObjectConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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

salesforceStandardObjectConfiguration_name :: Lens' SalesforceStandardObjectConfiguration SalesforceStandardObjectName Source #

The name of the standard object.

salesforceStandardObjectConfiguration_documentDataFieldName :: Lens' SalesforceStandardObjectConfiguration Text Source #

The name of the field in the standard object table that contains the document contents.