Copyright | (c) 2013-2021 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 |
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.
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
- data RespondActivityTaskCompleted = RespondActivityTaskCompleted' {}
- newRespondActivityTaskCompleted :: Text -> RespondActivityTaskCompleted
- respondActivityTaskCompleted_result :: Lens' RespondActivityTaskCompleted (Maybe Text)
- respondActivityTaskCompleted_taskToken :: Lens' RespondActivityTaskCompleted Text
- data RespondActivityTaskCompletedResponse = RespondActivityTaskCompletedResponse' {
- newRespondActivityTaskCompletedResponse :: RespondActivityTaskCompletedResponse
Creating a Request
data RespondActivityTaskCompleted Source #
See: newRespondActivityTaskCompleted
smart constructor.
RespondActivityTaskCompleted' | |
|
Instances
newRespondActivityTaskCompleted Source #
Create a value of RespondActivityTaskCompleted
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:result:RespondActivityTaskCompleted'
, respondActivityTaskCompleted_result
- The result of the activity task. It is a free form string that is
implementation specific.
$sel:taskToken:RespondActivityTaskCompleted'
, respondActivityTaskCompleted_taskToken
- 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.
Request Lenses
respondActivityTaskCompleted_result :: Lens' RespondActivityTaskCompleted (Maybe Text) Source #
The result of the activity task. It is a free form string that is implementation specific.
respondActivityTaskCompleted_taskToken :: Lens' RespondActivityTaskCompleted 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
data RespondActivityTaskCompletedResponse Source #
See: newRespondActivityTaskCompletedResponse
smart constructor.
Instances
newRespondActivityTaskCompletedResponse :: RespondActivityTaskCompletedResponse Source #
Create a value of RespondActivityTaskCompletedResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.