aws_sdk_neptune/client/

describe_db_cluster_snapshots.rs

// 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 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):<br>required: **false**<br><p>The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the <code>DBClusterSnapshotIdentifier</code> parameter. This parameter is not case-sensitive.</p> <p>Constraints:</p> <ul>  <li>   <p>If supplied, must match the identifier of an existing DBCluster.</p></li> </ul><br>
    ///   - [`db_cluster_snapshot_identifier(impl 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):<br>required: **false**<br><p>A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the <code>DBClusterIdentifier</code> parameter. This value is stored as a lowercase string.</p> <p>Constraints:</p> <ul>  <li>   <p>If supplied, must match the identifier of an existing DBClusterSnapshot.</p></li>  <li>   <p>If this identifier is for an automated snapshot, the <code>SnapshotType</code> parameter must also be specified.</p></li> </ul><br>
    ///   - [`snapshot_type(impl 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):<br>required: **false**<br><p>The type of DB cluster snapshots to be returned. You can specify one of the following values:</p> <ul>  <li>   <p><code>automated</code> - Return all DB cluster snapshots that have been automatically taken by Amazon Neptune for my Amazon account.</p></li>  <li>   <p><code>manual</code> - Return all DB cluster snapshots that have been taken by my Amazon account.</p></li>  <li>   <p><code>shared</code> - Return all manual DB cluster snapshots that have been shared to my Amazon account.</p></li>  <li>   <p><code>public</code> - Return all DB 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 DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the <code>IncludeShared</code> parameter to <code>true</code>. You can include public DB 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><br>
    ///   - [`filters(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):<br>required: **false**<br><p>This parameter is not currently supported.</p><br>
    ///   - [`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):<br>required: **false**<br><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 called a 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><br>
    ///   - [`marker(impl 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):<br>required: **false**<br><p>An optional pagination token provided by a previous <code>DescribeDBClusterSnapshots</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p><br>
    ///   - [`include_shared(bool)`](crate::operation::describe_db_cluster_snapshots::builders::DescribeDBClusterSnapshotsFluentBuilder::include_shared) / [`set_include_shared(Option<bool>)`](crate::operation::describe_db_cluster_snapshots::builders::DescribeDBClusterSnapshotsFluentBuilder::set_include_shared):<br>required: **false**<br><p>True to include shared manual DB cluster snapshots from other Amazon accounts that this Amazon account has been given permission to copy or restore, and otherwise false. The default is <code>false</code>.</p> <p>You can give an Amazon account permission to restore a manual DB cluster snapshot from another Amazon account by the <code>ModifyDBClusterSnapshotAttribute</code> API action.</p><br>
    ///   - [`include_public(bool)`](crate::operation::describe_db_cluster_snapshots::builders::DescribeDBClusterSnapshotsFluentBuilder::include_public) / [`set_include_public(Option<bool>)`](crate::operation::describe_db_cluster_snapshots::builders::DescribeDBClusterSnapshotsFluentBuilder::set_include_public):<br>required: **false**<br><p>True to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon account, and otherwise false. The default is <code>false</code>. The default is false.</p> <p>You can share a manual DB cluster snapshot as public by using the <code>ModifyDBClusterSnapshotAttribute</code> API action.</p><br>
    /// - 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 <code>DescribeDBClusterSnapshots</code> 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 DB cluster snapshots for the user.</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())
    }
}