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 SalesforceDestinationProperties = SalesforceDestinationProperties' {}
- newSalesforceDestinationProperties :: Text -> SalesforceDestinationProperties
- salesforceDestinationProperties_dataTransferApi :: Lens' SalesforceDestinationProperties (Maybe SalesforceDataTransferApi)
- salesforceDestinationProperties_errorHandlingConfig :: Lens' SalesforceDestinationProperties (Maybe ErrorHandlingConfig)
- salesforceDestinationProperties_idFieldNames :: Lens' SalesforceDestinationProperties (Maybe [Text])
- salesforceDestinationProperties_writeOperationType :: Lens' SalesforceDestinationProperties (Maybe WriteOperationType)
- salesforceDestinationProperties_object :: Lens' SalesforceDestinationProperties Text
Documentation
data SalesforceDestinationProperties Source #
The properties that are applied when Salesforce is being used as a destination.
See: newSalesforceDestinationProperties
smart constructor.
SalesforceDestinationProperties' | |
|
Instances
newSalesforceDestinationProperties Source #
Create a value of SalesforceDestinationProperties
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:dataTransferApi:SalesforceDestinationProperties'
, salesforceDestinationProperties_dataTransferApi
- Specifies which Salesforce API is used by Amazon AppFlow when your flow
transfers data to Salesforce.
- AUTOMATIC
- The default. Amazon AppFlow selects which API to use based on the
number of records that your flow transfers to Salesforce. If your
flow transfers fewer than 1,000 records, Amazon AppFlow uses
Salesforce REST API. If your flow transfers 1,000 records or more,
Amazon AppFlow uses Salesforce Bulk API 2.0.
Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow runs daily, it might use REST API on one day to transfer 900 records, and it might use Bulk API 2.0 on the next day to transfer 1,100 records. For each of these flow runs, the respective Salesforce API formats the data differently. Some of the differences include how dates are formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound fields.
By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output.
- BULKV2
- Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs
asynchronous data transfers, and it's optimal for large sets of
data. By choosing this option, you ensure that your flow writes
consistent output, but you optimize performance only for large data
transfers.
Note that Bulk API 2.0 does not transfer Salesforce compound fields.
- REST_SYNC
- Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. In some cases, if your flow attempts to transfer a vary large set of data, it might fail with a timed out error.
$sel:errorHandlingConfig:SalesforceDestinationProperties'
, salesforceDestinationProperties_errorHandlingConfig
- The settings that determine how Amazon AppFlow handles an error when
placing data in the Salesforce destination. For example, this setting
would determine if the flow should fail after one insertion error, or
continue and attempt to insert every record regardless of the initial
failure. ErrorHandlingConfig
is a part of the destination connector
details.
$sel:idFieldNames:SalesforceDestinationProperties'
, salesforceDestinationProperties_idFieldNames
- The name of the field that Amazon AppFlow uses as an ID when performing
a write operation such as update or delete.
$sel:writeOperationType:SalesforceDestinationProperties'
, salesforceDestinationProperties_writeOperationType
- This specifies the type of write operation to be performed in
Salesforce. When the value is UPSERT
, then idFieldNames
is required.
$sel:object':SalesforceDestinationProperties'
, salesforceDestinationProperties_object
- The object specified in the Salesforce flow destination.
salesforceDestinationProperties_dataTransferApi :: Lens' SalesforceDestinationProperties (Maybe SalesforceDataTransferApi) Source #
Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data to Salesforce.
- AUTOMATIC
- The default. Amazon AppFlow selects which API to use based on the
number of records that your flow transfers to Salesforce. If your
flow transfers fewer than 1,000 records, Amazon AppFlow uses
Salesforce REST API. If your flow transfers 1,000 records or more,
Amazon AppFlow uses Salesforce Bulk API 2.0.
Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow runs daily, it might use REST API on one day to transfer 900 records, and it might use Bulk API 2.0 on the next day to transfer 1,100 records. For each of these flow runs, the respective Salesforce API formats the data differently. Some of the differences include how dates are formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound fields.
By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output.
- BULKV2
- Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs
asynchronous data transfers, and it's optimal for large sets of
data. By choosing this option, you ensure that your flow writes
consistent output, but you optimize performance only for large data
transfers.
Note that Bulk API 2.0 does not transfer Salesforce compound fields.
- REST_SYNC
- Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. In some cases, if your flow attempts to transfer a vary large set of data, it might fail with a timed out error.
salesforceDestinationProperties_errorHandlingConfig :: Lens' SalesforceDestinationProperties (Maybe ErrorHandlingConfig) Source #
The settings that determine how Amazon AppFlow handles an error when
placing data in the Salesforce destination. For example, this setting
would determine if the flow should fail after one insertion error, or
continue and attempt to insert every record regardless of the initial
failure. ErrorHandlingConfig
is a part of the destination connector
details.
salesforceDestinationProperties_idFieldNames :: Lens' SalesforceDestinationProperties (Maybe [Text]) Source #
The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update or delete.
salesforceDestinationProperties_writeOperationType :: Lens' SalesforceDestinationProperties (Maybe WriteOperationType) Source #
This specifies the type of write operation to be performed in
Salesforce. When the value is UPSERT
, then idFieldNames
is required.
salesforceDestinationProperties_object :: Lens' SalesforceDestinationProperties Text Source #
The object specified in the Salesforce flow destination.