mypy-boto3-route53 Type Annotations

1.42.6 · active · verified Sat Apr 11

mypy-boto3-route53 provides comprehensive type annotations for the Amazon Route53 service client in `boto3`. It enhances development with static type checking, autocompletion, and improved readability for AWS interactions. The current version is 1.42.6, generated with `mypy-boto3-builder 8.12.0`, and it typically releases new versions in sync with `boto3` and `botocore` updates.

Warnings

breaking Support for Python 3.8 has been removed across all `mypy-boto3-builder` generated packages. Projects still on Python 3.8 will encounter compatibility errors.
Fix: Upgrade your Python environment to 3.9 or newer. If stuck on 3.8, pin to an older `mypy-boto3-route53` version (e.g., `<1.42.0`).
breaking TypeDef naming conventions were changed in `mypy-boto3-builder`, resulting in shorter or re-ordered names for some type definitions. This will break code that explicitly imports or references `TypeDef` objects by their old names.
Fix: Update your `TypeDef` imports and references according to the new naming scheme (e.g., `CreateDistributionRequestRequestTypeDef` might become `CreateDistributionRequestTypeDef`). Consult the `mypy-boto3-builder` release notes or regenerate your type-hinted code to identify changes.
gotcha These stubs are generated for specific `boto3` and `botocore` versions. Using a significantly different version of `boto3` can lead to discrepancies between the actual runtime behavior and the provided type hints, resulting in `mypy` errors or incorrect assumptions.
Fix: Ensure your `boto3` and `mypy-boto3-route53` package versions are compatible. Ideally, `mypy-boto3-route53`'s minor version should match `boto3`'s minor version (e.g., `mypy-boto3-route53==1.42.x` for `boto3==1.42.x`).
gotcha The `mypy-boto3-builder` ecosystem transitioned to PEP 561 compliance in version 8.12.0. While largely transparent, this could affect type checker discovery in complex setups or when using custom `MYPYPATH` configurations.
Fix: Most users will not need a fix. If encountering `mypy` stub discovery issues, verify your `mypy` configuration and ensure stub packages are correctly installed in your environment.

Install

pip install mypy-boto3-route53 Install specific service stubs
pip install boto3-stubs[route53] Install with boto3-stubs meta-package

Imports

Route53Client
```
from mypy_boto3_route53.client import Route53Client
```
The actual boto3 client does not export its type directly. You need to import the stub type from `mypy_boto3_route53`.
ListHostedZonesResponseTypeDef
```
from mypy_boto3_route53.type_defs import ListHostedZonesResponseTypeDef
```
Type definitions for response objects are found in the `type_defs` submodule.

Quickstart

This quickstart demonstrates how to initialize a Route53 client with type hints and retrieve a list of hosted zones. It explicitly types the `boto3` client and the API response, allowing `mypy` to validate usage and provide autocompletion.

import boto3
from mypy_boto3_route53 import Route53Client
from mypy_boto3_route53.type_defs import ListHostedZonesResponseTypeDef

def get_hosted_zones() -> ListHostedZonesResponseTypeDef:
    # boto3.client is untyped by default
    client: Route53Client = boto3.client("route53")
    
    response: ListHostedZonesResponseTypeDef = client.list_hosted_zones()
    print(f"Found {len(response.get('HostedZones', []))} hosted zones.")
    for zone in response.get('HostedZones', []):
        print(f"  - {zone.get('Name')} ({zone.get('Id')})")
    return response

if __name__ == "__main__":
    get_hosted_zones()

view raw JSON →