feature: Kafka Parser support

Author: Ran Isenberg

aws_lambda_powertools/utilities/parser/envelopes/__init__.py

@@ -4,6 +4,7 @@
 from .cloudwatch import CloudWatchLogsEnvelope
 from .dynamodb import DynamoDBStreamEnvelope
 from .event_bridge import EventBridgeEnvelope
+from .kafka import KafkaEnvelope
 from .kinesis import KinesisDataStreamEnvelope
 from .lambda_function_url import LambdaFunctionUrlEnvelope
 from .sns import SnsEnvelope, SnsSqsEnvelope
@@ -20,5 +21,6 @@
     "SnsEnvelope",
     "SnsSqsEnvelope",
     "SqsEnvelope",
+    "KafkaEnvelope",
     "BaseEnvelope",
 ]

aws_lambda_powertools/utilities/parser/models/__init__.py

@@ -17,6 +17,7 @@
 from .cloudwatch import CloudWatchLogsData, CloudWatchLogsDecode, CloudWatchLogsLogEvent, CloudWatchLogsModel
 from .dynamodb import DynamoDBStreamChangedRecordModel, DynamoDBStreamModel, DynamoDBStreamRecordModel
 from .event_bridge import EventBridgeModel
+from .kafka import KafkaEventModel, KafkaRecordModel
 from .kinesis import KinesisDataStreamModel, KinesisDataStreamRecord, KinesisDataStreamRecordPayload
 from .lambda_function_url import LambdaFunctionUrlModel
 from .s3 import S3Model, S3RecordModel
@@ -98,4 +99,6 @@
     "APIGatewayEventRequestContext",
     "APIGatewayEventAuthorizer",
     "APIGatewayEventIdentity",
+    "KafkaEventModel",
+    "KafkaRecordModel",
 ]

docs/utilities/parser.md

@@ -168,6 +168,7 @@ Parser comes with the following built-in models:
 | **APIGatewayProxyEventModel**   | Lambda Event Source payload for Amazon API Gateway                 |
 | **APIGatewayProxyEventV2Model** | Lambda Event Source payload for Amazon API Gateway v2 payload      |
 | **LambdaFunctionUrlModel**      | Lambda Event Source payload for Lambda Function URL payload        |
+| **KafkaModel**                  | Lambda Event Source payload for self managed Kafka payload         |
 
 ### extending built-in models
 
@@ -308,6 +309,7 @@ Parser comes with the following built-in envelopes, where `Model` in the return
 | **ApiGatewayEnvelope**        | 1. Parses data using `APIGatewayProxyEventModel`. <br/> 2. Parses `body` key using your model and returns it.                                                                                               | `Model`                            |
 | **ApiGatewayV2Envelope**      | 1. Parses data using `APIGatewayProxyEventV2Model`. <br/> 2. Parses `body` key using your model and returns it.                                                                                             | `Model`                            |
 | **LambdaFunctionUrlEnvelope** | 1. Parses data using `LambdaFunctionUrlModel`. <br/> 2. Parses `body` key using your model and returns it.                                                                                                  | `Model`                            |
+| **KafkaEnvelope**             | 1. Parses data using `KafkaRecordModel`. <br/> 2. Parses `value` key using your model and returns it.                                                                                                       | `Model`                            |
 
 ### Bringing your own envelope
 

tests/functional/parser/schemas.py

@@ -91,3 +91,7 @@ class MyApiGatewayBusiness(BaseModel):
 class MyALambdaFuncUrlBusiness(BaseModel):
     message: str
     username: str
+
+
+class MyALambdaKafkaBusiness(BaseModel):
+    key: str