Skip to content

iter_describe_cluster_snapshots

iter_describe_cluster_snapshots(
    *,
    config_overrides: Optional[RedshiftClientConfig] = None,
    cluster_identifier: Optional[String] = None,
    snapshot_identifier: Optional[String] = None,
    snapshot_arn: Optional[String] = None,
    snapshot_type: Optional[String] = None,
    start_time: Optional[TStamp] = None,
    end_time: Optional[TStamp] = None,
    max_records: Optional[IntegerOptional] = None,
    marker: Optional[String] = None,
    owner_account: Optional[String] = None,
    tag_keys: Optional[TagKeyList] = None,
    tag_values: Optional[TagValueList] = None,
    cluster_exists: Optional[BooleanOptional] = None,
    sorting_entities: Optional[SnapshotSortingEntityList] = None,
) -> Iterator[Snapshot]
Source code in docs_src/capo_redshift/_services/redshift.py
def iter_describe_cluster_snapshots(
    self,
    *,
    config_overrides: Optional[RedshiftClientConfig] = None,
    cluster_identifier: Optional["capo_redshift.types.string.String"] = None,
    snapshot_identifier: Optional["capo_redshift.types.string.String"] = None,
    snapshot_arn: Optional["capo_redshift.types.string.String"] = None,
    snapshot_type: Optional["capo_redshift.types.string.String"] = None,
    start_time: Optional["capo_redshift.types.t_stamp.TStamp"] = None,
    end_time: Optional["capo_redshift.types.t_stamp.TStamp"] = None,
    max_records: Optional[
        "capo_redshift.types.integer_optional.IntegerOptional"
    ] = None,
    marker: Optional["capo_redshift.types.string.String"] = None,
    owner_account: Optional["capo_redshift.types.string.String"] = None,
    tag_keys: Optional["capo_redshift.types.tag_key_list.TagKeyList"] = None,
    tag_values: Optional["capo_redshift.types.tag_value_list.TagValueList"] = None,
    cluster_exists: Optional[
        "capo_redshift.types.boolean_optional.BooleanOptional"
    ] = None,
    sorting_entities: Optional[
        "capo_redshift.types.snapshot_sorting_entity_list.SnapshotSortingEntityList"
    ] = None,
) -> "Iterator[capo_redshift.types.snapshot.Snapshot]":
    _token = marker
    while True:
        _response = self.describe_cluster_snapshots(
            config_overrides=config_overrides,
            cluster_identifier=cluster_identifier,
            snapshot_identifier=snapshot_identifier,
            snapshot_arn=snapshot_arn,
            snapshot_type=snapshot_type,
            start_time=start_time,
            end_time=end_time,
            max_records=max_records,
            marker=_token,
            owner_account=owner_account,
            tag_keys=tag_keys,
            tag_values=tag_values,
            cluster_exists=cluster_exists,
            sorting_entities=sorting_entities,
        )
        _page = _resolve_path(_response, ("snapshots",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("marker",))
        if not _token:
            break