Container for the parameters to the StopExecution operation. 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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.StepFunctions.AmazonStepFunctionsRequest
Amazon.StepFunctions.Model.StopExecutionRequest
Namespace: Amazon.StepFunctions.Model
Assembly: AWSSDK.StepFunctions.dll
Version: 3.x.y.z
Syntax
public class StopExecutionRequest : AmazonStepFunctionsRequest IAmazonWebServiceRequest
The StopExecutionRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
StopExecutionRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Cause | System.String |
Gets and sets the property Cause. A more detailed explanation of the cause of the failure. |
|
|
Error | System.String |
Gets and sets the property Error. The error code of the failure. |
|
|
ExecutionArn | System.String |
Gets and sets the property ExecutionArn. The Amazon Resource Name (ARN) of the execution to stop. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5