{"id":24555,"library":"sample-helper-aws-appconfig","title":"sample-helper-aws-appconfig","description":"A sample helper library for AWS AppConfig that simplifies configuration retrieval and management. Current version 2.3.1, supports Python >=3.10, <4.0.","status":"active","version":"2.3.1","language":"python","source_language":"en","source_url":"https://github.com/aws-samples/sample-python-helper-aws-appconfig","tags":["aws","appconfig","configuration","helper"],"install":[{"cmd":"pip install sample-helper-aws-appconfig","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"AWS SDK for Python, required for AppConfig API calls","package":"boto3","optional":false},{"reason":"Backports for type hints","package":"typing-extensions","optional":true}],"imports":[{"note":"Wrong because the package slug uses hyphens but the import uses underscores.","wrong":"from appconfig_helper import AppConfigHelper","symbol":"AppConfigHelper","correct":"from sample_helper_aws_appconfig import AppConfigHelper"}],"quickstart":{"code":"import os\nfrom sample_helper_aws_appconfig import AppConfigHelper\n\nhelper = AppConfigHelper(\n    application='my-app',\n    environment='production',\n    configuration='my-config',\n    client_id='my-client'\n)\nconfig = helper.get_configuration()\nprint(config)","lang":"python","description":"Initialize the helper with AppConfig identifiers and retrieve configuration."},"warnings":[{"fix":"Use `helper.get_configuration_validated()` and provide a schema.","message":"The `get_configuration` method returns raw configuration content without validation; use `get_configuration_validated` for schema validation.","severity":"deprecated","affected_versions":">=1.0.0,<2.4.0"},{"fix":"Generate a unique client ID per instance (e.g., using uuid.uuid4()).","message":"Client ID must be unique; reusing the same client ID across multiple instances may cause throttling.","severity":"gotcha","affected_versions":"all"},{"fix":"Use `json.loads(helper.get_configuration())` to parse the string if needed.","message":"In version 2.0.0, the `get_configuration` method changed from returning a dict to returning a string. Code expecting a dict will break.","severity":"breaking","affected_versions":"<2.0.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Use: from sample_helper_aws_appconfig import AppConfigHelper","cause":"Using wrong import path due to package name hyphen vs underscore confusion.","error":"ImportError: cannot import name 'AppConfigHelper' from 'sample_helper_aws_appconfig'"},{"fix":"Verify that the application, environment, and configuration names are correct and that the configuration has been created in AWS AppConfig.","cause":"The specified configuration name does not exist in AppConfig.","error":"botocore.exceptions.ClientError: An error occurred (ResourceNotFoundException) when calling the GetConfiguration operation: Configuration 'my-config' not found"},{"fix":"Ensure you pass client_id to the helper constructor or to get_configuration().","cause":"The client_id parameter was omitted when calling get_configuration, but it is required.","error":"TypeError: get_configuration() missing 1 required positional argument: 'client_id'"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}