aws-sdk-appflow 1.39.0 → 1.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83e61885b65c7cafcae7903743983818337d88368477b6c320e81a7a00ba6e1b
-  data.tar.gz: a5cafbf04f0e518ab36c04918012343a1789be5591d2188e738fb90e82a0ffb0
+  metadata.gz: 9cc57e3696ca5adff62cd080b215acd3eefd251d510882568dd55986083babb1
+  data.tar.gz: 3aa3803ad09c976c9b94a58412cd70dedf7120b79373e179fe5c9f8b770f58fe
 SHA512:
-  metadata.gz: 6c1942e9bbea35232f743bc9c70cf3494f7037b4637d3ac49f6b7dfb627cd401086c7c83b245e173e3022539ab554778ec62759c84af6a324280d9a05d10a9bd
-  data.tar.gz: 221eba0f46f38361ae3d02c7bd3c46460ac8b60763b94c3ca033427745039b2f8797391a7336a084fbde0cc3792aa9fb906695dba9ddc058979c9f8c32e1e2dd
+  metadata.gz: e56604e6a67d0d43197d1932d58a9c9304b7bb11b32bc544af6b2ffd6e39d699c103b411ca1d1d9f36554d52914fec30521399c757405164974b3d91f4e82236
+  data.tar.gz: 2a39498893563699b1c10d034837e842edd0e741d78156f11436280e6bf9240a564e12f66d46951f1769b6be08c3fb636e0bcd0d44f39e77e2c310aa8b531bc7

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.40.0 (2023-05-02)
+------------------
+
+* Feature - This release adds new API to cancel flow executions.
+
 1.39.0 (2023-04-28)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.39.0
+1.40.0

data/lib/aws-sdk-appflow/client.rb

@@ -368,6 +368,73 @@ module Aws::Appflow
 
     # @!group API Operations
 
+    # Cancels active runs for a flow.
+    #
+    # You can cancel all of the active runs for a flow, or you can cancel
+    # specific runs by providing their IDs.
+    #
+    # You can cancel a flow run only when the run is in progress. You can't
+    # cancel a run that has already completed or failed. You also can't
+    # cancel a run that's scheduled to occur but hasn't started yet. To
+    # prevent a scheduled run, you can deactivate the flow with the
+    # `StopFlow` action.
+    #
+    # You cannot resume a run after you cancel it.
+    #
+    # When you send your request, the status for each run becomes
+    # `CancelStarted`. When the cancellation completes, the status becomes
+    # `Canceled`.
+    #
+    # <note markdown="1"> When you cancel a run, you still incur charges for any data that the
+    # run already processed before the cancellation. If the run had already
+    # written some data to the flow destination, then that data remains in
+    # the destination. If you configured the flow to use a batch API (such
+    # as the Salesforce Bulk API 2.0), then the run will finish reading or
+    # writing its entire batch of data after the cancellation. For these
+    # operations, the data processing charges for Amazon AppFlow apply. For
+    # the pricing information, see [Amazon AppFlow pricing][1].
+    #
+    #  </note>
+    #
+    #
+    #
+    # [1]: http://aws.amazon.com/appflow/pricing/
+    #
+    # @option params [required, String] :flow_name
+    #   The name of a flow with active runs that you want to cancel.
+    #
+    # @option params [Array<String>] :execution_ids
+    #   The ID of each active run to cancel. These runs must belong to the
+    #   flow you specify in your request.
+    #
+    #   If you omit this parameter, your request ends all active runs that
+    #   belong to the flow.
+    #
+    # @return [Types::CancelFlowExecutionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CancelFlowExecutionsResponse#invalid_executions #invalid_executions} => Array&lt;String&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.cancel_flow_executions({
+    #     flow_name: "FlowName", # required
+    #     execution_ids: ["ExecutionId"],
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.invalid_executions #=> Array
+    #   resp.invalid_executions[0] #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/CancelFlowExecutions AWS API Documentation
+    #
+    # @overload cancel_flow_executions(params = {})
+    # @param [Hash] params ({})
+    def cancel_flow_executions(params = {}, options = {})
+      req = build_request(:cancel_flow_executions, params)
+      req.send_request(options)
+    end
+
     # Creates a new connector profile associated with your Amazon Web
     # Services account. There is a soft quota of 100 connector profiles per
     # Amazon Web Services account. If you need more connector profiles than
@@ -1728,7 +1795,7 @@ module Aws::Appflow
     #   resp.destination_flow_config_list[0].destination_connector_properties.sapo_data.write_operation_type #=> String, one of "INSERT", "UPSERT", "UPDATE", "DELETE"
     #   resp.last_run_execution_details.most_recent_execution_message #=> String
     #   resp.last_run_execution_details.most_recent_execution_time #=> Time
-    #   resp.last_run_execution_details.most_recent_execution_status #=> String, one of "InProgress", "Successful", "Error"
+    #   resp.last_run_execution_details.most_recent_execution_status #=> String, one of "InProgress", "Successful", "Error", "CancelStarted", "Canceled"
     #   resp.trigger_config.trigger_type #=> String, one of "Scheduled", "Event", "OnDemand"
     #   resp.trigger_config.trigger_properties.scheduled.schedule_expression #=> String
     #   resp.trigger_config.trigger_properties.scheduled.data_pull_mode #=> String, one of "Incremental", "Complete"
@@ -1776,10 +1843,10 @@ module Aws::Appflow
     #   resp.last_run_metadata_catalog_details[0].table_name #=> String
     #   resp.last_run_metadata_catalog_details[0].table_registration_output.message #=> String
     #   resp.last_run_metadata_catalog_details[0].table_registration_output.result #=> String
-    #   resp.last_run_metadata_catalog_details[0].table_registration_output.status #=> String, one of "InProgress", "Successful", "Error"
+    #   resp.last_run_metadata_catalog_details[0].table_registration_output.status #=> String, one of "InProgress", "Successful", "Error", "CancelStarted", "Canceled"
     #   resp.last_run_metadata_catalog_details[0].partition_registration_output.message #=> String
     #   resp.last_run_metadata_catalog_details[0].partition_registration_output.result #=> String
-    #   resp.last_run_metadata_catalog_details[0].partition_registration_output.status #=> String, one of "InProgress", "Successful", "Error"
+    #   resp.last_run_metadata_catalog_details[0].partition_registration_output.status #=> String, one of "InProgress", "Successful", "Error", "CancelStarted", "Canceled"
     #   resp.schema_version #=> Integer
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/DescribeFlow AWS API Documentation
@@ -1824,7 +1891,7 @@ module Aws::Appflow
     #
     #   resp.flow_executions #=> Array
     #   resp.flow_executions[0].execution_id #=> String
-    #   resp.flow_executions[0].execution_status #=> String, one of "InProgress", "Successful", "Error"
+    #   resp.flow_executions[0].execution_status #=> String, one of "InProgress", "Successful", "Error", "CancelStarted", "Canceled"
     #   resp.flow_executions[0].execution_result.error_info.put_failures_count #=> Integer
     #   resp.flow_executions[0].execution_result.error_info.execution_message #=> String
     #   resp.flow_executions[0].execution_result.bytes_processed #=> Integer
@@ -1839,10 +1906,10 @@ module Aws::Appflow
     #   resp.flow_executions[0].metadata_catalog_details[0].table_name #=> String
     #   resp.flow_executions[0].metadata_catalog_details[0].table_registration_output.message #=> String
     #   resp.flow_executions[0].metadata_catalog_details[0].table_registration_output.result #=> String
-    #   resp.flow_executions[0].metadata_catalog_details[0].table_registration_output.status #=> String, one of "InProgress", "Successful", "Error"
+    #   resp.flow_executions[0].metadata_catalog_details[0].table_registration_output.status #=> String, one of "InProgress", "Successful", "Error", "CancelStarted", "Canceled"
     #   resp.flow_executions[0].metadata_catalog_details[0].partition_registration_output.message #=> String
     #   resp.flow_executions[0].metadata_catalog_details[0].partition_registration_output.result #=> String
-    #   resp.flow_executions[0].metadata_catalog_details[0].partition_registration_output.status #=> String, one of "InProgress", "Successful", "Error"
+    #   resp.flow_executions[0].metadata_catalog_details[0].partition_registration_output.status #=> String, one of "InProgress", "Successful", "Error", "CancelStarted", "Canceled"
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/DescribeFlowExecutionRecords AWS API Documentation
@@ -2016,7 +2083,7 @@ module Aws::Appflow
     #   resp.flows[0].tags["TagKey"] #=> String
     #   resp.flows[0].last_run_execution_details.most_recent_execution_message #=> String
     #   resp.flows[0].last_run_execution_details.most_recent_execution_time #=> Time
-    #   resp.flows[0].last_run_execution_details.most_recent_execution_status #=> String, one of "InProgress", "Successful", "Error"
+    #   resp.flows[0].last_run_execution_details.most_recent_execution_status #=> String, one of "InProgress", "Successful", "Error", "CancelStarted", "Canceled"
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/ListFlows AWS API Documentation
@@ -3028,7 +3095,7 @@ module Aws::Appflow
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-appflow'
-      context[:gem_version] = '1.39.0'
+      context[:gem_version] = '1.40.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-appflow/client_api.rb

@@ -46,6 +46,8 @@ module Aws::Appflow
     BucketName = Shapes::StringShape.new(name: 'BucketName')
     BucketPrefix = Shapes::StringShape.new(name: 'BucketPrefix')
     BusinessUnitId = Shapes::StringShape.new(name: 'BusinessUnitId')
+    CancelFlowExecutionsRequest = Shapes::StructureShape.new(name: 'CancelFlowExecutionsRequest')
+    CancelFlowExecutionsResponse = Shapes::StructureShape.new(name: 'CancelFlowExecutionsResponse')
     CatalogType = Shapes::StringShape.new(name: 'CatalogType')
     ClientCredentialsArn = Shapes::StringShape.new(name: 'ClientCredentialsArn')
     ClientId = Shapes::StringShape.new(name: 'ClientId')
@@ -166,6 +168,7 @@ module Aws::Appflow
     EventBridgeMetadata = Shapes::StructureShape.new(name: 'EventBridgeMetadata')
     ExecutionDetails = Shapes::StructureShape.new(name: 'ExecutionDetails')
     ExecutionId = Shapes::StringShape.new(name: 'ExecutionId')
+    ExecutionIds = Shapes::ListShape.new(name: 'ExecutionIds')
     ExecutionMessage = Shapes::StringShape.new(name: 'ExecutionMessage')
     ExecutionRecord = Shapes::StructureShape.new(name: 'ExecutionRecord')
     ExecutionResult = Shapes::StructureShape.new(name: 'ExecutionResult')
@@ -460,6 +463,13 @@ module Aws::Appflow
     BasicAuthCredentials.add_member(:password, Shapes::ShapeRef.new(shape: Password, required: true, location_name: "password"))
     BasicAuthCredentials.struct_class = Types::BasicAuthCredentials
 
+    CancelFlowExecutionsRequest.add_member(:flow_name, Shapes::ShapeRef.new(shape: FlowName, required: true, location_name: "flowName"))
+    CancelFlowExecutionsRequest.add_member(:execution_ids, Shapes::ShapeRef.new(shape: ExecutionIds, location_name: "executionIds"))
+    CancelFlowExecutionsRequest.struct_class = Types::CancelFlowExecutionsRequest
+
+    CancelFlowExecutionsResponse.add_member(:invalid_executions, Shapes::ShapeRef.new(shape: ExecutionIds, location_name: "invalidExecutions"))
+    CancelFlowExecutionsResponse.struct_class = Types::CancelFlowExecutionsResponse
+
     ConflictException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
     ConflictException.struct_class = Types::ConflictException
 
@@ -899,6 +909,8 @@ module Aws::Appflow
     ExecutionDetails.add_member(:most_recent_execution_status, Shapes::ShapeRef.new(shape: ExecutionStatus, location_name: "mostRecentExecutionStatus"))
     ExecutionDetails.struct_class = Types::ExecutionDetails
 
+    ExecutionIds.member = Shapes::ShapeRef.new(shape: ExecutionId)
+
     ExecutionRecord.add_member(:execution_id, Shapes::ShapeRef.new(shape: ExecutionId, location_name: "executionId"))
     ExecutionRecord.add_member(:execution_status, Shapes::ShapeRef.new(shape: ExecutionStatus, location_name: "executionStatus"))
     ExecutionRecord.add_member(:execution_result, Shapes::ShapeRef.new(shape: ExecutionResult, location_name: "executionResult"))
@@ -1578,6 +1590,19 @@ module Aws::Appflow
         "uid" => "appflow-2020-08-23",
       }
 
+      api.add_operation(:cancel_flow_executions, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "CancelFlowExecutions"
+        o.http_method = "POST"
+        o.http_request_uri = "/cancel-flow-executions"
+        o.input = Shapes::ShapeRef.new(shape: CancelFlowExecutionsRequest)
+        o.output = Shapes::ShapeRef.new(shape: CancelFlowExecutionsResponse)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+      end)
+
       api.add_operation(:create_connector_profile, Seahorse::Model::Operation.new.tap do |o|
         o.name = "CreateConnectorProfile"
         o.http_method = "POST"

data/lib/aws-sdk-appflow/endpoints.rb

@@ -11,6 +11,20 @@
 module Aws::Appflow
   module Endpoints
 
+    class CancelFlowExecutions
+      def self.build(context)
+        unless context.config.regional_endpoint
+          endpoint = context.config.endpoint.to_s
+        end
+        Aws::Appflow::EndpointParameters.new(
+          region: context.config.region,
+          use_dual_stack: context.config.use_dualstack_endpoint,
+          use_fips: context.config.use_fips_endpoint,
+          endpoint: endpoint,
+        )
+      end
+    end
+
     class CreateConnectorProfile
       def self.build(context)
         unless context.config.regional_endpoint

data/lib/aws-sdk-appflow/plugins/endpoints.rb

@@ -56,6 +56,8 @@ module Aws::Appflow
 
         def parameters_for_operation(context)
           case context.operation_name
+          when :cancel_flow_executions
+            Aws::Appflow::Endpoints::CancelFlowExecutions.build(context)
           when :create_connector_profile
             Aws::Appflow::Endpoints::CreateConnectorProfile.build(context)
           when :create_flow

data/lib/aws-sdk-appflow/types.rb

@@ -221,6 +221,41 @@ module Aws::Appflow
       include Aws::Structure
     end
 
+    # @!attribute [rw] flow_name
+    #   The name of a flow with active runs that you want to cancel.
+    #   @return [String]
+    #
+    # @!attribute [rw] execution_ids
+    #   The ID of each active run to cancel. These runs must belong to the
+    #   flow you specify in your request.
+    #
+    #   If you omit this parameter, your request ends all active runs that
+    #   belong to the flow.
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/CancelFlowExecutionsRequest AWS API Documentation
+    #
+    class CancelFlowExecutionsRequest < Struct.new(
+      :flow_name,
+      :execution_ids)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] invalid_executions
+    #   The IDs of runs that Amazon AppFlow couldn't cancel. These runs
+    #   might be ineligible for canceling because they haven't started yet
+    #   or have already completed.
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/CancelFlowExecutionsResponse AWS API Documentation
+    #
+    class CancelFlowExecutionsResponse < Struct.new(
+      :invalid_executions)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # There was a conflict when processing the request (for example, a flow
     # with the given name already exists within the account. Check for
     # conflicting resource names and try again.

data/lib/aws-sdk-appflow.rb

@@ -32,7 +32,7 @@ require_relative 'aws-sdk-appflow/customizations'
 # structure.
 #
 #     appflow = Aws::Appflow::Client.new
-#     resp = appflow.create_connector_profile(params)
+#     resp = appflow.cancel_flow_executions(params)
 #
 # See {Client} for more information.
 #
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-appflow/customizations'
 # @!group service
 module Aws::Appflow
 
-  GEM_VERSION = '1.39.0'
+  GEM_VERSION = '1.40.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-appflow
 version: !ruby/object:Gem::Version
-  version: 1.39.0
+  version: 1.40.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-28 00:00:00.000000000 Z
+date: 2023-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core