AWS SDK for .NET Documentation
TerminateWorkflowExecutionRequest Class
AmazonAmazon.SimpleWorkflow.ModelTerminateWorkflowExecutionRequest Did this page help you?   Yes   No    Tell us about it...
Container for the parameters to the TerminateWorkflowExecution operation.

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.

IMPORTANT: If the identified workflow execution was in progress, it is terminated immediately.

NOTE: 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.

NOTE: 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 by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Declaration Syntax
C#
public class TerminateWorkflowExecutionRequest : AmazonWebServiceRequest
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
TerminateWorkflowExecutionRequest()()()()
Initializes a new instance of the TerminateWorkflowExecutionRequest class

ChildPolicy
If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution. The supported child policies are:
  • TERMINATE: the child executions will be terminated.
  • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON: no action will be taken. The child executions will continue to run.
Note:
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time, a fault will be returned.

Constraints:

Allowed Values
TERMINATE, REQUEST_CANCEL, ABANDON


Details
Optional details for terminating the workflow execution.

Constraints:

Length
0 - 32768


Domain
The domain of the workflow execution to terminate.

Constraints:

Length
1 - 256


Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
Reason
An optional descriptive reason for terminating the workflow execution.

Constraints:

Length
0 - 256


RunId
The runId of the workflow execution to terminate.

Constraints:

Length
0 - 64


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
WithChildPolicy(String) Obsolete.
Sets the ChildPolicy property

WithDetails(String) Obsolete.
Sets the Details property

WithDomain(String) Obsolete.
Sets the Domain property

WithReason(String) Obsolete.
Sets the Reason property

WithRunId(String) Obsolete.
Sets the RunId property

WithWorkflowId(String) Obsolete.
Sets the WorkflowId property

WorkflowId
The workflowId of the workflow execution to terminate.

Constraints:

Length
1 - 256


Inheritance Hierarchy
Object
AmazonWebServiceRequest
 TerminateWorkflowExecutionRequest
See Also

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)