Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
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.
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:
- 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 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.
See: AWS API Reference for RequestCancelWorkflowExecution.
- requestCancelWorkflowExecution :: Text -> Text -> RequestCancelWorkflowExecution
- data RequestCancelWorkflowExecution
- rcweRunId :: Lens' RequestCancelWorkflowExecution (Maybe Text)
- rcweDomain :: Lens' RequestCancelWorkflowExecution Text
- rcweWorkflowId :: Lens' RequestCancelWorkflowExecution Text
- requestCancelWorkflowExecutionResponse :: RequestCancelWorkflowExecutionResponse
- data RequestCancelWorkflowExecutionResponse
Creating a Request
requestCancelWorkflowExecution Source
Creates a value of RequestCancelWorkflowExecution
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data RequestCancelWorkflowExecution Source
See: requestCancelWorkflowExecution
smart constructor.
Request Lenses
rcweRunId :: Lens' RequestCancelWorkflowExecution (Maybe Text) Source
The runId of the workflow execution to cancel.
rcweDomain :: Lens' RequestCancelWorkflowExecution Text Source
The name of the domain containing the workflow execution to cancel.
rcweWorkflowId :: Lens' RequestCancelWorkflowExecution Text Source
The workflowId of the workflow execution to cancel.
Destructuring the Response
requestCancelWorkflowExecutionResponse :: RequestCancelWorkflowExecutionResponse Source
Creates a value of RequestCancelWorkflowExecutionResponse
with the minimum fields required to make a request.
data RequestCancelWorkflowExecutionResponse Source
See: requestCancelWorkflowExecutionResponse
smart constructor.