aws_sdk_costexplorer/operation/get_usage_forecast/
builders.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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::get_usage_forecast::_get_usage_forecast_output::GetUsageForecastOutputBuilder;

pub use crate::operation::get_usage_forecast::_get_usage_forecast_input::GetUsageForecastInputBuilder;

impl crate::operation::get_usage_forecast::builders::GetUsageForecastInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::get_usage_forecast::GetUsageForecastOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::get_usage_forecast::GetUsageForecastError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.get_usage_forecast();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `GetUsageForecast`.
///
/// <p>Retrieves a forecast for how much Amazon Web Services predicts that you will use over the forecast time period that you select, based on your past usage.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct GetUsageForecastFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::get_usage_forecast::builders::GetUsageForecastInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::get_usage_forecast::GetUsageForecastOutput,
        crate::operation::get_usage_forecast::GetUsageForecastError,
    > for GetUsageForecastFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::get_usage_forecast::GetUsageForecastOutput,
            crate::operation::get_usage_forecast::GetUsageForecastError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl GetUsageForecastFluentBuilder {
    /// Creates a new `GetUsageForecastFluentBuilder`.
    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
        Self {
            handle,
            inner: ::std::default::Default::default(),
            config_override: ::std::option::Option::None,
        }
    }
    /// Access the GetUsageForecast as a reference.
    pub fn as_input(&self) -> &crate::operation::get_usage_forecast::builders::GetUsageForecastInputBuilder {
        &self.inner
    }
    /// Sends the request and returns the response.
    ///
    /// If an error occurs, an `SdkError` will be returned with additional details that
    /// can be matched against.
    ///
    /// By default, any retryable failures will be retried twice. Retry behavior
    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
    /// set when configuring the client.
    pub async fn send(
        self,
    ) -> ::std::result::Result<
        crate::operation::get_usage_forecast::GetUsageForecastOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::get_usage_forecast::GetUsageForecastError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let input = self
            .inner
            .build()
            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
        let runtime_plugins = crate::operation::get_usage_forecast::GetUsageForecast::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::get_usage_forecast::GetUsageForecast::orchestrate(&runtime_plugins, input).await
    }

    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
    pub fn customize(
        self,
    ) -> crate::client::customize::CustomizableOperation<
        crate::operation::get_usage_forecast::GetUsageForecastOutput,
        crate::operation::get_usage_forecast::GetUsageForecastError,
        Self,
    > {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    /// <p>The start and end dates of the period that you want to retrieve usage forecast for. The start date is included in the period, but the end date isn't included in the period. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>. The start date must be equal to or later than the current date to avoid a validation error.</p>
    pub fn time_period(mut self, input: crate::types::DateInterval) -> Self {
        self.inner = self.inner.time_period(input);
        self
    }
    /// <p>The start and end dates of the period that you want to retrieve usage forecast for. The start date is included in the period, but the end date isn't included in the period. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>. The start date must be equal to or later than the current date to avoid a validation error.</p>
    pub fn set_time_period(mut self, input: ::std::option::Option<crate::types::DateInterval>) -> Self {
        self.inner = self.inner.set_time_period(input);
        self
    }
    /// <p>The start and end dates of the period that you want to retrieve usage forecast for. The start date is included in the period, but the end date isn't included in the period. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>. The start date must be equal to or later than the current date to avoid a validation error.</p>
    pub fn get_time_period(&self) -> &::std::option::Option<crate::types::DateInterval> {
        self.inner.get_time_period()
    }
    /// <p>Which metric Cost Explorer uses to create your forecast.</p>
    /// <p>Valid values for a <code>GetUsageForecast</code> call are the following:</p>
    /// <ul>
    /// <li>
    /// <p>USAGE_QUANTITY</p></li>
    /// <li>
    /// <p>NORMALIZED_USAGE_AMOUNT</p></li>
    /// </ul>
    pub fn metric(mut self, input: crate::types::Metric) -> Self {
        self.inner = self.inner.metric(input);
        self
    }
    /// <p>Which metric Cost Explorer uses to create your forecast.</p>
    /// <p>Valid values for a <code>GetUsageForecast</code> call are the following:</p>
    /// <ul>
    /// <li>
    /// <p>USAGE_QUANTITY</p></li>
    /// <li>
    /// <p>NORMALIZED_USAGE_AMOUNT</p></li>
    /// </ul>
    pub fn set_metric(mut self, input: ::std::option::Option<crate::types::Metric>) -> Self {
        self.inner = self.inner.set_metric(input);
        self
    }
    /// <p>Which metric Cost Explorer uses to create your forecast.</p>
    /// <p>Valid values for a <code>GetUsageForecast</code> call are the following:</p>
    /// <ul>
    /// <li>
    /// <p>USAGE_QUANTITY</p></li>
    /// <li>
    /// <p>NORMALIZED_USAGE_AMOUNT</p></li>
    /// </ul>
    pub fn get_metric(&self) -> &::std::option::Option<crate::types::Metric> {
        self.inner.get_metric()
    }
    /// <p>How granular you want the forecast to be. You can get 3 months of <code>DAILY</code> forecasts or 12 months of <code>MONTHLY</code> forecasts.</p>
    /// <p>The <code>GetUsageForecast</code> operation supports only <code>DAILY</code> and <code>MONTHLY</code> granularities.</p>
    pub fn granularity(mut self, input: crate::types::Granularity) -> Self {
        self.inner = self.inner.granularity(input);
        self
    }
    /// <p>How granular you want the forecast to be. You can get 3 months of <code>DAILY</code> forecasts or 12 months of <code>MONTHLY</code> forecasts.</p>
    /// <p>The <code>GetUsageForecast</code> operation supports only <code>DAILY</code> and <code>MONTHLY</code> granularities.</p>
    pub fn set_granularity(mut self, input: ::std::option::Option<crate::types::Granularity>) -> Self {
        self.inner = self.inner.set_granularity(input);
        self
    }
    /// <p>How granular you want the forecast to be. You can get 3 months of <code>DAILY</code> forecasts or 12 months of <code>MONTHLY</code> forecasts.</p>
    /// <p>The <code>GetUsageForecast</code> operation supports only <code>DAILY</code> and <code>MONTHLY</code> granularities.</p>
    pub fn get_granularity(&self) -> &::std::option::Option<crate::types::Granularity> {
        self.inner.get_granularity()
    }
    /// <p>The filters that you want to use to filter your forecast. The <code>GetUsageForecast</code> API supports filtering by the following dimensions:</p>
    /// <ul>
    /// <li>
    /// <p><code>AZ</code></p></li>
    /// <li>
    /// <p><code>INSTANCE_TYPE</code></p></li>
    /// <li>
    /// <p><code>LINKED_ACCOUNT</code></p></li>
    /// <li>
    /// <p><code>LINKED_ACCOUNT_NAME</code></p></li>
    /// <li>
    /// <p><code>OPERATION</code></p></li>
    /// <li>
    /// <p><code>PURCHASE_TYPE</code></p></li>
    /// <li>
    /// <p><code>REGION</code></p></li>
    /// <li>
    /// <p><code>SERVICE</code></p></li>
    /// <li>
    /// <p><code>USAGE_TYPE</code></p></li>
    /// <li>
    /// <p><code>USAGE_TYPE_GROUP</code></p></li>
    /// <li>
    /// <p><code>RECORD_TYPE</code></p></li>
    /// <li>
    /// <p><code>OPERATING_SYSTEM</code></p></li>
    /// <li>
    /// <p><code>TENANCY</code></p></li>
    /// <li>
    /// <p><code>SCOPE</code></p></li>
    /// <li>
    /// <p><code>PLATFORM</code></p></li>
    /// <li>
    /// <p><code>SUBSCRIPTION_ID</code></p></li>
    /// <li>
    /// <p><code>LEGAL_ENTITY_NAME</code></p></li>
    /// <li>
    /// <p><code>DEPLOYMENT_OPTION</code></p></li>
    /// <li>
    /// <p><code>DATABASE_ENGINE</code></p></li>
    /// <li>
    /// <p><code>INSTANCE_TYPE_FAMILY</code></p></li>
    /// <li>
    /// <p><code>BILLING_ENTITY</code></p></li>
    /// <li>
    /// <p><code>RESERVATION_ID</code></p></li>
    /// <li>
    /// <p><code>SAVINGS_PLAN_ARN</code></p></li>
    /// </ul>
    pub fn filter(mut self, input: crate::types::Expression) -> Self {
        self.inner = self.inner.filter(input);
        self
    }
    /// <p>The filters that you want to use to filter your forecast. The <code>GetUsageForecast</code> API supports filtering by the following dimensions:</p>
    /// <ul>
    /// <li>
    /// <p><code>AZ</code></p></li>
    /// <li>
    /// <p><code>INSTANCE_TYPE</code></p></li>
    /// <li>
    /// <p><code>LINKED_ACCOUNT</code></p></li>
    /// <li>
    /// <p><code>LINKED_ACCOUNT_NAME</code></p></li>
    /// <li>
    /// <p><code>OPERATION</code></p></li>
    /// <li>
    /// <p><code>PURCHASE_TYPE</code></p></li>
    /// <li>
    /// <p><code>REGION</code></p></li>
    /// <li>
    /// <p><code>SERVICE</code></p></li>
    /// <li>
    /// <p><code>USAGE_TYPE</code></p></li>
    /// <li>
    /// <p><code>USAGE_TYPE_GROUP</code></p></li>
    /// <li>
    /// <p><code>RECORD_TYPE</code></p></li>
    /// <li>
    /// <p><code>OPERATING_SYSTEM</code></p></li>
    /// <li>
    /// <p><code>TENANCY</code></p></li>
    /// <li>
    /// <p><code>SCOPE</code></p></li>
    /// <li>
    /// <p><code>PLATFORM</code></p></li>
    /// <li>
    /// <p><code>SUBSCRIPTION_ID</code></p></li>
    /// <li>
    /// <p><code>LEGAL_ENTITY_NAME</code></p></li>
    /// <li>
    /// <p><code>DEPLOYMENT_OPTION</code></p></li>
    /// <li>
    /// <p><code>DATABASE_ENGINE</code></p></li>
    /// <li>
    /// <p><code>INSTANCE_TYPE_FAMILY</code></p></li>
    /// <li>
    /// <p><code>BILLING_ENTITY</code></p></li>
    /// <li>
    /// <p><code>RESERVATION_ID</code></p></li>
    /// <li>
    /// <p><code>SAVINGS_PLAN_ARN</code></p></li>
    /// </ul>
    pub fn set_filter(mut self, input: ::std::option::Option<crate::types::Expression>) -> Self {
        self.inner = self.inner.set_filter(input);
        self
    }
    /// <p>The filters that you want to use to filter your forecast. The <code>GetUsageForecast</code> API supports filtering by the following dimensions:</p>
    /// <ul>
    /// <li>
    /// <p><code>AZ</code></p></li>
    /// <li>
    /// <p><code>INSTANCE_TYPE</code></p></li>
    /// <li>
    /// <p><code>LINKED_ACCOUNT</code></p></li>
    /// <li>
    /// <p><code>LINKED_ACCOUNT_NAME</code></p></li>
    /// <li>
    /// <p><code>OPERATION</code></p></li>
    /// <li>
    /// <p><code>PURCHASE_TYPE</code></p></li>
    /// <li>
    /// <p><code>REGION</code></p></li>
    /// <li>
    /// <p><code>SERVICE</code></p></li>
    /// <li>
    /// <p><code>USAGE_TYPE</code></p></li>
    /// <li>
    /// <p><code>USAGE_TYPE_GROUP</code></p></li>
    /// <li>
    /// <p><code>RECORD_TYPE</code></p></li>
    /// <li>
    /// <p><code>OPERATING_SYSTEM</code></p></li>
    /// <li>
    /// <p><code>TENANCY</code></p></li>
    /// <li>
    /// <p><code>SCOPE</code></p></li>
    /// <li>
    /// <p><code>PLATFORM</code></p></li>
    /// <li>
    /// <p><code>SUBSCRIPTION_ID</code></p></li>
    /// <li>
    /// <p><code>LEGAL_ENTITY_NAME</code></p></li>
    /// <li>
    /// <p><code>DEPLOYMENT_OPTION</code></p></li>
    /// <li>
    /// <p><code>DATABASE_ENGINE</code></p></li>
    /// <li>
    /// <p><code>INSTANCE_TYPE_FAMILY</code></p></li>
    /// <li>
    /// <p><code>BILLING_ENTITY</code></p></li>
    /// <li>
    /// <p><code>RESERVATION_ID</code></p></li>
    /// <li>
    /// <p><code>SAVINGS_PLAN_ARN</code></p></li>
    /// </ul>
    pub fn get_filter(&self) -> &::std::option::Option<crate::types::Expression> {
        self.inner.get_filter()
    }
    /// <p>The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to Amazon Web Services Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API.</p>
    pub fn billing_view_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.billing_view_arn(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to Amazon Web Services Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API.</p>
    pub fn set_billing_view_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_billing_view_arn(input);
        self
    }
    /// <p>The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to Amazon Web Services Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API.</p>
    pub fn get_billing_view_arn(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_billing_view_arn()
    }
    /// <p>Amazon Web Services Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.</p>
    pub fn prediction_interval_level(mut self, input: i32) -> Self {
        self.inner = self.inner.prediction_interval_level(input);
        self
    }
    /// <p>Amazon Web Services Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.</p>
    pub fn set_prediction_interval_level(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_prediction_interval_level(input);
        self
    }
    /// <p>Amazon Web Services Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.</p>
    pub fn get_prediction_interval_level(&self) -> &::std::option::Option<i32> {
        self.inner.get_prediction_interval_level()
    }
}