Skip to content

iter_describe_snapshots

iter_describe_snapshots(
    *,
    config_overrides: Optional[ElastiCacheClientConfig] = None,
    replication_group_id: Optional[String] = None,
    cache_cluster_id: Optional[String] = None,
    snapshot_name: Optional[String] = None,
    snapshot_source: Optional[String] = None,
    marker: Optional[String] = None,
    max_records: Optional[IntegerOptional] = None,
    show_node_group_config: Optional[BooleanOptional] = None,
) -> Iterator[Snapshot]
Source code in docs_src/capo_elasticache/_services/elasti_cache.py
def iter_describe_snapshots(
    self,
    *,
    config_overrides: Optional[ElastiCacheClientConfig] = None,
    replication_group_id: Optional["capo_elasticache.types.string.String"] = None,
    cache_cluster_id: Optional["capo_elasticache.types.string.String"] = None,
    snapshot_name: Optional["capo_elasticache.types.string.String"] = None,
    snapshot_source: Optional["capo_elasticache.types.string.String"] = None,
    marker: Optional["capo_elasticache.types.string.String"] = None,
    max_records: Optional[
        "capo_elasticache.types.integer_optional.IntegerOptional"
    ] = None,
    show_node_group_config: Optional[
        "capo_elasticache.types.boolean_optional.BooleanOptional"
    ] = None,
) -> "Iterator[capo_elasticache.types.snapshot.Snapshot]":
    _token = marker
    while True:
        _response = self.describe_snapshots(
            config_overrides=config_overrides,
            replication_group_id=replication_group_id,
            cache_cluster_id=cache_cluster_id,
            snapshot_name=snapshot_name,
            snapshot_source=snapshot_source,
            marker=_token,
            max_records=max_records,
            show_node_group_config=show_node_group_config,
        )
        _page = _resolve_path(_response, ("snapshots",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("marker",))
        if not _token:
            break