Container for the parameters to the {@link com.amazonaws.services.simpleworkflow.AmazonSimpleWorkflow#recordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest) RecordActivityTaskHeartbeat operation}.
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.
NOTE: 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.
NOTE: This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted.
IMPORTANT: 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.
@see com.amazonaws.services.simpleworkflow.AmazonSimpleWorkflow#recordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest)