Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Used by workers to tell the service that the ActivityTask identified by
the taskToken
was successfully canceled. Additional details
can be
optionally provided using the details
argument.
These details
(if provided) appear in the ActivityTaskCanceled
event
added to the workflow history.
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:
- 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 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.
See: AWS API Reference for RespondActivityTaskCanceled.
- respondActivityTaskCanceled :: Text -> RespondActivityTaskCanceled
- data RespondActivityTaskCanceled
- rDetails :: Lens' RespondActivityTaskCanceled (Maybe Text)
- rTaskToken :: Lens' RespondActivityTaskCanceled Text
- respondActivityTaskCanceledResponse :: RespondActivityTaskCanceledResponse
- data RespondActivityTaskCanceledResponse
Creating a Request
respondActivityTaskCanceled Source
Creates a value of RespondActivityTaskCanceled
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data RespondActivityTaskCanceled Source
See: respondActivityTaskCanceled
smart constructor.
Request Lenses
rDetails :: Lens' RespondActivityTaskCanceled (Maybe Text) Source
Optional. Information about the cancellation.
rTaskToken :: Lens' RespondActivityTaskCanceled Text Source
The taskToken
of the ActivityTask.
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.
Destructuring the Response
respondActivityTaskCanceledResponse :: RespondActivityTaskCanceledResponse Source
Creates a value of RespondActivityTaskCanceledResponse
with the minimum fields required to make a request.
data RespondActivityTaskCanceledResponse Source
See: respondActivityTaskCanceledResponse
smart constructor.