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
has failed with reason
(if specified). The reason
and details
appear in the ActivityTaskFailed
event added to the
workflow history.
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 RespondActivityTaskFailed = RespondActivityTaskFailed' {}
- newRespondActivityTaskFailed :: Text -> RespondActivityTaskFailed
- respondActivityTaskFailed_reason :: Lens' RespondActivityTaskFailed (Maybe Text)
- respondActivityTaskFailed_details :: Lens' RespondActivityTaskFailed (Maybe Text)
- respondActivityTaskFailed_taskToken :: Lens' RespondActivityTaskFailed Text
- data RespondActivityTaskFailedResponse = RespondActivityTaskFailedResponse' {
- newRespondActivityTaskFailedResponse :: RespondActivityTaskFailedResponse
Creating a Request
data RespondActivityTaskFailed Source #
See: newRespondActivityTaskFailed
smart constructor.
RespondActivityTaskFailed' | |
|
Instances
newRespondActivityTaskFailed Source #
Create a value of RespondActivityTaskFailed
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:reason:RespondActivityTaskFailed'
, respondActivityTaskFailed_reason
- Description of the error that may assist in diagnostics.
$sel:details:RespondActivityTaskFailed'
, respondActivityTaskFailed_details
- Detailed information about the failure.
$sel:taskToken:RespondActivityTaskFailed'
, respondActivityTaskFailed_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
respondActivityTaskFailed_reason :: Lens' RespondActivityTaskFailed (Maybe Text) Source #
Description of the error that may assist in diagnostics.
respondActivityTaskFailed_details :: Lens' RespondActivityTaskFailed (Maybe Text) Source #
Detailed information about the failure.
respondActivityTaskFailed_taskToken :: Lens' RespondActivityTaskFailed 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 RespondActivityTaskFailedResponse Source #
See: newRespondActivityTaskFailedResponse
smart constructor.
Instances
newRespondActivityTaskFailedResponse :: RespondActivityTaskFailedResponse Source #
Create a value of RespondActivityTaskFailedResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.