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.
Records a
If the identified workflow execution was in progress, it is terminated immediately.
If a runId isn't specified, then the
You should consider using RequestCancelWorkflowExecution action instead because
it allows the workflow to gracefully close while TerminateWorkflowExecution
doesn't.
WorkflowExecutionTerminated event and forces closure of the workflow
execution identified by the given domain, runId, and workflowId. The child policy,
registered with the workflow type or specified when starting this execution, is applied
to any open child workflow executions of this workflow execution.
WorkflowExecutionTerminated event is recorded
in the history of the current open workflow with the matching workflowId in the domain.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified
domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter
values fall outside the specified constraints, the action fails. The associated event
attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details
and example IAM policies, see Using
IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 BeginTerminateWorkflowExecution and EndTerminateWorkflowExecution.
Namespace: Amazon.SimpleWorkflow
Assembly: AWSSDK.SimpleWorkflow.dll
Version: 3.x.y.z
public virtual Task<TerminateWorkflowExecutionResponse> TerminateWorkflowExecutionAsync( TerminateWorkflowExecutionRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the TerminateWorkflowExecution service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| OperationNotPermittedException | Returned when the caller doesn't have sufficient permissions to invoke the action. |
| UnknownResourceException | Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer