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.
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.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginCancelFlowExecutions and EndCancelFlowExecutions.
Namespace: Amazon.Appflow
Assembly: AWSSDK.Appflow.dll
Version: 3.x.y.z
public virtual Task<CancelFlowExecutionsResponse> CancelFlowExecutionsAsync( CancelFlowExecutionsRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the CancelFlowExecutions service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| AccessDeniedException | AppFlow/Requester has invalid or missing permissions. |
| InternalServerException | An internal service error occurred during the processing of your request. Try again later. |
| ResourceNotFoundException | The resource specified in the request (such as the source or destination connector profile) is not found. |
| ThrottlingException | API calls have exceeded the maximum allowed API request rate per account and per Region. |
| ValidationException | The request has invalid or missing parameters. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5