Examples#
Auto-generated documentation for Polly type annotations stubs module types-aiobotocore-polly.
Client#
Implicit type annotations#
Can be used with types-aiobotocore[polly]
package installed.
Write your Polly
code as usual,
type checking and code completion should work out of the box.
Client method usage example#
# PollyClient usage example
from aiobotocore.session import get_session
session = get_session()
async with session.create_client("polly") as client: # (1)
result = await client.describe_voices() # (2)
- client: PollyClient
- result: DescribeVoicesOutputTypeDef
Paginator usage example#
# DescribeVoicesPaginator usage example
from aiobotocore.session import get_session
session = get_session()
async with session.create_client("polly") as client: # (1)
paginator = client.get_paginator("describe_voices") # (2)
async for item in paginator.paginate(...):
print(item) # (3)
- client: PollyClient
- paginator: DescribeVoicesPaginator
- item: DescribeVoicesOutputTypeDef
Explicit type annotations#
With types-aiobotocore-lite[polly]
or a standalone types_aiobotocore_polly
package, you have to explicitly specify
client: PollyClient
type annotation.
All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.
Client method usage example#
# PollyClient usage example with type annotations
from aiobotocore.session import get_session
from types_aiobotocore_polly.client import PollyClient
from types_aiobotocore_polly.type_defs import DescribeVoicesOutputTypeDef
from types_aiobotocore_polly.type_defs import DescribeVoicesInputTypeDef
session = get_session()
async with session.create_client("polly") as client:
client: PollyClient
kwargs: DescribeVoicesInputTypeDef = {...}
result: DescribeVoicesOutputTypeDef = await client.describe_voices(**kwargs)
Paginator usage example#
# DescribeVoicesPaginator usage example with type annotations
from aiobotocore.session import get_session
from types_aiobotocore_polly.client import PollyClient
from types_aiobotocore_polly.paginator import DescribeVoicesPaginator
from types_aiobotocore_polly.type_defs import DescribeVoicesOutputTypeDef
session = get_session()
async with session.create_client("polly") as client:
client: PollyClient
paginator: DescribeVoicesPaginator = client.get_paginator("describe_voices")
async for item in paginator.paginate(...):
item: DescribeVoicesOutputTypeDef
print(item)