Type Annotations for boto3 DataZone

1.42.85 · active · verified Sat Apr 11

mypy-boto3-datazone provides type annotations for the boto3 DataZone service, enabling static type checking with tools like mypy, pyright, and enhanced IDE autocomplete. It is part of the `boto3-stubs` ecosystem, generated by `mypy-boto3-builder`. The current version is 1.42.85, released in sync with boto3 versions, ensuring compatibility and a frequent update cadence.

Warnings

breaking Python 3.8 support was removed in `mypy-boto3-builder` version 8.12.0. Users on Python 3.8 or older will need to upgrade their Python version to `>=3.9` to use recent versions of `mypy-boto3-datazone`.
Fix: Upgrade your Python environment to 3.9 or newer.
breaking Breaking changes in `mypy-boto3-builder` version 8.9.0 introduced shorter names for TypeDefs used in packed method arguments (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`). Conflicting `Extra` postfixes in TypeDef names were also moved to the end.
Fix: Review and update `TypeDef` import paths and names in your codebase according to the new naming conventions.
gotcha The standalone `mypy-boto3` package is considered legacy. While `mypy-boto3-datazone` is a valid and current service-specific stub, it is recommended to install service stubs using the `boto3-stubs` meta-package (e.g., `pip install 'boto3-stubs[datazone]'`) for better maintainability and to avoid confusion with the older `mypy-boto3` meta-package.
Fix: Prefer `pip install 'boto3-stubs[service]'` over `pip install mypy-boto3-service` for managing service stubs, although both approaches for `mypy-boto3-datazone` are currently functional.
gotcha Some IDEs (like older PyCharm versions) or linters might require explicit type annotations for `boto3.client` calls to ensure full autocomplete and type checking, due to limitations with function overloads.
Fix: Use explicit type annotations as shown in the quickstart (e.g., `client: DataZoneClient = boto3.client("datazone")`). Consider using `boto3-stubs-lite` if PyCharm performance issues arise with large projects, though it requires more explicit typing.

Install

pip install mypy-boto3-datazone Install standalone DataZone stubs
pip install 'boto3-stubs[datazone]' Install as part of boto3-stubs (recommended)

Imports

DataZoneClient
```
from mypy_boto3_datazone.client import DataZoneClient
```
While `boto3.client('datazone')` returns a client, for full type-hinting, import the stub client directly. Importing `DataZoneClient` directly from `mypy_boto3_datazone` works but explicit `mypy_boto3_datazone.client` is clearer.
ListDomainsOutputTypeDef
```
from mypy_boto3_datazone.type_defs import ListDomainsOutputTypeDef
```
Type definitions (TypeDefs) are located in the `type_defs` submodule for clarity and organization.
ListDomainsPaginator
```
from mypy_boto3_datazone.paginator import ListDomainsPaginator
```
Paginator type hints are provided in the `paginator` submodule.

Quickstart

This quickstart demonstrates how to use `mypy-boto3-datazone` to add type hints to a boto3 DataZone client. It shows importing the client type and a common `TypeDef` for a response, then using them with a standard `boto3` client call. The `TYPE_CHECKING` block ensures the stub package is only used for type analysis, not runtime.

import boto3
from mypy_boto3_datazone.client import DataZoneClient
from mypy_boto3_datazone.type_defs import ListDomainsOutputTypeDef
from typing import TYPE_CHECKING, cast

if TYPE_CHECKING:
    client: DataZoneClient = boto3.client("datazone")
else:
    client = boto3.client("datazone")

def list_datazone_domains() -> ListDomainsOutputTypeDef:
    """Lists DataZone domains with type hints."""
    # Example: List domains
    response = client.list_domains()
    print(f"Found {len(response.get('items', []))} DataZone domains.")
    return cast(ListDomainsOutputTypeDef, response)

if __name__ == "__main__":
    # Ensure boto3 is configured (e.g., AWS_REGION, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY)
    # For demonstration, we'll assume default config or environment variables.
    try:
        domains = list_datazone_domains()
        for domain in domains.get('items', []):
            print(f"- Domain ID: {domain.get('id')}, Name: {domain.get('name')}")
    except Exception as e:
        print(f"Error listing domains: {e}")
        # In a real application, you'd handle specific boto3 exceptions.

view raw JSON →