Skip to content

MacHu-GWU/aws_lambda_event-project

Repository files navigation

image

image

image

image

image

image


image

image

image

image

image

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

About

Class Interface for AWS Lambda event

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published