From e92336f103ec083c76994380b2f5669262932305 Mon Sep 17 00:00:00 2001 From: Ran Isenberg Date: Sun, 2 Jan 2022 08:42:19 +0200 Subject: [PATCH 1/2] docs: fix internal _get documentation --- aws_lambda_powertools/utilities/parameters/appconfig.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/aws_lambda_powertools/utilities/parameters/appconfig.py b/aws_lambda_powertools/utilities/parameters/appconfig.py index d1613c14513..3932c3e287b 100644 --- a/aws_lambda_powertools/utilities/parameters/appconfig.py +++ b/aws_lambda_powertools/utilities/parameters/appconfig.py @@ -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 From 3f8d60f27e37b8b79b160f5d97befeb7e8c21955 Mon Sep 17 00:00:00 2001 From: Ran Isenberg Date: Sun, 2 Jan 2022 08:55:26 +0200 Subject: [PATCH 2/2] docs: fix internal documentation --- aws_lambda_powertools/utilities/parameters/appconfig.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/aws_lambda_powertools/utilities/parameters/appconfig.py b/aws_lambda_powertools/utilities/parameters/appconfig.py index 3932c3e287b..3455617e952 100644 --- a/aws_lambda_powertools/utilities/parameters/appconfig.py +++ b/aws_lambda_powertools/utilities/parameters/appconfig.py @@ -138,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 ------ @@ -161,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') >>>