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
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct GetResourceMetricsInput {
/// <p>The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:</p>
/// <ul>
/// <li>
/// <p><code>RDS</code></p></li>
/// <li>
/// <p><code>DOCDB</code></p></li>
/// </ul>
pub service_type: ::std::option::Option<crate::types::ServiceType>,
/// <p>An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as <i>ResourceID</i>. When you call <code>DescribeDBInstances</code>, the identifier is returned as <code>DbiResourceId</code>.</p>
/// <p>To use a DB instance as a data source, specify its <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.</p>
pub identifier: ::std::option::Option<::std::string::String>,
/// <p>An array of one or more queries to perform. Each query must specify a Performance Insights metric and specify an aggregate function, and you can provide filtering criteria. You must append the aggregate function to the metric. For example, to find the average for the metric <code>db.load</code> you must use <code>db.load.avg</code>. Valid values for aggregate functions include <code>.avg</code>, <code>.min</code>, <code>.max</code>, and <code>.sum</code>.</p>
pub metric_queries: ::std::option::Option<::std::vec::Vec<crate::types::MetricQuery>>,
/// <p>The date and time specifying the beginning of the requested time series query range. You can't specify a <code>StartTime</code> that is earlier than 7 days ago. By default, Performance Insights has 7 days of retention, but you can extend this range up to 2 years. The value specified is <i>inclusive</i>. Thus, the command returns data points equal to or greater than <code>StartTime</code>.</p>
/// <p>The value for <code>StartTime</code> must be earlier than the value for <code>EndTime</code>.</p>
pub start_time: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>The date and time specifying the end of the requested time series query range. The value specified is <i>exclusive</i>. Thus, the command returns data points less than (but not equal to) <code>EndTime</code>.</p>
/// <p>The value for <code>EndTime</code> must be later than the value for <code>StartTime</code>.</p>
pub end_time: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:</p>
/// <ul>
/// <li>
/// <p><code>1</code> (one second)</p></li>
/// <li>
/// <p><code>60</code> (one minute)</p></li>
/// <li>
/// <p><code>300</code> (five minutes)</p></li>
/// <li>
/// <p><code>3600</code> (one hour)</p></li>
/// <li>
/// <p><code>86400</code> (twenty-four hours)</p></li>
/// </ul>
/// <p>If you don't specify <code>PeriodInSeconds</code>, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response.</p>
pub period_in_seconds: ::std::option::Option<i32>,
/// <p>The maximum number of items to return in the response.</p>
pub max_results: ::std::option::Option<i32>,
/// <p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by <code>MaxRecords</code>.</p>
pub next_token: ::std::option::Option<::std::string::String>,
/// <p>The returned timestamp which is the start or end time of the time periods. The default value is <code>END_TIME</code>.</p>
pub period_alignment: ::std::option::Option<crate::types::PeriodAlignment>,
}
impl GetResourceMetricsInput {
/// <p>The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:</p>
/// <ul>
/// <li>
/// <p><code>RDS</code></p></li>
/// <li>
/// <p><code>DOCDB</code></p></li>
/// </ul>
pub fn service_type(&self) -> ::std::option::Option<&crate::types::ServiceType> {
self.service_type.as_ref()
}
/// <p>An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as <i>ResourceID</i>. When you call <code>DescribeDBInstances</code>, the identifier is returned as <code>DbiResourceId</code>.</p>
/// <p>To use a DB instance as a data source, specify its <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.</p>
pub fn identifier(&self) -> ::std::option::Option<&str> {
self.identifier.as_deref()
}
/// <p>An array of one or more queries to perform. Each query must specify a Performance Insights metric and specify an aggregate function, and you can provide filtering criteria. You must append the aggregate function to the metric. For example, to find the average for the metric <code>db.load</code> you must use <code>db.load.avg</code>. Valid values for aggregate functions include <code>.avg</code>, <code>.min</code>, <code>.max</code>, and <code>.sum</code>.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.metric_queries.is_none()`.
pub fn metric_queries(&self) -> &[crate::types::MetricQuery] {
self.metric_queries.as_deref().unwrap_or_default()
}
/// <p>The date and time specifying the beginning of the requested time series query range. You can't specify a <code>StartTime</code> that is earlier than 7 days ago. By default, Performance Insights has 7 days of retention, but you can extend this range up to 2 years. The value specified is <i>inclusive</i>. Thus, the command returns data points equal to or greater than <code>StartTime</code>.</p>
/// <p>The value for <code>StartTime</code> must be earlier than the value for <code>EndTime</code>.</p>
pub fn start_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.start_time.as_ref()
}
/// <p>The date and time specifying the end of the requested time series query range. The value specified is <i>exclusive</i>. Thus, the command returns data points less than (but not equal to) <code>EndTime</code>.</p>
/// <p>The value for <code>EndTime</code> must be later than the value for <code>StartTime</code>.</p>
pub fn end_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.end_time.as_ref()
}
/// <p>The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:</p>
/// <ul>
/// <li>
/// <p><code>1</code> (one second)</p></li>
/// <li>
/// <p><code>60</code> (one minute)</p></li>
/// <li>
/// <p><code>300</code> (five minutes)</p></li>
/// <li>
/// <p><code>3600</code> (one hour)</p></li>
/// <li>
/// <p><code>86400</code> (twenty-four hours)</p></li>
/// </ul>
/// <p>If you don't specify <code>PeriodInSeconds</code>, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response.</p>
pub fn period_in_seconds(&self) -> ::std::option::Option<i32> {
self.period_in_seconds
}
/// <p>The maximum number of items to return in the response.</p>
pub fn max_results(&self) -> ::std::option::Option<i32> {
self.max_results
}
/// <p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by <code>MaxRecords</code>.</p>
pub fn next_token(&self) -> ::std::option::Option<&str> {
self.next_token.as_deref()
}
/// <p>The returned timestamp which is the start or end time of the time periods. The default value is <code>END_TIME</code>.</p>
pub fn period_alignment(&self) -> ::std::option::Option<&crate::types::PeriodAlignment> {
self.period_alignment.as_ref()
}
}
impl GetResourceMetricsInput {
/// Creates a new builder-style object to manufacture [`GetResourceMetricsInput`](crate::operation::get_resource_metrics::GetResourceMetricsInput).
pub fn builder() -> crate::operation::get_resource_metrics::builders::GetResourceMetricsInputBuilder {
crate::operation::get_resource_metrics::builders::GetResourceMetricsInputBuilder::default()
}
}
/// A builder for [`GetResourceMetricsInput`](crate::operation::get_resource_metrics::GetResourceMetricsInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct GetResourceMetricsInputBuilder {
pub(crate) service_type: ::std::option::Option<crate::types::ServiceType>,
pub(crate) identifier: ::std::option::Option<::std::string::String>,
pub(crate) metric_queries: ::std::option::Option<::std::vec::Vec<crate::types::MetricQuery>>,
pub(crate) start_time: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) end_time: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) period_in_seconds: ::std::option::Option<i32>,
pub(crate) max_results: ::std::option::Option<i32>,
pub(crate) next_token: ::std::option::Option<::std::string::String>,
pub(crate) period_alignment: ::std::option::Option<crate::types::PeriodAlignment>,
}
impl GetResourceMetricsInputBuilder {
/// <p>The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:</p>
/// <ul>
/// <li>
/// <p><code>RDS</code></p></li>
/// <li>
/// <p><code>DOCDB</code></p></li>
/// </ul>
/// This field is required.
pub fn service_type(mut self, input: crate::types::ServiceType) -> Self {
self.service_type = ::std::option::Option::Some(input);
self
}
/// <p>The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:</p>
/// <ul>
/// <li>
/// <p><code>RDS</code></p></li>
/// <li>
/// <p><code>DOCDB</code></p></li>
/// </ul>
pub fn set_service_type(mut self, input: ::std::option::Option<crate::types::ServiceType>) -> Self {
self.service_type = input;
self
}
/// <p>The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:</p>
/// <ul>
/// <li>
/// <p><code>RDS</code></p></li>
/// <li>
/// <p><code>DOCDB</code></p></li>
/// </ul>
pub fn get_service_type(&self) -> &::std::option::Option<crate::types::ServiceType> {
&self.service_type
}
/// <p>An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as <i>ResourceID</i>. When you call <code>DescribeDBInstances</code>, the identifier is returned as <code>DbiResourceId</code>.</p>
/// <p>To use a DB instance as a data source, specify its <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.</p>
/// This field is required.
pub fn identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.identifier = ::std::option::Option::Some(input.into());
self
}
/// <p>An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as <i>ResourceID</i>. When you call <code>DescribeDBInstances</code>, the identifier is returned as <code>DbiResourceId</code>.</p>
/// <p>To use a DB instance as a data source, specify its <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.</p>
pub fn set_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.identifier = input;
self
}
/// <p>An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as <i>ResourceID</i>. When you call <code>DescribeDBInstances</code>, the identifier is returned as <code>DbiResourceId</code>.</p>
/// <p>To use a DB instance as a data source, specify its <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.</p>
pub fn get_identifier(&self) -> &::std::option::Option<::std::string::String> {
&self.identifier
}
/// Appends an item to `metric_queries`.
///
/// To override the contents of this collection use [`set_metric_queries`](Self::set_metric_queries).
///
/// <p>An array of one or more queries to perform. Each query must specify a Performance Insights metric and specify an aggregate function, and you can provide filtering criteria. You must append the aggregate function to the metric. For example, to find the average for the metric <code>db.load</code> you must use <code>db.load.avg</code>. Valid values for aggregate functions include <code>.avg</code>, <code>.min</code>, <code>.max</code>, and <code>.sum</code>.</p>
pub fn metric_queries(mut self, input: crate::types::MetricQuery) -> Self {
let mut v = self.metric_queries.unwrap_or_default();
v.push(input);
self.metric_queries = ::std::option::Option::Some(v);
self
}
/// <p>An array of one or more queries to perform. Each query must specify a Performance Insights metric and specify an aggregate function, and you can provide filtering criteria. You must append the aggregate function to the metric. For example, to find the average for the metric <code>db.load</code> you must use <code>db.load.avg</code>. Valid values for aggregate functions include <code>.avg</code>, <code>.min</code>, <code>.max</code>, and <code>.sum</code>.</p>
pub fn set_metric_queries(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::MetricQuery>>) -> Self {
self.metric_queries = input;
self
}
/// <p>An array of one or more queries to perform. Each query must specify a Performance Insights metric and specify an aggregate function, and you can provide filtering criteria. You must append the aggregate function to the metric. For example, to find the average for the metric <code>db.load</code> you must use <code>db.load.avg</code>. Valid values for aggregate functions include <code>.avg</code>, <code>.min</code>, <code>.max</code>, and <code>.sum</code>.</p>
pub fn get_metric_queries(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::MetricQuery>> {
&self.metric_queries
}
/// <p>The date and time specifying the beginning of the requested time series query range. You can't specify a <code>StartTime</code> that is earlier than 7 days ago. By default, Performance Insights has 7 days of retention, but you can extend this range up to 2 years. The value specified is <i>inclusive</i>. Thus, the command returns data points equal to or greater than <code>StartTime</code>.</p>
/// <p>The value for <code>StartTime</code> must be earlier than the value for <code>EndTime</code>.</p>
/// This field is required.
pub fn start_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.start_time = ::std::option::Option::Some(input);
self
}
/// <p>The date and time specifying the beginning of the requested time series query range. You can't specify a <code>StartTime</code> that is earlier than 7 days ago. By default, Performance Insights has 7 days of retention, but you can extend this range up to 2 years. The value specified is <i>inclusive</i>. Thus, the command returns data points equal to or greater than <code>StartTime</code>.</p>
/// <p>The value for <code>StartTime</code> must be earlier than the value for <code>EndTime</code>.</p>
pub fn set_start_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.start_time = input;
self
}
/// <p>The date and time specifying the beginning of the requested time series query range. You can't specify a <code>StartTime</code> that is earlier than 7 days ago. By default, Performance Insights has 7 days of retention, but you can extend this range up to 2 years. The value specified is <i>inclusive</i>. Thus, the command returns data points equal to or greater than <code>StartTime</code>.</p>
/// <p>The value for <code>StartTime</code> must be earlier than the value for <code>EndTime</code>.</p>
pub fn get_start_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.start_time
}
/// <p>The date and time specifying the end of the requested time series query range. The value specified is <i>exclusive</i>. Thus, the command returns data points less than (but not equal to) <code>EndTime</code>.</p>
/// <p>The value for <code>EndTime</code> must be later than the value for <code>StartTime</code>.</p>
/// This field is required.
pub fn end_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.end_time = ::std::option::Option::Some(input);
self
}
/// <p>The date and time specifying the end of the requested time series query range. The value specified is <i>exclusive</i>. Thus, the command returns data points less than (but not equal to) <code>EndTime</code>.</p>
/// <p>The value for <code>EndTime</code> must be later than the value for <code>StartTime</code>.</p>
pub fn set_end_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.end_time = input;
self
}
/// <p>The date and time specifying the end of the requested time series query range. The value specified is <i>exclusive</i>. Thus, the command returns data points less than (but not equal to) <code>EndTime</code>.</p>
/// <p>The value for <code>EndTime</code> must be later than the value for <code>StartTime</code>.</p>
pub fn get_end_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.end_time
}
/// <p>The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:</p>
/// <ul>
/// <li>
/// <p><code>1</code> (one second)</p></li>
/// <li>
/// <p><code>60</code> (one minute)</p></li>
/// <li>
/// <p><code>300</code> (five minutes)</p></li>
/// <li>
/// <p><code>3600</code> (one hour)</p></li>
/// <li>
/// <p><code>86400</code> (twenty-four hours)</p></li>
/// </ul>
/// <p>If you don't specify <code>PeriodInSeconds</code>, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response.</p>
pub fn period_in_seconds(mut self, input: i32) -> Self {
self.period_in_seconds = ::std::option::Option::Some(input);
self
}
/// <p>The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:</p>
/// <ul>
/// <li>
/// <p><code>1</code> (one second)</p></li>
/// <li>
/// <p><code>60</code> (one minute)</p></li>
/// <li>
/// <p><code>300</code> (five minutes)</p></li>
/// <li>
/// <p><code>3600</code> (one hour)</p></li>
/// <li>
/// <p><code>86400</code> (twenty-four hours)</p></li>
/// </ul>
/// <p>If you don't specify <code>PeriodInSeconds</code>, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response.</p>
pub fn set_period_in_seconds(mut self, input: ::std::option::Option<i32>) -> Self {
self.period_in_seconds = input;
self
}
/// <p>The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:</p>
/// <ul>
/// <li>
/// <p><code>1</code> (one second)</p></li>
/// <li>
/// <p><code>60</code> (one minute)</p></li>
/// <li>
/// <p><code>300</code> (five minutes)</p></li>
/// <li>
/// <p><code>3600</code> (one hour)</p></li>
/// <li>
/// <p><code>86400</code> (twenty-four hours)</p></li>
/// </ul>
/// <p>If you don't specify <code>PeriodInSeconds</code>, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response.</p>
pub fn get_period_in_seconds(&self) -> &::std::option::Option<i32> {
&self.period_in_seconds
}
/// <p>The maximum number of items to return in the response.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.max_results = ::std::option::Option::Some(input);
self
}
/// <p>The maximum number of items to return in the response.</p>
pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
self.max_results = input;
self
}
/// <p>The maximum number of items to return in the response.</p>
pub fn get_max_results(&self) -> &::std::option::Option<i32> {
&self.max_results
}
/// <p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by <code>MaxRecords</code>.</p>
pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.next_token = ::std::option::Option::Some(input.into());
self
}
/// <p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by <code>MaxRecords</code>.</p>
pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.next_token = input;
self
}
/// <p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by <code>MaxRecords</code>.</p>
pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
&self.next_token
}
/// <p>The returned timestamp which is the start or end time of the time periods. The default value is <code>END_TIME</code>.</p>
pub fn period_alignment(mut self, input: crate::types::PeriodAlignment) -> Self {
self.period_alignment = ::std::option::Option::Some(input);
self
}
/// <p>The returned timestamp which is the start or end time of the time periods. The default value is <code>END_TIME</code>.</p>
pub fn set_period_alignment(mut self, input: ::std::option::Option<crate::types::PeriodAlignment>) -> Self {
self.period_alignment = input;
self
}
/// <p>The returned timestamp which is the start or end time of the time periods. The default value is <code>END_TIME</code>.</p>
pub fn get_period_alignment(&self) -> &::std::option::Option<crate::types::PeriodAlignment> {
&self.period_alignment
}
/// Consumes the builder and constructs a [`GetResourceMetricsInput`](crate::operation::get_resource_metrics::GetResourceMetricsInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::get_resource_metrics::GetResourceMetricsInput, ::aws_smithy_types::error::operation::BuildError>
{
::std::result::Result::Ok(crate::operation::get_resource_metrics::GetResourceMetricsInput {
service_type: self.service_type,
identifier: self.identifier,
metric_queries: self.metric_queries,
start_time: self.start_time,
end_time: self.end_time,
period_in_seconds: self.period_in_seconds,
max_results: self.max_results,
next_token: self.next_token,
period_alignment: self.period_alignment,
})
}
}