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 WorkflowExecutionSignaled
event in the workflow execution
history and creates a decision task for the workflow execution
identified by the given domain, workflowId and runId. The event is
recorded with the specified user defined signalName and input (if
provided).
If a runId is not specified, then the WorkflowExecutionSignaled
event
is recorded in the history of the current open workflow with the
matching workflowId in the domain.
If the specified workflow execution is not open, this method fails with
UnknownResource
.
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 SignalWorkflowExecution.
- signalWorkflowExecution :: Text -> Text -> Text -> SignalWorkflowExecution
- data SignalWorkflowExecution
- sweInput :: Lens' SignalWorkflowExecution (Maybe Text)
- sweRunId :: Lens' SignalWorkflowExecution (Maybe Text)
- sweDomain :: Lens' SignalWorkflowExecution Text
- sweWorkflowId :: Lens' SignalWorkflowExecution Text
- sweSignalName :: Lens' SignalWorkflowExecution Text
- signalWorkflowExecutionResponse :: SignalWorkflowExecutionResponse
- data SignalWorkflowExecutionResponse
Creating a Request
signalWorkflowExecution Source
Creates a value of SignalWorkflowExecution
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data SignalWorkflowExecution Source
See: signalWorkflowExecution
smart constructor.
Request Lenses
sweInput :: Lens' SignalWorkflowExecution (Maybe Text) Source
Data to attach to the WorkflowExecutionSignaled
event in the target
workflow execution's history.
sweRunId :: Lens' SignalWorkflowExecution (Maybe Text) Source
The runId of the workflow execution to signal.
sweDomain :: Lens' SignalWorkflowExecution Text Source
The name of the domain containing the workflow execution to signal.
sweWorkflowId :: Lens' SignalWorkflowExecution Text Source
The workflowId of the workflow execution to signal.
sweSignalName :: Lens' SignalWorkflowExecution Text Source
The name of the signal. This name must be meaningful to the target workflow.
Destructuring the Response
signalWorkflowExecutionResponse :: SignalWorkflowExecutionResponse Source
Creates a value of SignalWorkflowExecutionResponse
with the minimum fields required to make a request.
data SignalWorkflowExecutionResponse Source
See: signalWorkflowExecutionResponse
smart constructor.