aws_sdk_rds/client/

describe_db_recommendations.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeDBRecommendations`](crate::operation::describe_db_recommendations::builders::DescribeDBRecommendationsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_db_recommendations::builders::DescribeDBRecommendationsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`last_updated_after(DateTime)`](crate::operation::describe_db_recommendations::builders::DescribeDBRecommendationsFluentBuilder::last_updated_after) / [`set_last_updated_after(Option<DateTime>)`](crate::operation::describe_db_recommendations::builders::DescribeDBRecommendationsFluentBuilder::set_last_updated_after):<br>required: **false**<br><p>A filter to include only the recommendations that were updated after this specified time.</p><br>
    ///   - [`last_updated_before(DateTime)`](crate::operation::describe_db_recommendations::builders::DescribeDBRecommendationsFluentBuilder::last_updated_before) / [`set_last_updated_before(Option<DateTime>)`](crate::operation::describe_db_recommendations::builders::DescribeDBRecommendationsFluentBuilder::set_last_updated_before):<br>required: **false**<br><p>A filter to include only the recommendations that were updated before this specified time.</p><br>
    ///   - [`locale(impl Into<String>)`](crate::operation::describe_db_recommendations::builders::DescribeDBRecommendationsFluentBuilder::locale) / [`set_locale(Option<String>)`](crate::operation::describe_db_recommendations::builders::DescribeDBRecommendationsFluentBuilder::set_locale):<br>required: **false**<br><p>The language that you choose to return the list of recommendations.</p> <p>Valid values:</p> <ul>  <li>   <p><code>en</code></p></li>  <li>   <p><code>en_UK</code></p></li>  <li>   <p><code>de</code></p></li>  <li>   <p><code>es</code></p></li>  <li>   <p><code>fr</code></p></li>  <li>   <p><code>id</code></p></li>  <li>   <p><code>it</code></p></li>  <li>   <p><code>ja</code></p></li>  <li>   <p><code>ko</code></p></li>  <li>   <p><code>pt_BR</code></p></li>  <li>   <p><code>zh_TW</code></p></li>  <li>   <p><code>zh_CN</code></p></li> </ul><br>
    ///   - [`filters(Filter)`](crate::operation::describe_db_recommendations::builders::DescribeDBRecommendationsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_db_recommendations::builders::DescribeDBRecommendationsFluentBuilder::set_filters):<br>required: **false**<br><p>A filter that specifies one or more recommendations to describe.</p> <p>Supported Filters:</p> <ul>  <li>   <p><code>recommendation-id</code> - Accepts a list of recommendation identifiers. The results list only includes the recommendations whose identifier is one of the specified filter values.</p></li>  <li>   <p><code>status</code> - Accepts a list of recommendation statuses.</p>   <p>Valid values:</p>   <ul>    <li>     <p><code>active</code> - The recommendations which are ready for you to apply.</p></li>    <li>     <p><code>pending</code> - The applied or scheduled recommendations which are in progress.</p></li>    <li>     <p><code>resolved</code> - The recommendations which are completed.</p></li>    <li>     <p><code>dismissed</code> - The recommendations that you dismissed.</p></li>   </ul>   <p>The results list only includes the recommendations whose status is one of the specified filter values.</p></li>  <li>   <p><code>severity</code> - Accepts a list of recommendation severities. The results list only includes the recommendations whose severity is one of the specified filter values.</p>   <p>Valid values:</p>   <ul>    <li>     <p><code>high</code></p></li>    <li>     <p><code>medium</code></p></li>    <li>     <p><code>low</code></p></li>    <li>     <p><code>informational</code></p></li>   </ul></li>  <li>   <p><code>type-id</code> - Accepts a list of recommendation type identifiers. The results list only includes the recommendations whose type is one of the specified filter values.</p></li>  <li>   <p><code>dbi-resource-id</code> - Accepts a list of database resource identifiers. The results list only includes the recommendations that generated for the specified databases.</p></li>  <li>   <p><code>cluster-resource-id</code> - Accepts a list of cluster resource identifiers. The results list only includes the recommendations that generated for the specified clusters.</p></li>  <li>   <p><code>pg-arn</code> - Accepts a list of parameter group ARNs. The results list only includes the recommendations that generated for the specified parameter groups.</p></li>  <li>   <p><code>cluster-pg-arn</code> - Accepts a list of cluster parameter group ARNs. The results list only includes the recommendations that generated for the specified cluster parameter groups.</p></li> </ul><br>
    ///   - [`max_records(i32)`](crate::operation::describe_db_recommendations::builders::DescribeDBRecommendationsFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_db_recommendations::builders::DescribeDBRecommendationsFluentBuilder::set_max_records):<br>required: **false**<br><p>The maximum number of recommendations 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_recommendations::builders::DescribeDBRecommendationsFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::describe_db_recommendations::builders::DescribeDBRecommendationsFluentBuilder::set_marker):<br>required: **false**<br><p>An optional pagination token provided by a previous <code>DescribeDBRecommendations</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>
    /// - On success, responds with [`DescribeDbRecommendationsOutput`](crate::operation::describe_db_recommendations::DescribeDbRecommendationsOutput) with field(s):
    ///   - [`db_recommendations(Option<Vec::<DbRecommendation>>)`](crate::operation::describe_db_recommendations::DescribeDbRecommendationsOutput::db_recommendations): <p>A list of recommendations which is returned from <code>DescribeDBRecommendations</code> API request.</p>
    ///   - [`marker(Option<String>)`](crate::operation::describe_db_recommendations::DescribeDbRecommendationsOutput::marker): <p>An optional pagination token provided by a previous <code>DBRecommendationsMessage</code> request. This token can be used later in a <code>DescribeDBRecomendations</code> request.</p>
    /// - On failure, responds with [`SdkError<DescribeDBRecommendationsError>`](crate::operation::describe_db_recommendations::DescribeDBRecommendationsError)
    pub fn describe_db_recommendations(&self) -> crate::operation::describe_db_recommendations::builders::DescribeDBRecommendationsFluentBuilder {
        crate::operation::describe_db_recommendations::builders::DescribeDBRecommendationsFluentBuilder::new(self.handle.clone())
    }
}