Understanding of the compress option

[nilsm0hr]

Hi,

I tired to understand the compress option in PowerTools. We have started to implement powertools on our functions. Some of them compressed the Lambda response in our python code and returned the base64 payload to enable larger payloads.

The documentation suggests that you just return an object, rather than the Response object powertools provides. Looking at the source code, I managed to use the powertools response object after I dumped my json response to a string.

Would it be possible to make the docs a bit clearer around this? Not quite sure if I am misunderstanding something here.

https://awslabs.github.io/aws-lambda-powertools-python/2.7.1/core/event_handler/api_gateway/#compress

Thanks

[rubenfonseca]

Hi @nilsm0hr thank you so much for opening this up! I agree that we need to improve the documentation on how to use compressed objects with the Response object. Would you mind opening a new documentation improvement issue for us to track and prioritize that?

Thank you!

[heitorlessa]

We can covert this discussion into an issue too - don't see the button on mobile but surely is on the web UI.

We can do tomorrow regardless

[rubenfonseca]

Done!

[rubenfonseca]

Converted the question to an issue #1890

[nilsm0hr]

Thanks guys! really appreciate it

[heitorlessa]

Closing as it was released back then: https://github.com/awslabs/aws-lambda-powertools-python/releases/tag/v2.17.0