chore: shorten docstrings, fix union single typehint

Author: heitorlessa

aws_lambda_powertools/utilities/parameters/appconfig.py

@@ -33,9 +33,9 @@ class AppConfigProvider(BaseProvider):
     config: botocore.config.Config, optional
         Botocore configuration to pass during client initialization
     boto3_session : boto3.session.Session, optional
-            Boto3 session to use for AWS API communication, will not be used if boto3_client is not None
+            Boto3 session to create a boto3_client from
     boto3_client: AppConfigClient, optional
-            Boto3 Client to use for AWS API communication, will be used instead of boto3_session if both provided
+            Boto3 AppConfig Client to use, boto3_session will be ignored if both are provided
 
     Example
     -------

aws_lambda_powertools/utilities/parameters/base.py

@@ -29,7 +29,6 @@
 TRANSFORM_METHOD_BINARY = "binary"
 SUPPORTED_TRANSFORM_METHODS = [TRANSFORM_METHOD_JSON, TRANSFORM_METHOD_BINARY]
 ParameterClients = Union["AppConfigClient", "SecretsManagerClient", "SSMClient"]
-ParameterResourceClients = Union["DynamoDBServiceResource"]
 
 
 class BaseProvider(ABC):
@@ -210,7 +209,7 @@ def _build_boto3_client(
         session : Optional[Type[boto3.Session]], optional
             boto3 session instance, by default None
         config : Optional[Type[Config]], optional
-            botocore config instance to configure client, by default None
+            botocore config instance to configure client with, by default None
 
         Returns
         -------
@@ -224,21 +223,22 @@ def _build_boto3_client(
         config = config or Config()
         return session.client(service_name=service_name, config=config)
 
+    # maintenance: change DynamoDBServiceResource type to ParameterResourceClients when we expand
     @staticmethod
     def _build_boto3_resource_client(
         service_name: str,
-        client: Optional[ParameterResourceClients] = None,
+        client: Optional["DynamoDBServiceResource"] = None,
         session: Optional[Type[boto3.Session]] = None,
         config: Optional[Type[Config]] = None,
         endpoint_url: Optional[str] = None,
-    ) -> Type[ParameterResourceClients]:
+    ) -> Type["DynamoDBServiceResource"]:
         """Builds a high level boto3 resource client with session, config and endpoint_url provided
 
         Parameters
         ----------
         service_name : str
             AWS service name to instantiate a boto3 client, e.g. ssm
-        client : Optional[ParameterResourceClients], optional
+        client : Optional[DynamoDBServiceResource], optional
             boto3 client instance, by default None
         session : Optional[Type[boto3.Session]], optional
             boto3 session instance, by default None
@@ -247,8 +247,8 @@ def _build_boto3_resource_client(
 
         Returns
         -------
-        Type[ParameterResourceClients]
-            Instance of a boto3 client for Parameters feature (e.g., ssm, appconfig, secretsmanager, etc.)
+        Type[DynamoDBServiceResource]
+            Instance of a boto3 resource client for Parameters feature (e.g., dynamodb, etc.)
         """
         if client is not None:
             return client

aws_lambda_powertools/utilities/parameters/dynamodb.py

@@ -35,10 +35,9 @@ class DynamoDBProvider(BaseProvider):
     config: botocore.config.Config, optional
         Botocore configuration to pass during client initialization
     boto3_session : boto3.session.Session, optional
-            Boto3 session to use for AWS API communication
+            Boto3 session to create a boto3_client from
     boto3_client: DynamoDBServiceResource, optional
-            Boto3 DynamoDB Resource Client to use for AWS API communication,
-            will be used instead of boto3_session if both provided
+            Boto3 DynamoDB Resource Client to use; boto3_session will be ignored if both are provided
 
     Example
     -------

aws_lambda_powertools/utilities/parameters/secrets.py

@@ -23,9 +23,9 @@ class SecretsProvider(BaseProvider):
     config: botocore.config.Config, optional
         Botocore configuration to pass during client initialization
     boto3_session : boto3.session.Session, optional
-            Boto3 session to use for AWS API communication, will not be used if boto3_client is not None
+            Boto3 session to create a boto3_client from
     boto3_client: SecretsManagerClient, optional
-            Boto3 Client to use for AWS API communication, will be used instead of boto3_session if both provided
+            Boto3 SecretsManager Client to use, boto3_session will be ignored if both are provided
 
     Example
     -------

aws_lambda_powertools/utilities/parameters/ssm.py

@@ -23,9 +23,9 @@ class SSMProvider(BaseProvider):
     config: botocore.config.Config, optional
         Botocore configuration to pass during client initialization
     boto3_session : boto3.session.Session, optional
-            Boto3 session to use for AWS API communication, will not be used if boto3_client is not None
+            Boto3 session to create a boto3_client from
     boto3_client: SSMClient, optional
-            Boto3 Client to use for AWS API communication, will be used instead of boto3_session if both provided
+            Boto3 SSM Client to use, boto3_session will be ignored if both are provided
 
     Example
     -------