Skip to content

Commit

Permalink
fix(parameters): appconfig internal _get docstrings (#934)
Browse files Browse the repository at this point in the history
Co-authored-by: Ran Isenberg <[email protected]>
  • Loading branch information
ran-isenberg and Ran Isenberg authored Jan 11, 2022
1 parent 3e4e1ab commit 4277a53
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions aws_lambda_powertools/utilities/parameters/appconfig.py
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

0 comments on commit 4277a53

Please sign in to comment.