Skip to content

iter_list_benefit_allocations

iter_list_benefit_allocations(
    catalog: CatalogName,
    *,
    config_overrides: Optional[PartnerCentralBenefitsClientConfig] = None,
    fulfillment_types: Optional[FulfillmentTypes] = None,
    benefit_identifiers: Optional[BenefitIdentifiers] = None,
    benefit_application_identifiers: Optional[BenefitApplicationIdentifierList] = None,
    status: Optional[BenefitAllocationStatusList] = None,
    max_results: Optional[int] = None,
    next_token: Optional[str] = None,
) -> Iterator[BenefitAllocationSummary]
Source code in docs_src/capo_partnercentral_benefits/_services/partner_central_benefits.py
def iter_list_benefit_allocations(
    self,
    catalog: "capo_partnercentral_benefits.types.catalog_name.CatalogName",
    *,
    config_overrides: Optional[PartnerCentralBenefitsClientConfig] = None,
    fulfillment_types: Optional[
        "capo_partnercentral_benefits.types.fulfillment_types.FulfillmentTypes"
    ] = None,
    benefit_identifiers: Optional[
        "capo_partnercentral_benefits.types.benefit_identifiers.BenefitIdentifiers"
    ] = None,
    benefit_application_identifiers: Optional[
        "capo_partnercentral_benefits.types.benefit_application_identifier_list.BenefitApplicationIdentifierList"
    ] = None,
    status: Optional[
        "capo_partnercentral_benefits.types.benefit_allocation_status_list.BenefitAllocationStatusList"
    ] = None,
    max_results: Optional[int] = None,
    next_token: Optional[str] = None,
) -> "Iterator[capo_partnercentral_benefits.types.benefit_allocation_summary.BenefitAllocationSummary]":
    _token = next_token
    while True:
        _response = self.list_benefit_allocations(
            catalog,
            config_overrides=config_overrides,
            fulfillment_types=fulfillment_types,
            benefit_identifiers=benefit_identifiers,
            benefit_application_identifiers=benefit_application_identifiers,
            status=status,
            max_results=max_results,
            next_token=_token,
        )
        _page = _resolve_path(_response, ("benefit_allocation_summaries",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break