Polly module#
Index > Polly
Auto-generated documentation for Polly type annotations stubs module types-boto3-polly.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.35.86' mypy_boto3_builder
- Select
boto3
AWS SDK. - Add
Polly
service. - Use provided commands to install generated packages.
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 types-boto3
for Polly
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[polly]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[polly]'
# standalone installation
python -m pip install types-boto3-polly
How to uninstall#
python -m pip uninstall -y types-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 types_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 types_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 types_boto3_polly.literals import DescribeVoicesPaginatorName
def get_value() -> DescribeVoicesPaginatorName:
return "describe_voices"
- DescribeVoicesPaginatorName
- EngineType
- GenderType
- LanguageCodeType
- ListLexiconsPaginatorName
- ListSpeechSynthesisTasksPaginatorName
- OutputFormatType
- SpeechMarkTypeType
- TaskStatusType
- TextTypeType
- VoiceIdType
- PollyServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- DeleteLexiconInputRequestTypeDef
- PaginatorConfigTypeDef
- DescribeVoicesInputRequestTypeDef
- ResponseMetadataTypeDef
- VoiceTypeDef
- GetLexiconInputRequestTypeDef
- LexiconAttributesTypeDef
- LexiconTypeDef
- GetSpeechSynthesisTaskInputRequestTypeDef
- SynthesisTaskTypeDef
- ListLexiconsInputRequestTypeDef
- ListSpeechSynthesisTasksInputRequestTypeDef
- PutLexiconInputRequestTypeDef
- StartSpeechSynthesisTaskInputRequestTypeDef
- SynthesizeSpeechInputRequestTypeDef
- DescribeVoicesInputPaginateTypeDef
- ListLexiconsInputPaginateTypeDef
- ListSpeechSynthesisTasksInputPaginateTypeDef
- SynthesizeSpeechOutputTypeDef
- DescribeVoicesOutputTypeDef
- LexiconDescriptionTypeDef
- GetLexiconOutputTypeDef
- GetSpeechSynthesisTaskOutputTypeDef
- ListSpeechSynthesisTasksOutputTypeDef
- StartSpeechSynthesisTaskOutputTypeDef
- ListLexiconsOutputTypeDef