34
34
class StepFunctionsClient extends AbstractApi
35
35
{
36
36
/**
37
- * Used by activity workers and task states using the callback [^1] pattern to report that the task identified by the
38
- * `taskToken` failed.
37
+ * Used by activity workers, Task states using the callback [^1] pattern, and optionally Task states using the job run
38
+ * [^2] pattern to report that the task identified by the `taskToken` failed.
39
39
*
40
40
* [^1]: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
41
+ * [^2]: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync
41
42
*
42
43
* @see https://docs.aws.amazon.com/step-functions/latest/apireference/API_SendTaskFailure.html
43
44
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-states-2016-11-23.html#sendtaskfailure
@@ -66,20 +67,21 @@ public function sendTaskFailure($input): SendTaskFailureOutput
66
67
}
67
68
68
69
/**
69
- * Used by activity workers and task states using the callback [^1] pattern to report to Step Functions that the task
70
- * represented by the specified `taskToken` is still making progress. This action resets the `Heartbeat` clock. The
71
- * `Heartbeat` threshold is specified in the state machine's Amazon States Language definition (`HeartbeatSeconds`).
72
- * This action does not in itself create an event in the execution history. However, if the task times out, the
73
- * execution history contains an `ActivityTimedOut` entry for activities, or a `TaskTimedOut ` entry for for tasks using
74
- * the job run [^2 ] or callback [^3 ] pattern.
70
+ * Used by activity workers and Task states using the callback [^1] pattern, and optionally Task states using the job
71
+ * run [^2] pattern to report to Step Functions that the task represented by the specified `taskToken` is still making
72
+ * progress. This action resets the `Heartbeat` clock. The `Heartbeat` threshold is specified in the state machine's
73
+ * Amazon States Language definition (`HeartbeatSeconds`). This action does not in itself create an event in the
74
+ * execution history. However, if the task times out, the execution history contains an `ActivityTimedOut ` entry for
75
+ * activities, or a `TaskTimedOut` entry for tasks using the job run [^3 ] or callback [^4 ] pattern.
75
76
*
76
77
* > The `Timeout` of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed
77
78
* > duration, regardless of the number of SendTaskHeartbeat requests received. Use `HeartbeatSeconds` to configure the
78
79
* > timeout interval for heartbeats.
79
80
*
80
81
* [^1]: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
81
82
* [^2]: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync
82
- * [^3]: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
83
+ * [^3]: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync
84
+ * [^4]: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
83
85
*
84
86
* @see https://docs.aws.amazon.com/step-functions/latest/apireference/API_SendTaskHeartbeat.html
85
87
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-states-2016-11-23.html#sendtaskheartbeat
@@ -106,10 +108,11 @@ public function sendTaskHeartbeat($input): SendTaskHeartbeatOutput
106
108
}
107
109
108
110
/**
109
- * Used by activity workers and task states using the callback [^1] pattern to report that the task identified by the
110
- * `taskToken` completed successfully.
111
+ * Used by activity workers, Task states using the callback [^1] pattern, and optionally Task states using the job run
112
+ * [^2] pattern to report that the task identified by the `taskToken` completed successfully.
111
113
*
112
114
* [^1]: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
115
+ * [^2]: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync
113
116
*
114
117
* @see https://docs.aws.amazon.com/step-functions/latest/apireference/API_SendTaskSuccess.html
115
118
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-states-2016-11-23.html#sendtasksuccess
0 commit comments