mypy-boto3-controlcatalog

Warnings

• breaking Starting with `mypy-boto3-builder` version 8.12.0 (which generates `mypy-boto3-*` packages), support for Python 3.8 has been removed across all generated stub packages.
  Fix: Upgrade your Python environment to 3.9 or higher. If you need Python 3.8 support, pin your `mypy-boto3-controlcatalog` version to an older release compatible with builder <8.12.0.
• breaking In `mypy-boto3-builder` version 8.9.0, there were breaking changes related to TypeDef naming conventions. Specifically, TypeDefs for packed method arguments now use shorter names (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`), and conflicting `Extra` postfixes moved to the end (e.g., `CreateDistributionExtraRequestTypeDef` became `CreateDistributionRequestExtraTypeDef`).
  Fix: Update your code to reflect the new TypeDef names. Refer to the `mypy-boto3-builder` release notes for exact naming changes if you encounter type errors related to these structures.
• gotcha These are type stubs for `boto3`. To benefit from type checking, you must also install a static type checker like `mypy` or `pyright` and configure your project to use it. The stubs alone do not alter `boto3`'s runtime behavior.
  Fix: Install `mypy` (`pip install mypy`) or `pyright` (`npm i -g pyright`) and configure it for your project. Run `mypy your_script.py` to check types.
• gotcha For optimal performance and to avoid unnecessary runtime dependencies, it is recommended to install specific service stubs (e.g., `mypy-boto3-controlcatalog`) rather than the monolithic `boto3-stubs[all]` or `mypy-boto3` packages if you only use a few AWS services.
  Fix: Only `pip install` the `mypy-boto3-` package for each specific AWS service you use. For general `boto3` stubs, `pip install boto3-stubs` is recommended.
• gotcha When using `mypy-boto3` with PyCharm, older versions of PyCharm might exhibit slow performance or incorrect type inference, especially with `Literal` overloads.
  Fix: Consider using `boto3-stubs-lite` (if available for your service) or ensure your PyCharm is updated to the latest version. Alternatively, explicit type annotations can sometimes mitigate issues.

Install

• pip install mypy-boto3-controlcatalog Install package

Imports

• ControlCatalogClient

  from mypy_boto3_controlcatalog.client import ControlCatalogClient

  While `boto3.client("controlcatalog")` works at runtime, importing `ControlCatalogClient` directly from `mypy_boto3_controlcatalog.client` provides the necessary type hints for static analysis and IDE autocomplete.
• TYPE_CHECKING

  from typing import TYPE_CHECKING

  It is best practice to wrap stub imports within an `if TYPE_CHECKING:` block to avoid adding the stub package as a runtime dependency.

Quickstart

This quickstart demonstrates how to obtain a type-hinted `ControlCatalogClient` using `boto3` and perform a basic operation like `list_domains`. Ensure your AWS credentials and default region are configured in your environment or `~/.aws/credentials` file.

import os
from typing import TYPE_CHECKING
import boto3

if TYPE_CHECKING:
    from mypy_boto3_controlcatalog.client import ControlCatalogClient
    from mypy_boto3_controlcatalog.type_defs import ListDomainsOutputTypeDef

def get_controlcatalog_client() -> "ControlCatalogClient":
    """
    Returns a typed ControlCatalog client.
    """
    # boto3 automatically uses credentials from environment variables (e.g., AWS_ACCESS_KEY_ID)
    # or ~/.aws/credentials.
    # Replace "us-east-1" with your desired AWS region.
    session = boto3.Session(region_name=os.environ.get("AWS_REGION", "us-east-1"))
    client: "ControlCatalogClient" = session.client("controlcatalog")
    return client

if __name__ == "__main__":
    client = get_controlcatalog_client()
    try:
        # Example: List Control Catalog domains
        # Replace with an actual Control Catalog operation for your use case.
        response: "ListDomainsOutputTypeDef" = client.list_domains()
        print(f"Successfully listed {len(response.get('Domains', []))} domains.")
        for domain in response.get('Domains', []):
            print(f"- Domain ARN: {domain.get('Arn')}, Name: {domain.get('Name')}")
    except client.exceptions.ClientError as e:
        print(f"Error listing domains: {e}")
    except Exception as e:
        print(f"An unexpected error occurred: {e}")