AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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
The 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.
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.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginSendTaskHeartbeat and EndSendTaskHeartbeat.
Namespace: Amazon.StepFunctions
Assembly: AWSSDK.StepFunctions.dll
Version: 3.x.y.z
public virtual Task<SendTaskHeartbeatResponse> SendTaskHeartbeatAsync( SendTaskHeartbeatRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the SendTaskHeartbeat service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Exception | Condition |
---|---|
InvalidTokenException | The provided token is not valid. |
TaskDoesNotExistException | The activity does not exist. |
TaskTimedOutException | The task token has either expired or the task associated with the token has already been closed. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5