Type Annotations for boto3 Voice ID

1.42.3 · active · verified Sat Apr 11

mypy-boto3-voice-id provides static type annotations for the AWS Voice ID service within the `boto3` library. It enhances developer experience with tools like MyPy, Pyright, and IDEs, offering features like autocompletion and static type checking for `boto3.client('voice-id')` calls. This package, currently at version 1.42.3, is automatically generated by the `youtype/mypy_boto3_builder` project, ensuring type definitions are kept up-to-date with the corresponding `boto3` releases.

Warnings

breaking The underlying `mypy_boto3_builder` project (which generates this package) removed support for Python 3.8 in version 8.12.0. `mypy-boto3-voice-id` versions generated with `builder` 8.12.0 or newer require Python 3.9 or higher.
Fix: Upgrade your Python environment to 3.9 or newer. Consider pinning to an older `mypy-boto3-voice-id` version if Python 3.8 is strictly required (though this is not recommended).
breaking In `mypy_boto3_builder` version 8.9.0, the naming convention for TypeDefs used for packed method arguments was shortened. For example, `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`. This affects explicit type hints in your code.
Fix: Review and update explicit `TypeDef` annotations in your code to match the new, shorter names. Consult the specific service documentation for the exact `TypeDef` names.
gotcha When using `TYPE_CHECKING` guards to conditionally import type stubs (a common pattern for production deployments), Pylint may report `undefined-variable` errors for the type-hinted objects.
Fix: To resolve Pylint issues, set the type-hinted variables to `object` in the `else` branch of the `TYPE_CHECKING` block. Example: `if TYPE_CHECKING: from mypy_boto3_ec2.client import EC2Client else: EC2Client = object`.
gotcha PyCharm has known performance issues when dealing with Python's `Literal` overloads, which are extensively used in `mypy-boto3` type stubs. This can lead to slower IDE performance.
Fix: If experiencing performance issues in PyCharm, consider installing the 'lite' version of `boto3-stubs` (e.g., `pip install boto3-stubs-lite[voice-id]`) which provides a more lightweight set of type annotations, albeit with some reduced granularity.

Install

pip install mypy-boto3-voice-id Install standalone package
pip install 'boto3-stubs[voice-id]' Install as part of boto3-stubs meta-package

Imports

VoiceIDClient

from mypy_boto3_voice_id.client import VoiceIDClient

VoiceIDPaginator
```
from mypy_boto3_voice_id.paginators import VoiceIDPaginator
```
Paginator classes are specific to the service and methods (e.g., ListDomainsPaginator). VoiceIDPaginator is a base type.

CreateDomainRequestTypeDef

from mypy_boto3_voice_id.type_defs import CreateDomainRequestTypeDef

Quickstart

This quickstart demonstrates how to use `mypy-boto3-voice-id` for type-hinting a `boto3` Voice ID client and its responses. It utilizes a `TYPE_CHECKING` guard to ensure the type stubs are only used during static analysis, preventing a runtime dependency in production environments.

import boto3
from typing import TYPE_CHECKING

# Recommended: Use TYPE_CHECKING to avoid runtime dependency on mypy-boto3-voice-id
if TYPE_CHECKING:
    from mypy_boto3_voice_id.client import VoiceIDClient
    from mypy_boto3_voice_id.type_defs import ListDomainsResponseTypeDef

def list_voice_id_domains():
    # Type-hint the boto3 client for static analysis
    client: VoiceIDClient = boto3.client("voice-id")
    
    # The response will also be type-checked
    response: ListDomainsResponseTypeDef = client.list_domains()
    
    print("Voice ID Domains:")
    for domain in response.get("DomainSummaries", []):
        print(f"  ID: {domain['DomainId']}, Name: {domain['Name']}")

if __name__ == "__main__":
    # Ensure AWS credentials are configured (e.g., via AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY)
    # or AWS CLI config for this to run successfully.
    list_voice_id_domains()

view raw JSON →