Skip to content

Commit

Permalink
Update project README to describe the response payload for non-http e…
Browse files Browse the repository at this point in the history
…vents (#346)

* Implement pass-through events

* Update README file

* Update e2e test template and the README file

* Optimize e2e test job

* Update README

* Update project README
  • Loading branch information
bnusunny authored Jan 21, 2024
1 parent 3e8b963 commit 82e5ade
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,6 @@ The [Express.js](examples/expressjs/app/src/index.js) gives a simple example. Mo

Lambda Web Adapter allows developers to develop web applications locally with familiar tools and debuggers: just run the web app locally and test it. If you want to simulate Lambda Runtime environment locally, you can use AWS SAM CLI. The following command starts a local api gateway endpoint and simulate the Lambda runtime execution environment.


```bash
sam local start-api
```
Expand All @@ -162,7 +161,7 @@ Please note that `sam local` starts a Lambda Runtime Interface Emulator on port

## Non-HTTP Event Triggers

Lambda Web Adapter supports non-http event triggers (such as SQS, EventBridge, and Bedrock Agents, etc.). The adapter will forward the event payload to the web application at the path specified by environment variable `AWS_LWA_PASS_THROUGH_PATH`. The default path is `/events`. The web application can retrieve the event payload from the request body.
Lambda Web Adapter supports non-http event triggers (such as SQS, EventBridge, and Bedrock Agents, etc.). The adapter will forward the event payload to the web application at the path specified by environment variable `AWS_LWA_PASS_THROUGH_PATH`. The default path is `/events`. The web application can retrieve the event payload from the request body. The http response body must be a valid JSON string and will be passed back as the response payload to the Lambda service.

## Examples

Expand Down

0 comments on commit 82e5ade

Please sign in to comment.