boto3-assist 0.14.0__py3-none-any.whl → 0.16.0__py3-none-any.whl

boto3_assist/aws_config.py

@@ -0,0 +1,199 @@
+import os
+from pathlib import Path
+import configparser
+from typing import Literal, Optional
+from boto3_assist.utilities.serialization_utility import SerializableModel
+
+
+class AWSConfigProfile(SerializableModel):
+    def __init__(
+        self, region: Optional[str] = "us-east-1", output: Optional[str] = "json"
+    ):
+
+        self.region: Optional[str] = region
+        self.output: Optional[str] = output
+
+        self.aws_access_key_id: Optional[str] = None
+        self.aws_secret_access_key: Optional[str] = None
+        self.aws_session_token: Optional[str] = None
+
+        self.sso_session: Optional[str] = None
+        self.sso_account_id: Optional[str] = None
+        self.sso_role_name: Optional[str] = None
+
+        self.credential_process: Optional[str] = None
+        self.credential_source: Optional[str] = None
+        self.role_arn: Optional[str] = None
+        self.source_profile: Optional[str] = None
+        self.external_id: Optional[str] = None
+        self.role_session_name: Optional[str] = None
+        self.duration_seconds: Optional[str] = None
+
+
+class AWSConfigSSOSession(SerializableModel):
+    def __init__(
+        self,
+        sso_start_url: Optional[str] = None,
+        sso_region: Optional[str] = None,
+        sso_registration_scopes: Optional[str] = None,
+    ):
+        self.sso_start_url: Optional[str] = sso_start_url
+        self.sso_region: Optional[str] = sso_region
+        self.sso_registration_scopes: Optional[str] = sso_registration_scopes
+
+
+class AWSConfig:
+    """
+    Performs Operations on an AWS Config
+    """
+
+    def __init__(self):
+        pass
+
+    def get_path(self) -> Path:
+        """
+        Returns the path to the AWS config file, honoring AWS_CONFIG_FILE
+        and falling back to ~/.aws/config (or %USERPROFILE%\.aws\config on Windows).
+        """
+        # 1) Check for explicit override
+        env_path = os.environ.get("AWS_CONFIG_FILE")
+        if env_path:
+            return Path(env_path).expanduser()
+
+        # 2) Default location
+        return os.path.join(Path.home(), ".aws", "config")
+
+    def path_exists(self) -> bool:
+        path = self.get_path()
+
+        return os.path.isfile(path)
+
+    def has_profile(self, profile_name: str) -> bool:
+        config = configparser.ConfigParser()
+        self.read_section(profile_name, config)
+        return profile_name in config.sections()
+
+    def upsert_profile(
+        self,
+        name: str,
+        profile: AWSConfigProfile,
+        config_path: Optional[str] = None,
+    ):
+        self.write_section(name, profile, config_path)
+
+    def upsert_sso_session(
+        self,
+        profile_name: str,
+        sso_session: AWSConfigSSOSession,
+        profile: AWSConfigProfile | None = None,
+        config_path: Optional[str] = None,
+    ):
+        """
+        Insert / Update the SSO Session block in the aws config
+        Args:
+            Name (str): Required.  Specifies the profile name.  This is the init key
+                which is added to the section for both sso-session and profile
+                e.g. [profile {profile_name}] or [sso-session {profile_name}]
+            sso_session (AWSConfigSSOSession): Defines the values written to this session block
+            profile (AWSConfigProfile): Defines the values written to the profile block.  Typically
+                you will need a profile block along with a session block when using sso-session
+
+
+        As a general rule you will typically need to build the following:
+            [profile {profile-name}]
+            sso_session = {optionally-use-profile-name}
+            sso_account_id = {aws-acount-id}
+            sso_role_name = {sso-role}
+            region = {region}
+            output = {output}
+
+            [sso-session {profile-name}]
+            sso_start_url = {sso_start_url} e.g. https://account-alias.awsapps.com/start
+            sso_region = {region}
+            sso_registration_scopes = {scopes}
+
+        """
+
+        if not profile_name:
+            raise ValueError("Name is required")
+
+        self.write_section(profile_name, sso_session, config_path)
+
+        if profile:
+            self.write_section(profile_name, profile, config_path)
+
+    def write_section(
+        self,
+        profile_name: str | None,
+        section: AWSConfigProfile | AWSConfigSSOSession,
+        config_path: Optional[str] = None,
+    ):
+        config = configparser.ConfigParser()
+        path = config_path or self.get_path()
+
+        if self.path_exists():
+            config.read(path)  # or any INI file path
+
+        section_key = ""
+
+        if profile_name.startswith("sso-session "):
+            profile_name = profile_name.replace("sso-session ", "")
+        if profile_name.startswith("profile "):
+            profile_name = profile_name.replace("profile ", "")
+
+        if isinstance(section, AWSConfigProfile):
+            if profile_name:
+                section_key = f"profile {profile_name}"
+            else:
+                section_key = "default"
+        elif isinstance(section, AWSConfigSSOSession):
+            section_key = f"sso-session {profile_name}"
+        else:
+            raise ValueError("Invalid section type")
+
+        config = self._write_section(section_key, section, config)
+
+        with open(path, "w", encoding="utf-8") as cfg_file:
+            config.write(cfg_file)
+
+    def _write_section(
+        self,
+        section_key: str,
+        section: AWSConfigProfile | AWSConfigSSOSession,
+        config: configparser.ConfigParser,
+    ) -> configparser.ConfigParser:
+
+        # always start with a "fresh" section
+        config[section_key] = {}
+
+        section_dictionary = section.to_dictionary()
+        for key, value in section_dictionary.items():
+            if value is not None:
+                config[section_key][key] = value
+
+        return config
+
+    def read_section(
+        self,
+        profile_name: Optional[str] = None,
+        config_path: Optional[str] = None,
+        section_type: Literal["profile", "sso-session"] = "profile",
+    ) -> configparser.SectionProxy:
+        config = configparser.ConfigParser()
+        if not config_path:
+            config_path = self.get_path()
+
+        if not os.path.isfile(config_path):
+            return config
+
+        config.read(config_path)
+        profile_ini = f"{section_type} {profile_name}"
+        if profile_ini in config:
+            profile = config[profile_ini]
+            return profile
+
+        if profile_name in config:
+            profile = config[profile_name]
+            return profile
+
+        return {}

boto3_assist/dynamodb/dynamodb.py

@@ -41,6 +41,8 @@ class DynamoDB(DynamoDBConnection):
         aws_access_key_id: Optional[str] = None,
         aws_secret_access_key: Optional[str] = None,
         assume_role_arn: Optional[str] = None,
+        assume_role_chain: Optional[List[str]] = None,
+        assume_role_duration_seconds: Optional[int] = 3600,
     ) -> None:
         super().__init__(
             aws_profile=aws_profile,
@@ -49,6 +51,8 @@ class DynamoDB(DynamoDBConnection):
             aws_access_key_id=aws_access_key_id,
             aws_secret_access_key=aws_secret_access_key,
             assume_role_arn=assume_role_arn,
+            assume_role_chain=assume_role_chain,
+            assume_role_duration_seconds=assume_role_duration_seconds,
         )
         self.helpers: DynamoDBHelpers = DynamoDBHelpers()
         self.log_dynamodb_item_size = (

boto3_assist/dynamodb/troubleshooting.md

@@ -3,3 +3,5 @@
 1. Unable to locate credentials. You can configure credentials by running "aws configure".
 
 - out of the blue, this started happening
+- depending on how you are connecting boto3 may require a credentials file
+- running "aws configure" and simply puttting in some garbage may fix the issue.

boto3_assist/session_setup_mixin.py

@@ -4,8 +4,10 @@ Maintainers: Eric Wilson
 MIT License.  See Project Root for the license information.
 """
 
+import os
 import boto3
 from typing import Optional
+from boto3_assist.aws_config import AWSConfig
 
 
 class SessionSetupMixin:
@@ -26,4 +28,43 @@ class SessionSetupMixin:
                 aws_session_token=aws_session_token,
             )
         except Exception as e:
-            raise RuntimeError(f"Failed to create boto3 session: {e}") from e
+
+            error_message = f"Failed to create boto3 session "
+            if "profile" in str(e).lower():
+                error_message += " due to a profile error "
+
+                error_message += f" with profile '{aws_profile}'."
+                config: AWSConfig = AWSConfig()
+                if not config.path_exists():
+                    error_message += (
+                        f" The AWS config file '{config.get_path()}' was not found. "
+                        "Please ensure that the AWS CLI is installed and configured correctly. "
+                        "You can install the AWS CLI by running 'pip install awscli' or 'pip install awscli --upgrade'. "
+                    )
+
+                    if (
+                        os.getenv("HOME") == "/tmp"
+                        or os.getenv("AWS_CONFIG_FILE") == "/tmp"
+                    ):
+                        error_message += (
+                            f'The environment HOME path is set to {os.getenv("HOME")}. '
+                        )
+                        if os.getenv("AWS_CONFIG_FILE"):
+                            error_message += (
+                                f"The environment AWS_CONFIG_FILE is set to {os.getenv('AWS_CONFIG_FILE')}. "
+                                "The AWS_CONFIG_FILE overrides the HOME directory and path. "
+                            )
+
+                        error_message += (
+                            "If you are running this locally and expecting it to be in your users home "
+                            "directory, you may need to set the HOME or AWS_CONFIG_FILE environment variable manually. "
+                            "There could be other actions such as a Lambda environment resetting the path to /tmp. "
+                            "If you are running in a GitHub Actions environment, "
+                            "you may need to set the HOME or AWS_CONFIG_FILE environment variable to '/home/runner'. "
+                        )
+                elif not config.has_profile(aws_profile):
+                    error_message += f" The profile '{aws_profile}' was not found in the AWS config file in {config.get_path()}."
+
+            # check for the existence of the profile and the path to the profile
+
+            raise RuntimeError(error_message) from e

boto3_assist/utilities/serialization_utility.py

@@ -22,7 +22,7 @@ logger = Logger()
 
 
 class SerializableModel:
-    """Library to Serialize object to a DynamoDB Format"""
+    """Library to Serialize object to a DynamoDB Format or other dictionary"""
 
     T = TypeVar("T", bound="SerializableModel")
 
@@ -47,9 +47,16 @@ class SerializableModel:
 
         return mapped
 
+    def dict(self) -> Dict[str, Any]:
+        """
+        Same as .to_dictionary
+
+        """
+        return self.to_dictionary()
+
     def to_dictionary(self) -> Dict[str, Any]:
         """
-        Convert the object to a dictionary.
+        Convert the object to a dictionary. Same as .dict()
         """
         # return Serialization.convert_object_to_dict(self)
         return Serialization.to_dict(

boto3_assist/version.py

@@ -1 +1 @@
-__version__ = '0.14.0'
+__version__ = '0.16.0'

{boto3_assist-0.14.0.dist-info → boto3_assist-0.16.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boto3_assist
-Version: 0.14.0
+Version: 0.16.0
 Summary: Additional boto3 wrappers to make your life a little easier
 Author-email: Eric Wilson <boto3-assist@geekcafe.com>
 License-File: LICENSE-EXPLAINED.txt

{boto3_assist-0.14.0.dist-info → boto3_assist-0.16.0.dist-info}/RECORD

@@ -1,11 +1,12 @@
 boto3_assist/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+boto3_assist/aws_config.py,sha256=hEIX1YihsXCqpM5ftbGmSuWySQoEUFgOQ9KXb3zmlK0,6557
 boto3_assist/boto3session.py,sha256=p4FKVSX5A-xNHdpRan8pgMoY4iIywNfwriyTfjQ-zTQ,2967
 boto3_assist/connection.py,sha256=tqsNGLouAzCiTdtm9JylDTA6IiYqaQQiHmY-kH2bksU,4905
 boto3_assist/connection_tracker.py,sha256=UgfR9RlvXf3A4ssMr3gDMpw89ka8mSRvJn4M34SzhbU,4378
 boto3_assist/http_status_codes.py,sha256=G0zRSWenwavYKETvDF9tNVUXQz3Ae2gXdBETYbjvJe8,3284
 boto3_assist/role_assumption_mixin.py,sha256=PMUU5yC2FUBjFD1UokVkRY3CPB5zTw85AhIB5BMtbc8,1031
-boto3_assist/session_setup_mixin.py,sha256=KgHOf560f2W_Qj04mnu4CiGHXAI_irjmQeEfhAJN3kA,865
-boto3_assist/version.py,sha256=4pkGIcN2HdoT4OEADiR3LUoE-VfT0mtYYKhwVWEwVMY,23
+boto3_assist/session_setup_mixin.py,sha256=X-JQKyyaWNA8Z8kKgf2V2I5vsiLAH8udLTX_xepnsdQ,3140
+boto3_assist/version.py,sha256=ZkVXSbnNkhhpmMRr5ur6FqBcUYuqHyK0KUV5Je_XFn8,23
 boto3_assist/aws_lambda/event_info.py,sha256=OkZ4WzuGaHEu_T8sB188KBgShAJhZpWASALKRGBOhMg,14648
 boto3_assist/aws_lambda/mock_context.py,sha256=LPjHP-3YSoY6iPl1kPqJDwSVf1zLNTcukUunDtYcbK0,116
 boto3_assist/cloudwatch/cloudwatch_connection.py,sha256=mnGWaLSQpHh5EeY7Ek_2o9JKHJxOELIYtQVMX1IaHn4,2480
@@ -18,7 +19,7 @@ boto3_assist/cognito/cognito_connection.py,sha256=deuXR3cNHz0mCYff2k0LfAvK--9Okq
 boto3_assist/cognito/cognito_utility.py,sha256=IVZAg58nHG1U7uxe7FsTYpqwwZiwwdIBGiVTZuLCFqg,18417
 boto3_assist/cognito/jwks_cache.py,sha256=1Y9r-YfQ8qrgZN5xYPvjUEEV0vthbdcPdAIaPbZP7kU,373
 boto3_assist/cognito/user.py,sha256=qc44qLx3gwq6q2zMxcPQze1EjeZwy5Kuav93vbe-4WU,820
-boto3_assist/dynamodb/dynamodb.py,sha256=8uzKaw9knqPvlkroQK5aMR-ASRxFwCCcMacm6wWpp8g,15757
+boto3_assist/dynamodb/dynamodb.py,sha256=Xkt-dRFVqvlUkDf8P_h9VX91qfY9kLxNgpV8e-QUzbk,15992
 boto3_assist/dynamodb/dynamodb_connection.py,sha256=D4KmVpMpE0OuVOwW5g4JBWllUNkwy0hMXEGUiToAMBc,3608
 boto3_assist/dynamodb/dynamodb_helpers.py,sha256=RoRRqKjdwfC-2-gvlkLvCoNWhIoMrHm-68dkyhXI_Xk,12080
 boto3_assist/dynamodb/dynamodb_importer.py,sha256=nCKsyRQeMqDSf0Q5mQ_X_oVIg4PRnu0hcUzZnBli610,3471
@@ -31,7 +32,7 @@ boto3_assist/dynamodb/dynamodb_reindexer.py,sha256=bCj6KIU0fQOgjkkiq9yF51PFZZr4Y
 boto3_assist/dynamodb/dynamodb_reserved_words.py,sha256=p0irNBSqGe4rd2FwWQqbRJWrNr4svdbWiyIXmz9lj4c,1937
 boto3_assist/dynamodb/dynamodb_reserved_words.txt,sha256=rvctS63Cv3i9SHmPq2Unmj6RZyQ-OMqxUXsNhtbg1is,4136
 boto3_assist/dynamodb/readme.md,sha256=wNMzdRwk0qRV0kE88UUYnJos3pEK0HNjEIVkq2PATf8,1490
-boto3_assist/dynamodb/troubleshooting.md,sha256=uGpBaBUt_MyzjzwFOLOe0udTgcvaOpiTFxfj7ilLNkM,136
+boto3_assist/dynamodb/troubleshooting.md,sha256=Wa2SlH7_5UDz_fffg1h8b9ua9YG7l65bZU22UltPFio,292
 boto3_assist/ec2/ec2_connection.py,sha256=IrtaidH6_SF5l3OeNehRsTlC-sX7EURVqcO-U6P6ff8,1318
 boto3_assist/environment_services/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 boto3_assist/environment_services/environment_loader.py,sha256=1uVLqSPQriUWazGXpxPJBLveGL8rLZaT5ZsciqqjVek,3979
@@ -53,10 +54,10 @@ boto3_assist/utilities/file_operations.py,sha256=IYhJkh8wUPMvGnyDRRa9yOCDdHN9wR3
 boto3_assist/utilities/http_utility.py,sha256=_K39Fq0V4QcgklAWctUktuMjqXDTwgMld77IOUfR2zc,1282
 boto3_assist/utilities/logging_utility.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 boto3_assist/utilities/numbers_utility.py,sha256=wzv9d0uXT_2_ZHHio7LBzibwxPqhGpvbq9HinrVn_4A,10160
-boto3_assist/utilities/serialization_utility.py,sha256=nieqW9b71Dr0X2HPsNmCei6zoIbsPRl9fDAigBQkaUg,21730
+boto3_assist/utilities/serialization_utility.py,sha256=_soAHu2Ym6SVwMBafMPcP4t9QwtxVC03MP0cm0L3A4g,21897
 boto3_assist/utilities/string_utility.py,sha256=0ChxbuT37xdG4y3cKzbNTHk4T3fl8lNMdOT7L5aJBQk,10382
-boto3_assist-0.14.0.dist-info/METADATA,sha256=p5_nuSMuOn99SxTVRdVG98y139Z2poxNjaVOL3Oj0WA,2875
-boto3_assist-0.14.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-boto3_assist-0.14.0.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
-boto3_assist-0.14.0.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
-boto3_assist-0.14.0.dist-info/RECORD,,
+boto3_assist-0.16.0.dist-info/METADATA,sha256=-PF1TMawM0HtsBC04sRDVryOP4BYhBpfNGOvPQNyyBk,2875
+boto3_assist-0.16.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+boto3_assist-0.16.0.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
+boto3_assist-0.16.0.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
+boto3_assist-0.16.0.dist-info/RECORD,,