| 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.StepFunctions.SendTaskHeartbeat
Description
Used by activity workers and task states using the
callback
pattern to report to Step Functions that the task represented by the
specified taskToken is still making progress. This action resets the
Heartbeat clock. The Heartbeat threshold is specified in the state
machine's Amazon States Language definition (HeartbeatSeconds). This
action does not in itself create an event in the execution history.
However, if the task times out, the execution history contains an
ActivityTimedOut entry for activities, or a TaskTimedOut entry for
for tasks using the
job run
or
callback
pattern.
The Timeout of a task, defined in the state machine's Amazon States
Language definition, is its maximum allowed duration, regardless of the
number of SendTaskHeartbeat requests received. Use HeartbeatSeconds to
configure the timeout interval for heartbeats.
Synopsis
- data SendTaskHeartbeat = SendTaskHeartbeat' {}
- newSendTaskHeartbeat :: Text -> SendTaskHeartbeat
- sendTaskHeartbeat_taskToken :: Lens' SendTaskHeartbeat Text
- data SendTaskHeartbeatResponse = SendTaskHeartbeatResponse' {
- httpStatus :: Int
- newSendTaskHeartbeatResponse :: Int -> SendTaskHeartbeatResponse
- sendTaskHeartbeatResponse_httpStatus :: Lens' SendTaskHeartbeatResponse Int
Creating a Request
data SendTaskHeartbeat Source #
See: newSendTaskHeartbeat smart constructor.
Constructors
| SendTaskHeartbeat' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> SendTaskHeartbeat |
Create a value of SendTaskHeartbeat 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:taskToken:SendTaskHeartbeat', sendTaskHeartbeat_taskToken - The token that represents this task. Task tokens are generated by Step
Functions when tasks are assigned to a worker, or in the
context object
when a workflow enters a task state. See
GetActivityTaskOutput$taskToken.
Request Lenses
sendTaskHeartbeat_taskToken :: Lens' SendTaskHeartbeat Text Source #
The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.
Destructuring the Response
data SendTaskHeartbeatResponse Source #
See: newSendTaskHeartbeatResponse smart constructor.
Constructors
| SendTaskHeartbeatResponse' | |
Fields
| |
Instances
newSendTaskHeartbeatResponse Source #
Create a value of SendTaskHeartbeatResponse 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:SendTaskHeartbeatResponse', sendTaskHeartbeatResponse_httpStatus - The response's http status code.
Response Lenses
sendTaskHeartbeatResponse_httpStatus :: Lens' SendTaskHeartbeatResponse Int Source #
The response's http status code.