https://github.com/simalexan/lambda-event-parser
A parse tool that helps you easily consume any AWS resource event triggering your AWS Lambda.
https://github.com/simalexan/lambda-event-parser
Last synced: 3 months ago
JSON representation
A parse tool that helps you easily consume any AWS resource event triggering your AWS Lambda.
- Host: GitHub
- URL: https://github.com/simalexan/lambda-event-parser
- Owner: simalexan
- License: mit
- Created: 2019-02-11T21:56:25.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T16:24:09.000Z (over 2 years ago)
- Last Synced: 2025-03-01T18:22:45.899Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 341 KB
- Stars: 7
- Watchers: 4
- Forks: 2
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Lambda Event Parser
[](https://travis-ci.org/simalexan/lambda-event-parser)
A simple parse tool to just parses the events triggering your AWS Lambda into a common format, so you don't have to worry.
## The standardized event format
```javascript
{
sourceType: 'api',
sourceEvent: originalEvent,
records: [{
userId: 123
}] // array of events (with parameters as properties)
}
```
## How does it work
**API Gateway GET Request Event**:
`?userId=456&name=someoneUnknown`
```javascript
{
httpMethod: 'GET',
queryStringParameters: {
userId: 456,
name: 'someoneUnknown'
}
}
}
```
will be translated into ->
```javascript
{
sourceType: 'api',
sourceEvent: originalEvent, // the complete, unchanged GET request event objet
records: [{
userId: 123,
name: 'someoneUnknown'
}] // array of events (with parameters as properties)
}
```
Let's take another example, an S3 Event:
**S3 Event**:
```javascript
{
Records: [
{
s3: {
object: {
key: "HappyFace.jpg",
size: 1024
}
}
}
]
}
```
will be translated into:
```javascript
{
sourceType: 's3',
sourceEvent: originalEvent, // the complete, unchanged S3 event objet
records: [{
key: "HappyFace.jpg",
size: 1024
}] // array of events (with parameters as properties)
}
```
**SNS Event**:
```javascript
{
"Records": [
{
"eventID": "7de3041dd709b024af6f29e4fa13d34c",
"eventName": "INSERT",
"eventVersion": "1.1",
"eventSource": "aws:dynamodb",
"awsRegion": "us-west-2",
"dynamodb": {
"ApproximateCreationDateTime": 1479499740,
"Keys": {
"Timestamp": {
"S": "2016-11-18:12:09:36"
},
"Username": {
"S": "John Doe"
}
},
"NewImage": {
"Timestamp": {
"S": "2016-11-18:12:09:36"
},
"Message": {
"S": "This is a bark from the Woofer social network"
},
"Username": {
"S": "John Doe"
}
},
"SequenceNumber": "13021600000000001596893679",
"SizeBytes": 112,
"StreamViewType": "NEW_IMAGE"
},
"eventSourceARN": "arn:aws:dynamodb:us-east-1:123456789012:table/BarkTable/stream/2016-11-16T20:42:48.104"
}
]
}
```
will be translated into:
```javascript
{
sourceType: 's3',
sourceEvent: originalEvent, // the complete, unchanged S3 event objet
records: [{
key: "HappyFace.jpg",
size: 1024
}] // array of events (with parameters as properties)
}
```
## Supported AWS Events (so far)
- [x] SNS
- [x] S3
- [x] API Gateway (GET, POST, PUT, DELETE, PATCH)
- [x] DynamoDB Streams (NEW_IMAGE)
- [ ] SQS
- [ ] Other AWS Lambda
- [ ] CloudWatch
- [ ] Kinesis DataFirehose
- [ ] Kinesis Data Streams
- [ ] SES
## License
MIT
Aleksandar Simovic