Feature request: Event Source Data Classes for API Gateway WebSocket events

[ericbn]

Use case

I see Pydantic models were added for API Gateway WebSocket events here:

Model name	Description
APIGatewayWebSocketMessageEventModel	Lambda Event Source payload for Amazon API Gateway WebSocket API message body
APIGatewayWebSocketConnectEventModel	Lambda Event Source payload for Amazon API Gateway WebSocket API $connect message
APIGatewayWebSocketDisconnectEventModel	Lambda Event Source payload for Amazon API Gateway WebSocket API $disconnect message

This is request to add the corresponding Event Source Data Classes.

Solution/User Experience

It would be used like below, as an example:

import requests
from aws_lambda_powertools.utilities.data_classes import (
    APIGatewayWebSocketMessageEvent,
    event_source,
)

session = requests.Session()

@event_source(data_class=APIGatewayWebSocketMessageEvent)
def lambda_handler(event: APIGatewayWebSocketMessageEvent, context):
    params = {
        "connection_id": event.request_context.connection_id,
        "data": event.json_body,
    }
    response = session.post("https://mydomain.com/myapi", data=params)
    if 400 <= response.status_code < 600:
        raise RuntimeError(response.text)
    return {"statusCode": 200}

Alternative solutions

I see other requests related to API Gateway WebSocket events, but they seem like different features: #1165, #5905

Acknowledgment

• This feature request meets Powertools for AWS Lambda (Python) Tenets
• Should this be considered in other Powertools for AWS Lambda languages? i.e. Java, TypeScript, and .NET

[leandrodamascena]

Bem-vindo de volta @ericbn! Super nice see you here again!

Yes, it makes perfect sense to add these models to the event source as well. Do you want to submit a PR for this?

These other requests are more related to creating a Resolver for WebSocket APIs, but I'd like to explore more ideas before deciding on that.

[ericbn]

Oi @leandrodamascena. Thanks! I can help with a PR. It's just not something I already started working at.

[leandrodamascena]

Oi @leandrodamascena. Thanks! I can help with a PR. It's just not something I already started working at.

No rush at all! Take your time and if you need any help with this PR, please let me know.