Skip to main content

Class Interface for AWS Lambda event.

Project description

https://github.com/MacHu-GWU/aws_lambda_event-project/workflows/CI/badge.svg https://codecov.io/gh/MacHu-GWU/aws_lambda_event-project/branch/main/graph/badge.svg https://img.shields.io/pypi/v/aws_lambda_event.svg https://img.shields.io/pypi/l/aws_lambda_event.svg https://img.shields.io/pypi/pyversions/aws_lambda_event.svg https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
https://img.shields.io/badge/Link-Install-blue.svg https://img.shields.io/badge/Link-GitHub-blue.svg https://img.shields.io/badge/Link-Submit_Issue-blue.svg https://img.shields.io/badge/Link-Request_Feature-blue.svg https://img.shields.io/badge/Link-Download-blue.svg

Welcome to aws_lambda_event Documentation

This library provides Python Class interface, attribute auto-complete, type hint for AWS Lambda Events. It can parse the AWS Lambda event data, and also generate fake event data for testing.

Example:

# An example lambda handler python module
import aws_lambda_event

# parse S3 Put event, convert it into a python object with type hint, auto complete
def handler(event, context):
    event_obj = aws_lambda_event.S3PutEvent.from_dict(event)

    for record in event_obj.Records:
        # access attribute
        _ = record.eventTime

        # important attributes quick access alias
        _ = record.bucket
        _ = record.key
        _ = record.etag
        _ = record.size
        ...

# generate an fake event for testing
event_obj = aws_lambda_event.S3PutEvent.fake(bucket="my-bucket", key="my-file.txt")
...

List of Supported Event:

  • CloudWatchLogsEvent

  • CloudWatchScheduledEvent

  • S3PutEvent

  • S3DeleteEvent

  • SNSTopicNotificationEvent

  • SQSEvent

  • DynamodbUpdateEvent

  • KinesisStreamEvent

  • KinesisFirehoseEvent

You can find the event JSON schema in two place:

  1. AWS Lambda Event Source Mapping Official Document: https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html

  2. Goto AWS Lambda Function Console -> Create Test Event -> Choose from Event template

Install

aws_lambda_event is released on PyPI, so all you need is:

$ pip install aws_lambda_event

To upgrade to latest version:

$ pip install --upgrade aws_lambda_event

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aws_lambda_event-2.0.2.tar.gz (24.8 kB view details)

Uploaded Source

Built Distribution

aws_lambda_event-2.0.2-py2.py3-none-any.whl (36.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file aws_lambda_event-2.0.2.tar.gz.

File metadata

  • Download URL: aws_lambda_event-2.0.2.tar.gz
  • Upload date:
  • Size: 24.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.11

File hashes

Hashes for aws_lambda_event-2.0.2.tar.gz
Algorithm Hash digest
SHA256 3a72c88cd975e5d8a25ea0540f477aedf4f60a652f6fafe2831008aa19628a40
MD5 5785041dce3e62136d658c1e7b180cf1
BLAKE2b-256 02d4fd45c97a7ef0b1a8f896bb1b09e0c8d1e38d739f2a2446bc90aeaee974f6

See more details on using hashes here.

File details

Details for the file aws_lambda_event-2.0.2-py2.py3-none-any.whl.

File metadata

  • Download URL: aws_lambda_event-2.0.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 36.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.11

File hashes

Hashes for aws_lambda_event-2.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 30f2da7d03f4bb70ffab9f33082864bb9e833f0693a350066c83008eea2573a6
MD5 d8608bd0c1193fb1773c9fea4fd11817
BLAKE2b-256 39e55cbe1a236612cd5ea2f37b64a178b290a295d5cfcb61d27c6dcd41b9bd6c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page