Skip to content

iter_search_rules

iter_search_rules(
    instance_id: InstanceId,
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    max_results: Optional[MaxResult200] = None,
    next_token: Optional[NextToken2500] = None,
    search_criteria: Optional[RulesSearchCriteria] = None,
    search_filter: Optional[RulesSearchFilter] = None,
) -> Iterator[RuleSearchSummary]
Source code in docs_src/capo_connect/_services/connect.py
def iter_search_rules(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    max_results: Optional["capo_connect.types.max_result200.MaxResult200"] = None,
    next_token: Optional["capo_connect.types.next_token2500.NextToken2500"] = None,
    search_criteria: Optional[
        "capo_connect.types.rules_search_criteria.RulesSearchCriteria"
    ] = None,
    search_filter: Optional[
        "capo_connect.types.rules_search_filter.RulesSearchFilter"
    ] = None,
) -> "Iterator[capo_connect.types.rule_search_summary.RuleSearchSummary]":
    _token = next_token
    while True:
        _response = self.search_rules(
            instance_id,
            config_overrides=config_overrides,
            max_results=max_results,
            next_token=_token,
            search_criteria=search_criteria,
            search_filter=search_filter,
        )
        _page = _resolve_path(_response, ("rules",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break