amazonka-swf-1.4.1: 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.PollForDecisionTask

Contents

Description

Used by deciders to get a DecisionTask from the specified decision taskList. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task.

This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string.

Deciders should set their client-side socket timeout to at least 70 seconds (10 seconds higher than the timeout).

Because the number of workflow history events for a single workflow execution might be very large, the result returned might be split up across a number of pages. To retrieve subsequent pages, make additional calls to PollForDecisionTask using the nextPageToken returned by the initial call. Note that you do not call GetWorkflowExecutionHistory with this nextPageToken. Instead, call PollForDecisionTask again.

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.

This operation returns paginated results.

Synopsis

Creating a Request

pollForDecisionTask Source #

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

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

data PollForDecisionTask Source #

See: pollForDecisionTask smart constructor.

Instances

Eq PollForDecisionTask Source # 
Data PollForDecisionTask Source # 

Methods

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

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

toConstr :: PollForDecisionTask -> Constr #

dataTypeOf :: PollForDecisionTask -> DataType #

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

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

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

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

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

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

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

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

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

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

Read PollForDecisionTask Source # 
Show PollForDecisionTask Source # 
Generic PollForDecisionTask Source # 
Hashable PollForDecisionTask Source # 
ToJSON PollForDecisionTask Source # 
NFData PollForDecisionTask Source # 

Methods

rnf :: PollForDecisionTask -> () #

AWSPager PollForDecisionTask Source # 
AWSRequest PollForDecisionTask Source # 
ToQuery PollForDecisionTask Source # 
ToPath PollForDecisionTask Source # 
ToHeaders PollForDecisionTask Source # 
type Rep PollForDecisionTask Source # 
type Rep PollForDecisionTask = D1 (MetaData "PollForDecisionTask" "Network.AWS.SWF.PollForDecisionTask" "amazonka-swf-1.4.1-B56KhnkqZ4FK6prO1ov5ps" False) (C1 (MetaCons "PollForDecisionTask'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_pfdtNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_pfdtReverseOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_pfdtMaximumPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))))) ((:*:) (S1 (MetaSel (Just Symbol "_pfdtIdentity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_pfdtDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_pfdtTaskList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TaskList))))))
type Rs PollForDecisionTask Source # 

Request Lenses

pfdtNextPageToken :: Lens' PollForDecisionTask (Maybe Text) Source #

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken will not return a new decision task.

.

pfdtReverseOrder :: Lens' PollForDecisionTask (Maybe Bool) Source #

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimestamp of the events.

pfdtMaximumPageSize :: Lens' PollForDecisionTask (Maybe Natural) Source #

The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

pfdtIdentity :: Lens' PollForDecisionTask (Maybe Text) Source #

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

pfdtDomain :: Lens' PollForDecisionTask Text Source #

The name of the domain containing the task lists to poll.

pfdtTaskList :: Lens' PollForDecisionTask TaskList Source #

Specifies the task list to poll for decision 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

data PollForDecisionTaskResponse Source #

A structure that represents a decision task. Decision tasks are sent to deciders in order for them to make decisions.

See: pollForDecisionTaskResponse smart constructor.

Instances

Eq PollForDecisionTaskResponse Source # 
Data PollForDecisionTaskResponse Source # 

Methods

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

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

toConstr :: PollForDecisionTaskResponse -> Constr #

dataTypeOf :: PollForDecisionTaskResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read PollForDecisionTaskResponse Source # 
Show PollForDecisionTaskResponse Source # 
Generic PollForDecisionTaskResponse Source # 
NFData PollForDecisionTaskResponse Source # 
type Rep PollForDecisionTaskResponse Source # 
type Rep PollForDecisionTaskResponse = D1 (MetaData "PollForDecisionTaskResponse" "Network.AWS.SWF.PollForDecisionTask" "amazonka-swf-1.4.1-B56KhnkqZ4FK6prO1ov5ps" False) (C1 (MetaCons "PollForDecisionTaskResponse'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_pfdtrsNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_pfdtrsWorkflowType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe WorkflowType)))) ((:*:) (S1 (MetaSel (Just Symbol "_pfdtrsPreviousStartedEventId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer))) (S1 (MetaSel (Just Symbol "_pfdtrsEvents") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [HistoryEvent]))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_pfdtrsTaskToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_pfdtrsWorkflowExecution") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe WorkflowExecution)))) ((:*:) (S1 (MetaSel (Just Symbol "_pfdtrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_pfdtrsStartedEventId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Integer))))))

Response Lenses

pfdtrsNextPageToken :: Lens' PollForDecisionTaskResponse (Maybe Text) Source #

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

pfdtrsWorkflowType :: Lens' PollForDecisionTaskResponse (Maybe WorkflowType) Source #

The type of the workflow execution for which this decision task was created.

pfdtrsPreviousStartedEventId :: Lens' PollForDecisionTaskResponse (Maybe Integer) Source #

The ID of the DecisionTaskStarted event of the previous decision task of this workflow execution that was processed by the decider. This can be used to determine the events in the history new since the last decision task received by the decider.

pfdtrsEvents :: Lens' PollForDecisionTaskResponse [HistoryEvent] Source #

A paginated list of history events of the workflow execution. The decider uses this during the processing of the decision task.

pfdtrsTaskToken :: Lens' PollForDecisionTaskResponse (Maybe Text) Source #

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.

pfdtrsWorkflowExecution :: Lens' PollForDecisionTaskResponse (Maybe WorkflowExecution) Source #

The workflow execution for which this decision task was created.