aws_sdk_rds/client/
describe_db_snapshot_tenant_databases.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeDBSnapshotTenantDatabases`](crate::operation::describe_db_snapshot_tenant_databases::builders::DescribeDBSnapshotTenantDatabasesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_db_snapshot_tenant_databases::builders::DescribeDBSnapshotTenantDatabasesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`db_instance_identifier(impl Into<String>)`](crate::operation::describe_db_snapshot_tenant_databases::builders::DescribeDBSnapshotTenantDatabasesFluentBuilder::db_instance_identifier) / [`set_db_instance_identifier(Option<String>)`](crate::operation::describe_db_snapshot_tenant_databases::builders::DescribeDBSnapshotTenantDatabasesFluentBuilder::set_db_instance_identifier):<br>required: **false**<br><p>The ID of the DB instance used to create the DB snapshots. This parameter isn't case-sensitive.</p> <p>Constraints:</p> <ul>  <li>   <p>If supplied, must match the identifier of an existing <code>DBInstance</code>.</p></li> </ul><br>
    ///   - [`db_snapshot_identifier(impl Into<String>)`](crate::operation::describe_db_snapshot_tenant_databases::builders::DescribeDBSnapshotTenantDatabasesFluentBuilder::db_snapshot_identifier) / [`set_db_snapshot_identifier(Option<String>)`](crate::operation::describe_db_snapshot_tenant_databases::builders::DescribeDBSnapshotTenantDatabasesFluentBuilder::set_db_snapshot_identifier):<br>required: **false**<br><p>The ID of a DB snapshot that contains the tenant databases to describe. This value is stored as a lowercase string.</p> <p>Constraints:</p> <ul>  <li>   <p>If you specify this parameter, the value must match the ID of an existing DB snapshot.</p></li>  <li>   <p>If you specify an automatic snapshot, you must also specify <code>SnapshotType</code>.</p></li> </ul><br>
    ///   - [`snapshot_type(impl Into<String>)`](crate::operation::describe_db_snapshot_tenant_databases::builders::DescribeDBSnapshotTenantDatabasesFluentBuilder::snapshot_type) / [`set_snapshot_type(Option<String>)`](crate::operation::describe_db_snapshot_tenant_databases::builders::DescribeDBSnapshotTenantDatabasesFluentBuilder::set_snapshot_type):<br>required: **false**<br><p>The type of DB snapshots to be returned. You can specify one of the following values:</p> <ul>  <li>   <p><code>automated</code> – All DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.</p></li>  <li>   <p><code>manual</code> – All DB snapshots that have been taken by my Amazon Web Services account.</p></li>  <li>   <p><code>shared</code> – All manual DB snapshots that have been shared to my Amazon Web Services account.</p></li>  <li>   <p><code>public</code> – All DB snapshots that have been marked as public.</p></li>  <li>   <p><code>awsbackup</code> – All DB snapshots managed by the Amazon Web Services Backup service.</p></li> </ul><br>
    ///   - [`filters(Filter)`](crate::operation::describe_db_snapshot_tenant_databases::builders::DescribeDBSnapshotTenantDatabasesFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_db_snapshot_tenant_databases::builders::DescribeDBSnapshotTenantDatabasesFluentBuilder::set_filters):<br>required: **false**<br><p>A filter that specifies one or more tenant databases to describe.</p> <p>Supported filters:</p> <ul>  <li>   <p><code>tenant-db-name</code> - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.</p></li>  <li>   <p><code>tenant-database-resource-id</code> - Tenant database resource identifiers. The results list only includes information about the tenant databases contained within the DB snapshots.</p></li>  <li>   <p><code>dbi-resource-id</code> - DB instance resource identifiers. The results list only includes information about snapshots containing tenant databases contained within the DB instances identified by these resource identifiers.</p></li>  <li>   <p><code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).</p></li>  <li>   <p><code>db-snapshot-id</code> - Accepts DB snapshot identifiers.</p></li>  <li>   <p><code>snapshot-type</code> - Accepts types of DB snapshots.</p></li> </ul><br>
    ///   - [`max_records(i32)`](crate::operation::describe_db_snapshot_tenant_databases::builders::DescribeDBSnapshotTenantDatabasesFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_db_snapshot_tenant_databases::builders::DescribeDBSnapshotTenantDatabasesFluentBuilder::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_snapshot_tenant_databases::builders::DescribeDBSnapshotTenantDatabasesFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::describe_db_snapshot_tenant_databases::builders::DescribeDBSnapshotTenantDatabasesFluentBuilder::set_marker):<br>required: **false**<br><p>An optional pagination token provided by a previous <code>DescribeDBSnapshotTenantDatabases</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>
    ///   - [`dbi_resource_id(impl Into<String>)`](crate::operation::describe_db_snapshot_tenant_databases::builders::DescribeDBSnapshotTenantDatabasesFluentBuilder::dbi_resource_id) / [`set_dbi_resource_id(Option<String>)`](crate::operation::describe_db_snapshot_tenant_databases::builders::DescribeDBSnapshotTenantDatabasesFluentBuilder::set_dbi_resource_id):<br>required: **false**<br><p>A specific DB resource identifier to describe.</p><br>
    /// - On success, responds with [`DescribeDbSnapshotTenantDatabasesOutput`](crate::operation::describe_db_snapshot_tenant_databases::DescribeDbSnapshotTenantDatabasesOutput) with field(s):
    ///   - [`marker(Option<String>)`](crate::operation::describe_db_snapshot_tenant_databases::DescribeDbSnapshotTenantDatabasesOutput::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_snapshot_tenant_databases(Option<Vec::<DbSnapshotTenantDatabase>>)`](crate::operation::describe_db_snapshot_tenant_databases::DescribeDbSnapshotTenantDatabasesOutput::db_snapshot_tenant_databases): <p>A list of DB snapshot tenant databases.</p>
    /// - On failure, responds with [`SdkError<DescribeDBSnapshotTenantDatabasesError>`](crate::operation::describe_db_snapshot_tenant_databases::DescribeDBSnapshotTenantDatabasesError)
    pub fn describe_db_snapshot_tenant_databases(
        &self,
    ) -> crate::operation::describe_db_snapshot_tenant_databases::builders::DescribeDBSnapshotTenantDatabasesFluentBuilder {
        crate::operation::describe_db_snapshot_tenant_databases::builders::DescribeDBSnapshotTenantDatabasesFluentBuilder::new(self.handle.clone())
    }
}