Copyright | (c) 2013-2016 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 |
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.
Important: Deciders should set their client-side socket timeout to at least 70 seconds (10 seconds higher than the timeout).Important: 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 anAction
element to allow or deny permission to call this action. * Constrain thetaskList.name
parameter by using a Condition element with theswf: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.
- pollForDecisionTask :: Text -> TaskList -> PollForDecisionTask
- data PollForDecisionTask
- pfdtNextPageToken :: Lens' PollForDecisionTask (Maybe Text)
- pfdtReverseOrder :: Lens' PollForDecisionTask (Maybe Bool)
- pfdtMaximumPageSize :: Lens' PollForDecisionTask (Maybe Natural)
- pfdtIdentity :: Lens' PollForDecisionTask (Maybe Text)
- pfdtDomain :: Lens' PollForDecisionTask Text
- pfdtTaskList :: Lens' PollForDecisionTask TaskList
- pollForDecisionTaskResponse :: Int -> Integer -> PollForDecisionTaskResponse
- data PollForDecisionTaskResponse
- pfdtrsNextPageToken :: Lens' PollForDecisionTaskResponse (Maybe Text)
- pfdtrsWorkflowType :: Lens' PollForDecisionTaskResponse (Maybe WorkflowType)
- pfdtrsPreviousStartedEventId :: Lens' PollForDecisionTaskResponse (Maybe Integer)
- pfdtrsEvents :: Lens' PollForDecisionTaskResponse [HistoryEvent]
- pfdtrsTaskToken :: Lens' PollForDecisionTaskResponse (Maybe Text)
- pfdtrsWorkflowExecution :: Lens' PollForDecisionTaskResponse (Maybe WorkflowExecution)
- pfdtrsResponseStatus :: Lens' PollForDecisionTaskResponse Int
- pfdtrsStartedEventId :: Lens' PollForDecisionTaskResponse Integer
Creating a Request
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:
pfdtNextPageToken
- If aNextPageToken
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 innextPageToken
. Keep all other arguments unchanged. The configuredmaximumPageSize
determines how many results can be returned in a single call. .pfdtReverseOrder
- When set totrue
, returns the events in reverse order. By default the results are returned in ascending order of theeventTimestamp
of the events.pfdtMaximumPageSize
- 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
- 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
- The name of the domain containing the task lists to poll.pfdtTaskList
- 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.
data PollForDecisionTask Source #
See: pollForDecisionTask
smart constructor.
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. .
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
pollForDecisionTaskResponse Source #
Creates a value of PollForDecisionTaskResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pfdtrsNextPageToken
- If aNextPageToken
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 innextPageToken
. Keep all other arguments unchanged. The configuredmaximumPageSize
determines how many results can be returned in a single call.pfdtrsWorkflowType
- The type of the workflow execution for which this decision task was created.pfdtrsPreviousStartedEventId
- 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
- A paginated list of history events of the workflow execution. The decider uses this during the processing of the decision task.pfdtrsTaskToken
- 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
- The workflow execution for which this decision task was created.pfdtrsResponseStatus
- -- | The response status code.pfdtrsStartedEventId
- The ID of theDecisionTaskStarted
event recorded in the history.
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.
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.
pfdtrsResponseStatus :: Lens' PollForDecisionTaskResponse Int Source #
- - | The response status code.
pfdtrsStartedEventId :: Lens' PollForDecisionTaskResponse Integer Source #
The ID of the DecisionTaskStarted
event recorded in the history.