aws_sdk_rds/client/

describe_tenant_databases.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeTenantDatabases`](crate::operation::describe_tenant_databases::builders::DescribeTenantDatabasesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_tenant_databases::builders::DescribeTenantDatabasesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`db_instance_identifier(impl Into<String>)`](crate::operation::describe_tenant_databases::builders::DescribeTenantDatabasesFluentBuilder::db_instance_identifier) / [`set_db_instance_identifier(Option<String>)`](crate::operation::describe_tenant_databases::builders::DescribeTenantDatabasesFluentBuilder::set_db_instance_identifier):<br>required: **false**<br><p>The user-supplied DB instance identifier, which must match the identifier of an existing instance owned by the Amazon Web Services account. This parameter isn't case-sensitive.</p><br>
    ///   - [`tenant_db_name(impl Into<String>)`](crate::operation::describe_tenant_databases::builders::DescribeTenantDatabasesFluentBuilder::tenant_db_name) / [`set_tenant_db_name(Option<String>)`](crate::operation::describe_tenant_databases::builders::DescribeTenantDatabasesFluentBuilder::set_tenant_db_name):<br>required: **false**<br><p>The user-supplied tenant database name, which must match the name of an existing tenant database on the specified DB instance owned by your Amazon Web Services account. This parameter isn’t case-sensitive.</p><br>
    ///   - [`filters(Filter)`](crate::operation::describe_tenant_databases::builders::DescribeTenantDatabasesFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_tenant_databases::builders::DescribeTenantDatabasesFluentBuilder::set_filters):<br>required: **false**<br><p>A filter that specifies one or more database tenants 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.</p></li>  <li>   <p><code>dbi-resource-id</code> - DB instance resource identifiers. The results list only includes information about the tenants contained within the DB instances identified by these resource identifiers.</p></li> </ul><br>
    ///   - [`marker(impl Into<String>)`](crate::operation::describe_tenant_databases::builders::DescribeTenantDatabasesFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::describe_tenant_databases::builders::DescribeTenantDatabasesFluentBuilder::set_marker):<br>required: **false**<br><p>An optional pagination token provided by a previous <code>DescribeTenantDatabases</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>
    ///   - [`max_records(i32)`](crate::operation::describe_tenant_databases::builders::DescribeTenantDatabasesFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_tenant_databases::builders::DescribeTenantDatabasesFluentBuilder::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>
    /// - On success, responds with [`DescribeTenantDatabasesOutput`](crate::operation::describe_tenant_databases::DescribeTenantDatabasesOutput) with field(s):
    ///   - [`marker(Option<String>)`](crate::operation::describe_tenant_databases::DescribeTenantDatabasesOutput::marker): <p>An optional pagination token provided by a previous <code>DescribeTenantDatabases</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>
    ///   - [`tenant_databases(Option<Vec::<TenantDatabase>>)`](crate::operation::describe_tenant_databases::DescribeTenantDatabasesOutput::tenant_databases): <p>An array of the tenant databases requested by the <code>DescribeTenantDatabases</code> operation.</p>
    /// - On failure, responds with [`SdkError<DescribeTenantDatabasesError>`](crate::operation::describe_tenant_databases::DescribeTenantDatabasesError)
    pub fn describe_tenant_databases(&self) -> crate::operation::describe_tenant_databases::builders::DescribeTenantDatabasesFluentBuilder {
        crate::operation::describe_tenant_databases::builders::DescribeTenantDatabasesFluentBuilder::new(self.handle.clone())
    }
}