AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CancelFlowExecutions operation. 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.

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Appflow.AmazonAppflowRequest
      Amazon.Appflow.Model.CancelFlowExecutionsRequest

Namespace: Amazon.Appflow.Model
Assembly: AWSSDK.Appflow.dll
Version: 3.x.y.z

Syntax

C#
public class CancelFlowExecutionsRequest : AmazonAppflowRequest
         IAmazonWebServiceRequest

The CancelFlowExecutionsRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property ExecutionIds System.Collections.Generic.List<System.String>

Gets and sets the property ExecutionIds.

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.

Public Property FlowName System.String

Gets and sets the property FlowName.

The name of a flow with active runs that you want to cancel.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5