Skip to content

iter_list_engagements

iter_list_engagements(
    catalog: CatalogIdentifier,
    *,
    config_overrides: Optional[PartnerCentralSellingClientConfig] = None,
    created_by: Optional[AwsAccountList] = None,
    exclude_created_by: Optional[AwsAccountList] = None,
    context_types: Optional[EngagementContextTypeList] = None,
    exclude_context_types: Optional[EngagementContextTypeList] = None,
    sort: Optional[EngagementSort] = None,
    max_results: Optional[EngagementPageSize] = None,
    next_token: Optional[str] = None,
    engagement_identifier: Optional[EngagementIdentifiers] = None,
) -> Iterator[EngagementSummary]
Source code in docs_src/capo_partnercentral_selling/_services/partner_central_selling.py
def iter_list_engagements(
    self,
    catalog: "capo_partnercentral_selling.types.catalog_identifier.CatalogIdentifier",
    *,
    config_overrides: Optional[PartnerCentralSellingClientConfig] = None,
    created_by: Optional[
        "capo_partnercentral_selling.types.aws_account_list.AwsAccountList"
    ] = None,
    exclude_created_by: Optional[
        "capo_partnercentral_selling.types.aws_account_list.AwsAccountList"
    ] = None,
    context_types: Optional[
        "capo_partnercentral_selling.types.engagement_context_type_list.EngagementContextTypeList"
    ] = None,
    exclude_context_types: Optional[
        "capo_partnercentral_selling.types.engagement_context_type_list.EngagementContextTypeList"
    ] = None,
    sort: Optional[
        "capo_partnercentral_selling.types.engagement_sort.EngagementSort"
    ] = None,
    max_results: Optional[
        "capo_partnercentral_selling.types.engagement_page_size.EngagementPageSize"
    ] = None,
    next_token: Optional[str] = None,
    engagement_identifier: Optional[
        "capo_partnercentral_selling.types.engagement_identifiers.EngagementIdentifiers"
    ] = None,
) -> "Iterator[capo_partnercentral_selling.types.engagement_summary.EngagementSummary]":
    _token = next_token
    while True:
        _response = self.list_engagements(
            catalog,
            config_overrides=config_overrides,
            created_by=created_by,
            exclude_created_by=exclude_created_by,
            context_types=context_types,
            exclude_context_types=exclude_context_types,
            sort=sort,
            max_results=max_results,
            next_token=_token,
            engagement_identifier=engagement_identifier,
        )
        _page = _resolve_path(_response, ("engagement_summary_list",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break