Paginators

Index > ConnectCampaignService > Paginators

Auto-generated documentation for ConnectCampaignService type annotations stubs module mypy-boto3-connectcampaigns.

ListCampaignsPaginator

Type annotations and code completion for boto3.client("connectcampaigns").get_paginator("list_campaigns"). boto3 documentation

# ListCampaignsPaginator usage example

from boto3.session import Session

from mypy_boto3_connectcampaigns.paginator import ListCampaignsPaginator

def get_list_campaigns_paginator() -> ListCampaignsPaginator:
    return Session().client("connectcampaigns").get_paginator("list_campaigns")

# ListCampaignsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_connectcampaigns.paginator import ListCampaignsPaginator

session = Session()

client = Session().client("connectcampaigns")  # (1)
paginator: ListCampaignsPaginator = client.get_paginator("list_campaigns")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: ConnectCampaignServiceClient
2. paginator: ListCampaignsPaginator
3. item: ListCampaignsResponseTypeDef

paginate

Type annotations and code completion for ListCampaignsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    filters: CampaignFiltersTypeDef = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> _PageIterator[ListCampaignsResponseTypeDef]:  # (3)
    ...

1. See CampaignFiltersTypeDef
2. See PaginatorConfigTypeDef
3. See ListCampaignsResponseTypeDef

# paginate method usage example with argument unpacking

kwargs: ListCampaignsRequestListCampaignsPaginateTypeDef = {  # (1)
    "filters": ...,
}

parent.paginate(**kwargs)

1. See ListCampaignsRequestListCampaignsPaginateTypeDef