AWS SDK Version 3 for .NET
API Reference

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 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 will contain an ActivityTimedOut event.

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.

Note:

For PCL this operation is only available in asynchronous form. Please refer to SendTaskHeartbeatAsync.

Namespace: Amazon.StepFunctions
Assembly: AWSSDK.StepFunctions.dll
Version: 3.x.y.z

Syntax

C#
public virtual SendTaskHeartbeatResponse SendTaskHeartbeat(
         SendTaskHeartbeatRequest request
)
Parameters
request
Type: Amazon.StepFunctions.Model.SendTaskHeartbeatRequest

Container for the necessary parameters to execute the SendTaskHeartbeat service method.

Return Value
The response from the SendTaskHeartbeat service method, as returned by StepFunctions.

Exceptions

ExceptionCondition
InvalidTokenException The provided token is invalid.
TaskDoesNotExistException
TaskTimedOutException

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also