Skip to content

Commit 16356dd

Browse files
authored
Clarify BatchItemFailure default values in documentation
Added clarification about default field values for BatchItemFailure.
1 parent 77c9fb4 commit 16356dd

File tree

1 file changed

+4
-0
lines changed
  • lambda-events/src/event/sqs

1 file changed

+4
-0
lines changed

lambda-events/src/event/sqs/mod.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,8 @@ impl SqsBatchResponse {
162162
/// messages to the queue for reprocessing while successfully processed messages
163163
/// will be deleted.
164164
///
165+
/// Besides `item_identifiers`, the generated struct will use default field values for [`BatchItemFailure`].
166+
///
165167
/// **Important**: This feature requires `FunctionResponseTypes: ReportBatchItemFailures`
166168
/// to be enabled in your Lambda function's SQS event source mapping configuration.
167169
/// Without this setting, Lambda will retry the entire batch on any failure.
@@ -210,6 +212,8 @@ impl SqsBatchResponse {
210212
/// This is a convenience method for setting all batch item failures in one call.
211213
/// It replaces any previously registered failures.
212214
///
215+
/// Besides `item_identifiers`, the generated struct will use default field values for [`BatchItemFailure`].
216+
///
213217
/// **Important**: This feature requires `FunctionResponseTypes: ReportBatchItemFailures`
214218
/// to be enabled in your Lambda function's SQS event source mapping configuration.
215219
/// Without this setting, Lambda will retry the entire batch on any failure.

0 commit comments

Comments
 (0)