AWS SDK Version 2 for .NET
API Reference

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.

.NET Framework 4.5
 
Records a 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. If the identified workflow execution was in progress, it is terminated immediately. If a runId is not specified, then the WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain. You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution does not.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Namespace: Amazon.SimpleWorkflow
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public abstract TerminateWorkflowExecutionResponse TerminateWorkflowExecution(
         TerminateWorkflowExecutionRequest request
)

Parameters

request
Type: Amazon.SimpleWorkflow.Model.TerminateWorkflowExecutionRequest

Container for the necessary parameters to execute the TerminateWorkflowExecution service method.

Return Value
Type: Amazon.SimpleWorkflow.Model.TerminateWorkflowExecutionResponse
The response from the TerminateWorkflowExecution service method, as returned by SimpleWorkflow.

Exceptions

ExceptionCondition
OperationNotPermittedException Returned when the caller does not 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.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5