API Reference

This reference is split into two independent package references. The lambda-api-decorators API covers the CDK-free declarations and runtime identity helpers. The lambda-api-decorators-cdk API covers infrastructure construction. The Getting Started tutorial is the fastest way to see a complete REST deployment.

lambda-api-decorators is CDK-free. Its decorators record declarations on Python handlers, and current_user reads identity claims at runtime. lambda-api-decorators-cdk consumes those declarations and synthesizes Lambda and API Gateway resources with AWS CDK.

The Project compatibility and limitations pages explain the supported versions and the boundaries behind these APIs.

Complete symbol index

lambda-api-decorators

HTTP: GET, PUT, POST, DELETE, ANY.

Configuration: memory_size, timeout, environment, layer, runtime, security_group, vpc, role, description, name.

Access and permissions: grant_dynamodb, grant_s3, permission, authorizer, public.

Identity: CurrentUser, CurrentUserError, current_user.

lambda-api-decorators-cdk

High-level interface: LambdaApi, LambdaApiConfig.

Advanced interface: ResourceBuilder.

Types: ApiType, SourceLayout.