SFN / Client / send_task_heartbeat
Used by activity workers and task states using the callback pattern to report to Step Functions that the task represented by the specified
taskTokenis still making progress. This action resets the
Heartbeatthreshold 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
ActivityTimedOutentry for activities, or a
TaskTimedOutentry for for tasks using the job run or callback pattern.
Timeoutof 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
HeartbeatSecondsto configure the timeout interval for heartbeats.
See also: AWS API Documentation
response = client.send_task_heartbeat( taskToken='string' )
taskToken (string) –
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.
- Return type: