Parser (Zod)

This utility provides data validation and parsing using Zod, a TypeScript-first schema declaration and validation library.

Key features

• Define data schema as Zod schema, then parse, validate and extract only what you want
• Built-in envelopes to unwrap and validate popular AWS event sources payloads
• Extend and customize envelopes to fit your needs
• Safe parsing option to avoid throwing errors and custom error handling
• Available for Middy.js middleware and TypeScript method decorators

Getting started

Install

npm install @aws-lambda-powertools/parser zod@~3

This utility supports Zod v3.x and above.

Define schema

You can define your schema using Zod:

import { z } from 'zod';

const orderSchema = z.object({
  id: z.number().positive(),
  description: z.string(),
  items: z.array(
    z.object({
      id: z.number().positive(),
      quantity: z.number(),
      description: z.string(),
    })
  ),
  optionalField: z.string().optional(),
});

export { orderSchema };

This is a schema for Order object using Zod. You can create complex schemas by using nested objects, arrays, unions, and other types, see Zod documentation for more details.

Parse events

You can parse inbound events using parser decorator, Middy.js middleware, or manually using built-in envelopes and schemas. Both are also able to parse either an object or JSON string as an input.

Warning

The decorator and middleware will replace the event object with the parsed schema if successful. Be cautious when using multiple decorators that expect event to have a specific structure, the order of evaluation for decorators is from bottom to top.

Middy middlewareDecorator

import type { Context } from 'aws-lambda';
import { parser } from '@aws-lambda-powertools/parser/middleware';
import { z } from 'zod';
import middy from '@middy/core';
import { Logger } from '@aws-lambda-powertools/logger';

const logger = new Logger();

const orderSchema = z.object({
  id: z.number().positive(),
  description: z.string(),
  items: z.array(
    z.object({
      id: z.number().positive(),
      quantity: z.number(),
      description: z.string(),
    })
  ),
  optionalField: z.string().optional(),
});

type Order = z.infer<typeof orderSchema>;

const lambdaHandler = async (
  event: Order,
  _context: Context
): Promise<void> => {
  for (const item of event.items) {
    // item is parsed as OrderItem
    logger.info('Processing item', { item });
  }
};

export const handler = middy(lambdaHandler).use(
  parser({ schema: orderSchema })
);

import type { Context } from 'aws-lambda';
import type { LambdaInterface } from '@aws-lambda-powertools/commons/types';
import { parser } from '@aws-lambda-powertools/parser';
import { z } from 'zod';
import { Logger } from '@aws-lambda-powertools/logger';

const logger = new Logger();

const orderSchema = z.object({
  id: z.number().positive(),
  description: z.string(),
  items: z.array(
    z.object({
      id: z.number().positive(),
      quantity: z.number(),
      description: z.string(),
    })
  ),
  optionalField: z.string().optional(),
});

type Order = z.infer<typeof orderSchema>;

class Lambda implements LambdaInterface {
  @parser({ schema: orderSchema })
  public async handler(event: Order, _context: Context): Promise<void> {
    // event is now typed as Order
    for (const item of event.items) {
      logger.info('Processing item', { item });
    }
  }
}

const myFunction = new Lambda();
export const handler = myFunction.handler.bind(myFunction);

Built-in schemas

Parser comes with the following built-in schemas:

Model name	Description
AlbSchema	Lambda Event Source payload for Amazon Application Load Balancer
APIGatewayProxyEventSchema	Lambda Event Source payload for Amazon API Gateway
APIGatewayRequestAuthorizerEventSchema	Lambda Event Source payload for Amazon API Gateway Request Authorizer
APIGatewayTokenAuthorizerEventSchema	Lambda Event Source payload for Amazon API Gateway Token Authorizer
APIGatewayProxyEventV2Schema	Lambda Event Source payload for Amazon API Gateway v2 payload
APIGatewayRequestAuthorizerEventV2Schema	Lambda Event Source payload for Amazon API Gateway v2 Authorizer
CloudFormationCustomResourceCreateSchema	Lambda Event Source payload for AWS CloudFormation CREATE operation
CloudFormationCustomResourceUpdateSchema	Lambda Event Source payload for AWS CloudFormation UPDATE operation
CloudFormationCustomResourceDeleteSchema	Lambda Event Source payload for AWS CloudFormation DELETE operation
CloudwatchLogsSchema	Lambda Event Source payload for Amazon CloudWatch Logs
DynamoDBStreamSchema	Lambda Event Source payload for Amazon DynamoDB Streams
EventBridgeSchema	Lambda Event Source payload for Amazon EventBridge
KafkaMskEventSchema	Lambda Event Source payload for AWS MSK payload
KafkaSelfManagedEventSchema	Lambda Event Source payload for self managed Kafka payload
KinesisDataStreamSchema	Lambda Event Source payload for Amazon Kinesis Data Streams
KinesisFirehoseSchema	Lambda Event Source payload for Amazon Kinesis Firehose
KinesisFirehoseSqsSchema	Lambda Event Source payload for SQS messages wrapped in Kinesis Firehose records
LambdaFunctionUrlSchema	Lambda Event Source payload for Lambda Function URL payload
S3EventNotificationEventBridgeSchema	Lambda Event Source payload for Amazon S3 Event Notification to EventBridge.
S3Schema	Lambda Event Source payload for Amazon S3
S3ObjectLambdaEvent	Lambda Event Source payload for Amazon S3 Object Lambda
S3SqsEventNotificationSchema	Lambda Event Source payload for S3 event notifications wrapped in SQS event (S3->SQS)
SesSchema	Lambda Event Source payload for Amazon Simple Email Service
SnsSchema	Lambda Event Source payload for Amazon Simple Notification Service
SqsSchema	Lambda Event Source payload for Amazon SQS
VpcLatticeSchema	Lambda Event Source payload for Amazon VPC Lattice
VpcLatticeV2Schema	Lambda Event Source payload for Amazon VPC Lattice v2 payload

Extend built-in schemas

You can extend every built-in schema to include your own schema, and yet have all other known fields parsed along the way.

handler.tsExample payload

import type { Context } from 'aws-lambda';
import type { LambdaInterface } from '@aws-lambda-powertools/commons/types';
import { parser } from '@aws-lambda-powertools/parser';
import { z } from 'zod';
import { EventBridgeSchema } from '@aws-lambda-powertools/parser/schemas';
import { Logger } from '@aws-lambda-powertools/logger';

const logger = new Logger();

const orderSchema = z.object({
  id: z.number().positive(),
  description: z.string(),
  items: z.array(
    z.object({
      id: z.number().positive(),
      quantity: z.number(),
      description: z.string(),
    })
  ),
  optionalField: z.string().optional(),
});

const orderEventSchema = EventBridgeSchema.extend({
  detail: orderSchema, // (1)!
});

type OrderEvent = z.infer<typeof orderEventSchema>;

class Lambda implements LambdaInterface {
  @parser({ schema: orderEventSchema }) // (2)!
  public async handler(event: OrderEvent, _context: Context): Promise<void> {
    for (const item of event.detail.items) {
      // process OrderItem
      logger.info('Processing item', { item }); // (3)!
    }
  }
}

const myFunction = new Lambda();
export const handler = myFunction.handler.bind(myFunction);

1. Extend built-in EventBridgeSchema with your own detail schema
2. Pass the extended schema to parser decorator or middy middleware
3. event is validated including your custom schema and now available in your handler

{
  "version": "0",
  "id": "6a7e8feb-b491-4cf7-a9f1-bf3703467718",
  "detail-type": "OrderPurchased",
  "source": "OrderService",
  "account": "111122223333",
  "time": "2020-10-22T18:43:48Z",
  "region": "us-west-1",
  "resources": ["some_additional"],
  "detail": {
    "id": 10876546789,
    "description": "My order",
    "items": [
      {
        "id": 1015938732,
        "quantity": 1,
        "description": "item xpto"
      }
    ]
  }
}

Envelopes

When trying to parse your payload you might encounter the following situations:

• Your actual payload is wrapped around a known structure, for example Lambda Event Sources like EventBridge
• You're only interested in a portion of the payload, for example parsing the detail of custom events in EventBridge, or body of SQS records
• You can either solve these situations by creating a schema of these known structures, parsing them, then extracting and parsing a key where your payload is.

This can become difficult quite quickly. Parser simplifies the development through a feature named Envelope. Envelopes can be used via envelope parameter available in middy and decorator. Here's an example of parsing a custom schema in an event coming from EventBridge, where all you want is what's inside the detail key.

Middy middlewareDecorator

import type { Context } from 'aws-lambda';
import { parser } from '@aws-lambda-powertools/parser/middleware';
import { z } from 'zod';
import middy from '@middy/core';
import { EventBridgeEnvelope } from '@aws-lambda-powertools/parser/envelopes';
import { Logger } from '@aws-lambda-powertools/logger';

const logger = new Logger();

const orderSchema = z.object({
  id: z.number().positive(),
  description: z.string(),
  items: z.array(
    z.object({
      id: z.number().positive(),
      quantity: z.number(),
      description: z.string(),
    })
  ),
  optionalField: z.string().optional(),
});

type Order = z.infer<typeof orderSchema>;

const lambdaHandler = async (
  event: Order,
  _context: Context
): Promise<void> => {
  for (const item of event.items) {
    // item is parsed as OrderItem
    logger.info('Processing item', { item });
  }
};

export const handler = middy(lambdaHandler).use(
  parser({ schema: orderSchema, envelope: EventBridgeEnvelope })
);

import type { Context } from 'aws-lambda';
import type { LambdaInterface } from '@aws-lambda-powertools/commons/types';
import { parser } from '@aws-lambda-powertools/parser';
import { z } from 'zod';
import { EventBridgeEnvelope } from '@aws-lambda-powertools/parser/envelopes';
import { Logger } from '@aws-lambda-powertools/logger';

const logger = new Logger();

const orderSchema = z.object({
  id: z.number().positive(),
  description: z.string(),
  items: z.array(
    z.object({
      id: z.number().positive(),
      quantity: z.number(),
      description: z.string(),
    })
  ),
  optionalField: z.string().optional(),
});

type Order = z.infer<typeof orderSchema>;

class Lambda implements LambdaInterface {
  @parser({ schema: orderSchema, envelope: EventBridgeEnvelope }) // (1)!
  public async handler(event: Order, _context: Context): Promise<void> {
    // event is now typed as Order
    for (const item of event.items) {
      logger.info('Processing item', item); // (2)!
    }
  }
}

const myFunction = new Lambda();
export const handler = myFunction.handler.bind(myFunction);

1. Pass eventBridgeEnvelope to parser decorator
2. event is parsed and replaced as Order object

The envelopes are functions that take an event and the schema to parse, and return the result of the inner schema. Depending on the envelope it can be something simple like extracting a key. We have also complex envelopes that parse the payload from a string, decode base64, uncompress gzip, etc.

Envelopes vs schema extension

Use envelopes if you want to extract only the inner part of an event payload and don't use the information from the Lambda event. Otherwise, extend built-in schema to parse the whole payload and use the metadata from the Lambda event.

Built-in envelopes

Parser comes with the following built-in envelopes:

Envelope name	Behaviour
apiGatewayEnvelope	1. Parses data using APIGatewayProxyEventSchema. 2. Parses body key using your schema and returns it.
apiGatewayV2Envelope	1. Parses data using APIGatewayProxyEventV2Schema. 2. Parses body key using your schema and returns it.
cloudWatchEnvelope	1. Parses data using CloudwatchLogsSchema which will base64 decode and decompress it. 2. Parses records in message key using your schema and return them in a list.
dynamoDBStreamEnvelope	1. Parses data using DynamoDBStreamSchema. 2. Parses records in NewImage and OldImage keys using your schema. 3. Returns a list with a dictionary containing NewImage and OldImage keys
eventBridgeEnvelope	1. Parses data using EventBridgeSchema. 2. Parses detail key using your schema and returns it.
kafkaEnvelope	1. Parses data using KafkaRecordSchema. 2. Parses value key using your schema and returns it.
kinesisEnvelope	1. Parses data using KinesisDataStreamSchema which will base64 decode it. 2. Parses records in Records key using your schema and returns them in a list.
kinesisFirehoseEnvelope	1. Parses data using KinesisFirehoseSchema which will base64 decode it. 2. Parses records in Records key using your schema and returns them in a list.
lambdaFunctionUrlEnvelope	1. Parses data using LambdaFunctionUrlSchema. 2. Parses body key using your schema and returns it.
snsEnvelope	1. Parses data using SnsSchema. 2. Parses records in body key using your schema and return them in a list.
snsSqsEnvelope	1. Parses data using SqsSchema. 2. Parses SNS records in body key using SnsNotificationSchema. 3. Parses data in Message key using your schema and return them in a list.
sqsEnvelope	1. Parses data using SqsSchema. 2. Parses records in body key using your schema and return them in a list.
vpcLatticeEnvelope	1. Parses data using VpcLatticeSchema. 2. Parses value key using your schema and returns it.
vpcLatticeV2Envelope	1. Parses data using VpcLatticeSchema. 2. Parses value key using your schema and returns it.

Safe parsing

If you want to parse the event without throwing an error, use the safeParse option. The handler event object will be replaced with ParsedResult<Input?, Oputput?>, for example ParsedResult<SqsEvent, Order>, where SqsEvent is the original event and Order is the parsed schema.

The ParsedResult object will have success, data, or error and originalEvent fields, depending on the outcome. If the parsing is successful, the data field will contain the parsed event, otherwise you can access the error field and the originalEvent to handle the error and recover the original event.

Middy middlewareDecorator

import type { Context } from 'aws-lambda';
import { parser } from '@aws-lambda-powertools/parser/middleware';
import { z } from 'zod';
import middy from '@middy/core';
import type {
  ParsedResult,
  EventBridgeEvent,
} from '@aws-lambda-powertools/parser/types';
import { Logger } from '@aws-lambda-powertools/logger';

const logger = new Logger();

const orderSchema = z.object({
  id: z.number().positive(),
  description: z.string(),
  items: z.array(
    z.object({
      id: z.number().positive(),
      quantity: z.number(),
      description: z.string(),
    })
  ),
  optionalField: z.string().optional(),
});

type Order = z.infer<typeof orderSchema>;

const lambdaHandler = async (
  event: ParsedResult<EventBridgeEvent, Order>,
  _context: Context
): Promise<void> => {
  if (event.success) {
    // (2)!
    for (const item of event.data.items) {
      logger.info('Processing item', { item }); // (3)!
    }
  } else {
    logger.error('Error parsing event', { event: event.error }); // (4)!
    logger.error('Original event', { event: event.originalEvent }); // (5)!
  }
};

export const handler = middy(lambdaHandler).use(
  parser({ schema: orderSchema, safeParse: true }) // (1)!
);

1. Use safeParse option to parse the event without throwing an error
2. Check if the result is successful or not and handle the error accordingly
3. Use data to access the parsed event
4. Use error to handle the error message
5. Use originalEvent to get the original event and recover

import type { Context } from 'aws-lambda';
import type { LambdaInterface } from '@aws-lambda-powertools/commons/types';
import { parser } from '@aws-lambda-powertools/parser';
import { z } from 'zod';
import type {
  ParsedResult,
  EventBridgeEvent,
} from '@aws-lambda-powertools/parser/types';
import { Logger } from '@aws-lambda-powertools/logger';

const logger = new Logger();

const orderSchema = z.object({
  id: z.number().positive(),
  description: z.string(),
  items: z.array(
    z.object({
      id: z.number().positive(),
      quantity: z.number(),
      description: z.string(),
    })
  ),
  optionalField: z.string().optional(),
});

type Order = z.infer<typeof orderSchema>;

class Lambda implements LambdaInterface {
  @parser({ schema: orderSchema, safeParse: true }) // (1)!
  public async handler(
    event: ParsedResult<EventBridgeEvent, Order>,
    _context: Context
  ): Promise<void> {
    if (event.success) {
      // (2)!
      for (const item of event.data.items) {
        logger.info('Processing item', { item }); // (3)!
      }
    } else {
      logger.error('Failed to parse event', event.error); // (4)!
      logger.error('Original event is: ', event.originalEvent); // (5)!
    }
  }
}

const myFunction = new Lambda();
export const handler = myFunction.handler.bind(myFunction);

1. Use safeParse option to parse the event without throwing an error
2. Check if the result is successful or not and handle the error accordingly
3. Use data to access the parsed event
4. Use error to handle the error message
5. Use originalEvent to get the original event and recover

Manual parsing

You can use built-in envelopes and schemas to parse the incoming events manually, without using middy or decorator.

Manual parseManual safeParse

import type { Context } from 'aws-lambda';
import { z } from 'zod';
import { EventBridgeEnvelope } from '@aws-lambda-powertools/parser/envelopes';
import { EventBridgeSchema } from '@aws-lambda-powertools/parser/schemas';
import type { EventBridgeEvent } from '@aws-lambda-powertools/parser/types';
import { Logger } from '@aws-lambda-powertools/logger';

const logger = new Logger();

const orderSchema = z.object({
  id: z.number().positive(),
  description: z.string(),
  items: z.array(
    z.object({
      id: z.number().positive(),
      quantity: z.number(),
      description: z.string(),
    })
  ),
  optionalField: z.string().optional(),
});
type Order = z.infer<typeof orderSchema>;

export const handler = async (
  event: EventBridgeEvent,
  _context: Context
): Promise<void> => {
  const parsedEvent = EventBridgeSchema.parse(event); // (1)!
  logger.info('Parsed event', parsedEvent);

  const orders: Order = EventBridgeEnvelope.parse(event, orderSchema); // (2)!
  logger.info('Parsed orders', orders);
};

1. Use EventBridgeSchema to parse the event, the details fields will be parsed as a generic record.
2. Use eventBridgeEnvelope with a combination of orderSchema to get Order object from the details field.

import type { Context } from 'aws-lambda';
import { z } from 'zod';
import { EventBridgeEnvelope } from '@aws-lambda-powertools/parser/envelopes';
import { EventBridgeSchema } from '@aws-lambda-powertools/parser/schemas';
import type { EventBridgeEvent } from '@aws-lambda-powertools/parser/types';
import { Logger } from '@aws-lambda-powertools/logger';

const logger = new Logger();

const orderSchema = z.object({
  id: z.number().positive(),
  description: z.string(),
  items: z.array(
    z.object({
      id: z.number().positive(),
      quantity: z.number(),
      description: z.string(),
    })
  ),
  optionalField: z.string().optional(),
});

export const handler = async (
  event: EventBridgeEvent,
  _context: Context
): Promise<void> => {
  const parsedEvent = EventBridgeSchema.safeParse(event); // (1)!
  parsedEvent.success
    ? logger.info('Event parsed successfully', parsedEvent.data)
    : logger.error('Event parsing failed', parsedEvent.error);
  const parsedEvenlope = EventBridgeEnvelope.safeParse(event, orderSchema); // (2)!
  parsedEvenlope.success
    ? logger.info('Event envelope parsed successfully')
    : logger.error('Event envelope parsing failed', parsedEvenlope.error);
};

1. Use safeParse option to parse the event without throwing an error
2. safeParse is also available for envelopes

Custom validation

Because Parser uses Zod, you can use all the features of Zod to validate your data. For example, you can use refine to validate a field or a combination of fields:

Custom validation

import { z } from 'zod';

const orderItemSchema = z.object({
  id: z.number().positive(),
  quantity: z.number(),
  description: z.string(),
});

export const orderSchema = z
  .object({
    id: z.number().positive(),
    description: z.string(),
    items: z.array(orderItemSchema).refine((items) => items.length > 0, {
      message: 'Order must have at least one item', // (1)!
    }),
    optionalField: z.string().optional(),
  })
  .refine((order) => order.id > 100 && order.items.length > 100, {
    message:
      'All orders with more than 100 items must have an id greater than 100', // (2)!
  });

1. validate a single field
2. validate an object with multiple fields

Zod provides a lot of other features and customization, see Zod documentation for more details.

Types

Schema and Type inference

Use z.infer to extract the type of the schema, so you can use types during development and avoid type errors.

Types

import type { Context } from 'aws-lambda';
import { parser } from '@aws-lambda-powertools/parser/middleware';
import { z } from 'zod';
import middy from '@middy/core';
import { Logger } from '@aws-lambda-powertools/logger';

const logger = new Logger();

const orderSchema = z.object({
  id: z.number().positive(),
  description: z.string(),
  items: z.array(
    z.object({
      id: z.number().positive(),
      quantity: z.number(),
      description: z.string(),
    })
  ),
  optionalField: z.string().optional(),
});

type Order = z.infer<typeof orderSchema>; // (1)!

const lambdaHandler = async (
  event: Order, // (2)!
  _context: Context
): Promise<void> => {
  for (const item of event.items) {
    // item is parsed as OrderItem
    logger.info('Processing item', { item }); // (3)!
  }
};

export const handler = middy(lambdaHandler).use(
  parser({ schema: orderSchema })
);

1. Use z.infer to extract the type of the schema, also works for nested schemas
2. event is of type Order
3. infer types from deeply nested schemas

Compatibility with @types/aws-lambda

The package @types/aws-lambda is a popular project that contains type definitions for many AWS service event invocations. Powertools parser utility also bring AWS Lambda event types based on the built-in schema definitions.

We recommend to use the types provided by the parser utility. If you encounter any issues or have any feedback, please submit an issue.