AWS.Lambda.Powertools.JMESPath 1.0.0

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package AWS.Lambda.Powertools.JMESPath --version 1.0.0
                    


                    

                
NuGet\Install-Package AWS.Lambda.Powertools.JMESPath -Version 1.0.0
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="AWS.Lambda.Powertools.JMESPath" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="AWS.Lambda.Powertools.JMESPath" Version="1.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="AWS.Lambda.Powertools.JMESPath" />
                    


                            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 AWS.Lambda.Powertools.JMESPath --version 1.0.0
                    


                    

                
#r "nuget: AWS.Lambda.Powertools.JMESPath, 1.0.0"
#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 AWS.Lambda.Powertools.JMESPath@1.0.0
#: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=AWS.Lambda.Powertools.JMESPath&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=AWS.Lambda.Powertools.JMESPath&version=1.0.0
                    


                            Install as a Cake Tool

Powertools JMESPath support

JMESPath is a query language for JSON used by AWS CLI, AWS Python SDK, and Powertools for AWS Lambda.

With built-in JMESPath functions to easily deserialize common encoded JSON payloads in Lambda functions.

Key features

  • Deserialize JSON from JSON strings, base64, and compressed data
  • Use JMESPath to extract and combine data recursively
  • Provides commonly used JMESPath expression with popular event sources

JMESPath allows you to transform a JsonDocument into another JsonDocument.

For example, consider the JSON data


string jsonString = """
{
    "body": "{\"customerId\":\"dd4649e6-2484-4993-acb8-0f9123103394\"}",
    "deeply_nested": [
        {
            "some_data": [
                1,
                2,
                3
            ]
        }
    ]
}
""";

using JsonDocument doc = JsonDocument.Parse(jsonString);

string expr = "powertools_json(body).customerId";
//also works for fetching and flattening deeply nested data
// string expr = "deeply_nested[*].some_data[]";

JsonDocument result = JsonTransformer.Transform(doc.RootElement, expr);

It produces the result

"dd4649e6-2484-4993-acb8-0f9123103394"

You can find more examples here

Built-in envelopes

We provide built-in envelopes for popular AWS Lambda event sources to easily decode and/or deserialize JSON objects.

Envelop JMESPath expression
API_GATEWAY_HTTP powertools_json(body)
API_GATEWAY_REST powertools_json(body)
CLOUDWATCH_LOGS awslogs.powertools_base64_gzip(data) | powertools_json(@).logEvents[*]
KINESIS_DATA_STREAM Records[*].kinesis.powertools_json(powertools_base64(data))
SNS Records[*].Sns.Message | powertools_json(@)
SQS Records[*].powertools_json(body)

More examples of events can be found here

Built-in JMESPath functions

You can use our built-in JMESPath functions within your envelope expression. They handle deserialization for common data formats found in AWS Lambda event sources such as JSON strings, base64, and uncompress gzip data.

powertools_json function

Use powertools_json function to decode any JSON string anywhere a JMESPath expression is allowed.

powertools_base64 function

Use powertools_base64 function to decode any base64 data.

powertools_base64_gzip function

Use powertools_base64_gzip function to decompress and decode base64 data.

Credit

We took heavy inspiration in the https://github.com/danielaparker/JsonCons.Net repository.

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 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • net8.0

    • No dependencies.

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 202 10/15/2025