aws_sdk_rds/client/
describe_db_cluster_automated_backups.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeDBClusterAutomatedBackups`](crate::operation::describe_db_cluster_automated_backups::builders::DescribeDBClusterAutomatedBackupsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_db_cluster_automated_backups::builders::DescribeDBClusterAutomatedBackupsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`db_cluster_resource_id(impl Into<String>)`](crate::operation::describe_db_cluster_automated_backups::builders::DescribeDBClusterAutomatedBackupsFluentBuilder::db_cluster_resource_id) / [`set_db_cluster_resource_id(Option<String>)`](crate::operation::describe_db_cluster_automated_backups::builders::DescribeDBClusterAutomatedBackupsFluentBuilder::set_db_cluster_resource_id):<br>required: **false**<br><p>The resource ID of the DB cluster that is the source of the automated backup. This parameter isn't case-sensitive.</p><br>
    ///   - [`db_cluster_identifier(impl Into<String>)`](crate::operation::describe_db_cluster_automated_backups::builders::DescribeDBClusterAutomatedBackupsFluentBuilder::db_cluster_identifier) / [`set_db_cluster_identifier(Option<String>)`](crate::operation::describe_db_cluster_automated_backups::builders::DescribeDBClusterAutomatedBackupsFluentBuilder::set_db_cluster_identifier):<br>required: **false**<br><p>(Optional) The user-supplied DB cluster identifier. If this parameter is specified, it must match the identifier of an existing DB cluster. It returns information from the specific DB cluster's automated backup. This parameter isn't case-sensitive.</p><br>
    ///   - [`filters(Filter)`](crate::operation::describe_db_cluster_automated_backups::builders::DescribeDBClusterAutomatedBackupsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_db_cluster_automated_backups::builders::DescribeDBClusterAutomatedBackupsFluentBuilder::set_filters):<br>required: **false**<br><p>A filter that specifies which resources to return based on status.</p> <p>Supported filters are the following:</p> <ul>  <li>   <p><code>status</code></p>   <ul>    <li>     <p><code>retained</code> - Automated backups for deleted clusters and after backup replication is stopped.</p></li>   </ul></li>  <li>   <p><code>db-cluster-id</code> - Accepts DB cluster identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster automated backups identified by these ARNs.</p></li>  <li>   <p><code>db-cluster-resource-id</code> - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster resources identified by these ARNs.</p></li> </ul> <p>Returns all resources by default. The status for each resource is specified in the response.</p><br>
    ///   - [`max_records(i32)`](crate::operation::describe_db_cluster_automated_backups::builders::DescribeDBClusterAutomatedBackupsFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_db_cluster_automated_backups::builders::DescribeDBClusterAutomatedBackupsFluentBuilder::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 you can retrieve the remaining results.</p><br>
    ///   - [`marker(impl Into<String>)`](crate::operation::describe_db_cluster_automated_backups::builders::DescribeDBClusterAutomatedBackupsFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::describe_db_cluster_automated_backups::builders::DescribeDBClusterAutomatedBackupsFluentBuilder::set_marker):<br>required: **false**<br><p>The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to <code>MaxRecords</code>.</p><br>
    /// - On success, responds with [`DescribeDbClusterAutomatedBackupsOutput`](crate::operation::describe_db_cluster_automated_backups::DescribeDbClusterAutomatedBackupsOutput) with field(s):
    ///   - [`marker(Option<String>)`](crate::operation::describe_db_cluster_automated_backups::DescribeDbClusterAutomatedBackupsOutput::marker): <p>The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to <code>MaxRecords</code>.</p>
    ///   - [`db_cluster_automated_backups(Option<Vec::<DbClusterAutomatedBackup>>)`](crate::operation::describe_db_cluster_automated_backups::DescribeDbClusterAutomatedBackupsOutput::db_cluster_automated_backups): <p>A list of <code>DBClusterAutomatedBackup</code> backups.</p>
    /// - On failure, responds with [`SdkError<DescribeDBClusterAutomatedBackupsError>`](crate::operation::describe_db_cluster_automated_backups::DescribeDBClusterAutomatedBackupsError)
    pub fn describe_db_cluster_automated_backups(
        &self,
    ) -> crate::operation::describe_db_cluster_automated_backups::builders::DescribeDBClusterAutomatedBackupsFluentBuilder {
        crate::operation::describe_db_cluster_automated_backups::builders::DescribeDBClusterAutomatedBackupsFluentBuilder::new(self.handle.clone())
    }
}