mypy-boto3-acm

Warnings

• breaking Python 3.8 support was removed with `mypy-boto3-builder` version 8.12.0. Users on Python 3.8 must upgrade their Python version to 3.9 or higher to use recent versions of `mypy-boto3-acm`.
  Fix: Upgrade your Python environment to 3.9 or newer. Consider using a virtual environment (e.g., `venv` or `conda`) to manage Python versions.
• breaking The `mypy-boto3-builder` migrated to PEP 561 compliant packages in version 8.12.0. While this generally improves compatibility with `mypy`, older `mypy` versions or custom `MYPYPATH` configurations might require adjustments.
  Fix: Ensure `mypy` is up-to-date. If using custom paths, verify they align with PEP 561's stub resolution order. For `stub-only` packages, they must be installed, not just added to `MYPYPATH`.
• breaking Starting from `mypy-boto3-builder` version 8.9.0, TypeDef naming conventions for method arguments were shortened (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`), and conflicting `Extra` postfixes were moved. This can cause type errors if you're explicitly referencing older TypeDef names.
  Fix: Update your type hints to use the new, shorter TypeDef names. Consult the `mypy-boto3-acm` documentation for the correct TypeDef names for specific API calls.
• gotcha `mypy-boto3-acm` provides only type *stubs*. `boto3` (the actual AWS SDK for Python) must be installed separately for your code to run successfully at runtime.
  Fix: Always ensure `pip install boto3` is executed in your environment alongside `pip install mypy-boto3-acm`.
• gotcha When using `TYPE_CHECKING` blocks for conditional imports, `pylint` may complain about 'undefined variables' in the `else` branch. This is a known issue with `pylint`'s handling of these blocks.
  Fix: To resolve `pylint` warnings, you can explicitly set the types to `object` in the `else` branch of your `TYPE_CHECKING` block (e.g., `else: ACMClient = object`).
• gotcha PyCharm users might experience slow performance or high CPU usage due to `Literal` overloads in `boto3-stubs`. This is a known issue (PY-40997).
  Fix: It is recommended to use `boto3-stubs-lite` if available for the service (though `mypy-boto3-acm` is a full stub package) or to disable PyCharm's built-in type checker and rely solely on `mypy` or `pyright`.

Install

• pip install mypy-boto3-acm Install service stubs
• pip install boto3 mypy Install runtime and type checker

Imports

• ACMClient

  from mypy_boto3_acm.client import ACMClient

  Imports the typed client for AWS Certificate Manager.
• TagTypeDef

  from mypy_boto3_acm.type_defs import TagTypeDef

  Imports a specific TypedDict for request/response structures. Other TypeDefs exist for various API call parameters and responses.

Quickstart

This quickstart demonstrates how to use `mypy-boto3-acm` for type-hinting a `boto3` ACM client. It shows importing `ACMClient` and a relevant `TypeDef` for type-checking the response of `list_certificates`. The `TYPE_CHECKING` block ensures these imports are only used by type checkers, avoiding runtime dependencies if desired.

from typing import TYPE_CHECKING
import boto3

if TYPE_CHECKING:
    from mypy_boto3_acm.client import ACMClient
    from mypy_boto3_acm.type_defs import CertificateSummaryTypeDef

    # Example of a TypedDict for a specific API response item
    # For a full list, refer to the mypy-boto3-acm documentation

def get_acm_certificates() -> list['CertificateSummaryTypeDef']:
    client: ACMClient = boto3.client("acm")
    response = client.list_certificates()
    certificates = response.get("CertificateSummaryList", [])
    return certificates

if __name__ == "__main__":
    # Example usage (requires AWS credentials configured)
    try:
        certs = get_acm_certificates()
        if certs:
            print(f"Found {len(certs)} ACM certificates:")
            for cert in certs:
                print(f"  ARN: {cert['CertificateArn']}, Domain: {cert.get('DomainName')}")
        else:
            print("No ACM certificates found.")
    except Exception as e:
        print(f"Error retrieving certificates: {e}")