| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.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 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 doesn't in itself create an event in the workflow execution
history. However, if the task times out, the workflow execution history
contains 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
Resourceelement with the domain name to limit the action to only specified domains. - Use an
Actionelement to allow or deny permission to call this action. - You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't 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 is set
to OPERATION_NOT_PERMITTED. For details and example IAM policies, see
Using IAM to Manage Access to Amazon SWF Workflows
in the Amazon SWF Developer Guide.
Synopsis
- data RecordActivityTaskHeartbeat = RecordActivityTaskHeartbeat' {}
- newRecordActivityTaskHeartbeat :: Text -> RecordActivityTaskHeartbeat
- recordActivityTaskHeartbeat_details :: Lens' RecordActivityTaskHeartbeat (Maybe Text)
- recordActivityTaskHeartbeat_taskToken :: Lens' RecordActivityTaskHeartbeat Text
- data RecordActivityTaskHeartbeatResponse = RecordActivityTaskHeartbeatResponse' {
- httpStatus :: Int
- cancelRequested :: Bool
- newRecordActivityTaskHeartbeatResponse :: Int -> Bool -> RecordActivityTaskHeartbeatResponse
- recordActivityTaskHeartbeatResponse_httpStatus :: Lens' RecordActivityTaskHeartbeatResponse Int
- recordActivityTaskHeartbeatResponse_cancelRequested :: Lens' RecordActivityTaskHeartbeatResponse Bool
Creating a Request
data RecordActivityTaskHeartbeat Source #
See: newRecordActivityTaskHeartbeat smart constructor.
Constructors
| RecordActivityTaskHeartbeat' | |
Fields
| |
Instances
newRecordActivityTaskHeartbeat Source #
Create a value of RecordActivityTaskHeartbeat with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:details:RecordActivityTaskHeartbeat', recordActivityTaskHeartbeat_details - If specified, contains details about the progress of the task.
$sel:taskToken:RecordActivityTaskHeartbeat', recordActivityTaskHeartbeat_taskToken - 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.
Request Lenses
recordActivityTaskHeartbeat_details :: Lens' RecordActivityTaskHeartbeat (Maybe Text) Source #
If specified, contains details about the progress of the task.
recordActivityTaskHeartbeat_taskToken :: 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
data RecordActivityTaskHeartbeatResponse Source #
Status information about an activity task.
See: newRecordActivityTaskHeartbeatResponse smart constructor.
Constructors
| RecordActivityTaskHeartbeatResponse' | |
Fields
| |
Instances
newRecordActivityTaskHeartbeatResponse Source #
Arguments
| :: Int | |
| -> Bool | |
| -> RecordActivityTaskHeartbeatResponse |
Create a value of RecordActivityTaskHeartbeatResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:RecordActivityTaskHeartbeatResponse', recordActivityTaskHeartbeatResponse_httpStatus - The response's http status code.
$sel:cancelRequested:RecordActivityTaskHeartbeatResponse', recordActivityTaskHeartbeatResponse_cancelRequested - Set to true if cancellation of the task is requested.
Response Lenses
recordActivityTaskHeartbeatResponse_httpStatus :: Lens' RecordActivityTaskHeartbeatResponse Int Source #
The response's http status code.
recordActivityTaskHeartbeatResponse_cancelRequested :: Lens' RecordActivityTaskHeartbeatResponse Bool Source #
Set to true if cancellation of the task is requested.