boto3-assist 0.33.0__py3-none-any.whl → 0.35.0__py3-none-any.whl

boto3_assist/connection.py

@@ -7,6 +7,7 @@ MIT License.  See Project Root for the license information.
 from typing import Optional, List
 
 from aws_lambda_powertools import Logger
+from botocore.config import Config
 from boto3_assist.boto3session import Boto3SessionManager
 from boto3_assist.environment_services.environment_variables import (
     EnvironmentVariables,
@@ -33,6 +34,7 @@ class Connection:
         assume_role_arn: Optional[str] = None,
         assume_role_chain: Optional[List[str]] = None,
         assume_role_duration_seconds: Optional[int] = 3600,
+        config: Optional[Config] = None,
     ) -> None:
         self.__aws_profile = aws_profile
         self.__aws_region = aws_region
@@ -44,6 +46,7 @@ class Connection:
         self.__service_name: str | None = service_name
         self.__assume_role_chain = assume_role_chain
         self.__assume_role_duration_seconds = assume_role_duration_seconds
+        self.__config = config
         if self.__service_name is None:
             raise RuntimeError(
                 "Service Name is not available. The service name is required."
@@ -80,6 +83,7 @@ class Connection:
             assume_role_arn=self.__assume_role_arn,
             assume_role_chain=self.__assume_role_chain,
             assume_role_duration_seconds=self.__assume_role_duration_seconds,
+            config=self.__config,
         )
 
         tracker.add(service_name=self.service_name)

boto3_assist/s3/s3_connection.py

@@ -4,10 +4,12 @@ Maintainers: Eric Wilson
 MIT License.  See Project Root for the license information.
 """
 
+import os
 from typing import Optional
 from typing import TYPE_CHECKING
 
 from aws_lambda_powertools import Logger
+from botocore.config import Config
 
 from boto3_assist.connection import Connection
 
@@ -32,7 +34,14 @@ class S3Connection(Connection):
         aws_end_point_url: Optional[str] = None,
         aws_access_key_id: Optional[str] = None,
         aws_secret_access_key: Optional[str] = None,
+        signature_version: Optional[str] = None,
     ) -> None:
+        # Build S3-specific config if signature_version is specified
+        config: Optional[Config] = None
+        signature_version = signature_version or os.getenv("AWS_S3_SIGNATURE_VERSION")
+        if signature_version:
+            config = Config(signature_version=signature_version)
+
         super().__init__(
             service_name="s3",
             aws_profile=aws_profile,
@@ -40,6 +49,7 @@ class S3Connection(Connection):
             aws_access_key_id=aws_access_key_id,
             aws_secret_access_key=aws_secret_access_key,
             aws_end_point_url=aws_end_point_url,
+            config=config,
         )
 
         self.__client: S3Client | None = None

boto3_assist/sqs/__init__.py

@@ -0,0 +1,12 @@
+"""
+SQS module for boto3-assist.
+
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License. See Project Root for the license information.
+"""
+
+from boto3_assist.sqs.sqs_connection import SQSConnection
+from boto3_assist.sqs.sqs_queue import SQSQueue
+
+__all__ = ["SQSConnection", "SQSQueue"]

boto3_assist/sqs/sqs_connection.py

@@ -0,0 +1,88 @@
+"""
+SQS Connection module.
+
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License. See Project Root for the license information.
+"""
+
+from typing import Optional, TYPE_CHECKING
+
+from aws_lambda_powertools import Logger
+
+from boto3_assist.connection import Connection
+
+if TYPE_CHECKING:
+    from mypy_boto3_sqs import SQSClient, SQSServiceResource
+else:
+    SQSClient = object
+    SQSServiceResource = object
+
+
+logger = Logger(child=True)
+
+
+class SQSConnection(Connection):
+    """SQS Connection wrapper."""
+
+    def __init__(
+        self,
+        *,
+        aws_profile: Optional[str] = None,
+        aws_region: Optional[str] = None,
+        aws_end_point_url: Optional[str] = None,
+        aws_access_key_id: Optional[str] = None,
+        aws_secret_access_key: Optional[str] = None,
+    ) -> None:
+        """
+        Initialize SQS connection.
+
+        Args:
+            aws_profile: AWS profile name
+            aws_region: AWS region
+            aws_end_point_url: Custom endpoint URL (for LocalStack, etc.)
+            aws_access_key_id: AWS access key ID
+            aws_secret_access_key: AWS secret access key
+        """
+        super().__init__(
+            service_name="sqs",
+            aws_profile=aws_profile,
+            aws_region=aws_region,
+            aws_access_key_id=aws_access_key_id,
+            aws_secret_access_key=aws_secret_access_key,
+            aws_end_point_url=aws_end_point_url,
+        )
+
+        self.__client: SQSClient | None = None
+        self.__resource: SQSServiceResource | None = None
+
+    @property
+    def client(self) -> SQSClient:
+        """Get SQS client."""
+        if self.__client is None:
+            self.__client = self.session.client
+        return self.__client
+
+    @client.setter
+    def client(self, value: SQSClient) -> None:
+        """Set SQS client."""
+        logger.info("Setting SQS Client")
+        self.__client = value
+
+    @property
+    def resource(self) -> SQSServiceResource:
+        """Get SQS resource."""
+        if self.__resource is None:
+            logger.info("Creating SQS Resource")
+            self.__resource = self.session.resource
+
+        if self.raise_on_error and self.__resource is None:
+            raise RuntimeError("SQS Resource is not available")
+
+        return self.__resource
+
+    @resource.setter
+    def resource(self, value: SQSServiceResource) -> None:
+        """Set SQS resource."""
+        logger.info("Setting SQS Resource")
+        self.__resource = value

boto3_assist/sqs/sqs_queue.py

@@ -0,0 +1,307 @@
+"""
+SQS Queue operations module.
+
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License. See Project Root for the license information.
+"""
+
+import json
+from typing import Any, Dict, List, Optional
+
+from aws_lambda_powertools import Logger
+
+from boto3_assist.sqs.sqs_connection import SQSConnection
+
+logger = Logger(child=True)
+
+
+class SQSQueue(SQSConnection):
+    """SQS Queue operations wrapper."""
+
+    def __init__(
+        self,
+        *,
+        aws_profile: Optional[str] = None,
+        aws_region: Optional[str] = None,
+        aws_end_point_url: Optional[str] = None,
+        aws_access_key_id: Optional[str] = None,
+        aws_secret_access_key: Optional[str] = None,
+    ) -> None:
+        """
+        Initialize SQS Queue.
+
+        Args:
+            aws_profile: AWS profile name
+            aws_region: AWS region
+            aws_end_point_url: Custom endpoint URL (for LocalStack, etc.)
+            aws_access_key_id: AWS access key ID
+            aws_secret_access_key: AWS secret access key
+        """
+        super().__init__(
+            aws_profile=aws_profile,
+            aws_region=aws_region,
+            aws_end_point_url=aws_end_point_url,
+            aws_access_key_id=aws_access_key_id,
+            aws_secret_access_key=aws_secret_access_key,
+        )
+
+    def send_message(
+        self,
+        queue_url: str,
+        message_body: str,
+        delay_seconds: int = 0,
+        message_attributes: Optional[Dict[str, Any]] = None,
+        message_group_id: Optional[str] = None,
+        message_deduplication_id: Optional[str] = None,
+    ) -> str:
+        """
+        Send a message to an SQS queue.
+
+        Args:
+            queue_url: The URL of the SQS queue
+            message_body: The message body (string)
+            delay_seconds: Delay before message becomes visible (0-900 seconds)
+            message_attributes: Optional message attributes
+            message_group_id: Required for FIFO queues
+            message_deduplication_id: Required for FIFO queues without content-based deduplication
+
+        Returns:
+            The message ID of the sent message
+        """
+        params: Dict[str, Any] = {
+            "QueueUrl": queue_url,
+            "MessageBody": message_body,
+        }
+
+        if delay_seconds > 0:
+            params["DelaySeconds"] = min(delay_seconds, 900)  # SQS max is 900 seconds
+
+        if message_attributes:
+            params["MessageAttributes"] = message_attributes
+
+        if message_group_id:
+            params["MessageGroupId"] = message_group_id
+
+        if message_deduplication_id:
+            params["MessageDeduplicationId"] = message_deduplication_id
+
+        response = self.client.send_message(**params)
+        message_id = response.get("MessageId", "")
+
+        logger.debug(f"Sent message to {queue_url}: {message_id}")
+        return message_id
+
+    def send_message_batch(
+        self,
+        queue_url: str,
+        entries: List[Dict[str, Any]],
+    ) -> Dict[str, Any]:
+        """
+        Send multiple messages to an SQS queue in a batch.
+
+        Args:
+            queue_url: The URL of the SQS queue
+            entries: List of message entries, each with 'Id' and 'MessageBody'
+
+        Returns:
+            Response containing 'Successful' and 'Failed' lists
+        """
+        response = self.client.send_message_batch(
+            QueueUrl=queue_url,
+            Entries=entries,
+        )
+
+        successful = response.get("Successful", [])
+        failed = response.get("Failed", [])
+
+        if failed:
+            logger.warning(f"Failed to send {len(failed)} messages to {queue_url}")
+
+        logger.debug(f"Sent batch of {len(successful)} messages to {queue_url}")
+        return response
+
+    def receive_messages(
+        self,
+        queue_url: str,
+        max_number_of_messages: int = 1,
+        wait_time_seconds: int = 0,
+        visibility_timeout: Optional[int] = None,
+        message_attribute_names: Optional[List[str]] = None,
+    ) -> List[Dict[str, Any]]:
+        """
+        Receive messages from an SQS queue.
+
+        Args:
+            queue_url: The URL of the SQS queue
+            max_number_of_messages: Maximum number of messages to receive (1-10)
+            wait_time_seconds: Long polling wait time (0-20 seconds)
+            visibility_timeout: Override the queue's default visibility timeout
+            message_attribute_names: List of message attribute names to retrieve
+
+        Returns:
+            List of messages
+        """
+        params: Dict[str, Any] = {
+            "QueueUrl": queue_url,
+            "MaxNumberOfMessages": min(max_number_of_messages, 10),
+            "WaitTimeSeconds": min(wait_time_seconds, 20),
+        }
+
+        if visibility_timeout is not None:
+            params["VisibilityTimeout"] = visibility_timeout
+
+        if message_attribute_names:
+            params["MessageAttributeNames"] = message_attribute_names
+
+        response = self.client.receive_message(**params)
+        messages = response.get("Messages", [])
+
+        logger.debug(f"Received {len(messages)} messages from {queue_url}")
+        return messages
+
+    def delete_message(
+        self,
+        queue_url: str,
+        receipt_handle: str,
+    ) -> None:
+        """
+        Delete a message from an SQS queue.
+
+        Args:
+            queue_url: The URL of the SQS queue
+            receipt_handle: The receipt handle of the message to delete
+        """
+        self.client.delete_message(
+            QueueUrl=queue_url,
+            ReceiptHandle=receipt_handle,
+        )
+        logger.debug(f"Deleted message from {queue_url}")
+
+    def delete_message_batch(
+        self,
+        queue_url: str,
+        entries: List[Dict[str, str]],
+    ) -> Dict[str, Any]:
+        """
+        Delete multiple messages from an SQS queue in a batch.
+
+        Args:
+            queue_url: The URL of the SQS queue
+            entries: List of entries with 'Id' and 'ReceiptHandle'
+
+        Returns:
+            Response containing 'Successful' and 'Failed' lists
+        """
+        response = self.client.delete_message_batch(
+            QueueUrl=queue_url,
+            Entries=entries,
+        )
+
+        logger.debug(f"Deleted batch of messages from {queue_url}")
+        return response
+
+    def get_queue_url(self, queue_name: str) -> str:
+        """
+        Get the URL of an SQS queue by name.
+
+        Args:
+            queue_name: The name of the queue
+
+        Returns:
+            The queue URL
+        """
+        response = self.client.get_queue_url(QueueName=queue_name)
+        return response["QueueUrl"]
+
+    def get_queue_attributes(
+        self,
+        queue_url: str,
+        attribute_names: Optional[List[str]] = None,
+    ) -> Dict[str, str]:
+        """
+        Get attributes of an SQS queue.
+
+        Args:
+            queue_url: The URL of the SQS queue
+            attribute_names: List of attribute names to retrieve (default: All)
+
+        Returns:
+            Dictionary of queue attributes
+        """
+        params: Dict[str, Any] = {"QueueUrl": queue_url}
+
+        if attribute_names:
+            params["AttributeNames"] = attribute_names
+        else:
+            params["AttributeNames"] = ["All"]
+
+        response = self.client.get_queue_attributes(**params)
+        return response.get("Attributes", {})
+
+    def purge_queue(self, queue_url: str) -> None:
+        """
+        Purge all messages from an SQS queue.
+
+        Args:
+            queue_url: The URL of the SQS queue
+
+        Note: This action can only be performed once every 60 seconds.
+        """
+        self.client.purge_queue(QueueUrl=queue_url)
+        logger.info(f"Purged queue: {queue_url}")
+
+    def change_message_visibility(
+        self,
+        queue_url: str,
+        receipt_handle: str,
+        visibility_timeout: int,
+    ) -> None:
+        """
+        Change the visibility timeout of a message.
+
+        Args:
+            queue_url: The URL of the SQS queue
+            receipt_handle: The receipt handle of the message
+            visibility_timeout: New visibility timeout in seconds (0-43200)
+        """
+        self.client.change_message_visibility(
+            QueueUrl=queue_url,
+            ReceiptHandle=receipt_handle,
+            VisibilityTimeout=visibility_timeout,
+        )
+        logger.debug(f"Changed visibility timeout for message in {queue_url}")
+
+    def send_json_message(
+        self,
+        queue_url: str,
+        message: Dict[str, Any],
+        delay_seconds: int = 0,
+        message_attributes: Optional[Dict[str, Any]] = None,
+        message_group_id: Optional[str] = None,
+        message_deduplication_id: Optional[str] = None,
+    ) -> str:
+        """
+        Send a JSON message to an SQS queue.
+
+        Convenience method that serializes a dict to JSON.
+
+        Args:
+            queue_url: The URL of the SQS queue
+            message: Dictionary to serialize and send
+            delay_seconds: Delay before message becomes visible
+            message_attributes: Optional message attributes
+            message_group_id: Required for FIFO queues
+            message_deduplication_id: Required for FIFO queues
+
+        Returns:
+            The message ID of the sent message
+        """
+        return self.send_message(
+            queue_url=queue_url,
+            message_body=json.dumps(message),
+            delay_seconds=delay_seconds,
+            message_attributes=message_attributes,
+            message_group_id=message_group_id,
+            message_deduplication_id=message_deduplication_id,
+        )

boto3_assist/version.py

@@ -1 +1 @@
-__version__ = "0.33.0"
+__version__ = "0.35.0"

{boto3_assist-0.33.0.dist-info → boto3_assist-0.35.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boto3_assist
-Version: 0.33.0
+Version: 0.35.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.33.0.dist-info → boto3_assist-0.35.0.dist-info}/RECORD

@@ -1,12 +1,12 @@
 boto3_assist/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 boto3_assist/aws_config.py,sha256=evmk_blj498ugptJa8lxIDJOIursxY6mT4joLfEbrl0,6558
 boto3_assist/boto3session.py,sha256=p4FKVSX5A-xNHdpRan8pgMoY4iIywNfwriyTfjQ-zTQ,2967
-boto3_assist/connection.py,sha256=tqsNGLouAzCiTdtm9JylDTA6IiYqaQQiHmY-kH2bksU,4905
+boto3_assist/connection.py,sha256=dfVq2nAwElmo0ek0PLBEf9HdULOuzKZG0fu7tDDewhA,5046
 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=X-JQKyyaWNA8Z8kKgf2V2I5vsiLAH8udLTX_xepnsdQ,3140
-boto3_assist/version.py,sha256=6K931DiWIOR94oP_7w9oZPyA0wEqkdgU1lkcLFyRTMU,23
+boto3_assist/version.py,sha256=w3TvNFSYTcLj3nBuRCGicelGZOzvgYOfnmgrBAuIKqY,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
@@ -44,11 +44,14 @@ boto3_assist/errors/custom_exceptions.py,sha256=QAMW49NbClELVnRd00u4NHfzVtRS3Tc1
 boto3_assist/models/serializable_model.py,sha256=ZMrRJRvJWLY8PBSKK_nPCgYKv1qUxDPEVdcADKbIHsI,266
 boto3_assist/s3/s3.py,sha256=ESTPXtyDi8mrwHaYNWjQLNGTuTUV4CxKDqw-O_KGzKs,2052
 boto3_assist/s3/s3_bucket.py,sha256=GfyBbuI5BWz_ybwU_nDqUZiC0wt24PNt49GKZmb05OY,2018
-boto3_assist/s3/s3_connection.py,sha256=0JgEDNoDFPQTo5hQe-lS8mWnFBJ2S8MDSl0LPG__lZo,2008
+boto3_assist/s3/s3_connection.py,sha256=iIWtOgTXaj4FQfkyWLI9jnD340XKkKT2UqPAMvItBM4,2421
 boto3_assist/s3/s3_event_data.py,sha256=Q7QUI1pwkc7g6yZ3IZWMXBIAfsMlPRC7wac2RvrQoA4,4112
 boto3_assist/s3/s3_object.py,sha256=77jZeIUFpQX3cFYGGwRFBvL-peCe54iILnthm-GFjMc,22518
 boto3_assist/securityhub/securityhub.py,sha256=ne-J_v4DaCVZm5YgJa_-LKVomLJQo5Gpw6wleAKSsws,5467
 boto3_assist/securityhub/securityhub_connection.py,sha256=hWfcj9gjS2lNXUObyw4cShtveoqJPIp8kKFuz-fz1J4,1449
+boto3_assist/sqs/__init__.py,sha256=VRuPPit-hSSbumKL2pN5AUtZKr_c9MpLeuqQ5a6wBLk,285
+boto3_assist/sqs/sqs_connection.py,sha256=Gacka0Aqco3qNSTVmPiJf8LeaLgNzhL1-npCOn85GmQ,2469
+boto3_assist/sqs/sqs_queue.py,sha256=sjz2Q4BbJMCO-cxSNM02UxMmgnRfPLFAC3Pt1kiqc14,9542
 boto3_assist/ssm/connection.py,sha256=gYpKn5HsUR3hcRUqJzF5QcTITCk0DReq9KhoE_8-Htg,1370
 boto3_assist/ssm/parameter_store/parameter_store.py,sha256=2ISi-SmR29mESHFH-onJkxPX1aThIgBRojA3ZoNcP9s,3949
 boto3_assist/utilities/datetime_utility.py,sha256=yQa9winN661Gt837zeQQWl4ARMYtZcU4pQEYMnTESC0,11171
@@ -60,8 +63,8 @@ boto3_assist/utilities/logging_utility.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5N
 boto3_assist/utilities/numbers_utility.py,sha256=wzv9d0uXT_2_ZHHio7LBzibwxPqhGpvbq9HinrVn_4A,10160
 boto3_assist/utilities/serialization_utility.py,sha256=m5wRZNeWW9VltQPVNziR27OGKO3MDJm6mFmcDHwN-n4,24479
 boto3_assist/utilities/string_utility.py,sha256=XxUIz19L2LFFTRDAAmdPa8Qhn40u9yO7g4nULFuvg0M,11033
-boto3_assist-0.33.0.dist-info/METADATA,sha256=a78hRROMB4f7zUlueukU3MsasKQcytMd72QWC4aB_So,2879
-boto3_assist-0.33.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-boto3_assist-0.33.0.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
-boto3_assist-0.33.0.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
-boto3_assist-0.33.0.dist-info/RECORD,,
+boto3_assist-0.35.0.dist-info/METADATA,sha256=xa5U1elxKIetkG0QKmbCEt_3ge6uO5ZyhdGNsNUW1o8,2879
+boto3_assist-0.35.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+boto3_assist-0.35.0.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
+boto3_assist-0.35.0.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
+boto3_assist-0.35.0.dist-info/RECORD,,