software.amazon.lambda.powertools.utilities

Class EventDeserializer

java.lang.Object

software.amazon.lambda.powertools.utilities.EventDeserializer

public class EventDeserializer
extends java.lang.Object

Class that can be used to extract the meaningful part of an event and deserialize it into a Java object.
For example, extract the body of an API Gateway event, or messages from an SQS event.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EventDeserializer.EventPart Meaningful part of a Lambda event. Use extractDataFrom(Object) to retrieve an instance of this class.

Constructor Summary

Constructors

Constructor and Description
EventDeserializer()

Method Summary

Modifier and Type	Method and Description
static EventDeserializer.EventPart	extractDataFrom(java.lang.Object object) Extract the meaningful part of a Lambda Event object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventDeserializer

public EventDeserializer()

Method Detail

extractDataFrom

public static EventDeserializer.EventPart extractDataFrom(java.lang.Object object)

Extract the meaningful part of a Lambda Event object. Main events are built-in:

• APIGatewayProxyRequestEvent -> body
• APIGatewayV2HTTPEvent -> body
• SNSEvent -> Records[0].Sns.Message
• SQSEvent -> Records[*].body (list)
• ScheduledEvent -> detail
• ApplicationLoadBalancerRequestEvent -> body
• CloudWatchLogsEvent -> powertools_base64_gzip(data)
• CloudFormationCustomResourceEvent -> resourceProperties
• KinesisEvent -> Records[*].kinesis.powertools_base64(data) (list)
• KinesisFirehoseEvent -> Records[*].powertools_base64(data) (list)
• KafkaEvent -> records[*].values[*].powertools_base64(value) (list)
• ActiveMQEvent -> messages[*].powertools_base64(data) (list)
• RabbitMQEvent -> rmqMessagesByQueue[*].values[*].powertools_base64(data) (list)
• KinesisAnalyticsFirehoseInputPreprocessingEvent -> Records[*].kinesis.powertools_base64(data) (list)
• KinesisAnalyticsStreamsInputPreprocessingEvent > Records[*].kinesis.powertools_base64(data) (list)
• String
• Map

To be used in conjunction with EventDeserializer.EventPart.as(Class) or EventDeserializer.EventPart.asListOf(Class) for the deserialization.

Parameters:

object - the event of your Lambda function handler method

Returns:

the part of the event which is meaningful (ex: body of the API Gateway).