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

Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.

NOTE: If the runId is not specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.

NOTE: Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible.

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 RequestCancelWorkflowExecutionRequest : AmazonWebServiceRequest
Members
All MembersConstructorsMethodsProperties



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

Domain
The name of the domain containing the workflow execution to cancel.

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.)
RunId
The runId of the workflow execution to cancel.

Constraints:

Length
0 - 64


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

WithRunId(String) Obsolete.
Sets the RunId property

WithWorkflowId(String) Obsolete.
Sets the WorkflowId property

WorkflowId
The workflowId of the workflow execution to cancel.

Constraints:

Length
1 - 256


Inheritance Hierarchy
Object
AmazonWebServiceRequest
 RequestCancelWorkflowExecutionRequest
See Also

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