aws_sdk_ec2/operation/get_capacity_manager_metric_data/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_capacity_manager_metric_data::_get_capacity_manager_metric_data_output::GetCapacityManagerMetricDataOutputBuilder;
3
4pub use crate::operation::get_capacity_manager_metric_data::_get_capacity_manager_metric_data_input::GetCapacityManagerMetricDataInputBuilder;
5
6impl crate::operation::get_capacity_manager_metric_data::builders::GetCapacityManagerMetricDataInputBuilder {
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::get_capacity_manager_metric_data::GetCapacityManagerMetricDataOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::get_capacity_manager_metric_data::GetCapacityManagerMetricDataError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.get_capacity_manager_metric_data();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `GetCapacityManagerMetricData`.
24///
25/// <p>Retrieves capacity usage metrics for your EC2 resources. Returns time-series data for metrics like unused capacity, utilization rates, and costs across On-Demand, Spot, and Capacity Reservations. Data can be grouped and filtered by various dimensions such as region, account, and instance family.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct GetCapacityManagerMetricDataFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::get_capacity_manager_metric_data::builders::GetCapacityManagerMetricDataInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::get_capacity_manager_metric_data::GetCapacityManagerMetricDataOutput,
35        crate::operation::get_capacity_manager_metric_data::GetCapacityManagerMetricDataError,
36    > for GetCapacityManagerMetricDataFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::get_capacity_manager_metric_data::GetCapacityManagerMetricDataOutput,
44            crate::operation::get_capacity_manager_metric_data::GetCapacityManagerMetricDataError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl GetCapacityManagerMetricDataFluentBuilder {
51    /// Creates a new `GetCapacityManagerMetricDataFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the GetCapacityManagerMetricData as a reference.
60    pub fn as_input(&self) -> &crate::operation::get_capacity_manager_metric_data::builders::GetCapacityManagerMetricDataInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::get_capacity_manager_metric_data::GetCapacityManagerMetricDataOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::get_capacity_manager_metric_data::GetCapacityManagerMetricDataError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::get_capacity_manager_metric_data::GetCapacityManagerMetricData::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::get_capacity_manager_metric_data::GetCapacityManagerMetricData::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::get_capacity_manager_metric_data::GetCapacityManagerMetricDataOutput,
97        crate::operation::get_capacity_manager_metric_data::GetCapacityManagerMetricDataError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// Create a paginator for this request
112    ///
113    /// Paginators are used by calling [`send().await`](crate::operation::get_capacity_manager_metric_data::paginator::GetCapacityManagerMetricDataPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
114    pub fn into_paginator(self) -> crate::operation::get_capacity_manager_metric_data::paginator::GetCapacityManagerMetricDataPaginator {
115        crate::operation::get_capacity_manager_metric_data::paginator::GetCapacityManagerMetricDataPaginator::new(self.handle, self.inner)
116    }
117    ///
118    /// Appends an item to `MetricNames`.
119    ///
120    /// To override the contents of this collection use [`set_metric_names`](Self::set_metric_names).
121    ///
122    /// <p>The names of the metrics to retrieve. Maximum of 10 metrics per request.</p>
123    pub fn metric_names(mut self, input: crate::types::Metric) -> Self {
124        self.inner = self.inner.metric_names(input);
125        self
126    }
127    /// <p>The names of the metrics to retrieve. Maximum of 10 metrics per request.</p>
128    pub fn set_metric_names(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Metric>>) -> Self {
129        self.inner = self.inner.set_metric_names(input);
130        self
131    }
132    /// <p>The names of the metrics to retrieve. Maximum of 10 metrics per request.</p>
133    pub fn get_metric_names(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Metric>> {
134        self.inner.get_metric_names()
135    }
136    /// <p>The start time for the metric data query, in ISO 8601 format. The time range (end time - start time) must be a multiple of the specified period.</p>
137    pub fn start_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
138        self.inner = self.inner.start_time(input);
139        self
140    }
141    /// <p>The start time for the metric data query, in ISO 8601 format. The time range (end time - start time) must be a multiple of the specified period.</p>
142    pub fn set_start_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
143        self.inner = self.inner.set_start_time(input);
144        self
145    }
146    /// <p>The start time for the metric data query, in ISO 8601 format. The time range (end time - start time) must be a multiple of the specified period.</p>
147    pub fn get_start_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
148        self.inner.get_start_time()
149    }
150    /// <p>The end time for the metric data query, in ISO 8601 format. If the end time is beyond the latest ingested data, it will be automatically adjusted to the latest available data point.</p>
151    pub fn end_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
152        self.inner = self.inner.end_time(input);
153        self
154    }
155    /// <p>The end time for the metric data query, in ISO 8601 format. If the end time is beyond the latest ingested data, it will be automatically adjusted to the latest available data point.</p>
156    pub fn set_end_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
157        self.inner = self.inner.set_end_time(input);
158        self
159    }
160    /// <p>The end time for the metric data query, in ISO 8601 format. If the end time is beyond the latest ingested data, it will be automatically adjusted to the latest available data point.</p>
161    pub fn get_end_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
162        self.inner.get_end_time()
163    }
164    /// <p>The granularity, in seconds, of the returned data points.</p>
165    pub fn period(mut self, input: i32) -> Self {
166        self.inner = self.inner.period(input);
167        self
168    }
169    /// <p>The granularity, in seconds, of the returned data points.</p>
170    pub fn set_period(mut self, input: ::std::option::Option<i32>) -> Self {
171        self.inner = self.inner.set_period(input);
172        self
173    }
174    /// <p>The granularity, in seconds, of the returned data points.</p>
175    pub fn get_period(&self) -> &::std::option::Option<i32> {
176        self.inner.get_period()
177    }
178    ///
179    /// Appends an item to `GroupBy`.
180    ///
181    /// To override the contents of this collection use [`set_group_by`](Self::set_group_by).
182    ///
183    /// <p>The dimensions by which to group the metric data. This determines how the data is aggregated and returned.</p>
184    pub fn group_by(mut self, input: crate::types::GroupBy) -> Self {
185        self.inner = self.inner.group_by(input);
186        self
187    }
188    /// <p>The dimensions by which to group the metric data. This determines how the data is aggregated and returned.</p>
189    pub fn set_group_by(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::GroupBy>>) -> Self {
190        self.inner = self.inner.set_group_by(input);
191        self
192    }
193    /// <p>The dimensions by which to group the metric data. This determines how the data is aggregated and returned.</p>
194    pub fn get_group_by(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::GroupBy>> {
195        self.inner.get_group_by()
196    }
197    ///
198    /// Appends an item to `FilterBy`.
199    ///
200    /// To override the contents of this collection use [`set_filter_by`](Self::set_filter_by).
201    ///
202    /// <p>Conditions to filter the metric data. Each filter specifies a dimension, comparison operator ('equals', 'in'), and values to match against.</p>
203    pub fn filter_by(mut self, input: crate::types::CapacityManagerCondition) -> Self {
204        self.inner = self.inner.filter_by(input);
205        self
206    }
207    /// <p>Conditions to filter the metric data. Each filter specifies a dimension, comparison operator ('equals', 'in'), and values to match against.</p>
208    pub fn set_filter_by(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::CapacityManagerCondition>>) -> Self {
209        self.inner = self.inner.set_filter_by(input);
210        self
211    }
212    /// <p>Conditions to filter the metric data. Each filter specifies a dimension, comparison operator ('equals', 'in'), and values to match against.</p>
213    pub fn get_filter_by(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::CapacityManagerCondition>> {
214        self.inner.get_filter_by()
215    }
216    /// <p>The maximum number of data points to return. Valid range is 1 to 100,000. Use with NextToken for pagination of large result sets.</p>
217    pub fn max_results(mut self, input: i32) -> Self {
218        self.inner = self.inner.max_results(input);
219        self
220    }
221    /// <p>The maximum number of data points to return. Valid range is 1 to 100,000. Use with NextToken for pagination of large result sets.</p>
222    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
223        self.inner = self.inner.set_max_results(input);
224        self
225    }
226    /// <p>The maximum number of data points to return. Valid range is 1 to 100,000. Use with NextToken for pagination of large result sets.</p>
227    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
228        self.inner.get_max_results()
229    }
230    /// <p>The token for the next page of results. Use this value in a subsequent call to retrieve additional data points.</p>
231    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
232        self.inner = self.inner.next_token(input.into());
233        self
234    }
235    /// <p>The token for the next page of results. Use this value in a subsequent call to retrieve additional data points.</p>
236    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
237        self.inner = self.inner.set_next_token(input);
238        self
239    }
240    /// <p>The token for the next page of results. Use this value in a subsequent call to retrieve additional data points.</p>
241    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
242        self.inner.get_next_token()
243    }
244    /// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
245    pub fn dry_run(mut self, input: bool) -> Self {
246        self.inner = self.inner.dry_run(input);
247        self
248    }
249    /// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
250    pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
251        self.inner = self.inner.set_dry_run(input);
252        self
253    }
254    /// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
255    pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
256        self.inner.get_dry_run()
257    }
258}