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 to report to the service that the ActivityTask represented
by the specified taskToken is still making progress. The worker can also specify
details of the progress, for example percent complete, using the details parameter.
This action can also be used by the worker as a mechanism to check if cancellation
is being requested for the activity task. If a cancellation is being attempted for
the specified task, then the boolean cancelRequested flag returned by the service
is set to true.
This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout
is specified in RegisterActivityType.
This action doesn't in itself create an event in the workflow execution history. However,
if the task times out, the workflow execution history contains a ActivityTaskTimedOut
event that contains the information from the last heartbeat generated by the activity
worker.
The taskStartToCloseTimeout of an activity type is the maximum duration of
an activity task, regardless of the number of RecordActivityTaskHeartbeat requests
received. The taskStartToCloseTimeout is also specified in RegisterActivityType.
This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted.
If the cancelRequested flag returns true, a cancellation is being attempted.
If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled.
Otherwise, it should ignore the cancellation request.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource element with the domain name to limit the action to only specified
domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter
values fall outside the specified constraints, the action fails. The associated event
attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details
and example IAM policies, see Using
IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 BeginRecordActivityTaskHeartbeat and EndRecordActivityTaskHeartbeat.
Namespace: Amazon.SimpleWorkflow
Assembly: AWSSDK.SimpleWorkflow.dll
Version: 3.x.y.z
public abstract Task<RecordActivityTaskHeartbeatResponse> RecordActivityTaskHeartbeatAsync( RecordActivityTaskHeartbeatRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the RecordActivityTaskHeartbeat service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| OperationNotPermittedException | Returned when the caller doesn't have sufficient permissions to invoke the action. |
| UnknownResourceException | Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5