Skip to content

docs(metadata): clarify public import path for get_lambda_metadata #8349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
leiwilson wants to merge 1 commit into
base: develop
Choose a base branch
from
+11 −0
Open

docs(metadata): clarify public import path for get_lambda_metadata #8349

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/utilities/metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,17 @@ The Metadata utility allows you to fetch data from the [AWS Lambda Metadata Endp

You can fetch data from the Lambda Metadata Endpoint using the `get_lambda_metadata` function.

Import it from `aws_lambda_powertools.utilities.metadata` (the public package path):

```python
from aws_lambda_powertools.utilities.metadata import get_lambda_metadata
```

???+ warning "Import path is `utilities.metadata`"
The correct module path is `aws_lambda_powertools.utilities.metadata`.

Do **not** import from `aws_lambda_powertools.utilities.lambda_metadata` — that path is not part of the public API (even though the implementation file and `get_lambda_metadata` helper share a similar name).

???+ tip
Metadata is cached for the duration of the Lambda sandbox, so subsequent calls to `get_lambda_metadata` will return the cached data.

Expand Down