SWF.Client.respond_activity_task_canceled(**kwargs)¶Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be provided using the details argument.
These details (if provided) appear in the ActivityTaskCanceled event added to the workflow history.
Warning
Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns 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.
Access Control
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 specified domains.Action element to allow or deny permission to call this action.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 .
See also: AWS API Documentation
Request Syntax
response = client.respond_activity_task_canceled(
taskToken='string',
details='string'
)
[REQUIRED]
The taskToken of the ActivityTask.
Warning
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.
None
Exceptions
SWF.Client.exceptions.UnknownResourceFaultSWF.Client.exceptions.OperationNotPermittedFault