Homepage
Powertools for AWS Lambda (Python) is a developer toolkit to implement Serverless best practices and increase developer velocity.
-
Features
Adopt one, a few, or all industry practices. Progressively.
-
Support this project
Become a public reference customer, share your work, contribute, use Lambda Layers, etc.
-
Available languages
Powertools for AWS Lambda is also available in other languages
Java, TypeScript, and .NET
Install¶
You can install Powertools for AWS Lambda (Python) using your favorite dependency management, or Lambda Layers:
Most features use Python standard library and the AWS SDK (boto3) that are available in the AWS Lambda runtime.
- pip:
pip install "aws-lambda-powertools"
- poetry:
poetry add "aws-lambda-powertools"
- pdm:
pdm add "aws-lambda-powertools"
Extra dependencies¶
However, you will need additional dependencies if you are using any of the features below:
Feature | Install | Default dependency |
---|---|---|
Tracer | pip install "aws-lambda-powertools[tracer]" |
aws-xray-sdk |
Validation | pip install "aws-lambda-powertools[validation]" |
fastjsonschema |
Parser | pip install "aws-lambda-powertools[parser]" |
pydantic (v1); v2 is possible |
Data Masking | pip install "aws-lambda-powertools[datamasking]" |
aws-encryption-sdk , jsonpath-ng |
All extra dependencies at once | pip install "aws-lambda-powertools[all]" |
|
Two or more extra dependencies only, not all | pip install "aws-lambda-powertools[tracer,parser,datamasking"] |
Lambda Layer is a .zip file archive that can contain additional code, pre-packaged dependencies, data, or configuration files. We compile and optimize all dependencies, and remove duplicate dependencies already available in the Lambda runtime to achieve the most optimal size.
Architecture | Layer ARN |
---|---|
x86 | arn:aws:lambda:{region}:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
ARM | arn:aws:lambda:{region}:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
You can add our layer using the AWS Lambda Console (direct link):
- Under Layers, choose
Specify an ARN
- Click to copy the correct ARN value based on your AWS Lambda function architecture and region
Click to expand and copy any regional Lambda Layer ARN
Region name | Region code | Layer ARN |
---|---|---|
Africa (Cape Town) | af-south-1 |
arn:aws:lambda:af-south-1:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
Asia Pacific (Hong Kong) | ap-east-1 |
arn:aws:lambda:ap-east-1:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
Asia Pacific (Tokyo) | ap-northeast-1 |
arn:aws:lambda:ap-northeast-1:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
Asia Pacific (Seoul) | ap-northeast-2 |
arn:aws:lambda:ap-northeast-2:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
Asia Pacific (Osaka) | ap-northeast-3 |
arn:aws:lambda:ap-northeast-3:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
Asia Pacific (Mumbai) | ap-south-1 |
arn:aws:lambda:ap-south-1:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
Asia Pacific (Hyderabad) | ap-south-2 |
arn:aws:lambda:ap-south-2:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
Asia Pacific (Singapore) | ap-southeast-1 |
arn:aws:lambda:ap-southeast-1:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
Asia Pacific (Sydney) | ap-southeast-2 |
arn:aws:lambda:ap-southeast-2:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
Asia Pacific (Jakarta) | ap-southeast-3 |
arn:aws:lambda:ap-southeast-3:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
Asia Pacific (Melbourne) | ap-southeast-4 |
arn:aws:lambda:ap-southeast-4:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
Canada (Central) | ca-central-1 |
arn:aws:lambda:ca-central-1:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
Canada (West) | ca-west-1 |
arn:aws:lambda:ca-west-1:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
Europe (Frankfurt) | eu-central-1 |
arn:aws:lambda:eu-central-1:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
Europe (Zurich) | eu-central-2 |
arn:aws:lambda:eu-central-2:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
Europe (Stockholm) | eu-north-1 |
arn:aws:lambda:eu-north-1:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
Europe (Milan) | eu-south-1 |
arn:aws:lambda:eu-south-1:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
Europe (Spain) | eu-south-2 |
arn:aws:lambda:eu-south-2:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
Europe (Ireland) | eu-west-1 |
arn:aws:lambda:eu-west-1:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
Europe (London) | eu-west-2 |
arn:aws:lambda:eu-west-2:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
Europe (Paris) | eu-west-3 |
arn:aws:lambda:eu-west-3:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
Middle East (Israel) | il-central-1 |
arn:aws:lambda:il-central-1:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
Middle East (UAE) | me-central-1 |
arn:aws:lambda:me-central-1:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
Middle East (Bahrain) | me-south-1 |
arn:aws:lambda:me-south-1:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
South America (SΓ£o Paulo) | sa-east-1 |
arn:aws:lambda:sa-east-1:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
US East (N. Virginia) | us-east-1 |
arn:aws:lambda:us-east-1:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
US East (Ohio) | us-east-2 |
arn:aws:lambda:us-east-2:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
US West (N. California) | us-west-1 |
arn:aws:lambda:us-west-1:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
US West (Oregon) | us-west-2 |
arn:aws:lambda:us-west-2:017000801446:layer:AWSLambdaPowertoolsPythonV2:79 |
Region name | Region code | Layer ARN |
---|---|---|
Africa (Cape Town) | af-south-1 |
arn:aws:lambda:af-south-1:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
Asia Pacific (Hong Kong) | ap-east-1 |
arn:aws:lambda:ap-east-1:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
Asia Pacific (Tokyo) | ap-northeast-1 |
arn:aws:lambda:ap-northeast-1:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
Asia Pacific (Seoul) | ap-northeast-2 |
arn:aws:lambda:ap-northeast-2:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
Asia Pacific (Osaka) | ap-northeast-3 |
arn:aws:lambda:ap-northeast-3:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
Asia Pacific (Mumbai) | ap-south-1 |
arn:aws:lambda:ap-south-1:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
Asia Pacific (Hyderabad) | ap-south-2 |
arn:aws:lambda:ap-south-2:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
Asia Pacific (Singapore) | ap-southeast-1 |
arn:aws:lambda:ap-southeast-1:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
Asia Pacific (Sydney) | ap-southeast-2 |
arn:aws:lambda:ap-southeast-2:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
Asia Pacific (Jakarta) | ap-southeast-3 |
arn:aws:lambda:ap-southeast-3:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
Asia Pacific (Melbourne) | ap-southeast-4 |
arn:aws:lambda:ap-southeast-4:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
Canada (Central) | ca-central-1 |
arn:aws:lambda:ca-central-1:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
Canada (West) | ca-west-1 |
arn:aws:lambda:ca-west-1:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:73 |
Europe (Frankfurt) | eu-central-1 |
arn:aws:lambda:eu-central-1:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
Europe (Zurich) | eu-central-2 |
arn:aws:lambda:eu-central-2:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
Europe (Stockholm) | eu-north-1 |
arn:aws:lambda:eu-north-1:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
Europe (Milan) | eu-south-1 |
arn:aws:lambda:eu-south-1:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
Europe (Spain) | eu-south-2 |
arn:aws:lambda:eu-south-2:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
Europe (Ireland) | eu-west-1 |
arn:aws:lambda:eu-west-1:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
Europe (London) | eu-west-2 |
arn:aws:lambda:eu-west-2:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
Europe (Paris) | eu-west-3 |
arn:aws:lambda:eu-west-3:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
Middle East (Israel) | il-central-1 |
arn:aws:lambda:il-central-1:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
Middle East (UAE) | me-central-1 |
arn:aws:lambda:me-central-1:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
Middle East (Bahrain) | me-south-1 |
arn:aws:lambda:me-south-1:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
South America (SΓ£o Paulo) | sa-east-1 |
arn:aws:lambda:sa-east-1:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
US East (N. Virginia) | us-east-1 |
arn:aws:lambda:us-east-1:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
US East (Ohio) | us-east-2 |
arn:aws:lambda:us-east-2:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
US West (N. California) | us-west-1 |
arn:aws:lambda:us-west-1:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
US West (Oregon) | us-west-2 |
arn:aws:lambda:us-west-2:017000801446:layer:AWSLambdaPowertoolsPythonV2-Arm64:79 |
Are we missing a framework? please create a documentation request.
Thanks to the community, we've covered most popular frameworks on how to add a Lambda Layer to an existing function.
1 2 3 4 5 6 7 8 9 10 11 |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
|
1 2 3 4 5 6 7 8 9 10 11 12 |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
|
You can use AWS CLI to generate a pre-signed URL to download the contents of our Lambda Layer.
AWS CLI command to download Lambda Layer content | |
---|---|
1 |
|
You'll find the pre-signed URL under Location
key as part of the CLI command output.
We provide a SAR App that deploys a CloudFormation stack with a copy of our Lambda Layer in your AWS account and region.
Compared with the public Layer ARN option, the advantage is being able to use a semantic version.
App | ARN | ||
---|---|---|---|
aws-lambda-powertools-python-layer | arn:aws:serverlessrepo:eu-west-1:057560766410:applications/aws-lambda-powertools-python-layer | ||
aws-lambda-powertools-python-layer-arm64 | arn:aws:serverlessrepo:eu-west-1:057560766410:applications/aws-lambda-powertools-python-layer-arm64 |
Don't have enough permissions? Expand for a least-privilege IAM policy example
Credits to mwarkentin for providing the scoped down IAM permissions.
Least-privileged IAM permissions SAM example | |
---|---|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
|
If you're using Infrastructure as Code, here are some excerpts on how to use SAR:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
|
Credits to Dani Comnea for providing the Terraform equivalent.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
|
Every morning during business days (~8am UTC), we publish a prerelease
to PyPi to accelerate customer feedback on unstable releases / bugfixes until they become production ready.
Here's how you can use them:
Local development¶
Using Lambda Layer? Simply add "aws-lambda-powertools[all]"
as a development dependency.
Powertools for AWS Lambda (Python) relies on the AWS SDK bundled in the Lambda runtime. This helps us achieve an optimal package size and initialization. However, when developing locally, you need to install AWS SDK as a development dependency to support IDE auto-completion and to run your tests locally:
- Pip:
pip install "aws-lambda-powertools[aws-sdk]"
- Poetry:
poetry add "aws-lambda-powertools[aws-sdk]" --group dev
- Pdm:
pdm add -dG "aws-lambda-powertools[aws-sdk]"
A word about dependency resolution
In this context, [aws-sdk]
is an alias to the boto3
package. Due to dependency resolution, it'll either install:
- (A) the SDK version available in Lambda runtime
- (B) a more up-to-date version if another package you use also depends on
boto3
, for example Powertools for AWS Lambda (Python) Tracer
Quick getting started¶
Hello world example using SAM CLI | |
---|---|
1 |
|
Features¶
Core utilities such as Tracing, Logging, Metrics, and Event Handler will be available across all Powertools for AWS Lambda languages. Additional utilities are subjective to each language ecosystem and customer demand.
Utility | Description |
---|---|
Tracing | Decorators and utilities to trace Lambda function handlers, and both synchronous and asynchronous functions |
Logger | Structured logging made easier, and decorator to enrich structured logging with key Lambda context details |
Metrics | Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF) |
Event handler: AppSync | AppSync event handler for Lambda Direct Resolver and Amplify GraphQL Transformer function |
Event handler: API Gateway, ALB and Lambda Function URL | Amazon API Gateway REST/HTTP API and ALB event handler for Lambda functions invoked using Proxy integration, and Lambda Function URL |
Middleware factory | Decorator factory to create your own middleware to run logic before, and after each Lambda invocation |
Parameters | Retrieve parameter values from AWS Systems Manager Parameter Store, AWS Secrets Manager, or Amazon DynamoDB, and cache them for a specific amount of time |
Batch processing | Handle partial failures for AWS SQS batch processing |
Typing | Static typing classes to speedup development in your IDE |
Validation | JSON Schema validator for inbound events and responses |
Event source data classes | Data classes describing the schema of common Lambda event triggers |
Parser | Data parsing and deep validation using Pydantic |
Idempotency | Idempotent Lambda handler |
Data Masking | Protect confidential data with easy removal or encryption |
Feature Flags | A simple rule engine to evaluate when one or multiple features should be enabled depending on the input |
Streaming | Streams datasets larger than the available memory as streaming data. |
Environment variables¶
Info
Explicit parameters take precedence over environment variables
Environment variable | Description | Utility | Default |
---|---|---|---|
POWERTOOLS_SERVICE_NAME | Sets service name used for tracing namespace, metrics dimension and structured logging | All | "service_undefined" |
POWERTOOLS_METRICS_NAMESPACE | Sets namespace used for metrics | Metrics | None |
POWERTOOLS_TRACE_DISABLED | Explicitly disables tracing | Tracing | false |
POWERTOOLS_TRACER_CAPTURE_RESPONSE | Captures Lambda or method return as metadata. | Tracing | true |
POWERTOOLS_TRACER_CAPTURE_ERROR | Captures Lambda or method exception as metadata. | Tracing | true |
POWERTOOLS_TRACE_MIDDLEWARES | Creates sub-segment for each custom middleware | Middleware factory | false |
POWERTOOLS_LOGGER_LOG_EVENT | Logs incoming event | Logging | false |
POWERTOOLS_LOGGER_SAMPLE_RATE | Debug log sampling | Logging | 0 |
POWERTOOLS_LOG_DEDUPLICATION_DISABLED | Disables log deduplication filter protection to use Pytest Live Log feature | Logging | false |
POWERTOOLS_PARAMETERS_MAX_AGE | Adjust how long values are kept in cache (in seconds) | Parameters | 5 |
POWERTOOLS_PARAMETERS_SSM_DECRYPT | Sets whether to decrypt or not values retrieved from AWS SSM Parameters Store | Parameters | false |
POWERTOOLS_DEV | Increases verbosity across utilities | Multiple; see POWERTOOLS_DEV effect below | false |
POWERTOOLS_LOG_LEVEL | Sets logging level | Logging | INFO |
Optimizing for non-production environments¶
We will emit a warning when this feature is used to help you detect misuse in production.
Whether you're prototyping locally or against a non-production environment, you can use POWERTOOLS_DEV
to increase verbosity across multiple utilities.
When POWERTOOLS_DEV
is set to a truthy value (1
, true
), it'll have the following effects:
Utility | Effect |
---|---|
Logger | Increase JSON indentation to 4. This will ease local debugging when running functions locally under emulators or direct calls while not affecting unit tests. However, Amazon CloudWatch Logs view will degrade as each new line is treated as a new message. |
Event Handler | Enable full traceback errors in the response, indent request/responses, and CORS in dev mode (* ). |
Tracer | Future-proof safety to disables tracing operations in non-Lambda environments. This already happens automatically in the Tracer utility. |
Debug mode¶
As a best practice for libraries, Powertools module logging statements are suppressed.
When necessary, you can use POWERTOOLS_DEBUG
environment variable to enable debugging. This will provide additional information on every internal operation.
Support Powertools for AWS Lambda (Python)¶
There are many ways you can help us gain future investments to improve everyone's experience:
-
Become a public reference
Add your company name and logo on our landing page.
-
Share your work
Blog posts, video, and sample projects about Powertools for AWS Lambda.
-
Join the community
Connect, ask questions, and share what features you use.
Becoming a reference customer¶
Knowing which companies are using this library is important to help prioritize the project internally. The following companies, among others, use Powertools:
Using Lambda Layers¶
Layers help us understand who uses Powertools for AWS Lambda (Python) in a non-intrusive way.
When using Layers, you can add Powertools for AWS Lambda (Python) as a dev dependency to not impact the development process. For Layers, we pre-package all dependencies, compile and optimize for storage and both x86 and ARM architecture.
Tenets¶
These are our core principles to guide our decision making.
- AWS Lambda only. We optimise for AWS Lambda function environments and supported runtimes only. Utilities might work with web frameworks and non-Lambda environments, though they are not officially supported.
- Eases the adoption of best practices. The main priority of the utilities is to facilitate best practices adoption, as defined in the AWS Well-Architected Serverless Lens; all other functionality is optional.
- Keep it lean. Additional dependencies are carefully considered for security and ease of maintenance, and prevent negatively impacting startup time.
- We strive for backwards compatibility. New features and changes should keep backwards compatibility. If a breaking change cannot be avoided, the deprecation and migration process should be clearly defined.
- We work backwards from the community. We aim to strike a balance of what would work best for 80% of customers. Emerging practices are considered and discussed via Requests for Comment (RFCs)
- Progressive. Utilities are designed to be incrementally adoptable for customers at any stage of their Serverless journey. They follow language idioms and their communityβs common practices.