Skip to content

Improve description of Python return serialization #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 24, 2019
Merged

Improve description of Python return serialization #73

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a376d3
Improve description of Python return serialization
adamchainz Aug 15, 2018
d950483
Merge branch 'master' into patch-4
mwunderl Jun 24, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions doc_source/python-programming-model-handler-types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@ In the syntax, note the following:
+ `event` – AWS Lambda uses this parameter to pass in event data to the handler\. This parameter is usually of the Python `dict` type\. It can also be `list`, `str`, `int`, `float`, or `NoneType` type\.
+ `context` – AWS Lambda uses this parameter to provide runtime information to your handler\. This parameter is of the `LambdaContext` type\.
+ Optionally, the handler can return a value\. What happens to the returned value depends on the invocation type you use when invoking the Lambda function:
+ If you use the `RequestResponse` invocation type \(synchronous execution\), AWS Lambda returns the result of the Python function call to the client invoking the Lambda function \(in the HTTP response to the invocation request, serialized into JSON\)\. For example, AWS Lambda console uses the `RequestResponse` invocation type, so when you invoke the function using the console, the console will display the returned value\.
+ If you use the `RequestResponse` invocation type \(synchronous execution\), AWS Lambda returns the result of the Python function call to the client invoking the Lambda function \(in the HTTP response to the invocation request, serialized into JSON with `json.dumps`\)\. For example, AWS Lambda console uses the `RequestResponse` invocation type, so when you invoke the function using the console, the console will display the returned value\.

If the handler returns `NONE`, AWS Lambda returns null\.
If the handler returns objects that can't be serialized by `json.dumps`, the runtime returns an error.

If the handler returns `None`, as Python functions with a `return` statement implicitly do, this gets serializes this as JSON `null`\.
+ If you use the `Event` invocation type \(asynchronous execution\), the value is discarded\.

For example, consider the following Python example code\.
Expand All @@ -28,4 +30,4 @@ def my_handler(event, context):
}
```

This example has one function called `my_handler`\. The function returns a message containing data from the event it received as input\.
This example has one function called `my_handler`\. The function returns a message containing data from the event it received as input\.