aws_sdk_costoptimizationhub/client/

list_efficiency_metrics.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListEfficiencyMetrics`](crate::operation::list_efficiency_metrics::builders::ListEfficiencyMetricsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_efficiency_metrics::builders::ListEfficiencyMetricsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`group_by(impl Into<String>)`](crate::operation::list_efficiency_metrics::builders::ListEfficiencyMetricsFluentBuilder::group_by) / [`set_group_by(Option<String>)`](crate::operation::list_efficiency_metrics::builders::ListEfficiencyMetricsFluentBuilder::set_group_by):<br>required: **false**<br><p>The dimension by which to group the cost efficiency metrics. Valid values include account ID, Amazon Web Services Region. When no grouping is specified, metrics are aggregated across all resources in the specified time period.</p><br>
    ///   - [`granularity(GranularityType)`](crate::operation::list_efficiency_metrics::builders::ListEfficiencyMetricsFluentBuilder::granularity) / [`set_granularity(Option<GranularityType>)`](crate::operation::list_efficiency_metrics::builders::ListEfficiencyMetricsFluentBuilder::set_granularity):<br>required: **true**<br><p>The time granularity for the cost efficiency metrics. Specify <code>Daily</code> for metrics aggregated by day, or <code>Monthly</code> for metrics aggregated by month.</p><br>
    ///   - [`time_period(TimePeriod)`](crate::operation::list_efficiency_metrics::builders::ListEfficiencyMetricsFluentBuilder::time_period) / [`set_time_period(Option<TimePeriod>)`](crate::operation::list_efficiency_metrics::builders::ListEfficiencyMetricsFluentBuilder::set_time_period):<br>required: **true**<br><p>The time period for which to retrieve the cost efficiency metrics. The start date is inclusive and the end date is exclusive. Dates can be specified in either YYYY-MM-DD format or YYYY-MM format depending on the desired granularity.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_efficiency_metrics::builders::ListEfficiencyMetricsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_efficiency_metrics::builders::ListEfficiencyMetricsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of groups to return in the response. Valid values range from 0 to 1000. Use in conjunction with <code>nextToken</code> to paginate through results when the total number of groups exceeds this limit.</p><br>
    ///   - [`order_by(OrderBy)`](crate::operation::list_efficiency_metrics::builders::ListEfficiencyMetricsFluentBuilder::order_by) / [`set_order_by(Option<OrderBy>)`](crate::operation::list_efficiency_metrics::builders::ListEfficiencyMetricsFluentBuilder::set_order_by):<br>required: **false**<br><p>The ordering specification for the results. Defines which dimension to sort by and whether to sort in ascending or descending order.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_efficiency_metrics::builders::ListEfficiencyMetricsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_efficiency_metrics::builders::ListEfficiencyMetricsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to retrieve the next page of results. This value is returned in the response when the number of groups exceeds the specified <code>maxResults</code> value.</p><br>
    /// - On success, responds with [`ListEfficiencyMetricsOutput`](crate::operation::list_efficiency_metrics::ListEfficiencyMetricsOutput) with field(s):
    ///   - [`efficiency_metrics_by_group(Option<Vec::<EfficiencyMetricsByGroup>>)`](crate::operation::list_efficiency_metrics::ListEfficiencyMetricsOutput::efficiency_metrics_by_group): <p>A list of cost efficiency metrics grouped by the specified dimension. Each group contains time-series data points with cost efficiency, potential savings, and optimzable spend for the specified time period.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_efficiency_metrics::ListEfficiencyMetricsOutput::next_token): <p>The token to retrieve the next page of results. When this value is present in the response, additional groups are available. Pass this token in the <code>nextToken</code> parameter of a subsequent request to retrieve the next page.</p>
    /// - On failure, responds with [`SdkError<ListEfficiencyMetricsError>`](crate::operation::list_efficiency_metrics::ListEfficiencyMetricsError)
    pub fn list_efficiency_metrics(&self) -> crate::operation::list_efficiency_metrics::builders::ListEfficiencyMetricsFluentBuilder {
        crate::operation::list_efficiency_metrics::builders::ListEfficiencyMetricsFluentBuilder::new(self.handle.clone())
    }
}