mypy-boto3-connect Type Stubs

Warnings

• breaking Support for Python 3.8 was removed in `mypy-boto3-builder` version 8.12.0. This affects all generated stubs, including `mypy-boto3-connect`. Ensure your project uses Python 3.9 or higher.
  Fix: Upgrade your Python environment to 3.9 or newer.
• breaking All `mypy-boto3` packages, including `mypy-boto3-connect`, migrated to PEP 561 compliant packages in `mypy-boto3-builder` version 8.12.0. This might affect how some tools discover and use stubs, though `mypy` typically handles this gracefully.
  Fix: Ensure your type-checking environment (e.g., `mypy`) is up-to-date. No specific code changes are typically required unless you're using custom stub discovery.
• breaking In `mypy-boto3-builder` version 8.9.0, TypeDef naming conventions changed for packed method arguments and conflicting names. TypeDefs like `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`, and `Extra` postfixes moved to the end (e.g., `CreateDistributionExtraRequestTypeDef` to `CreateDistributionRequestExtraTypeDef`). While `mypy-boto3-connect` may not directly use these specific examples, similar renames could affect Connect-specific TypeDefs.
  Fix: Review your code for any explicit imports of TypeDefs. If you encounter `NameError` or type-checking issues with TypeDefs, consult the `mypy_boto3_connect.type_defs` module for the updated names.
• deprecated The `sms-voice` service was deprecated and removed from `mypy-boto3-builder` in version 8.11.0. Users should migrate to `pinpoint-sms-voice` instead. This is a general `mypy-boto3` warning, not directly affecting `mypy-boto3-connect`, but important for users of the overall `mypy-boto3` ecosystem.
  Fix: If using SMS Voice, migrate to `mypy-boto3-pinpoint-sms-voice`.
• gotcha You must install `boto3` alongside `mypy-boto3-connect`. `mypy-boto3-connect` only provides type stubs and does not include the runtime `boto3` library itself. Without `boto3`, your code will fail at runtime.
  Fix: Ensure `pip install boto3 mypy-boto3-connect` is run to install both the runtime library and its type stubs.

Install

• pip install boto3 mypy-boto3-connect mypy Install with Mypy

Imports

• ConnectClient

  from mypy_boto3_connect import ConnectClient

• ConnectServiceResource

  from mypy_boto3_connect import ConnectServiceResource

• InstanceTypeDef

  from mypy_boto3_connect.type_defs import InstanceTypeDef

  Type definitions are typically found in the `type_defs` submodule, not directly in `client`.

Quickstart

This quickstart demonstrates how to import `ConnectClient` and use it to type-hint a `boto3` AWS Connect client. It shows an example of using type-hinted request parameters for `create_instance` and retrieving `InstanceTypeDef` from the response, leveraging the static type checking provided by `mypy-boto3-connect`.

import boto3
from mypy_boto3_connect import ConnectClient
from mypy_boto3_connect.type_defs import CreateInstanceRequestRequestTypeDef, InstanceTypeDef

# Instantiate the boto3 client and cast it to the Mypy-Boto3 type for type checking
connect_client: ConnectClient = boto3.client("connect")

# Example usage with type-hinted data
# Note: This is a placeholder; actual Connect operations might require more complex setup.
# Replace with actual data relevant to your AWS Connect instance.
create_instance_request: CreateInstanceRequestRequestTypeDef = {
    "ClientToken": "example-token",
    "IdentityManagementType": "SAML", # Other options: 'CONNECT_MANAGED', 'EXISTING_DIRECTORY'
    "InstanceAlias": "my-test-instance-alias",
    "DirectoryId": "dir-xxxxxxxx", # Required if IdentityManagementType is EXISTING_DIRECTORY
    "InboundCallsEnabled": True,
    "OutboundCallsEnabled": True
}

# The actual call might fail without correct setup, this demonstrates type usage
try:
    # This call is illustrative for type checking, it will likely fail without a real setup.
    response = connect_client.create_instance(
        IdentityManagementType=create_instance_request["IdentityManagementType"],
        InstanceAlias=create_instance_request["InstanceAlias"],
        InboundCallsEnabled=create_instance_request["InboundCallsEnabled"],
        OutboundCallsEnabled=create_instance_request["OutboundCallsEnabled"]
    )
    # The response object will also be type-hinted if Mypy is run
    instance_summary: InstanceTypeDef = response["InstanceSummary"]
    print(f"Instance created with ARN: {instance_summary['Arn']}")
except Exception as e:
    print(f"Could not create instance (this is expected without a valid setup): {e}")

# Example of getting an existing instance (requires an actual instance ARN)
try:
    # Replace with a real instance ARN if you want to test live
    instance_id = "arn:aws:connect:REGION:ACCOUNT_ID:instance/INSTANCE_ID"
    # This call is illustrative for type checking
    response = connect_client.describe_instance(InstanceId=instance_id)
    instance_summary: InstanceTypeDef = response['Instance']['InstanceSummary']
    print(f"Described instance ID: {instance_summary['Id']}")
except connect_client.exceptions.ResourceNotFoundException:
    print(f"Instance {instance_id} not found.")
except Exception as e:
    print(f"Could not describe instance (this is expected without a valid ARN): {e}")