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
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
This action resets the
taskHeartbeatTimeout clock. The
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
event that contains the information from the last heartbeat generated by the activity
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.
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.
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only
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
cause parameter is set to
For details and example IAM policies, see Using
IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
For .NET Core and PCL this operation is only available in asynchronous form. Please refer to RecordActivityTaskHeartbeatAsync.
public virtual RecordActivityTaskHeartbeatResponse RecordActivityTaskHeartbeat( RecordActivityTaskHeartbeatRequest request )
Container for the necessary parameters to execute the RecordActivityTaskHeartbeat service method.
|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.|
Supported in: 4.5, 4.0, 3.5
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms