mypy-boto3-migrationhuborchestrator Type Annotations

Warnings

• breaking Starting with `mypy-boto3-builder` version 8.12.0 (which generated this package), Python 3.8 is no longer supported for generated stub packages.
  Fix: Upgrade your Python environment to 3.9 or newer.
• breaking In `mypy-boto3-builder` version 8.9.0, type definition (TypeDef) naming conventions changed. This includes shorter names for packed method arguments and revised postfix handling for conflicting `TypeDef` names (e.g., `CreateDistributionExtraRequestTypeDef` became `CreateDistributionRequestExtraTypeDef`).
  Fix: Update your code to use the new `TypeDef` names as per the latest stub documentation. Your IDE or type checker should flag these if you are using explicit type hints.
• gotcha Type imports from `mypy_boto3_*` packages should ideally be placed within `if TYPE_CHECKING:` blocks. This ensures that these stub packages are only used by static analysis tools (like mypy) and are not treated as runtime dependencies by your application, reducing the deployed package size.
  Fix: Wrap your `from mypy_boto3_* import ...` statements in `if TYPE_CHECKING:` blocks. For example: `from typing import TYPE_CHECKING; if TYPE_CHECKING: from mypy_boto3_migrationhuborchestrator import MigrationHubOrchestratorClient`.
• gotcha Following the migration to PEP 561 packages in `mypy-boto3-builder` 8.12.0, ensure your `mypy` or other type checker is up-to-date. Older versions might not correctly discover or utilize the stubs, leading to `Missing type stub` errors or incorrect type inference.
  Fix: Update your type checker (e.g., `pip install --upgrade mypy`) and ensure it's configured to recognize PEP 561-compliant stub packages.

Install

• pip install mypy-boto3-migrationhuborchestrator Install specific service stubs
• pip install 'boto3-stubs[migrationhuborchestrator]' Install via boto3-stubs meta-package

Imports

• MigrationHubOrchestratorClient

  from typing import TYPE_CHECKING
  if TYPE_CHECKING:
      from mypy_boto3_migrationhuborchestrator import MigrationHubOrchestratorClient

  It is best practice to guard type imports with `if TYPE_CHECKING:` to avoid introducing runtime dependencies.
• TemplateSummaryTypeDef

  from typing import TYPE_CHECKING
  if TYPE_CHECKING:
      from mypy_boto3_migrationhuborchestrator.type_defs import TemplateSummaryTypeDef

  Type definitions (TypedDicts) for API responses are available in the `type_defs` submodule.

Quickstart

This quickstart demonstrates how to use the `mypy-boto3-migrationhuborchestrator` stubs with a `boto3` client to get type-checking for the `list_templates` operation. It includes the recommended `TYPE_CHECKING` guard for imports and handles potential `AccessDeniedException`.

import boto3
from typing import TYPE_CHECKING

# Best practice: guard type imports with if TYPE_CHECKING
if TYPE_CHECKING:
    from mypy_boto3_migrationhuborchestrator import MigrationHubOrchestratorClient
    from mypy_boto3_migrationhuborchestrator.type_defs import TemplateSummaryTypeDef

# Initialize a boto3 client for Migration Hub Orchestrator
client: MigrationHubOrchestratorClient = boto3.client('migrationhuborchestrator')

# Use a method and check its return type
try:
    response = client.list_templates(maxResults=5)
    templates: list[TemplateSummaryTypeDef] = response['Templates']
    for template in templates:
        print(f"Template ID: {template['Id']}, Name: {template['Name']}")
except client.exceptions.AccessDeniedException:
    print("Access denied. Please check your AWS credentials and permissions.")
except Exception as e:
    print(f"An unexpected error occurred: {e}")

# To run mypy:
# 1. pip install mypy boto3 mypy-boto3-migrationhuborchestrator
# 2. mypy your_script_name.py