Copyright | (c) 2013-2015 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 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.
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.
See: AWS API Reference for PollForActivityTask.
- pollForActivityTask :: Text -> TaskList -> PollForActivityTask
- data PollForActivityTask
- pfatIdentity :: Lens' PollForActivityTask (Maybe Text)
- pfatDomain :: Lens' PollForActivityTask Text
- pfatTaskList :: Lens' PollForActivityTask TaskList
- pollForActivityTaskResponse :: Int -> Text -> Text -> Integer -> WorkflowExecution -> ActivityType -> PollForActivityTaskResponse
- data PollForActivityTaskResponse
- pfatrsInput :: Lens' PollForActivityTaskResponse (Maybe Text)
- pfatrsResponseStatus :: Lens' PollForActivityTaskResponse Int
- pfatrsTaskToken :: Lens' PollForActivityTaskResponse Text
- pfatrsActivityId :: Lens' PollForActivityTaskResponse Text
- pfatrsStartedEventId :: Lens' PollForActivityTaskResponse Integer
- pfatrsWorkflowExecution :: Lens' PollForActivityTaskResponse WorkflowExecution
- pfatrsActivityType :: Lens' PollForActivityTaskResponse ActivityType
Creating a Request
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:
data PollForActivityTask Source
See: pollForActivityTask
smart constructor.
Request Lenses
pfatIdentity :: Lens' PollForActivityTask (Maybe Text) Source
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 Source
The name of the domain that contains the task lists being polled.
pfatTaskList :: Lens' PollForActivityTask TaskList Source
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 Source
:: Int | |
-> Text | |
-> Text | |
-> Integer | |
-> WorkflowExecution | |
-> ActivityType | |
-> 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:
data PollForActivityTaskResponse Source
Unit of work sent to an activity worker.
See: pollForActivityTaskResponse
smart constructor.
Response Lenses
pfatrsInput :: Lens' PollForActivityTaskResponse (Maybe Text) Source
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.
pfatrsResponseStatus :: Lens' PollForActivityTaskResponse Int Source
The response status code.
pfatrsTaskToken :: Lens' PollForActivityTaskResponse 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.
pfatrsActivityId :: Lens' PollForActivityTaskResponse Text Source
The unique ID of the task.
pfatrsStartedEventId :: Lens' PollForActivityTaskResponse Integer Source
The ID of the ActivityTaskStarted
event recorded in the history.
pfatrsWorkflowExecution :: Lens' PollForActivityTaskResponse WorkflowExecution Source
The workflow execution that started this activity task.
pfatrsActivityType :: Lens' PollForActivityTaskResponse ActivityType Source
The type of this activity task.