Skip to content

Paginators#

Index > PartnerCentralBenefits > Paginators

Auto-generated documentation for PartnerCentralBenefits type annotations stubs module mypy-boto3-partnercentral-benefits.

ListBenefitAllocationsPaginator#

Type annotations and code completion for boto3.client("partnercentral-benefits").get_paginator("list_benefit_allocations"). boto3 documentation

# ListBenefitAllocationsPaginator usage example

from boto3.session import Session

from mypy_boto3_partnercentral_benefits.paginator import ListBenefitAllocationsPaginator

def get_list_benefit_allocations_paginator() -> ListBenefitAllocationsPaginator:
    return Session().client("partnercentral-benefits").get_paginator("list_benefit_allocations")
# ListBenefitAllocationsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_partnercentral_benefits.paginator import ListBenefitAllocationsPaginator

session = Session()

client = Session().client("partnercentral-benefits")  # (1)
paginator: ListBenefitAllocationsPaginator = client.get_paginator("list_benefit_allocations")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: PartnerCentralBenefitsClient
  2. paginator: ListBenefitAllocationsPaginator
  3. item: PageIterator[ListBenefitAllocationsOutputTypeDef]

paginate#

Type annotations and code completion for ListBenefitAllocationsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Catalog: str,
    FulfillmentTypes: Sequence[FulfillmentTypeType] = ...,  # (1)
    BenefitIdentifiers: Sequence[str] = ...,
    BenefitApplicationIdentifiers: Sequence[str] = ...,
    Status: Sequence[BenefitAllocationStatusType] = ...,  # (2)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (3)
) -> botocore.paginate.PageIterator[ListBenefitAllocationsOutputTypeDef]:  # (4)
    ...
  1. See Sequence[FulfillmentTypeType]
  2. See Sequence[BenefitAllocationStatusType]
  3. See PaginatorConfigTypeDef
  4. See PageIterator[ListBenefitAllocationsOutputTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListBenefitAllocationsInputPaginateTypeDef = {  # (1)
    "Catalog": ...,
}

parent.paginate(**kwargs)
  1. See ListBenefitAllocationsInputPaginateTypeDef

ListBenefitApplicationsPaginator#

Type annotations and code completion for boto3.client("partnercentral-benefits").get_paginator("list_benefit_applications"). boto3 documentation

# ListBenefitApplicationsPaginator usage example

from boto3.session import Session

from mypy_boto3_partnercentral_benefits.paginator import ListBenefitApplicationsPaginator

def get_list_benefit_applications_paginator() -> ListBenefitApplicationsPaginator:
    return Session().client("partnercentral-benefits").get_paginator("list_benefit_applications")
# ListBenefitApplicationsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_partnercentral_benefits.paginator import ListBenefitApplicationsPaginator

session = Session()

client = Session().client("partnercentral-benefits")  # (1)
paginator: ListBenefitApplicationsPaginator = client.get_paginator("list_benefit_applications")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: PartnerCentralBenefitsClient
  2. paginator: ListBenefitApplicationsPaginator
  3. item: PageIterator[ListBenefitApplicationsOutputTypeDef]

paginate#

Type annotations and code completion for ListBenefitApplicationsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Catalog: str,
    Programs: Sequence[str] = ...,
    FulfillmentTypes: Sequence[FulfillmentTypeType] = ...,  # (1)
    BenefitIdentifiers: Sequence[str] = ...,
    Status: Sequence[BenefitApplicationStatusType] = ...,  # (2)
    Stages: Sequence[str] = ...,
    AssociatedResources: Sequence[AssociatedResourceTypeDef] = ...,  # (3)
    AssociatedResourceArns: Sequence[str] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (4)
) -> botocore.paginate.PageIterator[ListBenefitApplicationsOutputTypeDef]:  # (5)
    ...
  1. See Sequence[FulfillmentTypeType]
  2. See Sequence[BenefitApplicationStatusType]
  3. See Sequence[AssociatedResourceTypeDef]
  4. See PaginatorConfigTypeDef
  5. See PageIterator[ListBenefitApplicationsOutputTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListBenefitApplicationsInputPaginateTypeDef = {  # (1)
    "Catalog": ...,
}

parent.paginate(**kwargs)
  1. See ListBenefitApplicationsInputPaginateTypeDef

ListBenefitsPaginator#

Type annotations and code completion for boto3.client("partnercentral-benefits").get_paginator("list_benefits"). boto3 documentation

# ListBenefitsPaginator usage example

from boto3.session import Session

from mypy_boto3_partnercentral_benefits.paginator import ListBenefitsPaginator

def get_list_benefits_paginator() -> ListBenefitsPaginator:
    return Session().client("partnercentral-benefits").get_paginator("list_benefits")
# ListBenefitsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_partnercentral_benefits.paginator import ListBenefitsPaginator

session = Session()

client = Session().client("partnercentral-benefits")  # (1)
paginator: ListBenefitsPaginator = client.get_paginator("list_benefits")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: PartnerCentralBenefitsClient
  2. paginator: ListBenefitsPaginator
  3. item: PageIterator[ListBenefitsOutputTypeDef]

paginate#

Type annotations and code completion for ListBenefitsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Catalog: str,
    Programs: Sequence[str] = ...,
    FulfillmentTypes: Sequence[FulfillmentTypeType] = ...,  # (1)
    Status: Sequence[BenefitStatusType] = ...,  # (2)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (3)
) -> botocore.paginate.PageIterator[ListBenefitsOutputTypeDef]:  # (4)
    ...
  1. See Sequence[FulfillmentTypeType]
  2. See Sequence[BenefitStatusType]
  3. See PaginatorConfigTypeDef
  4. See PageIterator[ListBenefitsOutputTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListBenefitsInputPaginateTypeDef = {  # (1)
    "Catalog": ...,
}

parent.paginate(**kwargs)
  1. See ListBenefitsInputPaginateTypeDef