Skip to content

AppSync module#

Index > AppSync

Auto-generated documentation for AppSync type annotations stubs module mypy-boto3-appsync.

How to install#

You can generate type annotations for boto3 package locally with mypy_boto3_builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.35.86' mypy_boto3_builder
  2. Select boto3-stubs AWS SDK.
  3. Add AppSync service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and AppSync.

From PyPI with pip#

Install boto3-stubs for AppSync service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[appsync]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[appsync]'

# standalone installation
python -m pip install mypy-boto3-appsync

How to uninstall#

python -m pip uninstall -y mypy-boto3-appsync

Usage#

Code samples can be found in Examples.

AppSyncClient#

Type annotations and code completion for boto3.client("appsync") as AppSyncClient boto3 documentation

# AppSyncClient usage example

from boto3.session import Session

from mypy_boto3_appsync.client import AppSyncClient

def get_client() -> AppSyncClient:
    return Session().client("appsync")

Paginators#

Type annotations and code completion for paginators from boto3.client("appsync").get_paginator("...").

# ListApiKeysPaginator usage example

from boto3.session import Session

from mypy_boto3_appsync.paginator import ListApiKeysPaginator

def get_list_api_keys_paginator() -> ListApiKeysPaginator:
    return Session().client("appsync").get_paginator("list_api_keys"))

Literals#

Type annotations for literals used in methods and schema.

# ApiCacheStatusType usage example

from mypy_boto3_appsync.literals import ApiCacheStatusType

def get_value() -> ApiCacheStatusType:
    return "AVAILABLE"

Type definitions#

Type annotations for type definitions used in methods and schema.