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
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::get_distribution_metric_data::_get_distribution_metric_data_input::GetDistributionMetricDataInputBuilder;
pub use crate::operation::get_distribution_metric_data::_get_distribution_metric_data_output::GetDistributionMetricDataOutputBuilder;
impl crate::operation::get_distribution_metric_data::builders::GetDistributionMetricDataInputBuilder {
/// 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_distribution_metric_data::GetDistributionMetricDataOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::get_distribution_metric_data::GetDistributionMetricDataError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.get_distribution_metric_data();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `GetDistributionMetricData`.
///
/// <p>Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.</p>
/// <p>Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct GetDistributionMetricDataFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::get_distribution_metric_data::builders::GetDistributionMetricDataInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::get_distribution_metric_data::GetDistributionMetricDataOutput,
crate::operation::get_distribution_metric_data::GetDistributionMetricDataError,
> for GetDistributionMetricDataFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::get_distribution_metric_data::GetDistributionMetricDataOutput,
crate::operation::get_distribution_metric_data::GetDistributionMetricDataError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl GetDistributionMetricDataFluentBuilder {
/// Creates a new `GetDistributionMetricDataFluentBuilder`.
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 GetDistributionMetricData as a reference.
pub fn as_input(&self) -> &crate::operation::get_distribution_metric_data::builders::GetDistributionMetricDataInputBuilder {
&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_distribution_metric_data::GetDistributionMetricDataOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::get_distribution_metric_data::GetDistributionMetricDataError,
::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_distribution_metric_data::GetDistributionMetricData::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::get_distribution_metric_data::GetDistributionMetricData::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_distribution_metric_data::GetDistributionMetricDataOutput,
crate::operation::get_distribution_metric_data::GetDistributionMetricDataError,
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 name of the distribution for which to get metric data.</p>
/// <p>Use the <code>GetDistributions</code> action to get a list of distribution names that you can specify.</p>
pub fn distribution_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.distribution_name(input.into());
self
}
/// <p>The name of the distribution for which to get metric data.</p>
/// <p>Use the <code>GetDistributions</code> action to get a list of distribution names that you can specify.</p>
pub fn set_distribution_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_distribution_name(input);
self
}
/// <p>The name of the distribution for which to get metric data.</p>
/// <p>Use the <code>GetDistributions</code> action to get a list of distribution names that you can specify.</p>
pub fn get_distribution_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_distribution_name()
}
/// <p>The metric for which you want to return information.</p>
/// <p>Valid distribution metric names are listed below, along with the most useful <code>statistics</code> to include in your request, and the published <code>unit</code> value.</p>
/// <ul>
/// <li>
/// <p><b> <code>Requests</code> </b> - The total number of viewer requests received by your Lightsail distribution, for all HTTP methods, and for both HTTP and HTTPS requests.</p>
/// <p><code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p>
/// <p><code>Unit</code>: The published unit is <code>None</code>.</p></li>
/// <li>
/// <p><b> <code>BytesDownloaded</code> </b> - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS requests.</p>
/// <p><code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p>
/// <p><code>Unit</code>: The published unit is <code>None</code>.</p></li>
/// <li>
/// <p><b> <code>BytesUploaded </code> </b> - The number of bytes uploaded to your origin by your Lightsail distribution, using POST and PUT requests.</p>
/// <p><code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p>
/// <p><code>Unit</code>: The published unit is <code>None</code>.</p></li>
/// <li>
/// <p><b> <code>TotalErrorRate</code> </b> - The percentage of all viewer requests for which the response's HTTP status code was 4xx or 5xx.</p>
/// <p><code>Statistics</code>: The most useful statistic is <code>Average</code>.</p>
/// <p><code>Unit</code>: The published unit is <code>Percent</code>.</p></li>
/// <li>
/// <p><b> <code>4xxErrorRate</code> </b> - The percentage of all viewer requests for which the response's HTTP status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of 404 (Not Found) means that the client requested an object that could not be found.</p>
/// <p><code>Statistics</code>: The most useful statistic is <code>Average</code>.</p>
/// <p><code>Unit</code>: The published unit is <code>Percent</code>.</p></li>
/// <li>
/// <p><b> <code>5xxErrorRate</code> </b> - The percentage of all viewer requests for which the response's HTTP status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503 (Service Unavailable) means that the origin server is currently unavailable.</p>
/// <p><code>Statistics</code>: The most useful statistic is <code>Average</code>.</p>
/// <p><code>Unit</code>: The published unit is <code>Percent</code>.</p></li>
/// </ul>
pub fn metric_name(mut self, input: crate::types::DistributionMetricName) -> Self {
self.inner = self.inner.metric_name(input);
self
}
/// <p>The metric for which you want to return information.</p>
/// <p>Valid distribution metric names are listed below, along with the most useful <code>statistics</code> to include in your request, and the published <code>unit</code> value.</p>
/// <ul>
/// <li>
/// <p><b> <code>Requests</code> </b> - The total number of viewer requests received by your Lightsail distribution, for all HTTP methods, and for both HTTP and HTTPS requests.</p>
/// <p><code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p>
/// <p><code>Unit</code>: The published unit is <code>None</code>.</p></li>
/// <li>
/// <p><b> <code>BytesDownloaded</code> </b> - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS requests.</p>
/// <p><code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p>
/// <p><code>Unit</code>: The published unit is <code>None</code>.</p></li>
/// <li>
/// <p><b> <code>BytesUploaded </code> </b> - The number of bytes uploaded to your origin by your Lightsail distribution, using POST and PUT requests.</p>
/// <p><code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p>
/// <p><code>Unit</code>: The published unit is <code>None</code>.</p></li>
/// <li>
/// <p><b> <code>TotalErrorRate</code> </b> - The percentage of all viewer requests for which the response's HTTP status code was 4xx or 5xx.</p>
/// <p><code>Statistics</code>: The most useful statistic is <code>Average</code>.</p>
/// <p><code>Unit</code>: The published unit is <code>Percent</code>.</p></li>
/// <li>
/// <p><b> <code>4xxErrorRate</code> </b> - The percentage of all viewer requests for which the response's HTTP status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of 404 (Not Found) means that the client requested an object that could not be found.</p>
/// <p><code>Statistics</code>: The most useful statistic is <code>Average</code>.</p>
/// <p><code>Unit</code>: The published unit is <code>Percent</code>.</p></li>
/// <li>
/// <p><b> <code>5xxErrorRate</code> </b> - The percentage of all viewer requests for which the response's HTTP status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503 (Service Unavailable) means that the origin server is currently unavailable.</p>
/// <p><code>Statistics</code>: The most useful statistic is <code>Average</code>.</p>
/// <p><code>Unit</code>: The published unit is <code>Percent</code>.</p></li>
/// </ul>
pub fn set_metric_name(mut self, input: ::std::option::Option<crate::types::DistributionMetricName>) -> Self {
self.inner = self.inner.set_metric_name(input);
self
}
/// <p>The metric for which you want to return information.</p>
/// <p>Valid distribution metric names are listed below, along with the most useful <code>statistics</code> to include in your request, and the published <code>unit</code> value.</p>
/// <ul>
/// <li>
/// <p><b> <code>Requests</code> </b> - The total number of viewer requests received by your Lightsail distribution, for all HTTP methods, and for both HTTP and HTTPS requests.</p>
/// <p><code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p>
/// <p><code>Unit</code>: The published unit is <code>None</code>.</p></li>
/// <li>
/// <p><b> <code>BytesDownloaded</code> </b> - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS requests.</p>
/// <p><code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p>
/// <p><code>Unit</code>: The published unit is <code>None</code>.</p></li>
/// <li>
/// <p><b> <code>BytesUploaded </code> </b> - The number of bytes uploaded to your origin by your Lightsail distribution, using POST and PUT requests.</p>
/// <p><code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p>
/// <p><code>Unit</code>: The published unit is <code>None</code>.</p></li>
/// <li>
/// <p><b> <code>TotalErrorRate</code> </b> - The percentage of all viewer requests for which the response's HTTP status code was 4xx or 5xx.</p>
/// <p><code>Statistics</code>: The most useful statistic is <code>Average</code>.</p>
/// <p><code>Unit</code>: The published unit is <code>Percent</code>.</p></li>
/// <li>
/// <p><b> <code>4xxErrorRate</code> </b> - The percentage of all viewer requests for which the response's HTTP status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of 404 (Not Found) means that the client requested an object that could not be found.</p>
/// <p><code>Statistics</code>: The most useful statistic is <code>Average</code>.</p>
/// <p><code>Unit</code>: The published unit is <code>Percent</code>.</p></li>
/// <li>
/// <p><b> <code>5xxErrorRate</code> </b> - The percentage of all viewer requests for which the response's HTTP status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503 (Service Unavailable) means that the origin server is currently unavailable.</p>
/// <p><code>Statistics</code>: The most useful statistic is <code>Average</code>.</p>
/// <p><code>Unit</code>: The published unit is <code>Percent</code>.</p></li>
/// </ul>
pub fn get_metric_name(&self) -> &::std::option::Option<crate::types::DistributionMetricName> {
self.inner.get_metric_name()
}
/// <p>The start of the time interval for which to get metric data.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Specified in Coordinated Universal Time (UTC).</p></li>
/// <li>
/// <p>Specified in the Unix time format.</p>
/// <p>For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify <code>1538424000</code> as the start time.</p></li>
/// </ul>
/// <p>You can convert a human-friendly time to Unix time format using a converter like <a href="https://www.epochconverter.com/">Epoch converter</a>.</p>
pub fn start_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.inner = self.inner.start_time(input);
self
}
/// <p>The start of the time interval for which to get metric data.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Specified in Coordinated Universal Time (UTC).</p></li>
/// <li>
/// <p>Specified in the Unix time format.</p>
/// <p>For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify <code>1538424000</code> as the start time.</p></li>
/// </ul>
/// <p>You can convert a human-friendly time to Unix time format using a converter like <a href="https://www.epochconverter.com/">Epoch converter</a>.</p>
pub fn set_start_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.inner = self.inner.set_start_time(input);
self
}
/// <p>The start of the time interval for which to get metric data.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Specified in Coordinated Universal Time (UTC).</p></li>
/// <li>
/// <p>Specified in the Unix time format.</p>
/// <p>For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify <code>1538424000</code> as the start time.</p></li>
/// </ul>
/// <p>You can convert a human-friendly time to Unix time format using a converter like <a href="https://www.epochconverter.com/">Epoch converter</a>.</p>
pub fn get_start_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
self.inner.get_start_time()
}
/// <p>The end of the time interval for which to get metric data.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Specified in Coordinated Universal Time (UTC).</p></li>
/// <li>
/// <p>Specified in the Unix time format.</p>
/// <p>For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify <code>1538427600</code> as the end time.</p></li>
/// </ul>
/// <p>You can convert a human-friendly time to Unix time format using a converter like <a href="https://www.epochconverter.com/">Epoch converter</a>.</p>
pub fn end_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.inner = self.inner.end_time(input);
self
}
/// <p>The end of the time interval for which to get metric data.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Specified in Coordinated Universal Time (UTC).</p></li>
/// <li>
/// <p>Specified in the Unix time format.</p>
/// <p>For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify <code>1538427600</code> as the end time.</p></li>
/// </ul>
/// <p>You can convert a human-friendly time to Unix time format using a converter like <a href="https://www.epochconverter.com/">Epoch converter</a>.</p>
pub fn set_end_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.inner = self.inner.set_end_time(input);
self
}
/// <p>The end of the time interval for which to get metric data.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Specified in Coordinated Universal Time (UTC).</p></li>
/// <li>
/// <p>Specified in the Unix time format.</p>
/// <p>For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify <code>1538427600</code> as the end time.</p></li>
/// </ul>
/// <p>You can convert a human-friendly time to Unix time format using a converter like <a href="https://www.epochconverter.com/">Epoch converter</a>.</p>
pub fn get_end_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
self.inner.get_end_time()
}
/// <p>The granularity, in seconds, for the metric data points that will be returned.</p>
pub fn period(mut self, input: i32) -> Self {
self.inner = self.inner.period(input);
self
}
/// <p>The granularity, in seconds, for the metric data points that will be returned.</p>
pub fn set_period(mut self, input: ::std::option::Option<i32>) -> Self {
self.inner = self.inner.set_period(input);
self
}
/// <p>The granularity, in seconds, for the metric data points that will be returned.</p>
pub fn get_period(&self) -> &::std::option::Option<i32> {
self.inner.get_period()
}
/// <p>The unit for the metric data request.</p>
/// <p>Valid units depend on the metric data being requested. For the valid units with each available metric, see the <code>metricName</code> parameter.</p>
pub fn unit(mut self, input: crate::types::MetricUnit) -> Self {
self.inner = self.inner.unit(input);
self
}
/// <p>The unit for the metric data request.</p>
/// <p>Valid units depend on the metric data being requested. For the valid units with each available metric, see the <code>metricName</code> parameter.</p>
pub fn set_unit(mut self, input: ::std::option::Option<crate::types::MetricUnit>) -> Self {
self.inner = self.inner.set_unit(input);
self
}
/// <p>The unit for the metric data request.</p>
/// <p>Valid units depend on the metric data being requested. For the valid units with each available metric, see the <code>metricName</code> parameter.</p>
pub fn get_unit(&self) -> &::std::option::Option<crate::types::MetricUnit> {
self.inner.get_unit()
}
///
/// Appends an item to `statistics`.
///
/// To override the contents of this collection use [`set_statistics`](Self::set_statistics).
///
/// <p>The statistic for the metric.</p>
/// <p>The following statistics are available:</p>
/// <ul>
/// <li>
/// <p><code>Minimum</code> - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.</p></li>
/// <li>
/// <p><code>Maximum</code> - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.</p></li>
/// <li>
/// <p><code>Sum</code> - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.</p></li>
/// <li>
/// <p><code>Average</code> - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.</p></li>
/// <li>
/// <p><code>SampleCount</code> - The count, or number, of data points used for the statistical calculation.</p></li>
/// </ul>
pub fn statistics(mut self, input: crate::types::MetricStatistic) -> Self {
self.inner = self.inner.statistics(input);
self
}
/// <p>The statistic for the metric.</p>
/// <p>The following statistics are available:</p>
/// <ul>
/// <li>
/// <p><code>Minimum</code> - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.</p></li>
/// <li>
/// <p><code>Maximum</code> - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.</p></li>
/// <li>
/// <p><code>Sum</code> - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.</p></li>
/// <li>
/// <p><code>Average</code> - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.</p></li>
/// <li>
/// <p><code>SampleCount</code> - The count, or number, of data points used for the statistical calculation.</p></li>
/// </ul>
pub fn set_statistics(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::MetricStatistic>>) -> Self {
self.inner = self.inner.set_statistics(input);
self
}
/// <p>The statistic for the metric.</p>
/// <p>The following statistics are available:</p>
/// <ul>
/// <li>
/// <p><code>Minimum</code> - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.</p></li>
/// <li>
/// <p><code>Maximum</code> - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.</p></li>
/// <li>
/// <p><code>Sum</code> - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.</p></li>
/// <li>
/// <p><code>Average</code> - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.</p></li>
/// <li>
/// <p><code>SampleCount</code> - The count, or number, of data points used for the statistical calculation.</p></li>
/// </ul>
pub fn get_statistics(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::MetricStatistic>> {
self.inner.get_statistics()
}
}