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 |
Network.AWS.SWF.RecordActivityTaskHeartbeat
Description
Used by activity workers to report to the service that the ActivityTask
represented by the specified taskToken
is still making progress. The
worker can also (optionally) specify details of the progress, for
example percent complete, using the details
parameter. This action can
also be used by the worker as a mechanism to check if cancellation is
being requested for the activity task. If a cancellation is being
attempted for the specified task, then the boolean cancelRequested
flag returned by the service is set to true
.
This action resets the taskHeartbeatTimeout
clock. The
taskHeartbeatTimeout
is specified in RegisterActivityType.
This action does not in itself create an event in the workflow execution
history. However, if the task times out, the workflow execution history
will contain a ActivityTaskTimedOut
event that contains the
information from the last heartbeat generated by the activity worker.
The taskStartToCloseTimeout
of an activity type is the maximum
duration of an activity task, regardless of the number of
RecordActivityTaskHeartbeat requests received. The
taskStartToCloseTimeout
is also specified in RegisterActivityType.
This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted.
If the cancelRequested
flag returns true
, a cancellation is being
attempted. If the worker can cancel the activity, it should respond with
RespondActivityTaskCanceled. Otherwise, it should ignore the
cancellation 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. - 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.
See: AWS API Reference for RecordActivityTaskHeartbeat.
- recordActivityTaskHeartbeat :: Text -> RecordActivityTaskHeartbeat
- data RecordActivityTaskHeartbeat
- rathDetails :: Lens' RecordActivityTaskHeartbeat (Maybe Text)
- rathTaskToken :: Lens' RecordActivityTaskHeartbeat Text
- recordActivityTaskHeartbeatResponse :: Int -> Bool -> RecordActivityTaskHeartbeatResponse
- data RecordActivityTaskHeartbeatResponse
- rathrsResponseStatus :: Lens' RecordActivityTaskHeartbeatResponse Int
- rathrsCancelRequested :: Lens' RecordActivityTaskHeartbeatResponse Bool
Creating a Request
recordActivityTaskHeartbeat Source
Arguments
:: Text | |
-> RecordActivityTaskHeartbeat |
Creates a value of RecordActivityTaskHeartbeat
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data RecordActivityTaskHeartbeat Source
See: recordActivityTaskHeartbeat
smart constructor.
Instances
Request Lenses
rathDetails :: Lens' RecordActivityTaskHeartbeat (Maybe Text) Source
If specified, contains details about the progress of the task.
rathTaskToken :: Lens' RecordActivityTaskHeartbeat Text Source
The taskToken
of the ActivityTask.
taskToken
is generated by the service and should be treated as an
opaque value. If the task is passed to another process, its taskToken
must also be passed. This enables it to provide its progress and respond
with results.
Destructuring the Response
recordActivityTaskHeartbeatResponse Source
Arguments
:: Int | |
-> Bool | |
-> RecordActivityTaskHeartbeatResponse |
Creates a value of RecordActivityTaskHeartbeatResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data RecordActivityTaskHeartbeatResponse Source
Status information about an activity task.
See: recordActivityTaskHeartbeatResponse
smart constructor.
Instances
Response Lenses
rathrsResponseStatus :: Lens' RecordActivityTaskHeartbeatResponse Int Source
The response status code.
rathrsCancelRequested :: Lens' RecordActivityTaskHeartbeatResponse Bool Source
Set to true
if cancellation of the task is requested.