Registry / type-stubs / mypy-boto3-controlcatalog

mypy-boto3-controlcatalog

JSON →
library1.43.17pypypi✓ verified 22d ago

mypy-boto3-controlcatalog provides comprehensive type annotations for the AWS Control Catalog service within the `boto3` library. This allows static type checkers like MyPy and IDEs to offer accurate autocomplete, parameter suggestions, and error checking for your `boto3` client calls, improving code quality and developer productivity. It is generated by `mypy-boto3-builder` and its releases align with new `boto3` versions and `mypy-boto3-builder` updates.

pip install mypy-boto3-controlcatalog
INSTALL
IMPORT
SIG · MYPY-BOTO3-CONTROL
M
mypy-boto3-controlcatalog
type-stubspythonv1.43.17
Install
1.6s avg
Import
Disk
16MB
Pass rate
10/ 10
Env Coverage10 / 10
glibc
3.93.13
musl
3.93.13
Install & Compatibility
Where this runs
tested against v1.43.17 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
py 3.103.95 runs
installs and imports cleanly · install 0.0s · import 0.000s · 18.3MB
glibc
py 3.103.95 runs
installs and imports cleanly · install 1.6s · import 0.000s · 19MB
16MB installed
● package 16MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

ControlCatalogClient
from mypy_boto3_controlcatalog import ControlCatalogClient
from mypy_boto3_controlcatalog import ControlCatalogClient

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}")
Debug
Known issues
breakingStarting 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.
affects: >=8.12.0 of mypy-boto3-builder
breakingIn `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.
affects: >=8.9.0 of mypy-boto3-builder
gotchaThese 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.
affects: all
gotchaFor 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.
affects: all
gotchaWhen 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.
affects: Some PyCharm versions
Upgrade
Version history
1.43.17latest on PyPI · released May 28, 2026
Audit
Dependencies
boto3requiredProvides the AWS SDK runtime library that these stubs type-annotate. Users must install boto3 separately.
mypyoptionalA static type checker that utilizes these stubs for type validation. Users must install mypy separately to perform type checks.
pythonrequiredMinimum Python version required for the library.
Agent activity
27 hits · last 30 days
node
22
OpenAI (training)
2
Resources
mypy-boto3-controlcatalog — pip install mypy-boto3-controlcatalog · libregistry