feat(client-appflow): With this update, you can choose which Salesforce API is used by Amazon AppFlow to transfer data to or from your Salesforce account. You can choose the Salesforce REST API or Bulk API 2.0. You can also choose for Amazon AppFlow to pick the API automatically.

Author: awstools

clients/client-appflow/src/models/models_0.ts

@@ -387,6 +387,12 @@ export interface RedshiftMetadata {}
  */
 export interface S3Metadata {}
 
+export enum SalesforceDataTransferApi {
+  AUTOMATIC = "AUTOMATIC",
+  BULKV2 = "BULKV2",
+  REST_SYNC = "REST_SYNC",
+}
+
 /**
  * <p> The connector metadata specific to Salesforce. </p>
  */
@@ -395,6 +401,12 @@ export interface SalesforceMetadata {
    * <p> The desired authorization scope for the Salesforce account. </p>
    */
   oAuthScopes?: string[];
+
+  /**
+   * <p>The Salesforce APIs that you can have Amazon AppFlow use when your flows transfers
+   *       data to or from Salesforce.</p>
+   */
+  dataTransferApis?: (SalesforceDataTransferApi | string)[];
 }
 
 /**
@@ -2959,6 +2971,47 @@ export interface SalesforceDestinationProperties {
    *       is <code>UPSERT</code>, then <code>idFieldNames</code> is required. </p>
    */
   writeOperationType?: WriteOperationType | string;
+
+  /**
+   * <p>Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers
+   *       data to Salesforce.</p>
+   *          <dl>
+   *             <dt>AUTOMATIC</dt>
+   *             <dd>
+   *                <p>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.</p>
+   *                <p>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.</p>
+   *                <p>By choosing this option, you optimize flow performance for both small and large data
+   *             transfers, but the tradeoff is inconsistent formatting in the output.</p>
+   *             </dd>
+   *             <dt>BULKV2</dt>
+   *             <dd>
+   *                <p>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.</p>
+   *                <p>Note that Bulk API 2.0 does not transfer Salesforce compound fields.</p>
+   *             </dd>
+   *             <dt>REST_SYNC</dt>
+   *             <dd>
+   *                <p>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.</p>
+   *             </dd>
+   *          </dl>
+   */
+  dataTransferApi?: SalesforceDataTransferApi | string;
 }
 
 /**
@@ -3358,6 +3411,47 @@ export interface SalesforceSourceProperties {
    * <p> Indicates whether Amazon AppFlow includes deleted files in the flow run. </p>
    */
   includeDeletedRecords?: boolean;
+
+  /**
+   * <p>Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers
+   *       data from Salesforce.</p>
+   *          <dl>
+   *             <dt>AUTOMATIC</dt>
+   *             <dd>
+   *                <p>The default. Amazon AppFlow selects which API to use based on the number of
+   *             records that your flow transfers from Salesforce. If your flow transfers fewer than
+   *             1,000,000 records, Amazon AppFlow uses Salesforce REST API. If your flow transfers
+   *             1,000,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0.</p>
+   *                <p>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,000 records, and it might use Bulk API 2.0 on the next
+   *             day to transfer 1,100,000 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.</p>
+   *                <p>By choosing this option, you optimize flow performance for both small and large data
+   *             transfers, but the tradeoff is inconsistent formatting in the output.</p>
+   *             </dd>
+   *             <dt>BULKV2</dt>
+   *             <dd>
+   *                <p>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.</p>
+   *                <p>Note that Bulk API 2.0 does not transfer Salesforce compound fields.</p>
+   *             </dd>
+   *             <dt>REST_SYNC</dt>
+   *             <dd>
+   *                <p>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.</p>
+   *             </dd>
+   *          </dl>
+   */
+  dataTransferApi?: SalesforceDataTransferApi | string;
 }
 
 /**
@@ -3576,6 +3670,7 @@ export enum OperatorPropertiesKeys {
   DATA_TYPE = "DATA_TYPE",
   DESTINATION_DATA_TYPE = "DESTINATION_DATA_TYPE",
   EXCLUDE_SOURCE_FIELDS_LIST = "EXCLUDE_SOURCE_FIELDS_LIST",
+  INCLUDE_NEW_FIELDS = "INCLUDE_NEW_FIELDS",
   LOWER_BOUND = "LOWER_BOUND",
   MASK_LENGTH = "MASK_LENGTH",
   MASK_VALUE = "MASK_VALUE",
@@ -3670,11 +3765,13 @@ export interface ScheduledTriggerProperties {
 
   /**
    * <p>Specifies the time zone used when referring to the dates and times of a scheduled flow,
-   *       such as <code>America/New_York</code>. This time zone is only a descriptive label. It doesn't affect how
-   *       Amazon AppFlow interprets the timestamps that you specify to schedule the flow.</p>
-   *          <p>If you want to schedule a flow by using times in a particular time zone, indicate the time zone as a UTC
-   *       offset in your timestamps. For example, the UTC offsets for the <code>America/New_York</code> timezone are
-   *       <code>-04:00</code> EDT and <code>-05:00 EST</code>.</p>
+   *       such as <code>America/New_York</code>. This time zone is only a descriptive label. It doesn't
+   *       affect how Amazon AppFlow interprets the timestamps that you specify to schedule the
+   *       flow.</p>
+   *          <p>If you want to schedule a flow by using times in a particular time zone, indicate the time
+   *       zone as a UTC offset in your timestamps. For example, the UTC offsets for the
+   *         <code>America/New_York</code> timezone are <code>-04:00</code> EDT and <code>-05:00
+   *         EST</code>.</p>
    */
   timezone?: string;
 

clients/client-appflow/src/protocols/Aws_restJson1.ts

@@ -174,6 +174,7 @@ import {
   S3SourceProperties,
   SalesforceConnectorProfileCredentials,
   SalesforceConnectorProfileProperties,
+  SalesforceDataTransferApi,
   SalesforceDestinationProperties,
   SalesforceMetadata,
   SalesforceSourceProperties,
@@ -2989,6 +2990,7 @@ const serializeAws_restJson1SalesforceDestinationProperties = (
   context: __SerdeContext
 ): any => {
   return {
+    ...(input.dataTransferApi != null && { dataTransferApi: input.dataTransferApi }),
     ...(input.errorHandlingConfig != null && {
       errorHandlingConfig: serializeAws_restJson1ErrorHandlingConfig(input.errorHandlingConfig, context),
     }),
@@ -3005,6 +3007,7 @@ const serializeAws_restJson1SalesforceSourceProperties = (
   context: __SerdeContext
 ): any => {
   return {
+    ...(input.dataTransferApi != null && { dataTransferApi: input.dataTransferApi }),
     ...(input.enableDynamicFieldUpdate != null && { enableDynamicFieldUpdate: input.enableDynamicFieldUpdate }),
     ...(input.includeDeletedRecords != null && { includeDeletedRecords: input.includeDeletedRecords }),
     ...(input.object != null && { object: input.object }),
@@ -4843,11 +4846,27 @@ const deserializeAws_restJson1SalesforceConnectorProfileProperties = (
   } as any;
 };
 
+const deserializeAws_restJson1SalesforceDataTransferApiList = (
+  output: any,
+  context: __SerdeContext
+): (SalesforceDataTransferApi | string)[] => {
+  const retVal = (output || [])
+    .filter((e: any) => e != null)
+    .map((entry: any) => {
+      if (entry === null) {
+        return null as any;
+      }
+      return __expectString(entry) as any;
+    });
+  return retVal;
+};
+
 const deserializeAws_restJson1SalesforceDestinationProperties = (
   output: any,
   context: __SerdeContext
 ): SalesforceDestinationProperties => {
   return {
+    dataTransferApi: __expectString(output.dataTransferApi),
     errorHandlingConfig:
       output.errorHandlingConfig != null
         ? deserializeAws_restJson1ErrorHandlingConfig(output.errorHandlingConfig, context)
@@ -4861,6 +4880,10 @@ const deserializeAws_restJson1SalesforceDestinationProperties = (
 
 const deserializeAws_restJson1SalesforceMetadata = (output: any, context: __SerdeContext): SalesforceMetadata => {
   return {
+    dataTransferApis:
+      output.dataTransferApis != null
+        ? deserializeAws_restJson1SalesforceDataTransferApiList(output.dataTransferApis, context)
+        : undefined,
     oAuthScopes:
       output.oAuthScopes != null ? deserializeAws_restJson1OAuthScopeList(output.oAuthScopes, context) : undefined,
   } as any;
@@ -4871,6 +4894,7 @@ const deserializeAws_restJson1SalesforceSourceProperties = (
   context: __SerdeContext
 ): SalesforceSourceProperties => {
   return {
+    dataTransferApi: __expectString(output.dataTransferApi),
     enableDynamicFieldUpdate: __expectBoolean(output.enableDynamicFieldUpdate),
     includeDeletedRecords: __expectBoolean(output.includeDeletedRecords),
     object: __expectString(output.object),