SendTaskFailure
Used by activity workers and task states using the callback
pattern to report that the task identified by the taskToken failed.
Request Syntax
{
"cause": "string",
"error": "string",
"taskToken": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- cause
-
A more detailed explanation of the cause of the failure.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 32768.
Required: No
- error
-
The error code of the failure.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
- taskToken
-
The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTask:taskToken.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidToken
-
The provided token is not valid.
HTTP Status Code: 400
- TaskDoesNotExist
-
HTTP Status Code: 400
- TaskTimedOut
-
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
