aws_sdk_redshift/client/
batch_modify_cluster_snapshots.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`BatchModifyClusterSnapshots`](crate::operation::batch_modify_cluster_snapshots::builders::BatchModifyClusterSnapshotsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`snapshot_identifier_list(impl Into<String>)`](crate::operation::batch_modify_cluster_snapshots::builders::BatchModifyClusterSnapshotsFluentBuilder::snapshot_identifier_list) / [`set_snapshot_identifier_list(Option<Vec::<String>>)`](crate::operation::batch_modify_cluster_snapshots::builders::BatchModifyClusterSnapshotsFluentBuilder::set_snapshot_identifier_list):<br>required: **true**<br><p>A list of snapshot identifiers you want to modify.</p><br>
7    ///   - [`manual_snapshot_retention_period(i32)`](crate::operation::batch_modify_cluster_snapshots::builders::BatchModifyClusterSnapshotsFluentBuilder::manual_snapshot_retention_period) / [`set_manual_snapshot_retention_period(Option<i32>)`](crate::operation::batch_modify_cluster_snapshots::builders::BatchModifyClusterSnapshotsFluentBuilder::set_manual_snapshot_retention_period):<br>required: **false**<br><p>The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely.</p> <p>The number must be either -1 or an integer between 1 and 3,653.</p> <p>If you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force option.</p><br>
8    ///   - [`force(bool)`](crate::operation::batch_modify_cluster_snapshots::builders::BatchModifyClusterSnapshotsFluentBuilder::force) / [`set_force(Option<bool>)`](crate::operation::batch_modify_cluster_snapshots::builders::BatchModifyClusterSnapshotsFluentBuilder::set_force):<br>required: **false**<br><p>A boolean value indicating whether to override an exception if the retention period has passed.</p><br>
9    /// - On success, responds with [`BatchModifyClusterSnapshotsOutput`](crate::operation::batch_modify_cluster_snapshots::BatchModifyClusterSnapshotsOutput) with field(s):
10    ///   - [`resources(Option<Vec::<String>>)`](crate::operation::batch_modify_cluster_snapshots::BatchModifyClusterSnapshotsOutput::resources): <p>A list of the snapshots that were modified.</p>
11    ///   - [`errors(Option<Vec::<SnapshotErrorMessage>>)`](crate::operation::batch_modify_cluster_snapshots::BatchModifyClusterSnapshotsOutput::errors): <p>A list of any errors returned.</p>
12    /// - On failure, responds with [`SdkError<BatchModifyClusterSnapshotsError>`](crate::operation::batch_modify_cluster_snapshots::BatchModifyClusterSnapshotsError)
13    pub fn batch_modify_cluster_snapshots(
14        &self,
15    ) -> crate::operation::batch_modify_cluster_snapshots::builders::BatchModifyClusterSnapshotsFluentBuilder {
16        crate::operation::batch_modify_cluster_snapshots::builders::BatchModifyClusterSnapshotsFluentBuilder::new(self.handle.clone())
17    }
18}