Type annotations for boto3 Connect Campaign Service V2

Warnings

• breaking Python 3.8 support has been removed. `mypy-boto3` packages (including this one) now require Python 3.9 or higher.
  Fix: Upgrade your Python environment to 3.9 or newer. Ensure your `pyproject.toml` or `setup.cfg` reflects `requires-python >= 3.9`.
• breaking Migration to PEP 561 packages. This is an internal change primarily affecting how Python tools discover stubs.
  Fix: No direct code change required for users. Ensure your `mypy` or `pyright` configurations are up-to-date and correctly configured to find third-party stubs.
• breaking TypeDef names for packed method arguments were shortened. E.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`.
  Fix: Review and update your import paths and variable annotations for `TypeDef` objects to use the new shorter names.
• gotcha This package only provides type stubs. You must also install `boto3` (the actual AWS SDK) for your code to run.
  Fix: Always install `boto3` alongside `mypy-boto3-connectcampaignsv2` (e.g., `pip install boto3 mypy-boto3-connectcampaignsv2`).
• gotcha Version mismatch between `boto3` and `mypy-boto3-*` can lead to incorrect or missing type hints.
  Fix: Try to keep `boto3` and `mypy-boto3-*` packages in sync. `pip install mypy-boto3-builder` can generate stubs compatible with your installed `boto3` version locally.
• gotcha Omitting `if TYPE_CHECKING:` for type imports will make `mypy-boto3-connectcampaignsv2` a runtime dependency, which is unnecessary overhead.
  Fix: Always encapsulate type-only imports within `from typing import TYPE_CHECKING` blocks.

Install

• pip install mypy-boto3-connectcampaignsv2 boto3 Install library and boto3
• pip install mypy Install MyPy (for type checking)

Imports

• ConnectCampaignServiceV2Client

  from mypy_boto3_connectcampaignsv2.client import ConnectCampaignServiceV2Client

  Client type is specifically within the 'client' submodule.
• ListCampaignsResponseTypeDef

  from mypy_boto3_connectcampaignsv2.type_defs import ListCampaignsResponseTypeDef

  Type definitions for response objects are crucial for comprehensive type checking.
• TYPE_CHECKING

  from typing import TYPE_CHECKING
  
  if TYPE_CHECKING:
      from mypy_boto3_connectcampaignsv2.client import ConnectCampaignServiceV2Client

  Imports for type-checking only should be guarded by `if TYPE_CHECKING:` to avoid adding stubs as runtime dependencies.

Quickstart

Demonstrates how to initialize a type-hinted `boto3` client for ConnectCampaignServiceV2 and perform a simple operation (`list_campaigns`). The `if TYPE_CHECKING:` block ensures that the `mypy-boto3` stubs are only used for static analysis and not as a runtime dependency. Ensure AWS credentials are set in your environment for `boto3` to function.

from __future__ import annotations
import boto3
import os
from typing import TYPE_CHECKING

# Guard type-only imports with TYPE_CHECKING
if TYPE_CHECKING:
    from mypy_boto3_connectcampaignsv2.client import ConnectCampaignServiceV2Client
    from mypy_boto3_connectcampaignsv2.type_defs import ListCampaignsResponseTypeDef

def list_all_connect_campaigns() -> ListCampaignsResponseTypeDef:
    """Lists all Connect Campaigns using type-hinted boto3 client."""
    # boto3 client is dynamically typed by default
    # The type hint from mypy-boto3 provides static analysis capabilities
    client: ConnectCampaignServiceV2Client = boto3.client(
        "connectcampaignsv2",
        region_name=os.environ.get("AWS_REGION", "us-east-1"),
        aws_access_key_id=os.environ.get("AWS_ACCESS_KEY_ID", ""),
        aws_secret_access_key=os.environ.get("AWS_SECRET_ACCESS_KEY", "")
    )

    print("Fetching Connect Campaigns...")
    response: ListCampaignsResponseTypeDef = client.list_campaigns()
    
    for campaign in response.get("campaigns", []):
        print(f"  Campaign ID: {campaign.get('id')}, Name: {campaign.get('name')}")
    
    print(f"Total campaigns found: {len(response.get('campaigns', []))}")
    return response

if __name__ == "__main__":
    # This code will run even without mypy-boto3 installed, 
    # but mypy would check its types during static analysis.
    campaign_data = list_all_connect_campaigns()
    # You can access typed attributes here, e.g., campaign_data['campaigns']