mypy-boto3-connectcases

Warnings

• breaking Python 3.8 support has been removed across all `mypy-boto3-*` packages, including `mypy-boto3-connectcases`.
  Fix: Upgrade your Python environment to version 3.9 or higher.
• breaking All `mypy-boto3-*` packages have migrated to PEP 561, potentially affecting how type checkers discover packages if custom `mypy` configurations were relying on older mechanisms.
  Fix: Ensure `mypy` is updated to a recent version. If issues arise, re-evaluate your `mypy` configuration, especially `mypy_path` or `plugins` settings.
• gotcha This package provides *only* type stubs. It does not contain any runtime code or functionality. Always use `import boto3` for actual AWS SDK operations.
  Fix: Do not attempt to instantiate classes or call methods directly from `mypy_boto3_connectcases`. It is purely for static analysis.
• breaking TypeDef names have undergone changes in recent versions (e.g., `CreateDistributionRequestRequestTypeDef` to `CreateDistributionRequestTypeDef`), which can break code explicitly importing and using these `TypedDict` definitions.
  Fix: Review your code for any direct imports of `ResponseTypeDef` or `RequestTypeDef` and adjust their names according to the latest package structure. Consult the specific service's `mypy-boto3` documentation for exact type names.
• gotcha AWS service names used in `boto3.client()` calls are case-sensitive and may change or be deprecated (e.g., `sms-voice` was replaced by `pinpoint-sms-voice`). Ensure you use the correct, current service name string.
  Fix: Always verify the correct service name in the official `boto3` documentation or `mypy-boto3` stubs if you encounter `UnknownServiceError` or `mypy` errors related to service client types.

Install

• pip install mypy-boto3-connectcases Install type stubs
• pip install boto3 Install runtime dependency

Imports

• ConnectCasesClient

  from mypy_boto3_connectcases.client import ConnectCasesClient

  For explicit type annotations of the boto3 client object. Most specific types are in submodules.
• ListDomainsResponseTypeDef

  from mypy_boto3_connectcases.type_defs import ListDomainsResponseTypeDef

  For specific input/output TypedDicts. These are typically located in `type_defs`.
• boto3

  import boto3

  mypy-boto3-* packages provide type hints, not runtime functionality. Always import 'boto3' for runtime code.

Quickstart

This quickstart demonstrates how to use `boto3` with `mypy-boto3-connectcases` for type hinting. The `TYPE_CHECKING` block ensures that type-specific imports are only active during static analysis by `mypy`, preventing runtime errors. The `boto3.client` call benefits from the provided type annotations, improving code completion and error detection.

import boto3
from typing import TYPE_CHECKING

# These imports are only for type checking, they won't be used at runtime
if TYPE_CHECKING:
    from mypy_boto3_connectcases.client import ConnectCasesClient
    from mypy_boto3_connectcases.type_defs import ListDomainsResponseTypeDef

def get_connect_cases_domains() -> 'ListDomainsResponseTypeDef':
    # boto3 client creation is type-hinted by mypy-boto3-connectcases
    client: ConnectCasesClient = boto3.client("connectcases")
    
    # Example operation with type-hinted methods and response
    response = client.list_domains()
    print("Connect Cases Domains found:")
    for domain in response.get("domains", []):
        print(f"- Domain ARN: {domain.get('domainArn')}, Domain ID: {domain.get('domainId')}")
    return response

if __name__ == "__main__":
    try:
        # Ensure AWS credentials are configured (e.g., via ~/.aws/credentials or env vars)
        result = get_connect_cases_domains()
    except Exception as e:
        print(f"Error interacting with AWS Connect Cases: {e}")
        print("Please ensure AWS credentials are set up and the 'connectcases' service is available in your region.")