Feature request: Support cookies in Lambda function response for format 2.0

[eflopez]

Use case

I am using the Router class to setup some resolvers for use with APIGatewayHttpResolver, and I would like to be able to set cookies in my customised Response object, but this is not currently possible.

According to the APIGateway response documentation, the format for this is

{
    "cookies" : ["cookie1", "cookie2"],
    "isBase64Encoded": true|false,
    "statusCode": httpStatusCode,
    "headers": { "headername": "headervalue", ... },
    "body": "Hello from Lambda!"
}

Solution/User Experience

Would be great to be able to just be able to do something like

    return Response(
        status_code=418,
        cookies=["cookie1", "cookie2"],
        content_type="application/json",
        body=payload,
        headers=custom_headers,
    )

Alternative solutions

No response

Acknowledgment

• This feature request meets Lambda Powertools Tenets
• Should this be considered in other Lambda Powertools languages? i.e. Java, TypeScript

[boring-cyborg]

Thanks for opening your first issue here! We'll come back to you as soon as we can.

[michaelbrewer]

Good idea! There are more cumbersome way, but format 2.0 does make it easier. Once this has been "approved" / "triaged", it should be an easy addition to the API GW handler.

[michaelbrewer]

@eflopez For discussion purpose i created a PR #1196

This will also allow for a more convenient method to set cookies for ALB, Http and Rest apis.

[heitorlessa]

Removing help wanted as @rubenfonseca will start working on this next week.

[heitorlessa]

Closing as we're wrap to launch V2

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.