mypy-boto3-amplifyuibuilder type annotations

Warnings

• breaking Support for Python 3.8 has been removed in `mypy-boto3-builder` version 8.12.0, which generates this package. Projects requiring Python 3.8 should use an older version of `mypy-boto3-amplifyuibuilder` or upgrade their Python environment.
  Fix: Upgrade to Python 3.9 or higher. If unable to upgrade, pin `mypy-boto3-amplifyuibuilder` to a version generated by `mypy-boto3-builder < 8.12.0`.
• breaking The `mypy-boto3-builder` migrated to PEP 561 compliant packages in version 8.12.0. While this simplifies `mypy` integration, it might affect custom build processes or older tooling that relied on non-PEP 561 distribution methods.
  Fix: Ensure your `mypy` configuration is up-to-date and relies on standard package discovery. No specific code changes are typically required unless you have highly customized type-checking setups.
• gotcha This package provides *only* type annotations. You must install `boto3` (and optionally `botocore`) separately for your application to function at runtime. Without `boto3`, your code will raise `ModuleNotFoundError`.
  Fix: Always install `boto3` alongside `mypy-boto3-amplifyuibuilder` (e.g., `pip install boto3 mypy-boto3-amplifyuibuilder`).
• gotcha For comprehensive type checking, especially when using `boto3.client()` or `boto3.resource()` without explicit type hints, it is recommended to install `boto3-stubs` with the appropriate service extras (e.g., `pip install 'boto3-stubs[amplifyuibuilder]'`). This provides overloads for the generic `boto3` functions.
  Fix: Install `boto3-stubs` with service extras: `pip install 'boto3-stubs[amplifyuibuilder]'`.
• breaking The `mypy-boto3-builder` (version 8.9.0) introduced changes to TypeDef naming conventions, potentially shortening names or reordering suffixes for clarity (e.g., `CreateDistributionRequestRequestTypeDef` -> `CreateDistributionRequestTypeDef`). If you directly reference these generated TypeDefs in your code, they might have changed.
  Fix: Review and update any explicit references to generated TypeDefs in your codebase. Refer to the specific service documentation for the updated TypeDef names.
• gotcha When using `if TYPE_CHECKING:` guards to conditionally import stubs for Pylint compatibility, Pylint might report `undefined variable` errors in the `else` block. This is a known Pylint limitation.
  Fix: To suppress Pylint errors, assign `object` to the client/resource variables in the `else` branch (e.g., `else: AmplifyUIBuilderClient = object`) or use `# type: ignore` for those lines. Refer to the official `mypy-boto3` documentation for Pylint compatibility details.

Install

• pip install mypy-boto3-amplifyuibuilder boto3 Install specific service stubs and boto3
• pip install 'boto3-stubs[amplifyuibuilder]' boto3 Install via boto3-stubs umbrella package (recommended)

Imports

• AmplifyUIBuilderClient

  from mypy_boto3_amplifyuibuilder.client import AmplifyUIBuilderClient

  The client type hint is imported from the specific `mypy-boto3-amplifyuibuilder` stub package, not directly from `boto3`.

Quickstart

This quickstart demonstrates how to obtain a type-hinted `AmplifyUIBuilderClient` using `boto3` and the `mypy-boto3-amplifyuibuilder` stubs. The `TYPE_CHECKING` guard ensures the stub import is only active during type checking, avoiding a runtime dependency on the stub package itself. Remember to have `boto3` installed and configured with AWS credentials.

import boto3
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from mypy_boto3_amplifyuibuilder.client import AmplifyUIBuilderClient

def get_amplifyuibuilder_client() -> AmplifyUIBuilderClient:
    """Gets a typed AmplifyUIBuilder client."""
    client: AmplifyUIBuilderClient = boto3.client(
        "amplifyuibuilder",
        region_name="us-east-1"
    )
    return client

# Example usage (will be type-checked by MyPy)
if __name__ == "__main__":
    try:
        amplify_client = get_amplifyuibuilder_client()
        # Replace with an actual AmplifyUIBuilder API call
        # For example, listing components, if any exist
        print(f"Client type: {type(amplify_client)}")
        # Example: list components (requires valid AWS credentials and existing resources)
        # response = amplify_client.list_components()
        # print(f"Components: {response.get('entities')}")
        print("AmplifyUIBuilder client initialized successfully. Further calls require valid AWS credentials and service usage.")
    except Exception as e:
        print(f"An error occurred: {e}")