Skip to content

iter_describe_volumes

iter_describe_volumes(
    *,
    config_overrides: Optional[FSxClientConfig] = None,
    volume_ids: Optional[VolumeIds] = None,
    filters: Optional[VolumeFilters] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> Iterator[Volume]
Source code in docs_src/capo_fsx/_services/f_sx.py
def iter_describe_volumes(
    self,
    *,
    config_overrides: Optional[FSxClientConfig] = None,
    volume_ids: Optional["capo_fsx.types.volume_ids.VolumeIds"] = None,
    filters: Optional["capo_fsx.types.volume_filters.VolumeFilters"] = None,
    max_results: Optional["capo_fsx.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_fsx.types.next_token.NextToken"] = None,
) -> "Iterator[capo_fsx.types.volume.Volume]":
    _token = next_token
    while True:
        _response = self.describe_volumes(
            config_overrides=config_overrides,
            volume_ids=volume_ids,
            filters=filters,
            max_results=max_results,
            next_token=_token,
        )
        _page = _resolve_path(_response, ("volumes",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break