The event object containing the batch of records
Sync function to process each record from the batch
Batch processor instance to handle the batch processing
Optionaloptions: BatchProcessingOptions<T>Batch processing options, which can vary with chosen batch processor implementation
import {
BatchProcessor,
EventType,
processPartialResponseSync,
} from '@aws-lambda-powertools/batch';
import type { SQSRecord, SQSHandler } from 'aws-lambda';
const processor = new BatchProcessor(EventType.SQS);
const recordHandler = async (record: SQSRecord): Promise<void> => {
const payload = JSON.parse(record.body);
};
export const handler: SQSHandler = async (event, context) =>
processPartialResponseSync(event, recordHandler, processor, {
context,
});
When working with SQS FIFO queues, we will stop processing at the first failure
and mark unprocessed messages as failed to preserve ordering. However, if you want to
continue processing messages from different group IDs, you can enable the skipGroupOnError
option for seamless processing of messages from various group IDs.
import {
SqsFifoPartialProcessor,
processPartialResponseSync,
} from '@aws-lambda-powertools/batch';
import type { SQSRecord, SQSHandler } from 'aws-lambda';
const processor = new SqsFifoPartialProcessor();
const recordHandler = async (record: SQSRecord): Promise<void> => {
const payload = JSON.parse(record.body);
};
export const handler: SQSHandler = async (event, context) =>
processPartialResponseSync(event, recordHandler, processor, {
context,
skipGroupOnError: true
});
By default, if the entire batch fails, the function will throw an error.
If you want to prevent this behavior, you can set the throwOnFullBatchFailure to false
import {
SqsFifoPartialProcessor,
processPartialResponseSync,
} from '@aws-lambda-powertools/batch';
import type { SQSRecord, SQSHandler } from 'aws-lambda';
const processor = new SqsFifoPartialProcessor();
const recordHandler = async (record: SQSRecord): Promise<void> => {
const payload = JSON.parse(record.body);
};
export const handler: SQSHandler = async (event, context) =>
processPartialResponseSync(event, recordHandler, processor, {
context,
throwOnFullBatchFailure: false
});
Higher level function to process a batch of records synchronously and handle partial failure cases.
This function is intended to be used within synchronous Lambda handlers and together with a batch processor that implements the BasePartialBatchProcessor interface.
It accepts a batch of records, a record handler function, a batch processor, and an optional set of options to configure the batch processing.
By default, the function will process the batch of records synchronously and in sequence. If you need to process the records asynchronously, you can use the processPartialResponse function instead.