Skip to content

docs(appconfig): Use correct import for docstring #271

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

Merged
merged 3 commits into from
Jan 27, 2021
Merged

docs(appconfig): Use correct import for docstring #271

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1cbd87b
docs(appconfig): Use correct import for docstring
michaelbrewer Jan 19, 2021
bcc9c8f
Merge branch 'develop' into docs-appconfig
michaelbrewer Jan 21, 2021
08a1dad
docs: Rename variable back
michaelbrewer Jan 21, 2021
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
12 changes: 6 additions & 6 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 @@ -32,23 +32,23 @@ class AppConfigProvider(BaseProvider):
-------
**Retrieves the latest configuration value from App Config**

>>> from aws_lambda_powertools.utilities.parameters import AppConfigProvider
>>> appconf_provider = parameters.AppConfigProvider(environment="my_env", application="my_app")
>>> from aws_lambda_powertools.utilities import parameters
>>> provider = parameters.AppConfigProvider(environment="my_env", application="my_app")
>>>
>>> value : bytes = appconf_provider.get("my_conf")
>>> value : bytes = provider.get("my_conf")
>>>
>>> print(value)
My configuration value

**Retrieves a configuration value from App Config in another AWS region**

>>> from botocore.config import Config
>>> from aws_lambda_powertools.utilities.parameters import AppConfigProvider
>>> from aws_lambda_powertools.utilities import parameters
>>>
>>> config = Config(region_name="us-west-1")
>>> appconf_provider = parameters.AppConfigProvider(environment="my_env", application="my_app", config=config)
>>> provider = parameters.AppConfigProvider(environment="my_env", application="my_app", config=config)
>>>
>>> value : bytes = appconf_provider.get("my_conf")
>>> value : bytes = provider.get("my_conf")
>>>
>>> print(value)
My configuration value
Expand Down