Type Annotations for boto3 NetworkManager

1.42.3 · active · verified Sat Apr 11

mypy-boto3-networkmanager provides type annotations for the `boto3` NetworkManager service. It is part of the `mypy-boto3` project, generated by `mypy-boto3-builder`, ensuring static type checking for the AWS SDK for Python (Boto3). It helps catch API usage errors at development time. The current version is 1.42.3 and new versions are frequently released to align with `boto3` updates and `mypy-boto3-builder` improvements.

Warnings

breaking `mypy-boto3` packages (including `mypy-boto3-networkmanager`) no longer support Python 3.8 as of `mypy-boto3-builder` version 8.12.0. The minimum required Python version is now 3.9.
Fix: Upgrade your Python environment to 3.9 or higher, or pin `mypy-boto3-networkmanager` to an older version compatible with Python 3.8 if necessary.
breaking Type definition naming conventions changed in `mypy-boto3-builder` version 8.9.0. This primarily affects `TypeDef` names which may have become shorter (e.g., `RequestRequestTypeDef` to `RequestTypeDef`) or had postfixes moved (e.g., `ExtraRequestTypeDef` to `RequestExtraTypeDef`).
Fix: Update your code to reflect the new `TypeDef` names. Consult the specific service's `type_defs.pyi` for the correct names if you're importing them directly.
gotcha This package provides only type stubs. `boto3` must be installed separately in your project for the code to run at runtime. `mypy-boto3-networkmanager` does not automatically install `boto3`.
Fix: Ensure `boto3` is included in your project's dependencies (e.g., `pip install boto3` or `requirements.txt`).
gotcha For optimal type checking, the version of `mypy-boto3-networkmanager` should closely match your installed `boto3` version. Mismatched versions can lead to incorrect type hints or missed type errors.
Fix: Align your `mypy-boto3-networkmanager` version with your `boto3` version. `mypy-boto3` package versions are typically tied to the `boto3` version they provide stubs for (e.g., `mypy-boto3-networkmanager==1.42.3` for `boto3==1.42.3`).
gotcha Migration to PEP 561 packages in `mypy-boto3-builder` version 8.12.0 means packages are now installed in an editable mode by default if using modern pip. While this generally improves discovery, it might interact unexpectedly with specific build systems or older environments.
Fix: Ensure your `pip` version is up-to-date. If encountering issues with type checker discovery, verify the package installation method (e.g., `pip install --no-deps` or `pip install --no-build-isolation` if applicable in your CI/CD setup).

Install

pip install mypy-boto3-networkmanager boto3 Install library and runtime dependency

Imports

NetworkManagerClient

from mypy_boto3_networkmanager.client import NetworkManagerClient

ServiceName
```
from mypy_boto3_networkmanager.literals import ServiceName
```
Useful for stricter typing of client creation, e.g., boto3.client(service_name: ServiceName)

Quickstart

Demonstrates how to import and use the `NetworkManagerClient` type hint with a standard `boto3` client. This allows MyPy to validate method calls and arguments, ensuring type safety for your AWS interactions.

import boto3
from mypy_boto3_networkmanager import NetworkManagerClient

def list_all_core_networks() -> None:
    # Initialize the client with type hinting
    client: NetworkManagerClient = boto3.client("networkmanager")

    print("Listing Core Networks...")
    try:
        response = client.list_core_networks()
        core_networks = response.get("CoreNetworks", [])
        if core_networks:
            for cn in core_networks:
                print(f"  - {cn.get('CoreNetworkId')} ({cn.get('State')})")
        else:
            print("  No Core Networks found.")
    except Exception as e:
        print(f"An error occurred: {e}")

if __name__ == "__main__":
    list_all_core_networks()

view raw JSON →