Skip to content
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

fix(parameters): appconfig internal _get docstrings #934

Merged
merged 2 commits into from
Jan 11, 2022
Merged

fix(parameters): appconfig internal _get docstrings #934

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e92336f
docs: fix internal _get documentation
Jan 2, 2022
3f8d60f
docs: fix internal documentation
Jan 2, 2022
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
8 changes: 3 additions & 5 deletions aws_lambda_powertools/utilities/parameters/appconfig.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,10 +92,8 @@ def _get(self, name: str, **sdk_options) -> str:
----------
name: str
Name of the configuration
environment: str
Environment of the configuration
sdk_options: dict, optional
Dictionary of options that will be passed to the Parameter Store get_parameter API call
Dictionary of options that will be passed to the client's get_configuration API call
"""

sdk_options["Configuration"] = name
Expand Down Expand Up @@ -140,7 +138,7 @@ def get_app_config(
max_age: int
Maximum age of the cached value
sdk_options: dict, optional
Dictionary of options that will be passed to the Parameter Store get_parameter API call
Dictionary of options that will be passed to the boto client get_configuration API call

Raises
------
Expand All @@ -163,7 +161,7 @@ def get_app_config(

**Retrieves a configuration value and decodes it using a JSON decoder**

>>> from aws_lambda_powertools.utilities.parameters import get_parameter
>>> from aws_lambda_powertools.utilities.parameters import get_app_config
>>>
>>> value = get_app_config("my_config", environment="my_env", application="my_env", transform='json')
>>>
Expand Down