amazonka-swf-1.4.5: Amazon Simple Workflow Service SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.SWF.SignalWorkflowExecution

Contents

Description

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).

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 .

Synopsis

Creating a Request

signalWorkflowExecution #

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:

  • sweInput - Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.
  • sweRunId - The runId of the workflow execution to signal.
  • sweDomain - The name of the domain containing the workflow execution to signal.
  • sweWorkflowId - The workflowId of the workflow execution to signal.
  • sweSignalName - The name of the signal. This name must be meaningful to the target workflow.

data SignalWorkflowExecution #

See: signalWorkflowExecution smart constructor.

Instances

Eq SignalWorkflowExecution # 
Data SignalWorkflowExecution # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SignalWorkflowExecution -> c SignalWorkflowExecution #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SignalWorkflowExecution #

toConstr :: SignalWorkflowExecution -> Constr #

dataTypeOf :: SignalWorkflowExecution -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SignalWorkflowExecution) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SignalWorkflowExecution) #

gmapT :: (forall b. Data b => b -> b) -> SignalWorkflowExecution -> SignalWorkflowExecution #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SignalWorkflowExecution -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SignalWorkflowExecution -> r #

gmapQ :: (forall d. Data d => d -> u) -> SignalWorkflowExecution -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SignalWorkflowExecution -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SignalWorkflowExecution -> m SignalWorkflowExecution #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SignalWorkflowExecution -> m SignalWorkflowExecution #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SignalWorkflowExecution -> m SignalWorkflowExecution #

Read SignalWorkflowExecution # 
Show SignalWorkflowExecution # 
Generic SignalWorkflowExecution # 
Hashable SignalWorkflowExecution # 
ToJSON SignalWorkflowExecution # 
NFData SignalWorkflowExecution # 

Methods

rnf :: SignalWorkflowExecution -> () #

AWSRequest SignalWorkflowExecution # 
ToQuery SignalWorkflowExecution # 
ToPath SignalWorkflowExecution # 
ToHeaders SignalWorkflowExecution # 
type Rep SignalWorkflowExecution # 
type Rep SignalWorkflowExecution = D1 (MetaData "SignalWorkflowExecution" "Network.AWS.SWF.SignalWorkflowExecution" "amazonka-swf-1.4.5-5efQTs2LdqG6LIeqZlvIEl" False) (C1 (MetaCons "SignalWorkflowExecution'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_sweInput") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_sweRunId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_sweDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_sweWorkflowId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_sweSignalName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))
type Rs SignalWorkflowExecution # 

Request Lenses

sweInput :: Lens' SignalWorkflowExecution (Maybe Text) #

Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.

sweRunId :: Lens' SignalWorkflowExecution (Maybe Text) #

The runId of the workflow execution to signal.

sweDomain :: Lens' SignalWorkflowExecution Text #

The name of the domain containing the workflow execution to signal.

sweWorkflowId :: Lens' SignalWorkflowExecution Text #

The workflowId of the workflow execution to signal.

sweSignalName :: Lens' SignalWorkflowExecution Text #

The name of the signal. This name must be meaningful to the target workflow.

Destructuring the Response

signalWorkflowExecutionResponse :: SignalWorkflowExecutionResponse #

Creates a value of SignalWorkflowExecutionResponse with the minimum fields required to make a request.

data SignalWorkflowExecutionResponse #

See: signalWorkflowExecutionResponse smart constructor.

Instances

Eq SignalWorkflowExecutionResponse # 
Data SignalWorkflowExecutionResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SignalWorkflowExecutionResponse -> c SignalWorkflowExecutionResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SignalWorkflowExecutionResponse #

toConstr :: SignalWorkflowExecutionResponse -> Constr #

dataTypeOf :: SignalWorkflowExecutionResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SignalWorkflowExecutionResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SignalWorkflowExecutionResponse) #

gmapT :: (forall b. Data b => b -> b) -> SignalWorkflowExecutionResponse -> SignalWorkflowExecutionResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SignalWorkflowExecutionResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SignalWorkflowExecutionResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> SignalWorkflowExecutionResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SignalWorkflowExecutionResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SignalWorkflowExecutionResponse -> m SignalWorkflowExecutionResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SignalWorkflowExecutionResponse -> m SignalWorkflowExecutionResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SignalWorkflowExecutionResponse -> m SignalWorkflowExecutionResponse #

Read SignalWorkflowExecutionResponse # 
Show SignalWorkflowExecutionResponse # 
Generic SignalWorkflowExecutionResponse # 
NFData SignalWorkflowExecutionResponse # 
type Rep SignalWorkflowExecutionResponse # 
type Rep SignalWorkflowExecutionResponse = D1 (MetaData "SignalWorkflowExecutionResponse" "Network.AWS.SWF.SignalWorkflowExecution" "amazonka-swf-1.4.5-5efQTs2LdqG6LIeqZlvIEl" False) (C1 (MetaCons "SignalWorkflowExecutionResponse'" PrefixI False) U1)