Network.AWS.SWF.SignalWorkflowExecution

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.

Creating a Request

signalWorkflowExecution

Arguments

:: Text

sweDomain

-> Text

sweWorkflowId

-> Text

sweSignalName

-> 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
• sweRunId
• sweDomain
• sweWorkflowId
• sweSignalName

data SignalWorkflowExecution

See: signalWorkflowExecution smart constructor.

Instances

Eq SignalWorkflowExecution

Methods

(==) :: SignalWorkflowExecution -> SignalWorkflowExecution -> Bool

(/=) :: SignalWorkflowExecution -> SignalWorkflowExecution -> Bool

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

Methods

readsPrec :: Int -> ReadS SignalWorkflowExecution

readList :: ReadS [SignalWorkflowExecution]

readPrec :: ReadPrec SignalWorkflowExecution

readListPrec :: ReadPrec [SignalWorkflowExecution]

Show SignalWorkflowExecution

Methods

showsPrec :: Int -> SignalWorkflowExecution -> ShowS

show :: SignalWorkflowExecution -> String

showList :: [SignalWorkflowExecution] -> ShowS

Generic SignalWorkflowExecution

Associated Types

type Rep SignalWorkflowExecution :: * -> *

Methods

from :: SignalWorkflowExecution -> Rep SignalWorkflowExecution x

to :: Rep SignalWorkflowExecution x -> SignalWorkflowExecution

Hashable SignalWorkflowExecution

Methods

hashWithSalt :: Int -> SignalWorkflowExecution -> Int

hash :: SignalWorkflowExecution -> Int

ToJSON SignalWorkflowExecution

Methods

toJSON :: SignalWorkflowExecution -> Value

toEncoding :: SignalWorkflowExecution -> Encoding

toJSONList :: [SignalWorkflowExecution] -> Value

toEncodingList :: [SignalWorkflowExecution] -> Encoding

NFData SignalWorkflowExecution

Methods

rnf :: SignalWorkflowExecution -> ()

AWSRequest SignalWorkflowExecution

Associated Types

type Rs SignalWorkflowExecution :: *

Methods

request :: SignalWorkflowExecution -> Request SignalWorkflowExecution

response :: MonadResource m => Logger -> Service -> Proxy * SignalWorkflowExecution -> ClientResponse -> m (Response SignalWorkflowExecution)

ToQuery SignalWorkflowExecution

Methods

toQuery :: SignalWorkflowExecution -> QueryString

ToPath SignalWorkflowExecution

Methods

toPath :: SignalWorkflowExecution -> ByteString

ToHeaders SignalWorkflowExecution

Methods

toHeaders :: SignalWorkflowExecution -> [Header]

type Rep SignalWorkflowExecution

type Rep SignalWorkflowExecution = D1 (MetaData "SignalWorkflowExecution" "Network.AWS.SWF.SignalWorkflowExecution" "amazonka-swf-1.4.3-CUgUcKlV8EhcLLfbuVW5c" 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

type Rs SignalWorkflowExecution = SignalWorkflowExecutionResponse

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

Methods

(==) :: SignalWorkflowExecutionResponse -> SignalWorkflowExecutionResponse -> Bool

(/=) :: SignalWorkflowExecutionResponse -> SignalWorkflowExecutionResponse -> Bool

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

Methods

readsPrec :: Int -> ReadS SignalWorkflowExecutionResponse

readList :: ReadS [SignalWorkflowExecutionResponse]

readPrec :: ReadPrec SignalWorkflowExecutionResponse

readListPrec :: ReadPrec [SignalWorkflowExecutionResponse]

Show SignalWorkflowExecutionResponse

Methods

showsPrec :: Int -> SignalWorkflowExecutionResponse -> ShowS

show :: SignalWorkflowExecutionResponse -> String

showList :: [SignalWorkflowExecutionResponse] -> ShowS

Generic SignalWorkflowExecutionResponse

Associated Types

type Rep SignalWorkflowExecutionResponse :: * -> *

Methods

from :: SignalWorkflowExecutionResponse -> Rep SignalWorkflowExecutionResponse x

to :: Rep SignalWorkflowExecutionResponse x -> SignalWorkflowExecutionResponse

NFData SignalWorkflowExecutionResponse

Methods

rnf :: SignalWorkflowExecutionResponse -> ()

type Rep SignalWorkflowExecutionResponse

type Rep SignalWorkflowExecutionResponse = D1 (MetaData "SignalWorkflowExecutionResponse" "Network.AWS.SWF.SignalWorkflowExecution" "amazonka-swf-1.4.3-CUgUcKlV8EhcLLfbuVW5c" False) (C1 (MetaCons "SignalWorkflowExecutionResponse'" PrefixI False) U1)