multicloud-py-aws-common 0.1.6__tar.gz

multicloud_py_aws_common-0.1.6/LICENSE.txt

@@ -0,0 +1,206 @@
+Apache License Version 2.0
+
+Copyright (c) 2026 Salesforce, Inc.
+All rights reserved.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

multicloud_py_aws_common-0.1.6/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.4
+Name: multicloud-py-aws-common
+Version: 0.1.6
+Summary: Shared AWS credential resolution utilities for multicloud-* providers.
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/salesforce/multicloud-py
+Project-URL: Repository, https://github.com/salesforce/multicloud-py
+Project-URL: Issues, https://github.com/salesforce/multicloud-py/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: multicloud-py-common>=0.1.6
+Requires-Dist: boto3>=1.18.0
+Requires-Dist: botocore>=1.21.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Dynamic: license-file
+
+MultiCloud Python SDK package.

multicloud_py_aws_common-0.1.6/multicloud/aws_common/__init__.py

@@ -0,0 +1,20 @@
+"""AWS-specific cross-service utilities.
+
+Shared helpers used by AWS provider modules across services
+(STS, Blob, PubSub, DocStore). This package depends on AWS SDKs and
+must not be imported by cloud-agnostic code (multicloud.common.*).
+"""
+
+from multicloud.aws_common.aws_client_config import s3_client_config
+from multicloud.aws_common.aws_credentials import get_session
+from multicloud.aws_common.error_mapping import (
+    translate_aws_sns_error,
+    translate_aws_sqs_error,
+)
+
+__all__ = [
+    "get_session",
+    "s3_client_config",
+    "translate_aws_sns_error",
+    "translate_aws_sqs_error",
+]

multicloud_py_aws_common-0.1.6/multicloud/aws_common/aws_client_config.py

@@ -0,0 +1,84 @@
+"""Shared botocore client configuration for AWS S3 providers.
+
+Isolates the S3 client settings that must be pinned explicitly rather than
+inherited from AWS SDK defaults.
+"""
+
+from __future__ import annotations
+
+from typing import Any, Optional
+
+from multicloud.common.proxy import ProxyConfig
+
+try:
+    from botocore.config import Config  # type: ignore[import-not-found]
+except ImportError as _exc:
+    raise ImportError(
+        "AWS dependencies not found. Install with: "
+        "pip install 'python-multicloud-sdk[aws]'"
+    ) from _exc
+
+# Signature version for S3 clients.
+#
+# The AWS SDK still defaults *presigned URL* generation to the legacy SigV2
+# algorithm in every region whose published endpoint metadata lists SigV2 as
+# supported (us-west-2, us-east-1, eu-west-1, the GovCloud regions, and
+# others). The downgrade is applied by botocore's ``choose-signer.s3`` event
+# handler, not by client config.
+#
+# SigV2 is deprecated by AWS and is rejected outright by buckets with KMS
+# default encryption: such buckets answer a SigV2 presigned request with
+# SignatureDoesNotMatch or InvalidArgument. Pinning "s3v4" makes presigned
+# URLs SigV4 in every region.
+#
+# This does not change ordinary (non-presigned) requests -- those already
+# resolve to SigV4 by default, so their signed request line and
+# Authorization header are unaffected.
+#
+# Deliberately absent: ``s3={"addressing_style": "virtual"}``. The default
+# global endpoint already accepts a correctly-scoped SigV4 signature, so
+# forcing virtual addressing fixes nothing while breaking custom endpoints
+# (MinIO/LocalStack become ``bucket.localhost:9000``) and pinning the host to
+# the configured region, which turns a region mismatch into a hard HTTP 301.
+_S3_SIGNATURE_VERSION = "s3v4"
+
+
+def s3_client_config(
+    proxy_config: Optional[ProxyConfig] = None, **overrides: Any
+) -> Config:
+    """Build the botocore ``Config`` for an S3 client.
+
+    The signature version is always pinned to SigV4. A ``signature_version``
+    supplied in ``overrides`` is ignored -- callers cannot silently
+    reintroduce the deprecated SigV2 presigned-URL behavior this helper exists
+    to prevent.
+
+    Args:
+        proxy_config: How to resolve the proxy. When omitted, botocore reads
+            the environment as usual.
+        **overrides: Additional botocore ``Config`` keyword arguments. Any
+            ``signature_version`` entry is superseded by SigV4.
+
+    Returns:
+        A ``Config`` pinning the S3 signature version to SigV4.
+    """
+    settings = dict(overrides)
+    proxies = _proxies_for(proxy_config)
+    if proxies is not None:
+        settings["proxies"] = proxies
+    return Config(**{**settings, "signature_version": _S3_SIGNATURE_VERSION})
+
+
+def _proxies_for(proxy_config: Optional[ProxyConfig]) -> Optional[dict[str, str]]:
+    """Translate a ProxyConfig into botocore's ``proxies`` setting.
+
+    None leaves it unset, which is what makes botocore read the environment;
+    an empty mapping is how a direct connection is requested.
+    """
+    if proxy_config is None:
+        return None
+    if proxy_config.endpoint is not None:
+        return {"http": proxy_config.endpoint, "https": proxy_config.endpoint}
+    if not proxy_config.use_environment_variable_proxy_values:
+        return {}
+    return None

multicloud_py_aws_common-0.1.6/multicloud/aws_common/aws_credentials.py

@@ -0,0 +1,271 @@
+"""AWS credential resolution from CredentialsOverrider.
+
+Shared utility for all AWS provider modules (STS, Blob, PubSub, DocStore).
+
+For ASSUME_ROLE and ASSUME_ROLE_WEB_IDENTITY, credentials are
+auto-refreshed via botocore's built-in credential fetchers — the session
+automatically re-assumes the role when the token approaches expiry.
+"""
+
+from __future__ import annotations
+
+import time
+from typing import Any, Optional
+
+try:
+    import boto3  # type: ignore[import-not-found]
+    from botocore.credentials import (  # type: ignore[import-not-found]
+        AssumeRoleCredentialFetcher,
+        AssumeRoleWithWebIdentityCredentialFetcher,
+        DeferredRefreshableCredentials,
+    )
+    from botocore.session import (
+        get_session as _get_botocore_session,  # type: ignore[import-not-found]
+    )
+except ImportError as _exc:
+    raise ImportError(
+        "AWS dependencies not found. Install with: "
+        "pip install 'python-multicloud-sdk[aws]'"
+    ) from _exc
+
+from multicloud.common.credentials import (
+    CredentialsOverrider,
+    CredentialsType,
+)
+from multicloud.common.exceptions import InvalidArgumentException
+
+_ASSUME_ROLE_METHOD = "sts-assume-role"
+_WEB_IDENTITY_METHOD = "sts-assume-role-with-web-identity"
+_DEFAULT_SESSION_NAME_PREFIX = "multicloud"
+
+
+def _default_session_name() -> str:
+    return f"{_DEFAULT_SESSION_NAME_PREFIX}-{int(time.time())}"
+
+
+def get_session(
+    overrider: Optional[CredentialsOverrider],
+    region: Optional[str] = None,
+) -> Any:
+    """Build a boto3 Session from a CredentialsOverrider, or use defaults.
+
+    For ASSUME_ROLE and ASSUME_ROLE_WEB_IDENTITY, the returned session
+    auto-refreshes credentials when the token approaches expiry.
+
+    Credential resolution for ASSUME_ROLE and ASSUME_ROLE_WEB_IDENTITY is
+    deferred to the first AWS API call (botocore's
+    ``DeferredRefreshableCredentials`` semantics). Invalid role ARNs,
+    expired source credentials, or missing IAM permissions surface at use
+    time rather than at Session construction.
+
+    Args:
+        overrider: Credential override configuration. If None, returns
+            a default boto3 session using environment/config discovery.
+        region: AWS region name for the session.
+
+    Returns:
+        A ``boto3.Session`` configured with the resolved credentials.
+    """
+    if overrider is None:
+        return boto3.Session()
+
+    if overrider.credentials_type == CredentialsType.SESSION:
+        # CredentialsOverrider.__post_init__ guarantees session_credentials
+        # is non-None for SESSION type.
+        creds = overrider.session_credentials
+        return boto3.Session(
+            aws_access_key_id=creds.access_key_id,
+            aws_secret_access_key=creds.access_key_secret,
+            aws_session_token=creds.security_token or None,
+            region_name=region,
+        )
+
+    if overrider.credentials_type == CredentialsType.ASSUME_ROLE:
+        return _build_session_with_fetcher(
+            _make_assume_role_fetcher(overrider, region),
+            method=_ASSUME_ROLE_METHOD,
+            region=region,
+        )
+
+    if overrider.credentials_type == CredentialsType.ASSUME_ROLE_WEB_IDENTITY:
+        return _build_session_with_fetcher(
+            _make_web_identity_fetcher(overrider, region),
+            method=_WEB_IDENTITY_METHOD,
+            region=region,
+        )
+
+    raise InvalidArgumentException(
+        f"Unsupported credentials_type: {overrider.credentials_type}"
+    )
+
+
+def _build_session_with_fetcher(
+    fetcher: Any,
+    method: str,
+    region: Optional[str],
+) -> Any:
+    """Create a boto3 Session backed by a botocore credential fetcher."""
+    refreshable = DeferredRefreshableCredentials(
+        method=method,
+        refresh_using=fetcher.fetch_credentials,
+    )
+
+    # No public API exists for injecting credentials into a botocore
+    # session — this private-attr pattern is the standard approach.
+    botocore_session = _get_botocore_session()
+    botocore_session._credentials = refreshable
+    if region:
+        botocore_session.set_config_variable("region", region)
+
+    return boto3.Session(botocore_session=botocore_session)
+
+
+def _make_assume_role_fetcher(
+    overrider: CredentialsOverrider,
+    region: Optional[str],
+) -> Any:
+    """Build a botocore ``AssumeRoleCredentialFetcher`` from an overrider."""
+    source_session = boto3.Session()
+    source_credentials = source_session.get_credentials()
+
+    extra_args: dict[str, Any] = {
+        "RoleSessionName": overrider.session_name or _default_session_name(),
+    }
+    if overrider.duration_seconds is not None:
+        extra_args["DurationSeconds"] = overrider.duration_seconds
+
+    return AssumeRoleCredentialFetcher(
+        client_creator=source_session._session.create_client,
+        source_credentials=source_credentials,
+        role_arn=overrider.role,
+        extra_args=extra_args,
+    )
+
+
+def _make_web_identity_fetcher(
+    overrider: CredentialsOverrider,
+    region: Optional[str],
+) -> Any:
+    """Build a botocore ``AssumeRoleWithWebIdentityCredentialFetcher`` from an overrider.
+
+    The STS client used for the token exchange is anonymous — we do not
+    want it to recursively pick up ambient credentials.
+    """
+    from botocore.credentials import Credentials as AnonymousCredentials
+
+    anon_botocore_session = _get_botocore_session()
+    anon_botocore_session._credentials = AnonymousCredentials("", "")
+    anon_session = boto3.Session(botocore_session=anon_botocore_session)
+
+    extra_args: dict[str, Any] = {
+        "RoleSessionName": overrider.session_name or _default_session_name(),
+    }
+    if overrider.duration_seconds is not None:
+        extra_args["DurationSeconds"] = overrider.duration_seconds
+
+    return AssumeRoleWithWebIdentityCredentialFetcher(
+        client_creator=anon_session._session.create_client,
+        web_identity_token_loader=overrider.web_identity_token_supplier,  # type: ignore[arg-type]
+        role_arn=overrider.role,
+        extra_args=extra_args,
+    )
+
+
+async def get_aio_session(
+    overrider: Optional[CredentialsOverrider],
+    region: Optional[str] = None,
+) -> Any:
+    """Build an aiobotocore session from a CredentialsOverrider, or use defaults.
+
+    Async counterpart of :func:`get_session`. aiobotocore is imported lazily
+    so this module stays importable without the ``async`` extra installed.
+
+    For ASSUME_ROLE and ASSUME_ROLE_WEB_IDENTITY the returned session
+    auto-refreshes credentials via aiobotocore's deferred fetchers. Source
+    credentials are resolved asynchronously, which is why this helper is a
+    coroutine.
+
+    Args:
+        overrider: Credential override configuration. If None, returns a
+            default aiobotocore session using environment/config discovery.
+        region: AWS region name for the session.
+
+    Returns:
+        An ``aiobotocore.session.AioSession`` configured with the resolved
+        credentials.
+    """
+    try:
+        from aiobotocore.credentials import (  # type: ignore[import-not-found]
+            AioAssumeRoleCredentialFetcher,
+            AioAssumeRoleWithWebIdentityCredentialFetcher,
+            AioDeferredRefreshableCredentials,
+        )
+        from aiobotocore.session import (
+            get_session as _get_aio_session,  # type: ignore[import-not-found]
+        )
+    except ImportError as exc:
+        raise ImportError(
+            "aiobotocore is required for async AWS credential resolution. "
+            "Install it with: pip install 'multicloud-py-blob-aws[async]'"
+        ) from exc
+
+    session = _get_aio_session()
+    if region:
+        session.set_config_variable("region", region)
+
+    if overrider is None:
+        return session
+
+    if overrider.credentials_type == CredentialsType.SESSION:
+        # CredentialsOverrider.__post_init__ guarantees session_credentials
+        # is non-None for SESSION type.
+        creds = overrider.session_credentials
+        session.set_credentials(
+            creds.access_key_id,
+            creds.access_key_secret,
+            creds.security_token or None,
+        )
+        return session
+
+    if overrider.credentials_type == CredentialsType.ASSUME_ROLE:
+        source_credentials = await session.get_credentials()
+        fetcher = AioAssumeRoleCredentialFetcher(
+            client_creator=session.create_client,
+            source_credentials=source_credentials,
+            role_arn=overrider.role,
+            extra_args=_assume_role_extra_args(overrider),
+        )
+        session._credentials = AioDeferredRefreshableCredentials(
+            method=_ASSUME_ROLE_METHOD,
+            refresh_using=fetcher.fetch_credentials,
+        )
+        return session
+
+    if overrider.credentials_type == CredentialsType.ASSUME_ROLE_WEB_IDENTITY:
+        # The web-identity fetcher signs the STS exchange as UNSIGNED
+        # internally, so no source credentials are needed.
+        fetcher = AioAssumeRoleWithWebIdentityCredentialFetcher(
+            client_creator=session.create_client,
+            web_identity_token_loader=overrider.web_identity_token_supplier,
+            role_arn=overrider.role,
+            extra_args=_assume_role_extra_args(overrider),
+        )
+        session._credentials = AioDeferredRefreshableCredentials(
+            method=_WEB_IDENTITY_METHOD,
+            refresh_using=fetcher.fetch_credentials,
+        )
+        return session
+
+    raise InvalidArgumentException(
+        f"Unsupported credentials_type: {overrider.credentials_type}"
+    )
+
+
+def _assume_role_extra_args(overrider: CredentialsOverrider) -> dict[str, Any]:
+    """Build the STS assume-role extra args shared by both async fetchers."""
+    extra_args: dict[str, Any] = {
+        "RoleSessionName": overrider.session_name or _default_session_name(),
+    }
+    if overrider.duration_seconds is not None:
+        extra_args["DurationSeconds"] = overrider.duration_seconds
+    return extra_args

multicloud_py_aws_common-0.1.6/multicloud/aws_common/error_mapping.py

@@ -0,0 +1,220 @@
+"""Shared AWS error translation helpers."""
+
+from __future__ import annotations
+
+from botocore import exceptions as boto_exceptions
+from multicloud.common.exceptions import (
+    InvalidArgumentException,
+    ResourceExhaustedException,
+    ResourceNotFoundException,
+    SubstrateSdkException,
+    TransactionFailedException,
+    UnAuthorizedException,
+    UnknownException,
+)
+
+#: Error codes meaning the caller is being throttled or the service is briefly
+#: unavailable. Covers every code botocore itself retries as throttling, plus
+#: ServiceUnavailable and RequestExpired, which services return for the same
+#: condition without botocore counting them. Note
+#: several arrive with HTTP 400 rather than 429 -- bare ``Throttling`` is what
+#: the query-protocol services (STS, IAM) send -- which is why callers must
+#: match on the code before falling back to the status.
+#:
+#: ``tests/common/unit/test_throttling_error_mapping.py`` asserts this stays a
+#: superset of botocore's own list, so a new code added upstream is caught.
+AWS_THROTTLING_CODES = frozenset(
+    {
+        "BandwidthLimitExceeded",
+        "EC2ThrottledException",
+        "LimitExceededException",
+        "PriorRequestNotComplete",
+        "ProvisionedThroughputExceededException",
+        "RequestExpired",
+        "RequestLimitExceeded",
+        "RequestThrottled",
+        "RequestThrottledException",
+        "ServiceUnavailable",
+        "SlowDown",
+        "Throttling",
+        "ThrottledException",
+        "ThrottlingException",
+        "TooManyRequestsException",
+        "TransactionInProgressException",
+    }
+)
+
+_SQS_AUTH_CODES = frozenset(
+    {
+        "InvalidClientTokenId",
+        "UnrecognizedClientException",
+        "ExpiredToken",
+        "IncompleteSignature",
+        "NotAuthorized",
+        "OptInRequired",
+        "AccountNotAuthorized",
+        "AccountProblem",
+        "AllAccessDisabled",
+        "InvalidAccessKeyId",
+        "InvalidPayer",
+        "InvalidSecurity",
+        "NotSignedUp",
+        "TokenRefreshRequired",
+        "AccessDenied",
+        "AccessDeniedException",
+        "UnauthorizedOperation",
+        "InvalidSecurityException",
+    }
+)
+#: SQS reports its queue-level limit with a code of its own.
+_SQS_THROTTLING_CODES = AWS_THROTTLING_CODES | {"OverLimit"}
+_SQS_INVALID_CODES = frozenset(
+    {
+        "InvalidAction",
+        "ValidationError",
+        "RequestTimeTooSkewed",
+        "SignatureDoesNotMatch",
+        "BadDigest",
+        "InvalidParameterValue",
+        "InvalidParameter",
+        "InvalidMessageBody",
+        "InvalidMessageAttributes",
+        "MessageTooLarge",
+        "BatchEntryIdsNotDistinct",
+        "InvalidIdFormat",
+        "ReceiptHandleIsInvalid",
+        "MessageNotInflight",
+        "InvalidAttributeName",
+        "InvalidBatchEntryId",
+        "InvalidMessageContents",
+        "TooManyEntriesInBatchRequest",
+        "UnsupportedOperation",
+        "EmptyBatchRequest",
+        "BatchRequestTooLong",
+        "PurgeQueueInProgress",
+        "QueueDeletedRecently",
+        "QueueNameExists",
+        "InvalidArgument",
+    }
+)
+_SQS_NOT_FOUND_CODES = frozenset(
+    {
+        "QueueDoesNotExist",
+        "AWS.SimpleQueueService.NonExistentQueue",
+        "NotFoundException",
+    }
+)
+_SQS_UNKNOWN_CODES = frozenset({"InternalError", "RequestCanceled"})
+
+_SNS_AUTH_CODES = frozenset(
+    {
+        "InvalidClientTokenId",
+        "UnrecognizedClientException",
+        "ExpiredToken",
+        "IncompleteSignature",
+        "NotAuthorized",
+        "OptInRequired",
+        "AccountNotAuthorized",
+        "AccountProblem",
+        "AllAccessDisabled",
+        "InvalidAccessKeyId",
+        "InvalidPayer",
+        "InvalidSecurity",
+        "NotSignedUp",
+        "TokenRefreshRequired",
+        "AuthorizationError",
+        "AccessDenied",
+        "AccessDeniedException",
+        "KMSAccessDenied",
+        "KMSInvalidState",
+    }
+)
+#: SNS reports throttling and oversized batches with codes of its own.
+_SNS_THROTTLING_CODES = AWS_THROTTLING_CODES | {
+    "Throttled",
+    "TooManyEntriesInBatchRequest",
+}
+_SNS_INVALID_CODES = frozenset(
+    {
+        "InvalidAction",
+        "ValidationError",
+        "RequestTimeTooSkewed",
+        "SignatureDoesNotMatch",
+        "BadDigest",
+        "InvalidParameter",
+        "InvalidParameterValue",
+        "InvalidMessage",
+        "InvalidMessageAttributes",
+        "MessageTooLong",
+        "InvalidTopicArn",
+        "InvalidTargetArn",
+        "InvalidPhoneNumber",
+        "InvalidSubject",
+        "PlatformApplicationDisabled",
+    }
+)
+_SNS_NOT_FOUND_CODES = frozenset(
+    {
+        "NotFound",
+        "TopicNotFound",
+        "EndpointNotFound",
+        "SubscriptionNotFound",
+    }
+)
+
+
+def translate_aws_sqs_error(exc: Exception) -> SubstrateSdkException:
+    """Translate AWS SQS errors to common exception hierarchy."""
+    return _translate_aws_error(
+        exc=exc,
+        auth_codes=_SQS_AUTH_CODES,
+        throttling_codes=_SQS_THROTTLING_CODES,
+        invalid_codes=_SQS_INVALID_CODES,
+        not_found_codes=_SQS_NOT_FOUND_CODES,
+        unknown_codes=_SQS_UNKNOWN_CODES,
+    )
+
+
+def translate_aws_sns_error(exc: Exception) -> SubstrateSdkException:
+    """Translate AWS SNS errors to common exception hierarchy."""
+    return _translate_aws_error(
+        exc=exc,
+        auth_codes=_SNS_AUTH_CODES,
+        throttling_codes=_SNS_THROTTLING_CODES,
+        invalid_codes=_SNS_INVALID_CODES,
+        not_found_codes=_SNS_NOT_FOUND_CODES,
+        unknown_codes=frozenset(),
+    )
+
+
+def _translate_aws_error(
+    *,
+    exc: Exception,
+    auth_codes: frozenset[str],
+    throttling_codes: frozenset[str],
+    invalid_codes: frozenset[str],
+    not_found_codes: frozenset[str],
+    unknown_codes: frozenset[str],
+) -> SubstrateSdkException:
+    if isinstance(exc, SubstrateSdkException):
+        return exc
+
+    if isinstance(exc, boto_exceptions.ClientError):
+        error_code = exc.response.get("Error", {}).get("Code", "")
+        if error_code in auth_codes:
+            return UnAuthorizedException(str(exc))
+        if error_code in throttling_codes:
+            return ResourceExhaustedException(str(exc))
+        if error_code in invalid_codes:
+            return InvalidArgumentException(str(exc))
+        if error_code == "InternalFailure":
+            return TransactionFailedException(str(exc))
+        if error_code in not_found_codes:
+            return ResourceNotFoundException(str(exc))
+        if error_code in unknown_codes:
+            return UnknownException(str(exc))
+        return UnknownException(str(exc))
+
+    if isinstance(exc, boto_exceptions.NoCredentialsError):
+        return UnAuthorizedException(str(exc))
+    return UnknownException(str(exc))

multicloud_py_aws_common-0.1.6/multicloud_py_aws_common.egg-info/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.4
+Name: multicloud-py-aws-common
+Version: 0.1.6
+Summary: Shared AWS credential resolution utilities for multicloud-* providers.
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/salesforce/multicloud-py
+Project-URL: Repository, https://github.com/salesforce/multicloud-py
+Project-URL: Issues, https://github.com/salesforce/multicloud-py/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: multicloud-py-common>=0.1.6
+Requires-Dist: boto3>=1.18.0
+Requires-Dist: botocore>=1.21.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Dynamic: license-file
+
+MultiCloud Python SDK package.

multicloud_py_aws_common-0.1.6/multicloud_py_aws_common.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE.txt
+pyproject.toml
+multicloud/aws_common/__init__.py
+multicloud/aws_common/aws_client_config.py
+multicloud/aws_common/aws_credentials.py
+multicloud/aws_common/error_mapping.py
+multicloud_py_aws_common.egg-info/PKG-INFO
+multicloud_py_aws_common.egg-info/SOURCES.txt
+multicloud_py_aws_common.egg-info/dependency_links.txt
+multicloud_py_aws_common.egg-info/requires.txt
+multicloud_py_aws_common.egg-info/top_level.txt

multicloud_py_aws_common-0.1.6/multicloud_py_aws_common.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

multicloud_py_aws_common-0.1.6/multicloud_py_aws_common.egg-info/requires.txt

@@ -0,0 +1,8 @@
+multicloud-py-common>=0.1.6
+boto3>=1.18.0
+botocore>=1.21.0
+
+[dev]
+pytest>=7.0.0
+pytest-cov>=4.0.0
+mypy>=1.0.0

multicloud_py_aws_common-0.1.6/multicloud_py_aws_common.egg-info/top_level.txt

@@ -0,0 +1 @@
+multicloud

multicloud_py_aws_common-0.1.6/pyproject.toml

@@ -0,0 +1,34 @@
+[build-system]
+requires = ["setuptools>=77", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "multicloud-py-aws-common"
+version = "0.1.6"
+license = "Apache-2.0"
+description = "Shared AWS credential resolution utilities for multicloud-* providers."
+readme = {text = "MultiCloud Python SDK package.", content-type = "text/markdown"}
+requires-python = ">=3.10"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "multicloud-py-common>=0.1.6",
+    "boto3>=1.18.0",
+    "botocore>=1.21.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/salesforce/multicloud-py"
+Repository = "https://github.com/salesforce/multicloud-py"
+Issues = "https://github.com/salesforce/multicloud-py/issues"
+
+[project.optional-dependencies]
+dev = ["pytest>=7.0.0", "pytest-cov>=4.0.0", "mypy>=1.0.0"]
+
+[tool.setuptools]
+license-files = ["LICENSE.txt"]
+
+[tool.setuptools.packages.find]
+include = ["multicloud*"]

multicloud_py_aws_common-0.1.6/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+