AwsLambda.Host.Envelopes.Sqs 1.0.0-beta.1

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
This is a prerelease version of AwsLambda.Host.Envelopes.Sqs. 
dotnet add package AwsLambda.Host.Envelopes.Sqs --version 1.0.0-beta.1
                    


                    

                
NuGet\Install-Package AwsLambda.Host.Envelopes.Sqs -Version 1.0.0-beta.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="AwsLambda.Host.Envelopes.Sqs" Version="1.0.0-beta.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="AwsLambda.Host.Envelopes.Sqs" Version="1.0.0-beta.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="AwsLambda.Host.Envelopes.Sqs" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add AwsLambda.Host.Envelopes.Sqs --version 1.0.0-beta.1
                    


                    

                
#r "nuget: AwsLambda.Host.Envelopes.Sqs, 1.0.0-beta.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package AwsLambda.Host.Envelopes.Sqs@1.0.0-beta.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=AwsLambda.Host.Envelopes.Sqs&version=1.0.0-beta.1&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=AwsLambda.Host.Envelopes.Sqs&version=1.0.0-beta.1&prerelease
                    


                            Install as a Cake Tool

AwsLambda.Host.Envelopes.Sqs

Strongly-typed SQS event handling for the AwsLambda.Host framework.

Overview

This package provides SqsEnvelope<T>, which extends the base SQSEvent class with a generic Records collection that deserializes message bodies into strongly-typed objects. Instead of manually parsing JSON from record.Body, you access deserialized payloads directly via record.BodyContent.

Envelope Class Base Class Use Case
SqsEnvelope<T> SQSEvent SQS event with deserialized message bodies

Quick Start

Define your message type and handler:

using AwsLambda.Host;
using AwsLambda.Host.Envelopes.Sqs;

// Your message payload - will be deserialized from SQS message body
record Message(string Name);

var builder = LambdaApplication.CreateBuilder();
var lambda = builder.Build();

// SqsEnvelope<Message> provides access to the SQS event and deserialized Message payloads
lambda.MapHandler(([Event] SqsEnvelope<Message> envelope, ILogger<Program> logger) =>
{
    foreach (var record in envelope.Records)
    {
        logger.LogInformation("Message: {Name}", record.BodyContent?.Name);
    }
});

await lambda.RunAsync();

record Message(string Name);

AOT Support

When using .NET Native AOT, register both the envelope and payload types in your JsonSerializerContext:

[JsonSerializable(typeof(SqsEnvelope<Message>))]
[JsonSerializable(typeof(Message))]
internal partial class SerializerContext : JsonSerializerContext;

Register the serializer and configure envelope options to use the context:

builder.Services.AddLambdaSerializerWithContext<SerializerContext>();

builder.Services.ConfigureEnvelopeOptions(options =>
{
    options.JsonOptions.TypeInfoResolver = SerializerContext.Default;
});

Note: The context must be registered in both places because the Lambda event and payload are deserialized at different steps: the Lambda serializer deserializes the raw SQS event, and the envelope options deserialize the message bodies into your payload type.

See the example project for a complete working example.

License

This project is licensed under the MIT License. See LICENSE for details.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0-beta.1 83 11/15/2025