aws_sdk_computeoptimizer/client/
get_rds_database_recommendations.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetRDSDatabaseRecommendations`](crate::operation::get_rds_database_recommendations::builders::GetRDSDatabaseRecommendationsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`resource_arns(impl Into<String>)`](crate::operation::get_rds_database_recommendations::builders::GetRDSDatabaseRecommendationsFluentBuilder::resource_arns) / [`set_resource_arns(Option<Vec::<String>>)`](crate::operation::get_rds_database_recommendations::builders::GetRDSDatabaseRecommendationsFluentBuilder::set_resource_arns):<br>required: **false**<br><p>The ARN that identifies the Amazon Aurora or RDS database.</p> <p>The following is the format of the ARN:</p> <p><code>arn:aws:rds:{region}:{accountId}:db:{resourceName}</code></p> <p>The following is the format of a DB Cluster ARN:</p> <p><code>arn:aws:rds:{region}:{accountId}:cluster:{resourceName}</code></p><br>
7    ///   - [`next_token(impl Into<String>)`](crate::operation::get_rds_database_recommendations::builders::GetRDSDatabaseRecommendationsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_rds_database_recommendations::builders::GetRDSDatabaseRecommendationsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to advance to the next page of Amazon Aurora and RDS database recommendations.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::get_rds_database_recommendations::builders::GetRDSDatabaseRecommendationsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_rds_database_recommendations::builders::GetRDSDatabaseRecommendationsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of Amazon Aurora and RDS database recommendations to return with a single request.</p> <p>To retrieve the remaining results, make another request with the returned <code>nextToken</code> value.</p><br>
9    ///   - [`filters(RdsdbRecommendationFilter)`](crate::operation::get_rds_database_recommendations::builders::GetRDSDatabaseRecommendationsFluentBuilder::filters) / [`set_filters(Option<Vec::<RdsdbRecommendationFilter>>)`](crate::operation::get_rds_database_recommendations::builders::GetRDSDatabaseRecommendationsFluentBuilder::set_filters):<br>required: **false**<br><p>An array of objects to specify a filter that returns a more specific list of Amazon Aurora and RDS database recommendations.</p><br>
10    ///   - [`account_ids(impl Into<String>)`](crate::operation::get_rds_database_recommendations::builders::GetRDSDatabaseRecommendationsFluentBuilder::account_ids) / [`set_account_ids(Option<Vec::<String>>)`](crate::operation::get_rds_database_recommendations::builders::GetRDSDatabaseRecommendationsFluentBuilder::set_account_ids):<br>required: **false**<br><p>Return the Amazon Aurora and RDS database recommendations to the specified Amazon Web Services account IDs.</p> <p>If your account is the management account or the delegated administrator of an organization, use this parameter to return the Amazon Aurora and RDS database recommendations to specific member accounts.</p> <p>You can only specify one account ID per request.</p><br>
11    ///   - [`recommendation_preferences(RecommendationPreferences)`](crate::operation::get_rds_database_recommendations::builders::GetRDSDatabaseRecommendationsFluentBuilder::recommendation_preferences) / [`set_recommendation_preferences(Option<RecommendationPreferences>)`](crate::operation::get_rds_database_recommendations::builders::GetRDSDatabaseRecommendationsFluentBuilder::set_recommendation_preferences):<br>required: **false**<br><p>Describes the recommendation preferences to return in the response of a <code>GetAutoScalingGroupRecommendations</code>, <code>GetEC2InstanceRecommendations</code>, <code>GetEC2RecommendationProjectedMetrics</code>, <code>GetRDSDatabaseRecommendations</code>, and <code>GetRDSDatabaseRecommendationProjectedMetrics</code> request.</p><br>
12    /// - On success, responds with [`GetRdsDatabaseRecommendationsOutput`](crate::operation::get_rds_database_recommendations::GetRdsDatabaseRecommendationsOutput) with field(s):
13    ///   - [`next_token(Option<String>)`](crate::operation::get_rds_database_recommendations::GetRdsDatabaseRecommendationsOutput::next_token): <p>The token to advance to the next page of Amazon Aurora and RDS database recommendations.</p>
14    ///   - [`rds_db_recommendations(Option<Vec::<RdsdbRecommendation>>)`](crate::operation::get_rds_database_recommendations::GetRdsDatabaseRecommendationsOutput::rds_db_recommendations): <p>An array of objects that describe the Amazon Aurora and RDS database recommendations.</p>
15    ///   - [`errors(Option<Vec::<GetRecommendationError>>)`](crate::operation::get_rds_database_recommendations::GetRdsDatabaseRecommendationsOutput::errors): <p>An array of objects that describe errors of the request.</p>
16    /// - On failure, responds with [`SdkError<GetRDSDatabaseRecommendationsError>`](crate::operation::get_rds_database_recommendations::GetRDSDatabaseRecommendationsError)
17    pub fn get_rds_database_recommendations(
18        &self,
19    ) -> crate::operation::get_rds_database_recommendations::builders::GetRDSDatabaseRecommendationsFluentBuilder {
20        crate::operation::get_rds_database_recommendations::builders::GetRDSDatabaseRecommendationsFluentBuilder::new(self.handle.clone())
21    }
22}