paws.application.integration (version 0.1.0)

sfn_send_task_heartbeat: Used by workers to report to the service that the task represented by the specified taskToken is still making progress

Description

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.

Usage

sfn_send_task_heartbeat(taskToken)

Arguments

taskToken

[required] The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTaskOutput\$taskToken).

Request syntax

svc$send_task_heartbeat(
  taskToken = "string"
)

Details

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.

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