Skip to content

iter_list_rule_groups

iter_list_rule_groups(
    *,
    config_overrides: Optional[NetworkFirewallClientConfig] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[PaginationMaxResults] = None,
    scope: Optional[ResourceManagedStatus] = None,
    managed_type: Optional[ResourceManagedType] = None,
    subscription_status: Optional[SubscriptionStatus] = None,
    type: Optional[RuleGroupType] = None,
) -> Iterator[RuleGroupMetadata]
Source code in docs_src/capo_network_firewall/_services/network_firewall.py
def iter_list_rule_groups(
    self,
    *,
    config_overrides: Optional[NetworkFirewallClientConfig] = None,
    next_token: Optional[
        "capo_network_firewall.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional[
        "capo_network_firewall.types.pagination_max_results.PaginationMaxResults"
    ] = None,
    scope: Optional[
        "capo_network_firewall.types.resource_managed_status.ResourceManagedStatus"
    ] = None,
    managed_type: Optional[
        "capo_network_firewall.types.resource_managed_type.ResourceManagedType"
    ] = None,
    subscription_status: Optional[
        "capo_network_firewall.types.subscription_status.SubscriptionStatus"
    ] = None,
    type: Optional[
        "capo_network_firewall.types.rule_group_type.RuleGroupType"
    ] = None,
) -> "Iterator[capo_network_firewall.types.rule_group_metadata.RuleGroupMetadata]":
    _token = next_token
    while True:
        _response = self.list_rule_groups(
            config_overrides=config_overrides,
            next_token=_token,
            max_results=max_results,
            scope=scope,
            managed_type=managed_type,
            subscription_status=subscription_status,
            type=type,
        )
        _page = _resolve_path(_response, ("rule_groups",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break