Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@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
completed successfully with a result
(if provided). The result
appears in the ActivityTaskCompleted
event in the workflow history.
Important: If the requested task doesn't complete successfully, use RespondActivityTaskFailed
instead. If the worker finds that the task is canceled through the canceled
flag returned by RecordActivityTaskHeartbeat
, it should cancel the task, clean up and then call RespondActivityTaskCanceled
.
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 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 .
Synopsis
- respondActivityTaskCompleted :: Text -> RespondActivityTaskCompleted
- data RespondActivityTaskCompleted
- ratcResult :: Lens' RespondActivityTaskCompleted (Maybe Text)
- ratcTaskToken :: Lens' RespondActivityTaskCompleted Text
- respondActivityTaskCompletedResponse :: RespondActivityTaskCompletedResponse
- data RespondActivityTaskCompletedResponse
Creating a Request
respondActivityTaskCompleted Source #
Creates a value of RespondActivityTaskCompleted
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ratcResult
- The result of the activity task. It is a free form string that is implementation specific.ratcTaskToken
- ThetaskToken
of theActivityTask
. Important:taskToken
is generated by the service and should be treated as an opaque value. If the task is passed to another process, itstaskToken
must also be passed. This enables it to provide its progress and respond with results.
data RespondActivityTaskCompleted Source #
See: respondActivityTaskCompleted
smart constructor.
Instances
Request Lenses
ratcResult :: Lens' RespondActivityTaskCompleted (Maybe Text) Source #
The result of the activity task. It is a free form string that is implementation specific.
ratcTaskToken :: Lens' RespondActivityTaskCompleted Text Source #
The taskToken
of the ActivityTask
. Important: 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
respondActivityTaskCompletedResponse :: RespondActivityTaskCompletedResponse Source #
Creates a value of RespondActivityTaskCompletedResponse
with the minimum fields required to make a request.
data RespondActivityTaskCompletedResponse Source #
See: respondActivityTaskCompletedResponse
smart constructor.