mypy-boto3-appsync Type Annotations

Warnings

• breaking Python 3.8 support was removed for all `mypy-boto3` packages. Projects targeting Python 3.8 will need to upgrade to Python 3.9 or newer.
  Fix: Upgrade your project's Python version to 3.9 or later. Consider using older `mypy-boto3` versions if 3.8 support is critical and you cannot upgrade Python.
• breaking `mypy-boto3` packages migrated to PEP 561. While this generally improves compatibility, specific `mypy` configurations (e.g., `MYPYPATH` usage) or older `mypy` versions might need adjustment.
  Fix: Ensure you are using a recent version of `mypy`. In most cases, simply installing the package should make stubs discoverable without special `mypy` configuration. Review `mypy` documentation if issues arise.
• breaking TypeDef names were refactored for brevity and consistency. For example, `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`. Conflicting TypeDef names had their `Extra` postfix moved.
  Fix: Update your code to use the new, shorter TypeDef names. Review your `mypy` errors for specific naming changes in the services you use.
• gotcha This package only provides type hints for `boto3`. You must install `boto3` itself to have the runtime functionality.
  Fix: Always install `boto3` (e.g., `pip install boto3`) alongside your `mypy-boto3-*` packages.
• gotcha The `mypy-boto3` ecosystem moved from a monolithic `mypy-boto3` package to granular `boto3-stubs-*` (e.g., `mypy-boto3-appsync`). Legacy `mypy-boto3` is no longer generated with the current builder.
  Fix: If you were previously using a single `mypy-boto3` package for all services, migrate to installing individual service stub packages like `mypy-boto3-appsync`.
• gotcha AWS service names can change, leading to updated package names for `mypy-boto3` stubs. For example, `sms-voice` was deprecated in favor of `pinpoint-sms-voice`.
  Fix: Always verify the correct package name for the specific AWS service you need. Check the `mypy-boto3` builder's documentation or PyPI for the latest package names.

Install

• pip install boto3 mypy-boto3-appsync Install boto3 (runtime) and mypy-boto3-appsync (type stubs)

Imports

• AppSyncClient

  from mypy_boto3_appsync.client import AppSyncClient

  boto3 itself does not export type hints directly this way; use the mypy-boto3 stub package.
• ListGraphqlApisResponseTypeDef

  from mypy_boto3_appsync.type_defs import ListGraphqlApisResponseTypeDef

  Type definitions often follow specific casing conventions (e.g., GraphQL -> Graphql).

Quickstart

This quickstart demonstrates how to import and use the `AppSyncClient` type annotation with `boto3`. It shows how to correctly type your `boto3` client instance and use a type definition for a response object, ensuring type safety for your AWS AppSync operations. Remember to have AWS credentials configured for actual execution.

import boto3
from mypy_boto3_appsync.client import AppSyncClient
from mypy_boto3_appsync.type_defs import ListGraphqlApisResponseTypeDef

# Instantiate the boto3 client with type annotation
client: AppSyncClient = boto3.client("appsync")

try:
    # Example: List GraphQL APIs (requires appropriate AWS credentials)
    response: ListGraphqlApisResponseTypeDef = client.list_graphql_apis()
    print("Successfully listed GraphQL APIs:")
    for api in response.get("graphqlApis", []):
        print(f"  - {api.get('name')} (API ID: {api.get('apiId')})")
except client.exceptions.UnauthorizedException as e:
    print(f"Authentication error: {e}. Make sure your AWS credentials are configured.")
except Exception as e:
    print(f"An error occurred: {e}")