docs: add examples for parameter utilities

Author: nmoutschen

aws_lambda_powertools/utilities/parameters/dynamodb.py

@@ -15,6 +15,60 @@
 class DynamoDBProvider(BaseProvider):
     """
     Amazon DynamoDB Parameter Provider
+
+    Example
+    -------
+    **Retrieves a parameter value from a DynamoDB table**
+
+    In this example, the DynamoDB table uses `id` as hash key and stores the value in the `value`
+    attribute.
+
+        >>> from aws_lambda_powertools.utilities.parameters import DynamoDBProvider
+        >>> ddb_provider = DynamoDBProvider("ParametersTable")
+        >>>
+        >>> ddb_provider.get("my-parameter")
+
+    **Retrieves a parameter value from a DynamoDB table that has custom attribute names**
+
+        >>> from aws_lambda_powertools.utilities.parameters import DynamoDBProvider
+        >>> ddb_provider = DynamoDBProvider(
+        ...     "ParametersTable",
+        ...     key_attr="my-id",
+        ...     value_attr="my-value"
+        ... )
+        >>>
+        >>> ddb_provider.get("my-parameter")
+
+    **Retrieves a parameter value from a DynamoDB table in another AWS region**
+
+        >>> from botocore.config import Config
+        >>> from aws_lambda_powertools.utilities.parameters import DynamoDBProvider
+        >>>
+        >>> config = Config(region_name="us-west-1")
+        >>> ddb_provider = DynamoDBProvider("ParametersTable", config=config)
+        >>>
+        >>> ddb_provider.get("my-parameter")
+
+    **Retrieves multiple values from a DynamoDB table**
+
+    In this case, the provider will use a sort key to retrieve multiple values using a query under
+    the hood. This expects that the sort key is named `sk`.
+
+        >>> from aws_lambda_powertools.utilities.parameters import DynamoDBProvider
+        >>> ddb_provider = DynamoDBProvider("ParametersTable")
+        >>>
+        >>> ddb_provider.get_multiple("my-parameters")
+
+    **Retrieves multiple values from a DynamoDB table with a custom sort key**
+
+    In this case, the provider will use a sort key to retrieve multiple values using a query under
+    the hood.
+
+        >>> from aws_lambda_powertools.utilities.parameters import DynamoDBProvider
+        >>> ddb_provider = DynamoDBProvider("ParametersTable")
+        >>>
+        >>> ddb_provider.get_multiple("my-parameters", sort_attr="my-sort-attr")
+
     """
 
     table = None

aws_lambda_powertools/utilities/parameters/secrets.py

@@ -14,6 +14,25 @@
 class SecretsProvider(BaseProvider):
     """
     AWS Secrets Manager Parameter Provider
+
+    Example
+    -------
+    **Retrieves a parameter value from Secrets Manager**
+
+        >>> from aws_lambda_powertools.utilities.parameters import SecretsProvider
+        >>> secrets_provider = SecretsProvider()
+        >>>
+        >>> secrets_provider.get("my-parameter")
+
+    **Retrieves a parameter value from Secrets Manager in another AWS region**
+
+        >>> from botocore.config import Config
+        >>> from aws_lambda_powertools.utilities.parameters import SecretsProvider
+        >>>
+        >>> config = Config(region_name="us-west-1")
+        >>> secrets_provider = SecretsProvider(config=config)
+        >>>
+        >>> secrets_provider.get("my-parameter")
     """
 
     client = None

aws_lambda_powertools/utilities/parameters/ssm.py

@@ -14,6 +14,32 @@
 class SSMProvider(BaseProvider):
     """
     AWS Systems Manager Parameter Store Provider
+
+    Example
+    -------
+    **Retrieves a parameter value from Systems Manager Parameter Store**
+
+        >>> from aws_lambda_powertools.utilities.parameters import SSMProvider
+        >>> ssm_provider = SSMProvider()
+        >>>
+        >>> ssm_provider.get("/my/parameter")
+
+    **Retrieves a parameter value from Systems Manager Parameter Store in another AWS region**
+
+        >>> from botocore.config import Config
+        >>> from aws_lambda_powertools.utilities.parameters import SSMProvider
+        >>>
+        >>> config = Config(region_name="us-west-1")
+        >>> ssm_provider = SSMProvider(config=config)
+        >>>
+        >>> ssm_provider.get("/my/parameter")
+
+    **Retrieves multiple parameter values from Systes Manager Parameter Store using a path prefix**
+
+        >>> from aws_lambda_powertools.utilities.parameters import SSMProvider
+        >>> ssm_provider = SSMProvider()
+        >>>
+        >>> ssm_provider.get_multiple("/my/path/prefix")
     """
 
     client = None