Paginators

Index > ConnectCases > Paginators

Auto-generated documentation for ConnectCases type annotations stubs module mypy-boto3-connectcases.

SearchCasesPaginator

Type annotations and code completion for boto3.client("connectcases").get_paginator("search_cases"). boto3 documentation

# SearchCasesPaginator usage example

from boto3.session import Session

from mypy_boto3_connectcases.paginator import SearchCasesPaginator

def get_search_cases_paginator() -> SearchCasesPaginator:
    return Session().client("connectcases").get_paginator("search_cases")

# SearchCasesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_connectcases.paginator import SearchCasesPaginator

session = Session()

client = Session().client("connectcases")  # (1)
paginator: SearchCasesPaginator = client.get_paginator("search_cases")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: ConnectCasesClient
2. paginator: SearchCasesPaginator
3. item: SearchCasesResponseTypeDef

paginate

Type annotations and code completion for SearchCasesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    domainId: str,
    fields: Sequence[FieldIdentifierTypeDef] = ...,  # (1)
    filter: CaseFilterPaginatorTypeDef = ...,  # (2)
    searchTerm: str = ...,
    sorts: Sequence[SortTypeDef] = ...,  # (3)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (4)
) -> _PageIterator[SearchCasesResponseTypeDef]:  # (5)
    ...

1. See FieldIdentifierTypeDef
2. See CaseFilterPaginatorTypeDef
3. See SortTypeDef
4. See PaginatorConfigTypeDef
5. See SearchCasesResponseTypeDef

# paginate method usage example with argument unpacking

kwargs: SearchCasesRequestSearchCasesPaginateTypeDef = {  # (1)
    "domainId": ...,
}

parent.paginate(**kwargs)

1. See SearchCasesRequestSearchCasesPaginateTypeDef

SearchRelatedItemsPaginator

Type annotations and code completion for boto3.client("connectcases").get_paginator("search_related_items"). boto3 documentation

# SearchRelatedItemsPaginator usage example

from boto3.session import Session

from mypy_boto3_connectcases.paginator import SearchRelatedItemsPaginator

def get_search_related_items_paginator() -> SearchRelatedItemsPaginator:
    return Session().client("connectcases").get_paginator("search_related_items")

# SearchRelatedItemsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_connectcases.paginator import SearchRelatedItemsPaginator

session = Session()

client = Session().client("connectcases")  # (1)
paginator: SearchRelatedItemsPaginator = client.get_paginator("search_related_items")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: ConnectCasesClient
2. paginator: SearchRelatedItemsPaginator
3. item: SearchRelatedItemsResponseTypeDef

paginate

Type annotations and code completion for SearchRelatedItemsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    caseId: str,
    domainId: str,
    filters: Sequence[RelatedItemTypeFilterTypeDef] = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> _PageIterator[SearchRelatedItemsResponseTypeDef]:  # (3)
    ...

1. See RelatedItemTypeFilterTypeDef
2. See PaginatorConfigTypeDef
3. See SearchRelatedItemsResponseTypeDef

# paginate method usage example with argument unpacking

kwargs: SearchRelatedItemsRequestSearchRelatedItemsPaginateTypeDef = {  # (1)
    "caseId": ...,
    "domainId": ...,
}

parent.paginate(**kwargs)

1. See SearchRelatedItemsRequestSearchRelatedItemsPaginateTypeDef