aws_sdk_databasemigration/client/
describe_fleet_advisor_databases.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeFleetAdvisorDatabases`](crate::operation::describe_fleet_advisor_databases::builders::DescribeFleetAdvisorDatabasesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_fleet_advisor_databases::builders::DescribeFleetAdvisorDatabasesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`filters(Filter)`](crate::operation::describe_fleet_advisor_databases::builders::DescribeFleetAdvisorDatabasesFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_fleet_advisor_databases::builders::DescribeFleetAdvisorDatabasesFluentBuilder::set_filters):<br>required: **false**<br><p>If you specify any of the following filters, the output includes information for only those databases that meet the filter criteria:</p> <ul>  <li>   <p><code>database-id</code> – The ID of the database.</p></li>  <li>   <p><code>database-name</code> – The name of the database.</p></li>  <li>   <p><code>database-engine</code> – The name of the database engine.</p></li>  <li>   <p><code>server-ip-address</code> – The IP address of the database server.</p></li>  <li>   <p><code>database-ip-address</code> – The IP address of the database.</p></li>  <li>   <p><code>collector-name</code> – The name of the associated Fleet Advisor collector.</p></li> </ul> <p>An example is: <code>describe-fleet-advisor-databases --filter Name="database-id",Values="45"</code></p><br>
    ///   - [`max_records(i32)`](crate::operation::describe_fleet_advisor_databases::builders::DescribeFleetAdvisorDatabasesFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_fleet_advisor_databases::builders::DescribeFleetAdvisorDatabasesFluentBuilder::set_max_records):<br>required: **false**<br><p>Sets the maximum number of records returned in the response.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_fleet_advisor_databases::builders::DescribeFleetAdvisorDatabasesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_fleet_advisor_databases::builders::DescribeFleetAdvisorDatabasesFluentBuilder::set_next_token):<br>required: **false**<br><p>If <code>NextToken</code> is returned by a previous response, there are more results available. The value of <code>NextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.</p><br>
    /// - On success, responds with [`DescribeFleetAdvisorDatabasesOutput`](crate::operation::describe_fleet_advisor_databases::DescribeFleetAdvisorDatabasesOutput) with field(s):
    ///   - [`databases(Option<Vec::<DatabaseResponse>>)`](crate::operation::describe_fleet_advisor_databases::DescribeFleetAdvisorDatabasesOutput::databases): <p>Provides descriptions of the Fleet Advisor collector databases, including the database's collector, ID, and name.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::describe_fleet_advisor_databases::DescribeFleetAdvisorDatabasesOutput::next_token): <p>If <code>NextToken</code> is returned, there are more results available. The value of <code>NextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.</p>
    /// - On failure, responds with [`SdkError<DescribeFleetAdvisorDatabasesError>`](crate::operation::describe_fleet_advisor_databases::DescribeFleetAdvisorDatabasesError)
    pub fn describe_fleet_advisor_databases(
        &self,
    ) -> crate::operation::describe_fleet_advisor_databases::builders::DescribeFleetAdvisorDatabasesFluentBuilder {
        crate::operation::describe_fleet_advisor_databases::builders::DescribeFleetAdvisorDatabasesFluentBuilder::new(self.handle.clone())
    }
}