1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeDBClusterSnapshots`](crate::operation::describe_db_cluster_snapshots::builders::DescribeDBClusterSnapshotsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_db_cluster_snapshots::builders::DescribeDBClusterSnapshotsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`db_cluster_identifier(impl ::std::convert::Into<String>)`](crate::operation::describe_db_cluster_snapshots::builders::DescribeDBClusterSnapshotsFluentBuilder::db_cluster_identifier) / [`set_db_cluster_identifier(Option<String>)`](crate::operation::describe_db_cluster_snapshots::builders::DescribeDBClusterSnapshotsFluentBuilder::set_db_cluster_identifier): <p>The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the <code>DBClusterSnapshotIdentifier</code> parameter. This parameter is not case sensitive. </p>  <p>Constraints:</p>  <ul>   <li> <p>If provided, must match the identifier of an existing <code>DBCluster</code>.</p> </li>  </ul>
    ///   - [`db_cluster_snapshot_identifier(impl ::std::convert::Into<String>)`](crate::operation::describe_db_cluster_snapshots::builders::DescribeDBClusterSnapshotsFluentBuilder::db_cluster_snapshot_identifier) / [`set_db_cluster_snapshot_identifier(Option<String>)`](crate::operation::describe_db_cluster_snapshots::builders::DescribeDBClusterSnapshotsFluentBuilder::set_db_cluster_snapshot_identifier): <p>A specific cluster snapshot identifier to describe. This parameter can't be used with the <code>DBClusterIdentifier</code> parameter. This value is stored as a lowercase string. </p>  <p>Constraints:</p>  <ul>   <li> <p>If provided, must match the identifier of an existing <code>DBClusterSnapshot</code>.</p> </li>   <li> <p>If this identifier is for an automated snapshot, the <code>SnapshotType</code> parameter must also be specified.</p> </li>  </ul>
    ///   - [`snapshot_type(impl ::std::convert::Into<String>)`](crate::operation::describe_db_cluster_snapshots::builders::DescribeDBClusterSnapshotsFluentBuilder::snapshot_type) / [`set_snapshot_type(Option<String>)`](crate::operation::describe_db_cluster_snapshots::builders::DescribeDBClusterSnapshotsFluentBuilder::set_snapshot_type): <p>The type of cluster snapshots to be returned. You can specify one of the following values:</p>  <ul>   <li> <p> <code>automated</code> - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.</p> </li>   <li> <p> <code>manual</code> - Return all cluster snapshots that you have manually created for your Amazon Web Services account.</p> </li>   <li> <p> <code>shared</code> - Return all manual cluster snapshots that have been shared to your Amazon Web Services account.</p> </li>   <li> <p> <code>public</code> - Return all cluster snapshots that have been marked as public.</p> </li>  </ul>  <p>If you don't specify a <code>SnapshotType</code> value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the <code>IncludeShared</code> parameter to <code>true</code>. You can include public cluster snapshots with these results by setting the<code>IncludePublic</code> parameter to <code>true</code>.</p>  <p>The <code>IncludeShared</code> and <code>IncludePublic</code> parameters don't apply for <code>SnapshotType</code> values of <code>manual</code> or <code>automated</code>. The <code>IncludePublic</code> parameter doesn't apply when <code>SnapshotType</code> is set to <code>shared</code>. The <code>IncludeShared</code> parameter doesn't apply when <code>SnapshotType</code> is set to <code>public</code>.</p>
    ///   - [`filters(Vec<Filter>)`](crate::operation::describe_db_cluster_snapshots::builders::DescribeDBClusterSnapshotsFluentBuilder::filters) / [`set_filters(Option<Vec<Filter>>)`](crate::operation::describe_db_cluster_snapshots::builders::DescribeDBClusterSnapshotsFluentBuilder::set_filters): <p>This parameter is not currently supported.</p>
    ///   - [`max_records(i32)`](crate::operation::describe_db_cluster_snapshots::builders::DescribeDBClusterSnapshotsFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_db_cluster_snapshots::builders::DescribeDBClusterSnapshotsFluentBuilder::set_max_records): <p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p>  <p>Default: 100</p>  <p>Constraints: Minimum 20, maximum 100.</p>
    ///   - [`marker(impl ::std::convert::Into<String>)`](crate::operation::describe_db_cluster_snapshots::builders::DescribeDBClusterSnapshotsFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::describe_db_cluster_snapshots::builders::DescribeDBClusterSnapshotsFluentBuilder::set_marker): <p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
    ///   - [`include_shared(bool)`](crate::operation::describe_db_cluster_snapshots::builders::DescribeDBClusterSnapshotsFluentBuilder::include_shared) / [`set_include_shared(bool)`](crate::operation::describe_db_cluster_snapshots::builders::DescribeDBClusterSnapshotsFluentBuilder::set_include_shared): <p>Set to <code>true</code> to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise <code>false</code>. The default is <code>false</code>.</p>
    ///   - [`include_public(bool)`](crate::operation::describe_db_cluster_snapshots::builders::DescribeDBClusterSnapshotsFluentBuilder::include_public) / [`set_include_public(bool)`](crate::operation::describe_db_cluster_snapshots::builders::DescribeDBClusterSnapshotsFluentBuilder::set_include_public): <p>Set to <code>true</code> to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise <code>false</code>. The default is <code>false</code>.</p>
    /// - On success, responds with [`DescribeDbClusterSnapshotsOutput`](crate::operation::describe_db_cluster_snapshots::DescribeDbClusterSnapshotsOutput) with field(s):
    ///   - [`marker(Option<String>)`](crate::operation::describe_db_cluster_snapshots::DescribeDbClusterSnapshotsOutput::marker): <p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
    ///   - [`db_cluster_snapshots(Option<Vec<DbClusterSnapshot>>)`](crate::operation::describe_db_cluster_snapshots::DescribeDbClusterSnapshotsOutput::db_cluster_snapshots): <p>Provides a list of cluster snapshots.</p>
    /// - On failure, responds with [`SdkError<DescribeDBClusterSnapshotsError>`](crate::operation::describe_db_cluster_snapshots::DescribeDBClusterSnapshotsError)
    pub fn describe_db_cluster_snapshots(
        &self,
    ) -> crate::operation::describe_db_cluster_snapshots::builders::DescribeDBClusterSnapshotsFluentBuilder {
        crate::operation::describe_db_cluster_snapshots::builders::DescribeDBClusterSnapshotsFluentBuilder::new(self.handle.clone())
    }
}