Skip to content

Commit db1d9d1

Browse files
author
Michael Brewer
committed
Merge branch 'develop' into docs-typo
2 parents a311246 + f2a4818 commit db1d9d1

File tree

4 files changed

+63
-52
lines changed

4 files changed

+63
-52
lines changed

aws_lambda_powertools/utilities/parameters/appconfig.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,10 +92,8 @@ def _get(self, name: str, **sdk_options) -> str:
9292
----------
9393
name: str
9494
Name of the configuration
95-
environment: str
96-
Environment of the configuration
9795
sdk_options: dict, optional
98-
Dictionary of options that will be passed to the Parameter Store get_parameter API call
96+
Dictionary of options that will be passed to the client's get_configuration API call
9997
"""
10098

10199
sdk_options["Configuration"] = name
@@ -140,7 +138,7 @@ def get_app_config(
140138
max_age: int
141139
Maximum age of the cached value
142140
sdk_options: dict, optional
143-
Dictionary of options that will be passed to the Parameter Store get_parameter API call
141+
Dictionary of options that will be passed to the boto client get_configuration API call
144142
145143
Raises
146144
------
@@ -163,7 +161,7 @@ def get_app_config(
163161
164162
**Retrieves a configuration value and decodes it using a JSON decoder**
165163
166-
>>> from aws_lambda_powertools.utilities.parameters import get_parameter
164+
>>> from aws_lambda_powertools.utilities.parameters import get_app_config
167165
>>>
168166
>>> value = get_app_config("my_config", environment="my_env", application="my_env", transform='json')
169167
>>>

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ A suite of utilities for AWS Lambda functions to ease adopting best practices su
1111

1212
## Tenets
1313

14-
This project separates core utilities that will be available in other runtimes vs general utilities that might not be available across all runtimes.
14+
Core utilities such as Tracing, Logging, Metrics, and Event Handler will be available across all Lambda Powertools runtimes. Additional utilities are subjective to each language ecosystem and customer demand.
1515

1616
* **AWS Lambda only**. We optimise for AWS Lambda function environments and supported runtimes only. Utilities might work with web frameworks and non-Lambda environments, though they are not officially supported.
1717
* **Eases the adoption of best practices**. The main priority of the utilities is to facilitate best practices adoption, as defined in the AWS Well-Architected Serverless Lens; all other functionality is optional.

poetry.lock

Lines changed: 58 additions & 45 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ flake8-bugbear = "^21.11.29"
5353
mkdocs-material = "^7.3.6"
5454
mkdocs-git-revision-date-plugin = "^0.3.1"
5555
mike = "^0.6.0"
56-
mypy = "^0.930"
56+
mypy = "^0.931"
5757

5858

5959
[tool.poetry.extras]

0 commit comments

Comments
 (0)