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.
For .NET Core this operation is only available in asynchronous form. Please refer to StopExecutionAsync.
Namespace: Amazon.StepFunctions
Assembly: AWSSDK.StepFunctions.dll
Version: 3.x.y.z
public abstract StopExecutionResponse StopExecution( StopExecutionRequest request )
Container for the necessary parameters to execute the StopExecution service method.
| 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 Framework:
Supported in: 4.5 and newer, 3.5