Paginators

Index > Polly > Paginators

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

DescribeVoicesPaginator

Type annotations and code completion for boto3.client("polly").get_paginator("describe_voices"). boto3 documentation

# 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")

# DescribeVoicesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_polly.paginator import DescribeVoicesPaginator

session = Session()

client = Session().client("polly")  # (1)
paginator: DescribeVoicesPaginator = client.get_paginator("describe_voices")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: PollyClient
2. paginator: DescribeVoicesPaginator
3. item: DescribeVoicesOutputTypeDef

paginate

Type annotations and code completion for DescribeVoicesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Engine: EngineType = ...,  # (1)
    LanguageCode: LanguageCodeType = ...,  # (2)
    IncludeAdditionalLanguageCodes: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (3)
) -> PageIterator[DescribeVoicesOutputTypeDef]:  # (4)
    ...

1. See EngineType
2. See LanguageCodeType
3. See PaginatorConfigTypeDef
4. See DescribeVoicesOutputTypeDef

# paginate method usage example with argument unpacking

kwargs: DescribeVoicesInputPaginateTypeDef = {  # (1)
    "Engine": ...,
}

parent.paginate(**kwargs)

1. See DescribeVoicesInputPaginateTypeDef

ListLexiconsPaginator

Type annotations and code completion for boto3.client("polly").get_paginator("list_lexicons"). boto3 documentation

# ListLexiconsPaginator usage example

from boto3.session import Session

from types_boto3_polly.paginator import ListLexiconsPaginator

def get_list_lexicons_paginator() -> ListLexiconsPaginator:
    return Session().client("polly").get_paginator("list_lexicons")

# ListLexiconsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_polly.paginator import ListLexiconsPaginator

session = Session()

client = Session().client("polly")  # (1)
paginator: ListLexiconsPaginator = client.get_paginator("list_lexicons")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: PollyClient
2. paginator: ListLexiconsPaginator
3. item: ListLexiconsOutputTypeDef

paginate

Type annotations and code completion for ListLexiconsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[ListLexiconsOutputTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ListLexiconsOutputTypeDef

# paginate method usage example with argument unpacking

kwargs: ListLexiconsInputPaginateTypeDef = {  # (1)
    "PaginationConfig": ...,
}

parent.paginate(**kwargs)

1. See ListLexiconsInputPaginateTypeDef

ListSpeechSynthesisTasksPaginator

Type annotations and code completion for boto3.client("polly").get_paginator("list_speech_synthesis_tasks"). boto3 documentation

# ListSpeechSynthesisTasksPaginator usage example

from boto3.session import Session

from types_boto3_polly.paginator import ListSpeechSynthesisTasksPaginator

def get_list_speech_synthesis_tasks_paginator() -> ListSpeechSynthesisTasksPaginator:
    return Session().client("polly").get_paginator("list_speech_synthesis_tasks")

# ListSpeechSynthesisTasksPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_polly.paginator import ListSpeechSynthesisTasksPaginator

session = Session()

client = Session().client("polly")  # (1)
paginator: ListSpeechSynthesisTasksPaginator = client.get_paginator("list_speech_synthesis_tasks")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: PollyClient
2. paginator: ListSpeechSynthesisTasksPaginator
3. item: ListSpeechSynthesisTasksOutputTypeDef

paginate

Type annotations and code completion for ListSpeechSynthesisTasksPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Status: TaskStatusType = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> PageIterator[ListSpeechSynthesisTasksOutputTypeDef]:  # (3)
    ...

1. See TaskStatusType
2. See PaginatorConfigTypeDef
3. See ListSpeechSynthesisTasksOutputTypeDef

# paginate method usage example with argument unpacking

kwargs: ListSpeechSynthesisTasksInputPaginateTypeDef = {  # (1)
    "Status": ...,
}

parent.paginate(**kwargs)

1. See ListSpeechSynthesisTasksInputPaginateTypeDef