Menu
AWS Step Functions
API Reference (API Version 2016-11-23)

SendTaskHeartbeat

Used by workers to report to the service 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. 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 event.

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.

Note

This operation is only useful for long-lived tasks to report the liveliness of the task.

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 the service when the tasks are assigned to a worker (see GetActivityTask:taskToken).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

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 invalid.

HTTP Status Code: 400

TaskDoesNotExist

HTTP Status Code: 400

TaskTimedOut

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: