aws_sdk_costoptimizationhub/client/
list_recommendation_summaries.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListRecommendationSummaries`](crate::operation::list_recommendation_summaries::builders::ListRecommendationSummariesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_recommendation_summaries::builders::ListRecommendationSummariesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`filter(Filter)`](crate::operation::list_recommendation_summaries::builders::ListRecommendationSummariesFluentBuilder::filter) / [`set_filter(Option<Filter>)`](crate::operation::list_recommendation_summaries::builders::ListRecommendationSummariesFluentBuilder::set_filter):<br>required: **false**<br><p>Describes a filter that returns a more specific list of recommendations. Filters recommendations by different dimensions.</p><br>
    ///   - [`group_by(impl Into<String>)`](crate::operation::list_recommendation_summaries::builders::ListRecommendationSummariesFluentBuilder::group_by) / [`set_group_by(Option<String>)`](crate::operation::list_recommendation_summaries::builders::ListRecommendationSummariesFluentBuilder::set_group_by):<br>required: **true**<br><p>The grouping of recommendations by a dimension.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_recommendation_summaries::builders::ListRecommendationSummariesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_recommendation_summaries::builders::ListRecommendationSummariesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of recommendations to be returned for the request.</p><br>
    ///   - [`metrics(SummaryMetrics)`](crate::operation::list_recommendation_summaries::builders::ListRecommendationSummariesFluentBuilder::metrics) / [`set_metrics(Option<Vec::<SummaryMetrics>>)`](crate::operation::list_recommendation_summaries::builders::ListRecommendationSummariesFluentBuilder::set_metrics):<br>required: **false**<br><p>Additional metrics to be returned for the request. The only valid value is <code>savingsPercentage</code>.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_recommendation_summaries::builders::ListRecommendationSummariesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_recommendation_summaries::builders::ListRecommendationSummariesFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to retrieve the next set of results.</p><br>
    /// - On success, responds with [`ListRecommendationSummariesOutput`](crate::operation::list_recommendation_summaries::ListRecommendationSummariesOutput) with field(s):
    ///   - [`estimated_total_deduped_savings(Option<f64>)`](crate::operation::list_recommendation_summaries::ListRecommendationSummariesOutput::estimated_total_deduped_savings): <p>The total overall savings for the aggregated view.</p>
    ///   - [`items(Option<Vec::<RecommendationSummary>>)`](crate::operation::list_recommendation_summaries::ListRecommendationSummariesOutput::items): <p>A list of all savings recommendations.</p>
    ///   - [`group_by(Option<String>)`](crate::operation::list_recommendation_summaries::ListRecommendationSummariesOutput::group_by): <p>The dimension used to group the recommendations by.</p>
    ///   - [`currency_code(Option<String>)`](crate::operation::list_recommendation_summaries::ListRecommendationSummariesOutput::currency_code): <p>The currency code used for the recommendation.</p>
    ///   - [`metrics(Option<SummaryMetricsResult>)`](crate::operation::list_recommendation_summaries::ListRecommendationSummariesOutput::metrics): <p>The results or descriptions for the additional metrics, based on whether the metrics were or were not requested.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_recommendation_summaries::ListRecommendationSummariesOutput::next_token): <p>The token to retrieve the next set of results.</p>
    /// - On failure, responds with [`SdkError<ListRecommendationSummariesError>`](crate::operation::list_recommendation_summaries::ListRecommendationSummariesError)
    pub fn list_recommendation_summaries(
        &self,
    ) -> crate::operation::list_recommendation_summaries::builders::ListRecommendationSummariesFluentBuilder {
        crate::operation::list_recommendation_summaries::builders::ListRecommendationSummariesFluentBuilder::new(self.handle.clone())
    }
}