Skip to content

Polly module#

Index > Polly

Auto-generated documentation for Polly type annotations stubs module mypy-boto3-polly.

How to install#

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and Polly.

From PyPI with pip#

Install boto3-stubs for Polly service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[polly]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[polly]'


# standalone installation
python -m pip install mypy-boto3-polly

How to uninstall#

python -m pip uninstall -y mypy-boto3-polly

Usage#

Code samples can be found in Examples.

PollyClient#

Type annotations and code completion for boto3.client("polly") as PollyClient boto3 documentation

# PollyClient usage example

from boto3.session import Session

from mypy_boto3_polly.client import PollyClient

def get_client() -> PollyClient:
    return Session().client("polly")

Paginators#

Type annotations and code completion for paginators from boto3.client("polly").get_paginator("...").

# DescribeVoicesPaginator usage example

from boto3.session import Session

from mypy_boto3_polly.paginator import DescribeVoicesPaginator

def get_describe_voices_paginator() -> DescribeVoicesPaginator:
    return Session().client("polly").get_paginator("describe_voices"))

Literals#

Type annotations for literals used in methods and schema.

# DescribeVoicesPaginatorName usage example

from mypy_boto3_polly.literals import DescribeVoicesPaginatorName

def get_value() -> DescribeVoicesPaginatorName:
    return "describe_voices"

Type definitions#

Type annotations for type definitions used in methods and schema.