Amazon.Lambda.APIGatewayEvents 2.7.1

Prefix Reserved

.NET 8.0 .NET Core 3.1 .NET Standard 2.0

dotnet add package Amazon.Lambda.APIGatewayEvents --version 2.7.1

NuGet\Install-Package Amazon.Lambda.APIGatewayEvents -Version 2.7.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="Amazon.Lambda.APIGatewayEvents" Version="2.7.1" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Amazon.Lambda.APIGatewayEvents" Version="2.7.1" />
                    

                            Directory.Packages.props

<PackageReference Include="Amazon.Lambda.APIGatewayEvents" />
                    

                            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 Amazon.Lambda.APIGatewayEvents --version 2.7.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Amazon.Lambda.APIGatewayEvents, 2.7.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 Amazon.Lambda.APIGatewayEvents@2.7.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=Amazon.Lambda.APIGatewayEvents&version=2.7.1
                    

                            Install as a Cake Addin

#tool nuget:?package=Amazon.Lambda.APIGatewayEvents&version=2.7.1
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Amazon.Lambda.APIGatewayEvents

This package contains classes that can be used as input types for Lambda functions that process Amazon API Gateway events.

API Gateway events consist of a request that was routed to a Lambda function by API Gateway. When this happens, API Gateway expects the result of the function to be the response that API Gateway should respond with. To see a more detailed example of this, take a look at the Amazon.Lambda.AspNetCoreServer README.md file.

Classes

Class	Description
APIGatewayProxyRequest	Represents proxy request coming from REST API, HTTP API payload format 1.0 or WebSocket API.
APIGatewayProxyResponse	The return object for functions handling requests for REST API, HTTP API payload format 1.0 or WebSocket API.
APIGatewayHttpApiV2ProxyRequest	Represents proxy request coming from HTTP API payload format 2.0.
APIGatewayHttpApiV2ProxyResponse	The return object for functions handling requests for HTTP API payload format 2.0.

Sample Functions

The following is a sample class and Lambda function that receives Amazon API Gateway event record data as an input, writes some of the record data to CloudWatch Logs, and responds with a 200 status and the same body as the request. (Note that by default anything written to Console will be logged as CloudWatch Logs events.)

Function handler

public class Function
{
    public APIGatewayProxyResponse Handler(APIGatewayProxyRequest apigProxyEvent)
    {
        Console.WriteLine($"Processing request data for request {apigProxyEvent.RequestContext.RequestId}.");
        Console.WriteLine($"Body size = {apigProxyEvent.Body.Length}.");
        var headerNames = string.Join(", ", apigProxyEvent.Headers.Keys);
        Console.WriteLine($"Specified headers = {headerNames}.");

        return new APIGatewayProxyResponse
        {
            Body = apigProxyEvent.Body,
            StatusCode = 200,
        };
    }
}

Product	Compatible and additional computed target framework versions.
.NET	net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. 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 was computed. 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 was computed. 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.
.NET Core	netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 is compatible.
.NET Standard	netstandard2.0 is compatible. netstandard2.1 was computed.
.NET Framework	net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed.
MonoAndroid	monoandroid was computed.
MonoMac	monomac was computed.
MonoTouch	monotouch was computed.
Tizen	tizen40 was computed. tizen60 was computed.
Xamarin.iOS	xamarinios was computed.
Xamarin.Mac	xamarinmac was computed.
Xamarin.TVOS	xamarintvos was computed.
Xamarin.WatchOS	xamarinwatchos was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETCoreApp 3.1
- No dependencies.
.NETStandard 2.0
- Newtonsoft.Json (>= 13.0.1)
net8.0
- No dependencies.

NuGet packages (65)

Showing the top 5 NuGet packages that depend on Amazon.Lambda.APIGatewayEvents:

Package	Downloads
Amazon.Lambda.AspNetCoreServer Amazon.Lambda.AspNetCoreServer makes it easy to run ASP.NET Core Web API applications as AWS Lambda functions.	26.2M
Amazon.Lambda.AspNetCoreServer.Hosting Package for running ASP.NET Core applications using the Minimal API style as a AWS Lambda function.	5.2M
OpenTelemetry.Instrumentation.AWSLambda AWS Lambda tracing wrapper for OpenTelemetry .NET.	2.2M
Epsagon.Dotnet.Instrumentation Package Description	427.3K
Xerris.DotNet.Core.Aws Package Description	287.3K

GitHub repositories (15)

Showing the top 15 popular GitHub repositories that depend on Amazon.Lambda.APIGatewayEvents:

Repository	Stars
mongodb/mongo-csharp-driver The Official C# .NET Driver for MongoDB	3.2K
open-telemetry/opentelemetry-dotnet-contrib This repository contains set of components extending functionality of the OpenTelemetry .NET SDK. Instrumentation libraries, exporters, and other components can find their home here.	569
DataDog/dd-trace-dotnet .NET Client Library for Datadog APM	508
aws/aws-extensions-for-dotnet-cli Extensions to the dotnet CLI to simplify the process of building and publishing .NET Core applications to AWS services	383
axzxs2001/Asp.NetCoreExperiment 原来所有项目都移动到OleVersion目录下进行保留。新的案例装以.net 5.0为主，一部分对以前案例进行升级，一部分将以前的工作经验总结出来，以供大家参考！	359
aws-samples/serverless-test-samples This repository is designed to provide guidance for implementing comprehensive test suites for serverless applications.	327
Elfocrash/aws-videos	286
aws-powertools/powertools-lambda-dotnet Powertools is a developer toolkit to implement Serverless best practices and increase developer velocity.	170
PowerShellOrg/tug Open-source, cross-platform Pull/Reporting Server for DSC	163
aws-samples/serverless-dotnet-demo	156
hlaueriksson/CommandQuery Command Query Separation for 🌐ASP.NET Core ⚡AWS Lambda ⚡Azure Functions ⚡Google Cloud Functions	110
newrelic/newrelic-dotnet-agent The New Relic .NET language agent.	108
Particular/docs.particular.net All content for ParticularDocs	108
LambdaSharp/LambdaSharpTool Serverless .NET on AWS - λ# is a CLI and Framework for Rapid Application Development using .NET on AWS	103
aws/integrations-on-dotnet-aspire-for-aws This repositry contains the integrations with .NET Aspire for AWS.	101

Version	Downloads	Last Updated
2.7.1	4,674,904	8/1/2024
2.7.0	7,918,830	10/26/2023
2.6.0	6,055,844	2/13/2023
2.5.0	4,378,984	6/28/2022
2.4.1	4,972,850	5/3/2022
2.4.0	9,792,049	12/4/2020
2.3.0	1,292,918	10/21/2020
2.2.0	436,104	9/30/2020
2.1.0	3,489,884	4/28/2020
2.0.0	1,133,841	3/31/2020
1.3.0	938,135	12/18/2019
1.2.0	3,328,501	2/7/2019
1.1.3	1,539,128	5/29/2018
1.1.2	266,011	2/5/2018
1.1.1	89,728	1/15/2018
1.1.0	190,346	4/26/2017
1.0.2	48,677	1/27/2017
1.0.1	17,072	12/21/2016
1.0.0	24,801	12/1/2016