Copyright | (c) 2013-2017 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
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 .
- terminateWorkflowExecution :: Text -> Text -> TerminateWorkflowExecution
- data TerminateWorkflowExecution
- tweReason :: Lens' TerminateWorkflowExecution (Maybe Text)
- tweRunId :: Lens' TerminateWorkflowExecution (Maybe Text)
- tweChildPolicy :: Lens' TerminateWorkflowExecution (Maybe ChildPolicy)
- tweDetails :: Lens' TerminateWorkflowExecution (Maybe Text)
- tweDomain :: Lens' TerminateWorkflowExecution Text
- tweWorkflowId :: Lens' TerminateWorkflowExecution Text
- terminateWorkflowExecutionResponse :: TerminateWorkflowExecutionResponse
- data TerminateWorkflowExecutionResponse
Creating a Request
terminateWorkflowExecution Source #
Creates a value of TerminateWorkflowExecution
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tweReason
- A descriptive reason for terminating the workflow execution.tweRunId
- The runId of the workflow execution to terminate.tweChildPolicy
- 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 are terminated. *REQUEST_CANCEL
– A request to cancel is attempted for each child execution by recording aWorkflowExecutionCancelRequested
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 is taken. The child executions continue to run.tweDetails
- Details for terminating the workflow execution.tweDomain
- The domain of the workflow execution to terminate.tweWorkflowId
- The workflowId of the workflow execution to terminate.
data TerminateWorkflowExecution Source #
See: terminateWorkflowExecution
smart constructor.
Request Lenses
tweReason :: Lens' TerminateWorkflowExecution (Maybe Text) Source #
A descriptive reason for terminating the workflow execution.
tweRunId :: Lens' TerminateWorkflowExecution (Maybe Text) Source #
The runId of the workflow execution to terminate.
tweChildPolicy :: Lens' TerminateWorkflowExecution (Maybe ChildPolicy) Source #
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 are terminated. * REQUEST_CANCEL
– A request to cancel is 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 is taken. The child executions continue to run.
tweDetails :: Lens' TerminateWorkflowExecution (Maybe Text) Source #
Details for terminating the workflow execution.
tweDomain :: Lens' TerminateWorkflowExecution Text Source #
The domain of the workflow execution to terminate.
tweWorkflowId :: Lens' TerminateWorkflowExecution Text Source #
The workflowId of the workflow execution to terminate.
Destructuring the Response
terminateWorkflowExecutionResponse :: TerminateWorkflowExecutionResponse Source #
Creates a value of TerminateWorkflowExecutionResponse
with the minimum fields required to make a request.
data TerminateWorkflowExecutionResponse Source #
See: terminateWorkflowExecutionResponse
smart constructor.