Container for the parameters to the SendTaskHeartbeat operation.
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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.StepFunctions.AmazonStepFunctionsRequest
Amazon.StepFunctions.Model.SendTaskHeartbeatRequest
Namespace: Amazon.StepFunctions.Model
Assembly: AWSSDK.StepFunctions.dll
Version: 3.x.y.z
Syntax
public class SendTaskHeartbeatRequest : AmazonStepFunctionsRequest IAmazonWebServiceRequest
The SendTaskHeartbeatRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
SendTaskHeartbeatRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
TaskToken | System.String |
Gets and sets the property TaskToken. 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. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5