.. image:: https://github.com/MacHu-GWU/aws_lambda_event-project/workflows/CI/badge.svg
:target: https://github.com/MacHu-GWU/aws_lambda_event-project/actions?query=workflow:CI
.. image:: https://codecov.io/gh/MacHu-GWU/aws_lambda_event-project/branch/main/graph/badge.svg
:target: https://codecov.io/gh/MacHu-GWU/aws_lambda_event-project
.. image:: https://img.shields.io/pypi/v/aws_lambda_event.svg
:target: https://pypi.python.org/pypi/aws_lambda_event
.. image:: https://img.shields.io/pypi/l/aws_lambda_event.svg
:target: https://pypi.python.org/pypi/aws_lambda_event
.. image:: https://img.shields.io/pypi/pyversions/aws_lambda_event.svg
:target: https://pypi.python.org/pypi/aws_lambda_event
.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
:target: https://github.com/MacHu-GWU/aws_lambda_event-project
------
.. image:: https://img.shields.io/badge/Link-Install-blue.svg
:target: `install`_
.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
:target: https://github.com/MacHu-GWU/aws_lambda_event-project
.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
:target: https://github.com/MacHu-GWU/aws_lambda_event-project/issues
.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
:target: https://github.com/MacHu-GWU/aws_lambda_event-project/issues
.. image:: https://img.shields.io/badge/Link-Download-blue.svg
:target: https://pypi.org/pypi/aws_lambda_event#files
Welcome to ``aws_lambda_event`` Documentation
==============================================================================
This library provides Python Class interface, attribute auto-complete, type hint for AWS Lambda Events.
**Example**:
.. code-block:: python
# An example lambda handler python module
import aws_lambda_event
# example S3 Put event
def handler(event, context):
event_obj = aws_lambda_event.S3PutEvent(event)
for record in event_obj.records:
# access attribute
_ = record.eventTime
# important attributes quick access alias
_ = record.bucket
_ = record.key
_ = record.etag
_ = record.size
...
**List of Supported Event**:
- ``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:
Install
------------------------------------------------------------------------------
``aws_lambda_event`` is released on PyPI, so all you need is:
.. code-block:: console
$ pip install aws_lambda_event
To upgrade to latest version:
.. code-block:: console
$ pip install --upgrade aws_lambda_event
Raw data
{
"_id": null,
"home_page": "https://github.com/MacHu-GWU/aws_lambda_event-project",
"name": "aws-lambda-event",
"maintainer": "Unknown",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Sanhe Hu",
"author_email": "husanhe@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/24/43/d1c0427280e7c58c6d346363a4ece254a89e8f3a0cf8c427863c8f11d5de/aws_lambda_event-2.0.1.tar.gz",
"platform": "Windows",
"description": ".. image:: https://github.com/MacHu-GWU/aws_lambda_event-project/workflows/CI/badge.svg\n :target: https://github.com/MacHu-GWU/aws_lambda_event-project/actions?query=workflow:CI\n\n.. image:: https://codecov.io/gh/MacHu-GWU/aws_lambda_event-project/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/MacHu-GWU/aws_lambda_event-project\n\n.. image:: https://img.shields.io/pypi/v/aws_lambda_event.svg\n :target: https://pypi.python.org/pypi/aws_lambda_event\n\n.. image:: https://img.shields.io/pypi/l/aws_lambda_event.svg\n :target: https://pypi.python.org/pypi/aws_lambda_event\n\n.. image:: https://img.shields.io/pypi/pyversions/aws_lambda_event.svg\n :target: https://pypi.python.org/pypi/aws_lambda_event\n\n.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social\n :target: https://github.com/MacHu-GWU/aws_lambda_event-project\n\n------\n\n.. image:: https://img.shields.io/badge/Link-Install-blue.svg\n :target: `install`_\n\n.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg\n :target: https://github.com/MacHu-GWU/aws_lambda_event-project\n\n.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg\n :target: https://github.com/MacHu-GWU/aws_lambda_event-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg\n :target: https://github.com/MacHu-GWU/aws_lambda_event-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Download-blue.svg\n :target: https://pypi.org/pypi/aws_lambda_event#files\n\n\nWelcome to ``aws_lambda_event`` Documentation\n==============================================================================\n\nThis library provides Python Class interface, attribute auto-complete, type hint for AWS Lambda Events.\n\n**Example**:\n\n.. code-block:: python\n\n # An example lambda handler python module\n import aws_lambda_event\n\n # example S3 Put event\n def handler(event, context):\n event_obj = aws_lambda_event.S3PutEvent(event)\n\n for record in event_obj.records:\n # access attribute\n _ = record.eventTime\n\n # important attributes quick access alias\n _ = record.bucket\n _ = record.key\n _ = record.etag\n _ = record.size\n ...\n\n\n**List of Supported Event**:\n\n- ``S3PutEvent``\n- ``S3DeleteEvent``\n- ``SNSTopicNotificationEvent``\n- ``SQSEvent``\n- ``DynamodbUpdateEvent``\n- ``KinesisStreamEvent``\n- ``KinesisFirehoseEvent``\n\nYou can find the event JSON schema in two place:\n\n1. AWS Lambda Event Source Mapping Official Document: https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html\n2. Goto AWS Lambda Function Console -> Create Test Event -> Choose from Event template\n\n\n.. _install:\n\nInstall\n------------------------------------------------------------------------------\n\n``aws_lambda_event`` is released on PyPI, so all you need is:\n\n.. code-block:: console\n\n $ pip install aws_lambda_event\n\nTo upgrade to latest version:\n\n.. code-block:: console\n\n $ pip install --upgrade aws_lambda_event\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Class Interface for AWS Lambda event.",
"version": "2.0.1",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6d45e5fc4b3ed8d4fb482496f7fa90d1fe7a371b735f7beb2bf9974e27d62e5d",
"md5": "cf30e2e078bc33e17b59bb15bca3a141",
"sha256": "b791f14aa50ebd2ef52491399c7dae5b2ebc714a7617af446a9479a8dc69bf69"
},
"downloads": -1,
"filename": "aws_lambda_event-2.0.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "cf30e2e078bc33e17b59bb15bca3a141",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 36033,
"upload_time": "2023-02-04T06:34:24",
"upload_time_iso_8601": "2023-02-04T06:34:24.909834Z",
"url": "https://files.pythonhosted.org/packages/6d/45/e5fc4b3ed8d4fb482496f7fa90d1fe7a371b735f7beb2bf9974e27d62e5d/aws_lambda_event-2.0.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2443d1c0427280e7c58c6d346363a4ece254a89e8f3a0cf8c427863c8f11d5de",
"md5": "4c0245cad25616e19fac0a9ac0ae7f2f",
"sha256": "ba9d335bd8c5e22aa1682e498005fae8fd6c53f55f7fc78ab2a51be8ca2bb278"
},
"downloads": -1,
"filename": "aws_lambda_event-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "4c0245cad25616e19fac0a9ac0ae7f2f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 24534,
"upload_time": "2023-02-04T06:34:26",
"upload_time_iso_8601": "2023-02-04T06:34:26.657944Z",
"url": "https://files.pythonhosted.org/packages/24/43/d1c0427280e7c58c6d346363a4ece254a89e8f3a0cf8c427863c8f11d5de/aws_lambda_event-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-04 06:34:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "MacHu-GWU",
"github_project": "aws_lambda_event-project",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "aws-lambda-event"
}
JSON
