Paginators

Index > Support > Paginators

Auto-generated documentation for Support type annotations stubs module mypy-boto3-support.

DescribeCasesPaginator

Type annotations and code completion for boto3.client("support").get_paginator("describe_cases"). boto3 documentation

# DescribeCasesPaginator usage example

from boto3.session import Session

from mypy_boto3_support.paginator import DescribeCasesPaginator

def get_describe_cases_paginator() -> DescribeCasesPaginator:
    return Session().client("support").get_paginator("describe_cases")

# DescribeCasesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_support.paginator import DescribeCasesPaginator

session = Session()

client = Session().client("support")  # (1)
paginator: DescribeCasesPaginator = client.get_paginator("describe_cases")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: SupportClient
2. paginator: DescribeCasesPaginator
3. item: DescribeCasesResponseTypeDef

paginate

Type annotations and code completion for DescribeCasesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    caseIdList: Sequence[str] = ...,
    displayId: str = ...,
    afterTime: str = ...,
    beforeTime: str = ...,
    includeResolvedCases: bool = ...,
    language: str = ...,
    includeCommunications: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[DescribeCasesResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See DescribeCasesResponseTypeDef

# paginate method usage example with argument unpacking

kwargs: DescribeCasesRequestPaginateTypeDef = {  # (1)
    "caseIdList": ...,
}

parent.paginate(**kwargs)

1. See DescribeCasesRequestPaginateTypeDef

DescribeCommunicationsPaginator

Type annotations and code completion for boto3.client("support").get_paginator("describe_communications"). boto3 documentation

# DescribeCommunicationsPaginator usage example

from boto3.session import Session

from mypy_boto3_support.paginator import DescribeCommunicationsPaginator

def get_describe_communications_paginator() -> DescribeCommunicationsPaginator:
    return Session().client("support").get_paginator("describe_communications")

# DescribeCommunicationsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_support.paginator import DescribeCommunicationsPaginator

session = Session()

client = Session().client("support")  # (1)
paginator: DescribeCommunicationsPaginator = client.get_paginator("describe_communications")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: SupportClient
2. paginator: DescribeCommunicationsPaginator
3. item: DescribeCommunicationsResponseTypeDef

paginate

Type annotations and code completion for DescribeCommunicationsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    caseId: str,
    beforeTime: str = ...,
    afterTime: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[DescribeCommunicationsResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See DescribeCommunicationsResponseTypeDef

# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)

1. See DescribeCommunicationsRequestPaginateTypeDef