Paginators

Index > ConnectCases > Paginators

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

ListCaseRulesPaginator

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

# ListCaseRulesPaginator usage example

from boto3.session import Session

from types_boto3_connectcases.paginator import ListCaseRulesPaginator

def get_list_case_rules_paginator() -> ListCaseRulesPaginator:
    return Session().client("connectcases").get_paginator("list_case_rules")

# ListCaseRulesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_connectcases.paginator import ListCaseRulesPaginator

session = Session()

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

1. client: ConnectCasesClient
2. paginator: ListCaseRulesPaginator
3. item: PageIterator[ListCaseRulesResponseTypeDef]

paginate

Type annotations and code completion for ListCaseRulesPaginator.paginate method.

# paginate method definition

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

1. See PaginatorConfigTypeDef
2. See PageIterator[ListCaseRulesResponseTypeDef]

# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)

1. See ListCaseRulesRequestPaginateTypeDef

SearchAllRelatedItemsPaginator

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

# SearchAllRelatedItemsPaginator usage example

from boto3.session import Session

from types_boto3_connectcases.paginator import SearchAllRelatedItemsPaginator

def get_search_all_related_items_paginator() -> SearchAllRelatedItemsPaginator:
    return Session().client("connectcases").get_paginator("search_all_related_items")

# SearchAllRelatedItemsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_connectcases.paginator import SearchAllRelatedItemsPaginator

session = Session()

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

1. client: ConnectCasesClient
2. paginator: SearchAllRelatedItemsPaginator
3. item: PageIterator[SearchAllRelatedItemsResponseTypeDef]

paginate

Type annotations and code completion for SearchAllRelatedItemsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    domainId: str,
    filters: Sequence[RelatedItemTypeFilterPaginatorTypeDef] = ...,  # (1)
    sorts: Sequence[SearchAllRelatedItemsSortTypeDef] = ...,  # (2)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (3)
) -> botocore.paginate.PageIterator[SearchAllRelatedItemsResponseTypeDef]:  # (4)
    ...

1. See Sequence[RelatedItemTypeFilterPaginatorTypeDef]
2. See Sequence[SearchAllRelatedItemsSortTypeDef]
3. See PaginatorConfigTypeDef
4. See PageIterator[SearchAllRelatedItemsResponseTypeDef]

# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)

1. See SearchAllRelatedItemsRequestPaginateTypeDef

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 types_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 types_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: PageIterator[SearchCasesResponseTypeDef]

paginate

Type annotations and code completion for SearchCasesPaginator.paginate method.

# paginate method definition

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

1. See CaseFilterPaginatorTypeDef
2. See Sequence[SortTypeDef]
3. See Sequence[FieldIdentifierTypeDef]
4. See PaginatorConfigTypeDef
5. See PageIterator[SearchCasesResponseTypeDef]

# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)

1. See SearchCasesRequestPaginateTypeDef

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 types_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 types_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: PageIterator[SearchRelatedItemsResponseTypeDef]

paginate

Type annotations and code completion for SearchRelatedItemsPaginator.paginate method.

# paginate method definition

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

1. See Sequence[RelatedItemTypeFilterPaginatorTypeDef]
2. See PaginatorConfigTypeDef
3. See PageIterator[SearchRelatedItemsResponseTypeDef]

# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)

1. See SearchRelatedItemsRequestPaginateTypeDef