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 |
Synopsis
- data SalesforceStandardObjectConfiguration = SalesforceStandardObjectConfiguration' {}
- newSalesforceStandardObjectConfiguration :: SalesforceStandardObjectName -> Text -> SalesforceStandardObjectConfiguration
- salesforceStandardObjectConfiguration_documentTitleFieldName :: Lens' SalesforceStandardObjectConfiguration (Maybe Text)
- salesforceStandardObjectConfiguration_fieldMappings :: Lens' SalesforceStandardObjectConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
- salesforceStandardObjectConfiguration_name :: Lens' SalesforceStandardObjectConfiguration SalesforceStandardObjectName
- salesforceStandardObjectConfiguration_documentDataFieldName :: Lens' SalesforceStandardObjectConfiguration Text
Documentation
data SalesforceStandardObjectConfiguration Source #
Provides the configuration information for indexing a single standard object.
See: newSalesforceStandardObjectConfiguration
smart constructor.
SalesforceStandardObjectConfiguration' | |
|
Instances
newSalesforceStandardObjectConfiguration Source #
:: SalesforceStandardObjectName | |
-> Text |
|
-> 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.