DeadLetterConfiguration
The dead-letter handling configuration for a queue. Each queue has built-in dead-letter
handling. When a record has been received MaxReceiveCount times without being
acknowledged, it becomes a dead-letter record, and ReceiveQueueRecords no
longer returns it. The dead-letter record stays in the same queue, and you work with it
through ReceiveDeadLetterQueueRecords,
AcknowledgeDeadLetterQueueRecords,
UpdateDeadLetterQueueRecordsVisibility, and
RestoreDeadLetterQueueRecords, which use the same queue ARN.
Dead-letter handling is enabled by default, with a MaxReceiveCount of 6. To
use a different value, or to turn dead-letter handling off, specify this configuration in
QueueAttributes.
Contents
- TargetType
-
Whether dead-letter handling is enabled for the queue.
BUILT_INenables it: when a record has been receivedMaxReceiveCounttimes without being acknowledged, it becomes a dead-letter record and ReceiveQueueRecords no longer returns it.NONEdisables it, and an unacknowledged record continues to be redelivered until it is acknowledged or its retention period ends.Type: String
Valid Values:
BUILT_IN | NONERequired: Yes
- MaxReceiveCount
-
The number of times a record can be received without being acknowledged before it becomes a dead-letter record. Required when
TargetTypeisBUILT_IN. A queue that you create withoutDeadLetterConfigurationgets aMaxReceiveCountof 6.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: