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

Contents

Description

Used by workers to get an ActivityTask from the specified activity taskList . This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll will return an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly.

Important: Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request).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. * Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

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

pollForActivityTask #

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

Use one of the following lenses to modify other fields as desired:

  • pfatIdentity - Identity of the worker making the request, recorded in the ActivityTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.
  • pfatDomain - The name of the domain that contains the task lists being polled.
  • pfatTaskList - Specifies the task list to poll for activity tasks. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (u0000-u001f | u007f - u009f). Also, it must not contain the literal string quotarnquot.

data PollForActivityTask #

See: pollForActivityTask smart constructor.

Instances

Eq PollForActivityTask # 
Data PollForActivityTask # 

Methods

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

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

toConstr :: PollForActivityTask -> Constr #

dataTypeOf :: PollForActivityTask -> DataType #

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

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

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

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

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

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

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

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

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

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

Read PollForActivityTask # 
Show PollForActivityTask # 
Generic PollForActivityTask # 
Hashable PollForActivityTask # 
ToJSON PollForActivityTask # 
NFData PollForActivityTask # 

Methods

rnf :: PollForActivityTask -> () #

AWSRequest PollForActivityTask # 
ToQuery PollForActivityTask # 
ToPath PollForActivityTask # 
ToHeaders PollForActivityTask # 
type Rep PollForActivityTask # 
type Rep PollForActivityTask = D1 (MetaData "PollForActivityTask" "Network.AWS.SWF.PollForActivityTask" "amazonka-swf-1.4.5-5efQTs2LdqG6LIeqZlvIEl" False) (C1 (MetaCons "PollForActivityTask'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_pfatIdentity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_pfatDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_pfatTaskList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TaskList)))))
type Rs PollForActivityTask # 

Request Lenses

pfatIdentity :: Lens' PollForActivityTask (Maybe Text) #

Identity of the worker making the request, recorded in the ActivityTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

pfatDomain :: Lens' PollForActivityTask Text #

The name of the domain that contains the task lists being polled.

pfatTaskList :: Lens' PollForActivityTask TaskList #

Specifies the task list to poll for activity tasks. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (u0000-u001f | u007f - u009f). Also, it must not contain the literal string quotarnquot.

Destructuring the Response

pollForActivityTaskResponse #

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

Use one of the following lenses to modify other fields as desired:

  • pfatrsActivityType - The type of this activity task.
  • pfatrsActivityId - The unique ID of the task.
  • pfatrsInput - The inputs provided when the activity task was scheduled. The form of the input is user defined and should be meaningful to the activity implementation.
  • pfatrsTaskToken - The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.
  • pfatrsWorkflowExecution - The workflow execution that started this activity task.
  • pfatrsResponseStatus - -- | The response status code.
  • pfatrsStartedEventId - The ID of the ActivityTaskStarted event recorded in the history.

data PollForActivityTaskResponse #

Unit of work sent to an activity worker.

See: pollForActivityTaskResponse smart constructor.

Instances

Eq PollForActivityTaskResponse # 
Data PollForActivityTaskResponse # 

Methods

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

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

toConstr :: PollForActivityTaskResponse -> Constr #

dataTypeOf :: PollForActivityTaskResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read PollForActivityTaskResponse # 
Show PollForActivityTaskResponse # 
Generic PollForActivityTaskResponse # 
NFData PollForActivityTaskResponse # 
type Rep PollForActivityTaskResponse # 
type Rep PollForActivityTaskResponse = D1 (MetaData "PollForActivityTaskResponse" "Network.AWS.SWF.PollForActivityTask" "amazonka-swf-1.4.5-5efQTs2LdqG6LIeqZlvIEl" False) (C1 (MetaCons "PollForActivityTaskResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_pfatrsActivityType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ActivityType))) ((:*:) (S1 (MetaSel (Just Symbol "_pfatrsActivityId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_pfatrsInput") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_pfatrsTaskToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_pfatrsWorkflowExecution") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe WorkflowExecution)))) ((:*:) (S1 (MetaSel (Just Symbol "_pfatrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_pfatrsStartedEventId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Integer))))))

Response Lenses

pfatrsInput :: Lens' PollForActivityTaskResponse (Maybe Text) #

The inputs provided when the activity task was scheduled. The form of the input is user defined and should be meaningful to the activity implementation.

pfatrsTaskToken :: Lens' PollForActivityTaskResponse (Maybe Text) #

The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.

pfatrsWorkflowExecution :: Lens' PollForActivityTaskResponse (Maybe WorkflowExecution) #

The workflow execution that started this activity task.

pfatrsStartedEventId :: Lens' PollForActivityTaskResponse Integer #

The ID of the ActivityTaskStarted event recorded in the history.