mypy-boto3-route53resolver

Warnings

• breaking The `mypy-boto3-builder` (which generates this package) migrated to PEP 561 package structure and removed support for Python 3.8 starting with builder version 8.12.0. This means `mypy-boto3-route53resolver` version 1.42.10 and newer will not work with Python 3.8.
  Fix: Upgrade your Python environment to 3.9 or higher. Reinstall `mypy-boto3-route53resolver` to ensure the correct PEP 561-compliant package structure is in place.
• breaking Starting with `mypy-boto3-builder` version 8.9.0, there were breaking changes to how TypeDef names for method arguments are generated, often resulting in shorter names (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`).
  Fix: Review and update any direct imports or references to `TypeDef` objects in your codebase to match the new naming conventions.
• gotcha The `mypy-boto3-route53resolver` package provides type hints only; it does not include the `boto3` runtime library itself. For your code to execute, `boto3` must be installed separately.
  Fix: Ensure `pip install boto3` is run in your environment alongside `mypy-boto3-route53resolver`.
• gotcha To effectively use these type annotations, `mypy` must be installed and configured to check your project. Simply installing the stub package is not enough; you must integrate `mypy` into your development workflow.
  Fix: Install `mypy` (`pip install mypy`) and run it against your project (e.g., `mypy your_module.py` or configure it via `pyproject.toml`).

Install

• pip install mypy-boto3-route53resolver Install package

Imports

• Route53ResolverClient

  from mypy_boto3_route53resolver.client import Route53ResolverClient

• ListFirewallConfigsRequestRequestTypeDef

  from mypy_boto3_route53resolver.type_defs import ListFirewallConfigsRequestRequestTypeDef

  Type definitions are typically imported from the `type_defs` submodule.

Quickstart

This quickstart demonstrates how to initialize a `boto3` Route53Resolver client and use its methods with `mypy-boto3-route53resolver` type hints. The `TYPE_CHECKING` block ensures type imports are only active during static analysis, avoiding runtime overhead or potential circular imports. The example lists firewall configurations, expecting AWS credentials to be configured in the environment.

import boto3
from typing import TYPE_CHECKING

# Only import type hints during type checking, not at runtime
if TYPE_CHECKING:
    from mypy_boto3_route53resolver.client import Route53ResolverClient
    from mypy_boto3_route53resolver.type_defs import ListFirewallConfigsRequestRequestTypeDef

def get_resolver_client() -> "Route53ResolverClient":
    """Initializes and returns a Route53Resolver client with type hints."""
    # boto3.client returns an untyped client; mypy uses the stub's definition
    return boto3.client("route53resolver")

def list_firewall_configs():
    """Lists Route53 Resolver firewall configurations."""
    client: Route53ResolverClient = get_resolver_client()
    
    # Example request type for a method
    # The actual arguments passed to list_firewall_configs will be type-checked
    request_params: ListFirewallConfigsRequestRequestTypeDef = {
        "MaxResults": 10
    }
    response = client.list_firewall_configs(**request_params)
    print("Firewall Configurations:")
    for config in response.get("FirewallConfigs", []):
        print(f"  - {config.get('Id')} ({config.get('Name')})")

if __name__ == "__main__":
    # This code requires AWS credentials configured (e.g., via AWS CLI or environment variables)
    try:
        list_firewall_configs()
    except Exception as e:
        print(f"Error during quickstart execution (likely AWS credentials/config issue): {e}")
        print("Please ensure your AWS credentials are configured.")