Paginators

Index > IoTDataPlane > Paginators

Auto-generated documentation for IoTDataPlane type annotations stubs module mypy-boto3-iot-data.

ListRetainedMessagesPaginator

Type annotations and code completion for boto3.client("iot-data").get_paginator("list_retained_messages"). boto3 documentation

# ListRetainedMessagesPaginator usage example

from boto3.session import Session

from mypy_boto3_iot_data.paginator import ListRetainedMessagesPaginator

def get_list_retained_messages_paginator() -> ListRetainedMessagesPaginator:
    return Session().client("iot-data").get_paginator("list_retained_messages")

# ListRetainedMessagesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_iot_data.paginator import ListRetainedMessagesPaginator

session = Session()

client = Session().client("iot-data")  # (1)
paginator: ListRetainedMessagesPaginator = client.get_paginator("list_retained_messages")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: IoTDataPlaneClient
2. paginator: ListRetainedMessagesPaginator
3. item: ListRetainedMessagesResponseTypeDef

paginate

Type annotations and code completion for ListRetainedMessagesPaginator.paginate method.

# paginate method definition

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

1. See PaginatorConfigTypeDef
2. See ListRetainedMessagesResponseTypeDef

# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)

1. See ListRetainedMessagesRequestPaginateTypeDef