RestoreDeadLetterQueueRecords
Restores up to 10 dead-letter records in the specified queue. Restoring a record clears
its dead-letter state and resets its receive count, so
ReceiveQueueRecords can return it again, up to MaxReceiveCount times before it becomes a dead-letter record
again. The result for each entry is reported individually in the response.
Restore records after you have corrected the condition that prevented your queue consumer from processing them.
Because the request can result in a combination of successful and unsuccessful entries, check the Failed list even when the call returns an HTTP status code of 200.
Request Syntax
{
"Entries": [
{
"ReceiptHandle": "string"
}
],
"QueueARN": "string"
}
Request Parameters
The request accepts the following data in JSON format.
- Entries
-
The dead-letter records to restore, identified by their receipt handles.
Type: Array of RestoreDeadLetterQueueRecordsRequestEntry objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
- QueueARN
-
The ARN of the queue whose dead-letter records are restored.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:aws.*:kinesis:.*:\d{12}:queue/\S+Required: Yes
Response Syntax
{
"Failed": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"ReceiptHandle": "string"
}
],
"Successful": [
{
"ReceiptHandle": "string"
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Failed
-
The records that were not restored, each with the reason the entry failed.
Type: Array of RestoreDeadLetterQueueRecordsErrorEntry objects
- Successful
-
The records that were restored.
Type: Array of RestoreDeadLetterQueueRecordsResultEntry objects
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
Specifies that you do not have the permissions required to perform this operation.
HTTP Status Code: 400
- InternalFailureException
-
The processing of the request failed because of an unknown error, exception, or failure.
HTTP Status Code: 500
- InvalidArgumentException
-
A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
- message
-
A message that provides information about the error.
HTTP Status Code: 400
- ResourceNotFoundException
-
The requested resource could not be found. The stream might not be specified correctly.
- message
-
A message that provides information about the error.
HTTP Status Code: 400
- ThrottlingException
-
The request was denied because the request rate is too high. Reduce the frequency of your requests, and retry them with exponential backoff.
- message
-
A message that provides information about the error.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: