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.
Stops an execution.
This API action is not supported by EXPRESS state machines.
For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role.
A caller can stop an execution without using any KMS permissions in the execution
role if the caller provides a null value for both error and cause fields
because no data needs to be encrypted.
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 BeginStopExecution and EndStopExecution.
Namespace: Amazon.StepFunctions
Assembly: AWSSDK.StepFunctions.dll
Version: 3.x.y.z
public abstract Task<StopExecutionResponse> StopExecutionAsync( StopExecutionRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the StopExecution service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| ExecutionDoesNotExistException | The specified execution does not exist. |
| InvalidArnException | The provided Amazon Resource Name (ARN) is not valid. |
| KmsAccessDeniedException | Either your KMS key policy or API caller does not have the required permissions. |
| KmsInvalidStateException | The KMS key is not in valid state, for example: Disabled or Deleted. |
| KmsThrottlingException | Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller. |
| ValidationException | The input does not satisfy the constraints specified by an Amazon Web Services service. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer