Paginators

Index > OpenSearchService > Paginators

Auto-generated documentation for OpenSearchService type annotations stubs module mypy-boto3-opensearch.

ListApplicationsPaginator

Type annotations and code completion for boto3.client("opensearch").get_paginator("list_applications"). boto3 documentation

# ListApplicationsPaginator usage example

from boto3.session import Session

from mypy_boto3_opensearch.paginator import ListApplicationsPaginator

def get_list_applications_paginator() -> ListApplicationsPaginator:
    return Session().client("opensearch").get_paginator("list_applications")

# ListApplicationsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_opensearch.paginator import ListApplicationsPaginator

session = Session()

client = Session().client("opensearch")  # (1)
paginator: ListApplicationsPaginator = client.get_paginator("list_applications")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: OpenSearchServiceClient
2. paginator: ListApplicationsPaginator
3. item: ListApplicationsResponseTypeDef

paginate

Type annotations and code completion for ListApplicationsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    statuses: Sequence[ApplicationStatusType] = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> PageIterator[ListApplicationsResponseTypeDef]:  # (3)
    ...

1. See ApplicationStatusType
2. See PaginatorConfigTypeDef
3. See ListApplicationsResponseTypeDef

# paginate method usage example with argument unpacking

kwargs: ListApplicationsRequestPaginateTypeDef = {  # (1)
    "statuses": ...,
}

parent.paginate(**kwargs)

1. See ListApplicationsRequestPaginateTypeDef