aws_sdk_costoptimizationhub/operation/list_efficiency_metrics/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_efficiency_metrics::_list_efficiency_metrics_output::ListEfficiencyMetricsOutputBuilder;
3
4pub use crate::operation::list_efficiency_metrics::_list_efficiency_metrics_input::ListEfficiencyMetricsInputBuilder;
5
6impl crate::operation::list_efficiency_metrics::builders::ListEfficiencyMetricsInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::list_efficiency_metrics::ListEfficiencyMetricsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::list_efficiency_metrics::ListEfficiencyMetricsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.list_efficiency_metrics();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `ListEfficiencyMetrics`.
24///
25/// <p>Returns cost efficiency metrics aggregated over time and optionally grouped by a specified dimension. The metrics provide insights into your cost optimization progress by tracking estimated savings, spending, and measures how effectively you're optimizing your Cloud resources.</p>
26/// <p>The operation supports both daily and monthly time granularities and allows grouping results by account ID, Amazon Web Services Region. Results are returned as time-series data, enabling you to analyze trends in your cost optimization performance over the specified time period.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct ListEfficiencyMetricsFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::list_efficiency_metrics::builders::ListEfficiencyMetricsInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::list_efficiency_metrics::ListEfficiencyMetricsOutput,
36        crate::operation::list_efficiency_metrics::ListEfficiencyMetricsError,
37    > for ListEfficiencyMetricsFluentBuilder
38{
39    fn send(
40        self,
41        config_override: crate::config::Builder,
42    ) -> crate::client::customize::internal::BoxFuture<
43        crate::client::customize::internal::SendResult<
44            crate::operation::list_efficiency_metrics::ListEfficiencyMetricsOutput,
45            crate::operation::list_efficiency_metrics::ListEfficiencyMetricsError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl ListEfficiencyMetricsFluentBuilder {
52    /// Creates a new `ListEfficiencyMetricsFluentBuilder`.
53    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54        Self {
55            handle,
56            inner: ::std::default::Default::default(),
57            config_override: ::std::option::Option::None,
58        }
59    }
60    /// Access the ListEfficiencyMetrics as a reference.
61    pub fn as_input(&self) -> &crate::operation::list_efficiency_metrics::builders::ListEfficiencyMetricsInputBuilder {
62        &self.inner
63    }
64    /// Sends the request and returns the response.
65    ///
66    /// If an error occurs, an `SdkError` will be returned with additional details that
67    /// can be matched against.
68    ///
69    /// By default, any retryable failures will be retried twice. Retry behavior
70    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71    /// set when configuring the client.
72    pub async fn send(
73        self,
74    ) -> ::std::result::Result<
75        crate::operation::list_efficiency_metrics::ListEfficiencyMetricsOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::list_efficiency_metrics::ListEfficiencyMetricsError,
78            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79        >,
80    > {
81        let input = self
82            .inner
83            .build()
84            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85        let runtime_plugins = crate::operation::list_efficiency_metrics::ListEfficiencyMetrics::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::list_efficiency_metrics::ListEfficiencyMetrics::orchestrate(&runtime_plugins, input).await
91    }
92
93    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94    pub fn customize(
95        self,
96    ) -> crate::client::customize::CustomizableOperation<
97        crate::operation::list_efficiency_metrics::ListEfficiencyMetricsOutput,
98        crate::operation::list_efficiency_metrics::ListEfficiencyMetricsError,
99        Self,
100    > {
101        crate::client::customize::CustomizableOperation::new(self)
102    }
103    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104        self.set_config_override(::std::option::Option::Some(config_override.into()));
105        self
106    }
107
108    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109        self.config_override = config_override;
110        self
111    }
112    /// Create a paginator for this request
113    ///
114    /// Paginators are used by calling [`send().await`](crate::operation::list_efficiency_metrics::paginator::ListEfficiencyMetricsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
115    pub fn into_paginator(self) -> crate::operation::list_efficiency_metrics::paginator::ListEfficiencyMetricsPaginator {
116        crate::operation::list_efficiency_metrics::paginator::ListEfficiencyMetricsPaginator::new(self.handle, self.inner)
117    }
118    /// <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>
119    pub fn group_by(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
120        self.inner = self.inner.group_by(input.into());
121        self
122    }
123    /// <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>
124    pub fn set_group_by(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
125        self.inner = self.inner.set_group_by(input);
126        self
127    }
128    /// <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>
129    pub fn get_group_by(&self) -> &::std::option::Option<::std::string::String> {
130        self.inner.get_group_by()
131    }
132    /// <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>
133    pub fn granularity(mut self, input: crate::types::GranularityType) -> Self {
134        self.inner = self.inner.granularity(input);
135        self
136    }
137    /// <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>
138    pub fn set_granularity(mut self, input: ::std::option::Option<crate::types::GranularityType>) -> Self {
139        self.inner = self.inner.set_granularity(input);
140        self
141    }
142    /// <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>
143    pub fn get_granularity(&self) -> &::std::option::Option<crate::types::GranularityType> {
144        self.inner.get_granularity()
145    }
146    /// <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>
147    pub fn time_period(mut self, input: crate::types::TimePeriod) -> Self {
148        self.inner = self.inner.time_period(input);
149        self
150    }
151    /// <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>
152    pub fn set_time_period(mut self, input: ::std::option::Option<crate::types::TimePeriod>) -> Self {
153        self.inner = self.inner.set_time_period(input);
154        self
155    }
156    /// <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>
157    pub fn get_time_period(&self) -> &::std::option::Option<crate::types::TimePeriod> {
158        self.inner.get_time_period()
159    }
160    /// <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>
161    pub fn max_results(mut self, input: i32) -> Self {
162        self.inner = self.inner.max_results(input);
163        self
164    }
165    /// <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>
166    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
167        self.inner = self.inner.set_max_results(input);
168        self
169    }
170    /// <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>
171    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
172        self.inner.get_max_results()
173    }
174    /// <p>The ordering specification for the results. Defines which dimension to sort by and whether to sort in ascending or descending order.</p>
175    pub fn order_by(mut self, input: crate::types::OrderBy) -> Self {
176        self.inner = self.inner.order_by(input);
177        self
178    }
179    /// <p>The ordering specification for the results. Defines which dimension to sort by and whether to sort in ascending or descending order.</p>
180    pub fn set_order_by(mut self, input: ::std::option::Option<crate::types::OrderBy>) -> Self {
181        self.inner = self.inner.set_order_by(input);
182        self
183    }
184    /// <p>The ordering specification for the results. Defines which dimension to sort by and whether to sort in ascending or descending order.</p>
185    pub fn get_order_by(&self) -> &::std::option::Option<crate::types::OrderBy> {
186        self.inner.get_order_by()
187    }
188    /// <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>
189    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
190        self.inner = self.inner.next_token(input.into());
191        self
192    }
193    /// <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>
194    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
195        self.inner = self.inner.set_next_token(input);
196        self
197    }
198    /// <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>
199    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
200        self.inner.get_next_token()
201    }
202}
aws_sdk_costoptimizationhub/operation/list_efficiency_metrics/builders.rs

aws_sdk_costoptimizationhub/operation/list_efficiency_metrics/
builders.rs
