Skip to content

iter_list_bots

iter_list_bots(
    network_id: NetworkId,
    *,
    config_overrides: Optional[WickrClientConfig] = None,
    next_token: Optional[GenericString] = None,
    max_results: Optional[int] = None,
    sort_fields: Optional[GenericString] = None,
    sort_direction: Optional[SortDirection] = None,
    display_name: Optional[GenericString] = None,
    username: Optional[GenericString] = None,
    status: Optional[BotStatus] = None,
    group_id: Optional[GenericString] = None,
) -> Iterator[Bot]
Source code in docs_src/capo_wickr/_services/wickr.py
def iter_list_bots(
    self,
    network_id: "capo_wickr.types.network_id.NetworkId",
    *,
    config_overrides: Optional[WickrClientConfig] = None,
    next_token: Optional["capo_wickr.types.generic_string.GenericString"] = None,
    max_results: Optional[int] = None,
    sort_fields: Optional["capo_wickr.types.generic_string.GenericString"] = None,
    sort_direction: Optional[
        "capo_wickr.types.sort_direction.SortDirection"
    ] = None,
    display_name: Optional["capo_wickr.types.generic_string.GenericString"] = None,
    username: Optional["capo_wickr.types.generic_string.GenericString"] = None,
    status: Optional["capo_wickr.types.bot_status.BotStatus"] = None,
    group_id: Optional["capo_wickr.types.generic_string.GenericString"] = None,
) -> "Iterator[capo_wickr.types.bot.Bot]":
    _token = next_token
    while True:
        _response = self.list_bots(
            network_id,
            config_overrides=config_overrides,
            next_token=_token,
            max_results=max_results,
            sort_fields=sort_fields,
            sort_direction=sort_direction,
            display_name=display_name,
            username=username,
            status=status,
            group_id=group_id,
        )
        _page = _resolve_path(_response, ("bots",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break