Type Annotations for boto3 CloudWatch Network Monitor

1.42.3 · active · verified Sat Apr 11

mypy-boto3-networkmonitor provides comprehensive type annotations for the `boto3` CloudWatch Network Monitor service (version 1.42.3). Generated by `mypy-boto3-builder` 8.12.0, it enhances developer experience by enabling static type checking with tools like mypy and pyright, and improving code completion in IDEs like VSCode and PyCharm. This library helps to proactively identify and fix potential type-related bugs in `boto3` code at development time.

Warnings

breaking As of `mypy-boto3-builder` version 8.12.0 (which generated `mypy-boto3-networkmonitor 1.42.3`), Python 3.8 support has been officially removed for all generated packages.
Fix: Upgrade your Python environment to 3.9 or newer. If you must use Python 3.8, you will need to pin `mypy-boto3-networkmonitor` to an older compatible version (e.g., <1.42.3) and `mypy-boto3-builder` to <8.12.0.
breaking Type definition (TypeDef) naming conventions changed in `mypy-boto3-builder` 8.9.0. This could affect code that explicitly imports or refers to TypeDefs by their full, verbose names (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`).
Fix: Update your code to use the shorter, revised TypeDef names. Refer to the specific service documentation or generated stub files for the correct names if encountering type errors.
gotcha The legacy `mypy-boto3` package was separated from the main `boto3-stubs` product in `mypy-boto3-builder` 8.9.0. Users upgrading from older `mypy-boto3` installations might find that new services or updates are not available via the old package.
Fix: For the latest and most comprehensive type annotations, prefer installing `boto3-stubs` with specific service extras (e.g., `boto3-stubs[networkmonitor]`) or the standalone `mypy-boto3-networkmonitor` package directly.
gotcha PyCharm users might experience slow performance or high CPU usage due to how PyCharm handles `Literal` overloads in `mypy-boto3` generated stubs (PyCharm issue PY-40997).
Fix: It is recommended to use `boto3-stubs-lite` (e.g., `pip install 'boto3-stubs-lite[networkmonitor]'`) as a more RAM-friendly alternative, though it requires more explicit type annotations. Alternatively, consider disabling PyCharm's built-in type checker and relying solely on an external checker like `mypy` or `pyright`.

Install

pip install mypy-boto3-networkmonitor Install standalone package
pip install 'boto3-stubs[networkmonitor]' Install as part of boto3-stubs

Imports

NetworkMonitorClient
```
from mypy_boto3_networkmonitor.client import NetworkMonitorClient
```
Client for the CloudWatch Network Monitor service.

Paginator

from mypy_boto3_networkmonitor.paginator import ListMonitorsPaginator

Type annotations for Paginators, e.g., for listing monitors.

Literal
```
from mypy_boto3_networkmonitor.literals import MonitorStateTypeDef
```
Provides type-checked string literals for service-specific values.
TypeDef
```
from mypy_boto3_networkmonitor.type_defs import MonitorSummaryTypeDef
```
Provides type definitions for API request and response structures (TypedDicts).

Quickstart

This example demonstrates how to obtain a type-annotated `NetworkMonitorClient` from a `boto3` session and use it to call an API method. Type annotations ensure that `client` methods and their arguments are correctly validated by a static type checker.

import os
import boto3
from boto3.session import Session
from mypy_boto3_networkmonitor.client import NetworkMonitorClient

def get_network_monitor_client() -> NetworkMonitorClient:
    # Assuming AWS credentials are set via environment variables or AWS CLI config
    session = Session(region_name=os.environ.get('AWS_DEFAULT_REGION', 'us-east-1'))
    client: NetworkMonitorClient = session.client("networkmonitor")
    return client

client = get_network_monitor_client()
response = client.list_monitors()
print(response.get('Monitors'))

view raw JSON →