Skip to content

Commit

Permalink
docs(jmespath): clarify envelope terminology
Browse files Browse the repository at this point in the history
  • Loading branch information
heitorlessa committed Oct 5, 2021
1 parent 465b6cb commit 5641914
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/utilities/jmespath_functions.md
Expand Up @@ -18,6 +18,8 @@ You might have events that contains encoded JSON payloads as string, base64, or

Lambda Powertools also have utilities like [validation](validation.md), [idempotency](idempotency.md), or [feature flags](feature_flags.md) where you might need to extract a portion of your data before using them.

!!! info "**Envelope** is the terminology we use for the JMESPath expression to extract your JSON object from your data input"

### Extracting data

You can use the `extract_data_from_envelope` function along with any [JMESPath expression](https://jmespath.org/tutorial.html){target="_blank"}.
Expand Down

0 comments on commit 5641914

Please sign in to comment.