Used by workers to tell the service that the ActivityTask identified by the
successfully canceled. Additional
details can be optionally provided using the
details (if provided) appear in the
ActivityTaskCanceled event added to the
Only use this operation if the
canceled flag of a RecordActivityTaskHeartbeat
true and if the activity can be safely undone or abandoned.
A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.
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.
You cannot use an IAM policy to constrain this action's parameters.
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.
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
Optional. Information about the cancellation.
Length Constraints: Maximum length of 32768.
taskTokenof the ActivityTask.
taskTokenis generated by the service and should be treated as an opaque value. If the task is passed to another process, its
taskTokenmust also be passed. This enables it to provide its progress and respond with results.
Length Constraints: Minimum length of 1. Maximum length of 1024.
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
For information about the errors that are common to all actions, see Common Errors.
Returned when the caller does not have sufficient permissions to invoke the action.
HTTP Status Code: 400
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.
HTTP Status Code: 400
HTTP/1.1 200 OK Content-Length: 0 Content-Type: application/json x-amzn-RequestId: b1a001a6-3ffb-11e1-9b11-7182192d0b57
For more information about using this API in one of the language-specific AWS SDKs, see the following: