mypy-boto3-mgn

1.42.68 · active · verified Sat Apr 11

mypy-boto3-mgn provides type annotations for the AWS Migration Hub rehost service (MGN) within `boto3`. It enhances development with static type checking for clients, paginators, waiters, literals, and type definitions, compatible with tools like mypy, pyright, VSCode, and PyCharm. The package is automatically generated by `mypy-boto3-builder` and is frequently updated to align with `boto3` releases.

Warnings

breaking Python 3.8 support has been removed in `mypy-boto3-builder` version 8.12.0 and later. Projects using `mypy-boto3-mgn` now require Python 3.9 or higher.
Fix: Upgrade your Python environment to 3.9 or newer. If stuck on Python 3.8, you might need to pin to an older `mypy-boto3-builder` or `mypy-boto3-mgn` version (e.g., `<8.12.0` for builder).
breaking Breaking changes to `TypeDef` naming conventions occurred in `mypy-boto3-builder` version 8.9.0. Some TypeDefs for method arguments or conflicting names might have been shortened or had postfixes rearranged (e.g., `*RequestRequestTypeDef` to `*RequestTypeDef`).
Fix: Review your type hints for `boto3` API call parameters and responses. Adjust `TypeDef` imports and usage according to the new naming conventions. Consult the specific service documentation or generated stub files if you encounter `NameError` for `TypeDef`s.
gotcha PyCharm users may experience slow performance or high CPU usage due to `Literal` overloads. This is a known upstream issue (PY-40997).
Fix: Consider using `boto3-stubs-lite` (if explicit type annotations are acceptable) or disable PyCharm's built-in type checker in favor of `mypy` or `pyright` for linting.
gotcha For production deployments, `mypy-boto3-mgn` should typically be a development-only dependency. To prevent runtime import errors or `pylint` complaints about undefined variables, use `if TYPE_CHECKING:` blocks.
Fix: Wrap `mypy-boto3-mgn` imports within `from typing import TYPE_CHECKING; if TYPE_CHECKING:` blocks. Alternatively, for non-`TYPE_CHECKING` contexts, assign imported types to `object`.

Install

pip install mypy-boto3-mgn Install service stubs
pip install 'boto3-stubs[mgn]' Install via boto3-stubs extras

Imports

MgnClient
```
from mypy_boto3_mgn import MgnClient
```
Used for type-hinting the boto3 MGN client.
ListWavesResponseTypeDef
```
from mypy_boto3_mgn.type_defs import ListWavesResponseTypeDef
```
TypedDict for MGN API responses, enhancing type safety.

Quickstart

This example demonstrates how to initialize an MGN client with type annotations and make a sample API call (`list_waves`). It also shows how to type-hint the response using a generated TypeDef. The `TYPE_CHECKING` block ensures that `mypy-boto3-mgn` is only a development dependency.

import boto3
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from mypy_boto3_mgn import MgnClient
    from mypy_boto3_mgn.type_defs import ListWavesResponseTypeDef

# Instantiate the boto3 client with type hinting
client: MgnClient = boto3.client("mgn")

try:
    # Example API call with typed response
    response: ListWavesResponseTypeDef = client.list_waves(
        maxResults=10
    )
    print("Successfully listed waves:")
    for wave in response.get("items", []):
        print(f"  - Wave ID: {wave.get('waveID')}, Name: {wave.get('name')}")
except client.exceptions.ResourceNotFoundException:
    print("No waves found or region misconfigured.")
except Exception as e:
    print(f"An error occurred: {e}")

view raw JSON →