Base

CLASS	DESCRIPTION
StoreProvider

StoreProvider

Bases: ABC

METHOD	DESCRIPTION
get_configuration	Get configuration from any store and return the parsed JSON dictionary

ATTRIBUTE	DESCRIPTION
get_raw_configuration	Get configuration from any store and return the parsed JSON dictionary TYPE: dict[str, Any]

get_raw_configuration abstractmethod property

get_raw_configuration: dict[str, Any]

Get configuration from any store and return the parsed JSON dictionary

get_configuration abstractmethod

get_configuration() -> dict[str, Any]

Get configuration from any store and return the parsed JSON dictionary

If envelope is set, it'll extract and return feature flags from configuration, otherwise it'll return the entire configuration fetched from the store.

RAISES	DESCRIPTION
ConfigurationStoreError	Any error that can occur during schema fetch or JSON parse

RETURNS	DESCRIPTION
dict[str, Any]	parsed JSON dictionary

Example

{
    "premium_features": {
        "default": False,
        "rules": {
            "customer tier equals premium": {
                "when_match": True,
                "conditions": [
                    {
                        "action": "EQUALS",
                        "key": "tier",
                        "value": "premium",
                    }
                ],
            }
        },
    },
    "feature_two": {
        "default": False
    }
}

Source code in aws_lambda_powertools/utilities/feature_flags/base.py

@abstractmethod
def get_configuration(self) -> dict[str, Any]:
    """Get configuration from any store and return the parsed JSON dictionary

    If envelope is set, it'll extract and return feature flags from configuration,
    otherwise it'll return the entire configuration fetched from the store.

    Raises
    ------
    ConfigurationStoreError
        Any error that can occur during schema fetch or JSON parse

    Returns
    -------
    dict[str, Any]
        parsed JSON dictionary

    Example
    -------

    ```python
    {
        "premium_features": {
            "default": False,
            "rules": {
                "customer tier equals premium": {
                    "when_match": True,
                    "conditions": [
                        {
                            "action": "EQUALS",
                            "key": "tier",
                            "value": "premium",
                        }
                    ],
                }
            },
        },
        "feature_two": {
            "default": False
        }
    }
    ```
    """
    raise NotImplementedError()  # pragma: no cover