mypy-boto3 Chime SDK Identity Stubs

Warnings

• breaking Starting with `mypy-boto3-builder` version 8.12.0, Python 3.8 is no longer supported for any generated `mypy-boto3` package. This package specifically requires Python >=3.9.
  Fix: Upgrade your Python environment to 3.9 or newer. The `requires_python` metadata for `mypy-boto3-chime-sdk-identity` indicates `>=3.9`.
• breaking `mypy-boto3-builder` version 8.12.0 migrated all packages to follow PEP 561 standards. This primarily affects how type checkers resolve modules, potentially changing behavior if you relied on older resolution methods.
  Fix: Ensure your type checker (e.g., mypy) is up-to-date and correctly configured to handle PEP 561 stub packages. Typically, this is handled automatically by modern type checkers.
• breaking Builder version 8.9.0 introduced breaking changes to TypeDef naming conventions. Method argument TypeDefs may have shorter names (e.g., `CreateDistributionRequestRequestTypeDef` -> `CreateDistributionRequestTypeDef`), and `Extra` postfixes in conflicting TypeDefs were moved to the end (e.g., `CreateDistributionExtraRequestTypeDef` -> `CreateDistributionRequestExtraTypeDef`).
  Fix: Review and update any explicit TypeDef imports or references in your code if you are upgrading from `mypy-boto3-builder` versions prior to 8.9.0 and were using affected TypeDefs.
• gotcha This package provides *type stubs* for `boto3`. For your Python code to run and interact with AWS, the `boto3` library itself must be installed in your environment alongside these stubs.
  Fix: Always install `boto3` in addition to `mypy-boto3-chime-sdk-identity` using `pip install boto3 mypy-boto3-chime-sdk-identity`.
• gotcha PyCharm users might experience slow performance or high CPU usage due to how it handles `Literal` overloads (PyCharm issue PY-40997).
  Fix: Consider using `boto3-stubs-lite` (if available for your service) or disabling PyCharm's internal type checker and using external tools like `mypy` or `pyright` via a plugin for better performance in PyCharm. Alternatively, ensure PyCharm is updated to the latest version, as this issue might be resolved in newer IDE releases.

Install

• pip install mypy-boto3-chime-sdk-identity boto3 Install stubs and boto3

Imports

• ChimeSDKIdentityClient

  from mypy_boto3_chime_sdk_identity.client import ChimeSDKIdentityClient

  Import for explicit type annotation of the boto3 client object.
• ListAppInstancesResponseTypeDef

  from mypy_boto3_chime_sdk_identity.type_defs import ListAppInstancesResponseTypeDef

  Import for explicit type annotation of service response objects.

Quickstart

This quickstart demonstrates how to initialize a Chime SDK Identity client with type annotations and make a sample API call (`list_app_instances`). The explicit type hints for the client and response objects allow static analysis tools to provide enhanced code completion and error checking.

import boto3
from mypy_boto3_chime_sdk_identity.client import ChimeSDKIdentityClient
from mypy_boto3_chime_sdk_identity.type_defs import ListAppInstancesResponseTypeDef
import os

# Ensure boto3 is configured (e.g., via AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION_NAME env vars)
# For a runnable example, these might be placeholders or rely on default AWS config
# client: ChimeSDKIdentityClient = boto3.client(
#     "chime-sdk-identity",
#     region_name=os.environ.get('AWS_REGION', 'us-east-1')
# )

# Type-hinted client
client: ChimeSDKIdentityClient = boto3.client(
    "chime-sdk-identity",
    region_name="us-east-1" # Replace with your desired region
)

try:
    # Use the client with type hints for methods and arguments
    response: ListAppInstancesResponseTypeDef = client.list_app_instances(
        MaxResults=5
    )
    print("Successfully listed App Instances:")
    for app_instance in response.get('AppInstances', []):
        print(f"  - AppInstanceArn: {app_instance['AppInstanceArn']}")
        print(f"    Name: {app_instance['Name']}")

except client.exceptions.NotFoundException as e:
    print(f"Error: {e}")
except Exception as e:
    print(f"An unexpected error occurred: {e}")