SendTaskHeartbeat
Used by activity workers and Task states using the callback
pattern, and optionally Task states using the job run 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 tasks using the job run or
callback
pattern.
Note
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.
Request Syntax
{
"taskToken": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- 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 GetActivityTask:taskToken.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidToken
-
The provided token is not valid.
HTTP Status Code: 400
- TaskDoesNotExist
-
The activity does not exist.
HTTP Status Code: 400
- TaskTimedOut
-
The task token has either expired or the task associated with the token has already been closed.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: