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.
taskTokenis still making progress. The worker can also (optionally) specify details of the progress, for example percent complete, using the
detailsparameter. 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
cancelRequestedflag returned by the service is set to
This action resets the
taskHeartbeatTimeout clock. The
is specified in RegisterActivityType.
This action does not in itself create an event in the workflow execution history.
However, if the task times out, the workflow execution history will contain a
event that contains the information from the last heartbeat generated by the activity
taskStartToCloseTimeoutof an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The
taskStartToCloseTimeoutis also specified in RegisterActivityType.
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:
Resourceelement with the domain name to limit the action to only specified domains.
Actionelement to allow or deny permission to call this action.
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Version: (assembly version)
public virtual RecordActivityTaskHeartbeatResponse RecordActivityTaskHeartbeat( RecordActivityTaskHeartbeatRequest request )
Container for the necessary parameters to execute the RecordActivityTaskHeartbeat service method.
|OperationNotPermittedException||Returned when the caller does not 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