@aws-sdk/client-pi 3.56.0 → 3.67.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +27 -0
- package/README.md +20 -21
- package/dist-types/PI.d.ts +23 -26
- package/dist-types/PIClient.d.ts +18 -20
- package/dist-types/commands/GetDimensionKeyDetailsCommand.d.ts +4 -5
- package/dist-types/commands/GetResourceMetricsCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +425 -261
- package/package.json +18 -18
|
@@ -21,138 +21,264 @@ export declare namespace DataPoint {
|
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
23
23
|
* <p>A logical grouping of Performance Insights metrics for a related subject area. For example, the
|
|
24
|
-
* <code>db.sql</code> dimension group consists of the following dimensions
|
|
25
|
-
* <
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
24
|
+
* <code>db.sql</code> dimension group consists of the following dimensions:</p>
|
|
25
|
+
* <ul>
|
|
26
|
+
* <li>
|
|
27
|
+
* <p>
|
|
28
|
+
* <code>db.sql.id</code> - The hash of a running SQL statement, generated by Performance Insights.</p>
|
|
29
|
+
* </li>
|
|
30
|
+
* <li>
|
|
31
|
+
* <p>
|
|
32
|
+
* <code>db.sql.db_id</code> - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with
|
|
33
|
+
* <code>pi-</code>.</p>
|
|
34
|
+
* </li>
|
|
35
|
+
* <li>
|
|
36
|
+
* <p>
|
|
37
|
+
* <code>db.sql.statement</code> - The full text of the SQL statement that is running, for example, <code>SELECT * FROM
|
|
38
|
+
* employees</code>.</p>
|
|
39
|
+
* </li>
|
|
40
|
+
* <li>
|
|
41
|
+
* <p>
|
|
42
|
+
* <code>db.sql_tokenized.id</code> - The hash of the SQL digest generated by Performance Insights.</p>
|
|
43
|
+
* </li>
|
|
44
|
+
* </ul>
|
|
45
|
+
* <note>
|
|
46
|
+
* <p>Each response element returns a maximum of 500 bytes. For larger elements, such as SQL
|
|
47
|
+
* statements, only the first 500 bytes are returned.</p>
|
|
30
48
|
* </note>
|
|
31
49
|
*/
|
|
32
50
|
export interface DimensionGroup {
|
|
33
51
|
/**
|
|
34
|
-
* <p>The name of the dimension group.
|
|
35
|
-
*
|
|
52
|
+
* <p>The name of the dimension group. Valid values are as follows:</p>
|
|
36
53
|
* <ul>
|
|
37
54
|
* <li>
|
|
38
55
|
* <p>
|
|
39
|
-
* <code>db</code> - The name of the database to which the client is connected
|
|
40
|
-
*
|
|
56
|
+
* <code>db</code> - The name of the database to which the client is connected. The following values are permitted:</p>
|
|
57
|
+
* <ul>
|
|
58
|
+
* <li>
|
|
59
|
+
* <p>Aurora PostgreSQL</p>
|
|
60
|
+
* </li>
|
|
61
|
+
* <li>
|
|
62
|
+
* <p>Amazon RDS PostgreSQL</p>
|
|
63
|
+
* </li>
|
|
64
|
+
* <li>
|
|
65
|
+
* <p>Aurora MySQL</p>
|
|
66
|
+
* </li>
|
|
67
|
+
* <li>
|
|
68
|
+
* <p>Amazon RDS MySQL</p>
|
|
69
|
+
* </li>
|
|
70
|
+
* <li>
|
|
71
|
+
* <p>Amazon RDS MariaDB</p>
|
|
72
|
+
* </li>
|
|
73
|
+
* <li>
|
|
74
|
+
* <p>Amazon DocumentDB</p>
|
|
75
|
+
* </li>
|
|
76
|
+
* </ul>
|
|
41
77
|
* </li>
|
|
42
78
|
* <li>
|
|
43
79
|
* <p>
|
|
44
|
-
* <code>db.application</code> - The name of the application that is connected to the database
|
|
45
|
-
*
|
|
80
|
+
* <code>db.application</code> - The name of the application that is connected to the database. The following values are
|
|
81
|
+
* permitted:</p>
|
|
82
|
+
* <ul>
|
|
83
|
+
* <li>
|
|
84
|
+
* <p>Aurora PostgreSQL</p>
|
|
85
|
+
* </li>
|
|
86
|
+
* <li>
|
|
87
|
+
* <p>Amazon RDS PostgreSQL</p>
|
|
88
|
+
* </li>
|
|
89
|
+
* <li>
|
|
90
|
+
* <p>Amazon DocumentDB</p>
|
|
91
|
+
* </li>
|
|
92
|
+
* </ul>
|
|
46
93
|
* </li>
|
|
47
94
|
* <li>
|
|
48
95
|
* <p>
|
|
49
|
-
*
|
|
96
|
+
* <code>db.host</code> - The host name of the connected client (all engines).</p>
|
|
50
97
|
* </li>
|
|
51
98
|
* <li>
|
|
52
|
-
*
|
|
53
|
-
*
|
|
99
|
+
* <p>
|
|
100
|
+
* <code>db.query</code> - The query that is currently running (only Amazon DocumentDB).</p>
|
|
101
|
+
* </li>
|
|
102
|
+
* <li>
|
|
103
|
+
* <p>
|
|
104
|
+
* <code>db.query_tokenized</code> - The digest query (only Amazon DocumentDB).</p>
|
|
54
105
|
* </li>
|
|
55
106
|
* <li>
|
|
56
107
|
* <p>
|
|
57
|
-
*
|
|
108
|
+
* <code>db.session_type</code> - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL).</p>
|
|
58
109
|
* </li>
|
|
59
110
|
* <li>
|
|
60
111
|
* <p>
|
|
61
|
-
*
|
|
112
|
+
* <code>db.sql</code> - The text of the SQL statement that is currently running (all engines except Amazon DocumentDB).</p>
|
|
62
113
|
* </li>
|
|
63
114
|
* <li>
|
|
64
115
|
* <p>
|
|
65
|
-
*
|
|
116
|
+
* <code>db.sql_tokenized</code> - The SQL digest (all engines except Amazon DocumentDB).</p>
|
|
117
|
+
* </li>
|
|
118
|
+
* <li>
|
|
119
|
+
* <p>
|
|
120
|
+
* <code>db.user</code> - The user logged in to the database (all engines except Amazon DocumentDB).</p>
|
|
66
121
|
* </li>
|
|
67
122
|
* <li>
|
|
68
123
|
* <p>
|
|
69
|
-
*
|
|
124
|
+
* <code>db.wait_event</code> - The event for which the database backend is waiting (all engines except Amazon DocumentDB).</p>
|
|
70
125
|
* </li>
|
|
71
126
|
* <li>
|
|
72
127
|
* <p>
|
|
73
|
-
*
|
|
128
|
+
* <code>db.wait_event_type</code> - The type of event for which the database backend is waiting (all engines except Amazon DocumentDB).</p>
|
|
129
|
+
* </li>
|
|
130
|
+
* <li>
|
|
131
|
+
* <p>
|
|
132
|
+
* <code>db.wait_state</code> - The event for which the database backend is waiting (only Amazon DocumentDB).</p>
|
|
74
133
|
* </li>
|
|
75
134
|
* </ul>
|
|
76
135
|
*/
|
|
77
136
|
Group: string | undefined;
|
|
78
137
|
/**
|
|
79
138
|
* <p>A list of specific dimensions from a dimension group. If this parameter is not present,
|
|
80
|
-
*
|
|
81
|
-
*
|
|
82
|
-
*
|
|
83
|
-
*
|
|
84
|
-
* <ul>
|
|
139
|
+
* then it signifies that all of the dimensions in the group were requested, or are present in
|
|
140
|
+
* the response.</p>
|
|
141
|
+
* <p>Valid values for elements in the <code>Dimensions</code> array are:</p>
|
|
142
|
+
* <ul>
|
|
85
143
|
* <li>
|
|
86
|
-
*
|
|
87
|
-
* <code>db.application.name</code> - The name of the application that is connected to the database
|
|
88
|
-
*
|
|
144
|
+
* <p>
|
|
145
|
+
* <code>db.application.name</code> - The name of the application that is connected to the database. Valid values are as follows: </p>
|
|
146
|
+
* <ul>
|
|
147
|
+
* <li>
|
|
148
|
+
* <p>Aurora PostgreSQL</p>
|
|
149
|
+
* </li>
|
|
150
|
+
* <li>
|
|
151
|
+
* <p>Amazon RDS PostgreSQL</p>
|
|
152
|
+
* </li>
|
|
153
|
+
* <li>
|
|
154
|
+
* <p>Amazon DocumentDB</p>
|
|
155
|
+
* </li>
|
|
156
|
+
* </ul>
|
|
89
157
|
* </li>
|
|
90
158
|
* <li>
|
|
91
|
-
*
|
|
92
|
-
*
|
|
159
|
+
* <p>
|
|
160
|
+
* <code>db.host.id</code> - The host ID of the connected client (all engines).</p>
|
|
93
161
|
* </li>
|
|
94
162
|
* <li>
|
|
95
|
-
*
|
|
96
|
-
*
|
|
163
|
+
* <p>
|
|
164
|
+
* <code>db.host.name</code> - The host name of the connected client (all engines).</p>
|
|
97
165
|
* </li>
|
|
98
166
|
* <li>
|
|
99
|
-
*
|
|
100
|
-
* <code>db.name</code> - The name of the database to which the client is connected
|
|
101
|
-
*
|
|
167
|
+
* <p>
|
|
168
|
+
* <code>db.name</code> - The name of the database to which the client is connected. Valid values are as follows:</p>
|
|
169
|
+
* <ul>
|
|
170
|
+
* <li>
|
|
171
|
+
* <p>Aurora PostgreSQL</p>
|
|
172
|
+
* </li>
|
|
173
|
+
* <li>
|
|
174
|
+
* <p>Amazon RDS PostgreSQL</p>
|
|
175
|
+
* </li>
|
|
176
|
+
* <li>
|
|
177
|
+
* <p>Aurora MySQL</p>
|
|
178
|
+
* </li>
|
|
179
|
+
* <li>
|
|
180
|
+
* <p>Amazon RDS MySQL</p>
|
|
181
|
+
* </li>
|
|
182
|
+
* <li>
|
|
183
|
+
* <p>Amazon RDS MariaDB</p>
|
|
184
|
+
* </li>
|
|
185
|
+
* <li>
|
|
186
|
+
* <p>Amazon DocumentDB</p>
|
|
187
|
+
* </li>
|
|
188
|
+
* </ul>
|
|
102
189
|
* </li>
|
|
103
190
|
* <li>
|
|
104
|
-
*
|
|
105
|
-
* <code>db.
|
|
191
|
+
* <p>
|
|
192
|
+
* <code>db.query.id</code> - The query ID generated by Performance Insights (only Amazon DocumentDB).</p>
|
|
106
193
|
* </li>
|
|
107
194
|
* <li>
|
|
108
|
-
*
|
|
109
|
-
*
|
|
195
|
+
* <p>
|
|
196
|
+
* <code>db.query.db_id</code> - The query ID generated by the database (only Amazon DocumentDB).</p>
|
|
110
197
|
* </li>
|
|
111
198
|
* <li>
|
|
112
|
-
*
|
|
113
|
-
*
|
|
199
|
+
* <p>
|
|
200
|
+
* <code>db.query.statement</code> - The text of the query that is being run (only Amazon DocumentDB).</p>
|
|
114
201
|
* </li>
|
|
115
202
|
* <li>
|
|
116
|
-
*
|
|
117
|
-
*
|
|
203
|
+
* <p>
|
|
204
|
+
* <code>db.query.tokenized_id</code>
|
|
205
|
+
* </p>
|
|
118
206
|
* </li>
|
|
119
207
|
* <li>
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
* </p>
|
|
208
|
+
* <p>
|
|
209
|
+
* <code>db.query.tokenized.id</code> - The query digest ID generated by Performance Insights (only Amazon DocumentDB).</p>
|
|
123
210
|
* </li>
|
|
124
211
|
* <li>
|
|
125
|
-
*
|
|
126
|
-
*
|
|
212
|
+
* <p>
|
|
213
|
+
* <code>db.query.tokenized.db_id</code> - The query digest ID generated by Performance Insights (only Amazon DocumentDB).</p>
|
|
127
214
|
* </li>
|
|
128
215
|
* <li>
|
|
129
|
-
*
|
|
130
|
-
*
|
|
216
|
+
* <p>
|
|
217
|
+
* <code>db.query.tokenized.statement</code> - The text of the query digest (only Amazon DocumentDB).</p>
|
|
131
218
|
* </li>
|
|
132
219
|
* <li>
|
|
133
|
-
*
|
|
134
|
-
*
|
|
220
|
+
* <p>
|
|
221
|
+
* <code>db.session_type.name</code> - The type of the current session (only Amazon DocumentDB).</p>
|
|
135
222
|
* </li>
|
|
136
223
|
* <li>
|
|
137
|
-
*
|
|
138
|
-
*
|
|
224
|
+
* <p>
|
|
225
|
+
* <code>db.sql.id</code> - The hash of the full, non-tokenized SQL statement generated by Performance Insights (all engines except Amazon DocumentDB).</p>
|
|
139
226
|
* </li>
|
|
140
227
|
* <li>
|
|
141
|
-
*
|
|
142
|
-
*
|
|
228
|
+
* <p>
|
|
229
|
+
* <code>db.sql.db_id</code> - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with
|
|
230
|
+
* <code>pi-</code> (all engines except Amazon DocumentDB).</p>
|
|
143
231
|
* </li>
|
|
144
232
|
* <li>
|
|
145
|
-
*
|
|
146
|
-
*
|
|
233
|
+
* <p>
|
|
234
|
+
* <code>db.sql.statement</code> - The full text of the SQL statement that is running, as in <code>SELECT * FROM employees</code>
|
|
235
|
+
* (all engines except Amazon DocumentDB)</p>
|
|
147
236
|
* </li>
|
|
148
237
|
* <li>
|
|
149
|
-
*
|
|
150
|
-
*
|
|
238
|
+
* <p>
|
|
239
|
+
* <code>db.sql.tokenized_id</code>
|
|
240
|
+
* </p>
|
|
151
241
|
* </li>
|
|
152
242
|
* <li>
|
|
153
|
-
*
|
|
154
|
-
*
|
|
155
|
-
*
|
|
243
|
+
* <p>
|
|
244
|
+
* <code>db.sql_tokenized.id</code> - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). In the console,
|
|
245
|
+
* <code>db.sql_tokenized.id</code> is called the Support ID because Amazon Web Services Support can look at this data to help you troubleshoot
|
|
246
|
+
* database issues.</p>
|
|
247
|
+
* </li>
|
|
248
|
+
* <li>
|
|
249
|
+
* <p>
|
|
250
|
+
* <code>db.sql_tokenized.db_id</code> - Either the native database ID used to refer to the SQL statement, or a synthetic ID such as
|
|
251
|
+
* <code>pi-2372568224</code> that Performance Insights generates if the native database ID isn't available (all engines except Amazon DocumentDB).</p>
|
|
252
|
+
* </li>
|
|
253
|
+
* <li>
|
|
254
|
+
* <p>
|
|
255
|
+
* <code>db.sql_tokenized.statement</code> - The text of the SQL digest, as in <code>SELECT * FROM employees WHERE employee_id =
|
|
256
|
+
* ?</code> (all engines except Amazon DocumentDB)</p>
|
|
257
|
+
* </li>
|
|
258
|
+
* <li>
|
|
259
|
+
* <p>
|
|
260
|
+
* <code>db.user.id</code> - The ID of the user logged in to the database (all engines except Amazon DocumentDB).</p>
|
|
261
|
+
* </li>
|
|
262
|
+
* <li>
|
|
263
|
+
* <p>
|
|
264
|
+
* <code>db.user.name</code> - The name of the user logged in to the database (all engines except Amazon DocumentDB).</p>
|
|
265
|
+
* </li>
|
|
266
|
+
* <li>
|
|
267
|
+
* <p>
|
|
268
|
+
* <code>db.wait_event.name</code> - The event for which the backend is waiting (all engines except Amazon DocumentDB).</p>
|
|
269
|
+
* </li>
|
|
270
|
+
* <li>
|
|
271
|
+
* <p>
|
|
272
|
+
* <code>db.wait_event.type</code> - The type of event for which the backend is waiting (all engines except Amazon DocumentDB).</p>
|
|
273
|
+
* </li>
|
|
274
|
+
* <li>
|
|
275
|
+
* <p>
|
|
276
|
+
* <code>db.wait_event_type.name</code> - The name of the event type for which the backend is waiting (all engines except
|
|
277
|
+
* Amazon DocumentDB).</p>
|
|
278
|
+
* </li>
|
|
279
|
+
* <li>
|
|
280
|
+
* <p>
|
|
281
|
+
* <code>db.wait_state.name</code> - The event for which the backend is waiting (only Amazon DocumentDB).</p>
|
|
156
282
|
* </li>
|
|
157
283
|
* </ul>
|
|
158
284
|
*/
|
|
@@ -174,125 +300,126 @@ export declare enum ServiceType {
|
|
|
174
300
|
}
|
|
175
301
|
export interface DescribeDimensionKeysRequest {
|
|
176
302
|
/**
|
|
177
|
-
* <p>The Amazon Web Services service for which Performance Insights will return metrics.
|
|
178
|
-
*
|
|
179
|
-
*
|
|
303
|
+
* <p>The Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows:</p>
|
|
304
|
+
* <ul>
|
|
305
|
+
* <li>
|
|
306
|
+
* <p>
|
|
307
|
+
* <code>RDS</code>
|
|
308
|
+
* </p>
|
|
309
|
+
* </li>
|
|
310
|
+
* <li>
|
|
311
|
+
* <p>
|
|
312
|
+
* <code>DOCDB</code>
|
|
313
|
+
* </p>
|
|
314
|
+
* </li>
|
|
315
|
+
* </ul>
|
|
180
316
|
*/
|
|
181
317
|
ServiceType: ServiceType | string | undefined;
|
|
182
318
|
/**
|
|
183
319
|
* <p>An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from
|
|
184
|
-
*
|
|
185
|
-
*
|
|
186
|
-
*
|
|
320
|
+
* this data source.</p>
|
|
321
|
+
* <p>To use an Amazon RDS instance as a data source, you specify its <code>DbiResourceId</code> value.
|
|
322
|
+
* For example, specify <code>db-FAIHNTYBKTGAUSUZQYPDS2GW4A</code>.
|
|
187
323
|
* </p>
|
|
188
324
|
*/
|
|
189
325
|
Identifier: string | undefined;
|
|
190
326
|
/**
|
|
191
327
|
* <p>The date and time specifying the beginning of the requested time series data. You must specify a
|
|
192
|
-
*
|
|
193
|
-
*
|
|
194
|
-
*
|
|
195
|
-
*
|
|
196
|
-
*
|
|
328
|
+
* <code>StartTime</code> within the past 7 days. The value specified is <i>inclusive</i>,
|
|
329
|
+
* which means that data points equal to or greater than <code>StartTime</code> are returned.
|
|
330
|
+
* </p>
|
|
331
|
+
* <p>The value for <code>StartTime</code> must be earlier than the value for <code>EndTime</code>.
|
|
332
|
+
* </p>
|
|
197
333
|
*/
|
|
198
334
|
StartTime: Date | undefined;
|
|
199
335
|
/**
|
|
200
336
|
* <p>The date and time specifying the end of the requested time series data. The value specified is
|
|
201
337
|
* <i>exclusive</i>, which means that data points less than (but not equal to) <code>EndTime</code> are
|
|
202
338
|
* returned.</p>
|
|
203
|
-
*
|
|
204
|
-
* <code>StartTime</code>.</p>
|
|
339
|
+
* <p>The value for <code>EndTime</code> must be later than the value for <code>StartTime</code>.</p>
|
|
205
340
|
*/
|
|
206
341
|
EndTime: Date | undefined;
|
|
207
342
|
/**
|
|
208
343
|
* <p>The name of a Performance Insights metric to be measured.</p>
|
|
209
|
-
*
|
|
210
|
-
*
|
|
211
|
-
* <ul>
|
|
344
|
+
* <p>Valid values for <code>Metric</code> are:</p>
|
|
345
|
+
* <ul>
|
|
212
346
|
* <li>
|
|
213
|
-
*
|
|
214
|
-
*
|
|
215
|
-
* </p>
|
|
347
|
+
* <p>
|
|
348
|
+
* <code>db.load.avg</code> - A scaled representation of the number of active sessions for the database engine. </p>
|
|
216
349
|
* </li>
|
|
217
350
|
* <li>
|
|
218
|
-
*
|
|
219
|
-
*
|
|
220
|
-
* </p>
|
|
351
|
+
* <p>
|
|
352
|
+
* <code>db.sampledload.avg</code> - The raw number of active sessions for the database engine. </p>
|
|
221
353
|
* </li>
|
|
222
354
|
* </ul>
|
|
223
|
-
*
|
|
224
|
-
*
|
|
225
|
-
*
|
|
226
|
-
*
|
|
227
|
-
*
|
|
228
|
-
*
|
|
229
|
-
*
|
|
355
|
+
* <p>If the number of active sessions is less than an internal Performance Insights threshold, <code>db.load.avg</code>
|
|
356
|
+
* and <code>db.sampledload.avg</code> are the same value. If the number of active sessions is greater than
|
|
357
|
+
* the internal threshold, Performance Insights samples the active sessions, with <code>db.load.avg</code>
|
|
358
|
+
* showing the scaled values, <code>db.sampledload.avg</code> showing the raw values, and
|
|
359
|
+
* <code>db.sampledload.avg</code> less than <code>db.load.avg</code>. For most use cases, you can
|
|
360
|
+
* query <code>db.load.avg</code> only.
|
|
361
|
+
* </p>
|
|
230
362
|
*/
|
|
231
363
|
Metric: string | undefined;
|
|
232
364
|
/**
|
|
233
365
|
* <p>The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as
|
|
234
|
-
*
|
|
235
|
-
*
|
|
366
|
+
* one second, or as long as one day (86400 seconds). Valid values are:
|
|
367
|
+
* </p>
|
|
236
368
|
* <ul>
|
|
237
369
|
* <li>
|
|
238
|
-
*
|
|
239
|
-
*
|
|
370
|
+
* <p>
|
|
371
|
+
* <code>1</code> (one second)</p>
|
|
240
372
|
* </li>
|
|
241
373
|
* <li>
|
|
242
|
-
*
|
|
243
|
-
*
|
|
374
|
+
* <p>
|
|
375
|
+
* <code>60</code> (one minute)</p>
|
|
244
376
|
* </li>
|
|
245
377
|
* <li>
|
|
246
|
-
*
|
|
247
|
-
*
|
|
378
|
+
* <p>
|
|
379
|
+
* <code>300</code> (five minutes)</p>
|
|
248
380
|
* </li>
|
|
249
381
|
* <li>
|
|
250
|
-
*
|
|
251
|
-
*
|
|
382
|
+
* <p>
|
|
383
|
+
* <code>3600</code> (one hour)</p>
|
|
252
384
|
* </li>
|
|
253
385
|
* <li>
|
|
254
|
-
*
|
|
255
|
-
*
|
|
386
|
+
* <p>
|
|
387
|
+
* <code>86400</code> (twenty-four hours)</p>
|
|
256
388
|
* </li>
|
|
257
389
|
* </ul>
|
|
258
390
|
*
|
|
259
|
-
*
|
|
260
|
-
*
|
|
261
|
-
*
|
|
391
|
+
* <p>If you don't specify <code>PeriodInSeconds</code>, then Performance Insights chooses a value for you, with a
|
|
392
|
+
* goal of returning roughly 100-200 data points in the response.
|
|
393
|
+
* </p>
|
|
262
394
|
*/
|
|
263
395
|
PeriodInSeconds?: number;
|
|
264
396
|
/**
|
|
265
|
-
* <p>A specification for how to aggregate the data points from a query result. You must specify
|
|
266
|
-
*
|
|
267
|
-
*
|
|
268
|
-
* a limited number of values for a dimension.
|
|
269
|
-
* </p>
|
|
397
|
+
* <p>A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all
|
|
398
|
+
* dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return
|
|
399
|
+
* a limited number of values for a dimension. </p>
|
|
270
400
|
*/
|
|
271
401
|
GroupBy: DimensionGroup | undefined;
|
|
272
402
|
/**
|
|
273
|
-
* <p>Additional metrics for the top <code>N</code> dimension keys.
|
|
274
|
-
*
|
|
275
|
-
*
|
|
276
|
-
* <code>"AdditionalMetrics" : { "<i>string</i>" : "<i>string</i>" }</code>.
|
|
277
|
-
* </p>
|
|
278
|
-
* <p></p>
|
|
403
|
+
* <p>Additional metrics for the top <code>N</code> dimension keys. If the specified dimension group in the <code>GroupBy</code> parameter is
|
|
404
|
+
* <code>db.sql_tokenized</code>, you can specify per-SQL metrics to get the values for the top <code>N</code> SQL digests. The response
|
|
405
|
+
* syntax is as follows: <code>"AdditionalMetrics" : { "<i>string</i>" : "<i>string</i>" }</code>. </p>
|
|
279
406
|
*/
|
|
280
407
|
AdditionalMetrics?: string[];
|
|
281
408
|
/**
|
|
282
409
|
* <p>For each dimension specified in <code>GroupBy</code>, specify a secondary dimension
|
|
283
|
-
*
|
|
284
|
-
*
|
|
410
|
+
* to further subdivide the partition keys in the response.
|
|
411
|
+
* </p>
|
|
285
412
|
*/
|
|
286
413
|
PartitionBy?: DimensionGroup;
|
|
287
414
|
/**
|
|
288
415
|
* <p>One or more filters to apply in the request. Restrictions:</p>
|
|
289
|
-
*
|
|
416
|
+
* <ul>
|
|
290
417
|
* <li>
|
|
291
|
-
*
|
|
418
|
+
* <p>Any number of filters by the same dimension, as specified in the <code>GroupBy</code> or
|
|
292
419
|
* <code>Partition</code> parameters.</p>
|
|
293
420
|
* </li>
|
|
294
421
|
* <li>
|
|
295
|
-
*
|
|
422
|
+
* <p>A single filter for any other dimension in this dimension group.</p>
|
|
296
423
|
* </li>
|
|
297
424
|
* </ul>
|
|
298
425
|
*/
|
|
@@ -300,16 +427,13 @@ export interface DescribeDimensionKeysRequest {
|
|
|
300
427
|
[key: string]: string;
|
|
301
428
|
};
|
|
302
429
|
/**
|
|
303
|
-
* <p>The maximum number of items to return in the response. If more items exist than the
|
|
304
|
-
*
|
|
305
|
-
* so that the remaining results can be retrieved.
|
|
306
|
-
* </p>
|
|
430
|
+
* <p>The maximum number of items to return in the response. If more items exist than the specified <code>MaxRecords</code> value, a
|
|
431
|
+
* pagination token is included in the response so that the remaining results can be retrieved. </p>
|
|
307
432
|
*/
|
|
308
433
|
MaxResults?: number;
|
|
309
434
|
/**
|
|
310
|
-
* <p>An optional pagination token provided by a previous request. If this parameter is specified,
|
|
311
|
-
*
|
|
312
|
-
* </p>
|
|
435
|
+
* <p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond
|
|
436
|
+
* the token, up to the value specified by <code>MaxRecords</code>.</p>
|
|
313
437
|
*/
|
|
314
438
|
NextToken?: string;
|
|
315
439
|
}
|
|
@@ -372,23 +496,18 @@ export declare namespace ResponsePartitionKey {
|
|
|
372
496
|
}
|
|
373
497
|
export interface DescribeDimensionKeysResponse {
|
|
374
498
|
/**
|
|
375
|
-
* <p>The start time for the returned dimension keys, after alignment to a granular boundary (as
|
|
376
|
-
*
|
|
377
|
-
* equal to the value of the user-specified <code>StartTime</code>.
|
|
378
|
-
* </p>
|
|
499
|
+
* <p>The start time for the returned dimension keys, after alignment to a granular boundary (as specified by <code>PeriodInSeconds</code>).
|
|
500
|
+
* <code>AlignedStartTime</code> will be less than or equal to the value of the user-specified <code>StartTime</code>. </p>
|
|
379
501
|
*/
|
|
380
502
|
AlignedStartTime?: Date;
|
|
381
503
|
/**
|
|
382
|
-
* <p>The end time for the returned dimension keys, after alignment to a granular boundary (as
|
|
383
|
-
*
|
|
384
|
-
* or equal to the value of the user-specified <code>Endtime</code>.
|
|
385
|
-
* </p>
|
|
504
|
+
* <p>The end time for the returned dimension keys, after alignment to a granular boundary (as specified by <code>PeriodInSeconds</code>).
|
|
505
|
+
* <code>AlignedEndTime</code> will be greater than or equal to the value of the user-specified <code>Endtime</code>. </p>
|
|
386
506
|
*/
|
|
387
507
|
AlignedEndTime?: Date;
|
|
388
508
|
/**
|
|
389
|
-
* <p>If <code>PartitionBy</code> was present in the request, <code>PartitionKeys</code> contains
|
|
390
|
-
*
|
|
391
|
-
* </p>
|
|
509
|
+
* <p>If <code>PartitionBy</code> was present in the request, <code>PartitionKeys</code> contains the breakdown of dimension keys by the
|
|
510
|
+
* specified partitions. </p>
|
|
392
511
|
*/
|
|
393
512
|
PartitionKeys?: ResponsePartitionKey[];
|
|
394
513
|
/**
|
|
@@ -396,10 +515,8 @@ export interface DescribeDimensionKeysResponse {
|
|
|
396
515
|
*/
|
|
397
516
|
Keys?: DimensionKeyDescription[];
|
|
398
517
|
/**
|
|
399
|
-
* <p>A pagination token that indicates the response didn’t return all available records
|
|
400
|
-
*
|
|
401
|
-
* remaining records, specify <code>NextToken</code> in a separate request with this value.
|
|
402
|
-
* </p>
|
|
518
|
+
* <p>A pagination token that indicates the response didn’t return all available records because <code>MaxRecords</code> was specified in the
|
|
519
|
+
* previous request. To get the remaining records, specify <code>NextToken</code> in a separate request with this value. </p>
|
|
403
520
|
*/
|
|
404
521
|
NextToken?: string;
|
|
405
522
|
}
|
|
@@ -489,13 +606,32 @@ export declare namespace DimensionGroupDetail {
|
|
|
489
606
|
*/
|
|
490
607
|
export interface DimensionKeyDetail {
|
|
491
608
|
/**
|
|
492
|
-
* <p>The value of the dimension detail data.
|
|
493
|
-
*
|
|
609
|
+
* <p>The value of the dimension detail data. Depending on the return status, this value is either the
|
|
610
|
+
* full or truncated SQL query for the following dimensions:</p>
|
|
611
|
+
* <ul>
|
|
612
|
+
* <li>
|
|
613
|
+
* <p>
|
|
614
|
+
* <code>db.query.statement</code> (Amazon DocumentDB)</p>
|
|
615
|
+
* </li>
|
|
616
|
+
* <li>
|
|
617
|
+
* <p>
|
|
618
|
+
* <code>db.sql.statement</code> (Amazon RDS and Aurora)</p>
|
|
619
|
+
* </li>
|
|
620
|
+
* </ul>
|
|
494
621
|
*/
|
|
495
622
|
Value?: string;
|
|
496
623
|
/**
|
|
497
|
-
* <p>The full name of the dimension. The full name includes the group name and key name. The
|
|
498
|
-
* <
|
|
624
|
+
* <p>The full name of the dimension. The full name includes the group name and key name. The following values are valid:</p>
|
|
625
|
+
* <ul>
|
|
626
|
+
* <li>
|
|
627
|
+
* <p>
|
|
628
|
+
* <code>db.query.statement</code> (Amazon DocumentDB)</p>
|
|
629
|
+
* </li>
|
|
630
|
+
* <li>
|
|
631
|
+
* <p>
|
|
632
|
+
* <code>db.sql.statement</code> (Amazon RDS and Aurora)</p>
|
|
633
|
+
* </li>
|
|
634
|
+
* </ul>
|
|
499
635
|
*/
|
|
500
636
|
Dimension?: string;
|
|
501
637
|
/**
|
|
@@ -507,9 +643,8 @@ export interface DimensionKeyDetail {
|
|
|
507
643
|
* </li>
|
|
508
644
|
* <li>
|
|
509
645
|
* <p>
|
|
510
|
-
* <code>PROCESSING</code> - The dimension detail data isn't ready to be retrieved because more processing time is
|
|
511
|
-
*
|
|
512
|
-
* Performance Insights returns the truncated query.</p>
|
|
646
|
+
* <code>PROCESSING</code> - The dimension detail data isn't ready to be retrieved because more processing time is required. If the
|
|
647
|
+
* requested detail data has the status <code>PROCESSING</code>, Performance Insights returns the truncated query.</p>
|
|
513
648
|
* </li>
|
|
514
649
|
* <li>
|
|
515
650
|
* <p>
|
|
@@ -539,34 +674,31 @@ export declare enum FeatureStatus {
|
|
|
539
674
|
*/
|
|
540
675
|
export interface FeatureMetadata {
|
|
541
676
|
/**
|
|
542
|
-
* <p>The status of the feature on the DB instance. Possible values include the following
|
|
543
|
-
*
|
|
544
|
-
* <ul>
|
|
677
|
+
* <p>The status of the feature on the DB instance. Possible values include the following:</p>
|
|
678
|
+
* <ul>
|
|
545
679
|
* <li>
|
|
546
680
|
* <p>
|
|
547
|
-
* <code>ENABLED</code
|
|
681
|
+
* <code>ENABLED</code> - The feature is enabled on the instance.</p>
|
|
548
682
|
* </li>
|
|
549
683
|
* <li>
|
|
550
684
|
* <p>
|
|
551
|
-
* <code>DISABLED</code
|
|
685
|
+
* <code>DISABLED</code> - The feature is disabled on the instance.</p>
|
|
552
686
|
* </li>
|
|
553
687
|
* <li>
|
|
554
688
|
* <p>
|
|
555
|
-
* <code>UNSUPPORTED</code
|
|
689
|
+
* <code>UNSUPPORTED</code> - The feature isn't supported on the instance.</p>
|
|
556
690
|
* </li>
|
|
557
691
|
* <li>
|
|
558
692
|
* <p>
|
|
559
|
-
* <code>ENABLED_PENDING_REBOOT</code
|
|
560
|
-
* a reboot to take effect.</p>
|
|
693
|
+
* <code>ENABLED_PENDING_REBOOT</code> - The feature is enabled on the instance but requires a reboot to take effect.</p>
|
|
561
694
|
* </li>
|
|
562
695
|
* <li>
|
|
563
696
|
* <p>
|
|
564
|
-
* <code>DISABLED_PENDING_REBOOT</code
|
|
565
|
-
* a reboot to take effect.</p>
|
|
697
|
+
* <code>DISABLED_PENDING_REBOOT</code> - The feature is disabled on the instance but requires a reboot to take effect.</p>
|
|
566
698
|
* </li>
|
|
567
699
|
* <li>
|
|
568
700
|
* <p>
|
|
569
|
-
* <code>UNKNOWN</code
|
|
701
|
+
* <code>UNKNOWN</code> - The feature status couldn't be determined.</p>
|
|
570
702
|
* </li>
|
|
571
703
|
* </ul>
|
|
572
704
|
*/
|
|
@@ -591,22 +723,50 @@ export interface GetDimensionKeyDetailsRequest {
|
|
|
591
723
|
*/
|
|
592
724
|
Identifier: string | undefined;
|
|
593
725
|
/**
|
|
594
|
-
* <p>The name of the dimension group.
|
|
595
|
-
*
|
|
726
|
+
* <p>The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are
|
|
727
|
+
* valid:</p>
|
|
728
|
+
* <ul>
|
|
729
|
+
* <li>
|
|
730
|
+
* <p>
|
|
731
|
+
* <code>db.query</code> (Amazon DocumentDB only)</p>
|
|
732
|
+
* </li>
|
|
733
|
+
* <li>
|
|
734
|
+
* <p>
|
|
735
|
+
* <code>db.sql</code> (Amazon RDS and Aurora only)</p>
|
|
736
|
+
* </li>
|
|
737
|
+
* </ul>
|
|
596
738
|
*/
|
|
597
739
|
Group: string | undefined;
|
|
598
740
|
/**
|
|
599
|
-
* <p>The ID of the dimension group from which to retrieve dimension details. For dimension group <code>db.sql</code>,
|
|
600
|
-
*
|
|
741
|
+
* <p>The ID of the dimension group from which to retrieve dimension details. For dimension group <code>db.sql</code>, the group ID is
|
|
742
|
+
* <code>db.sql.id</code>. The following group ID values are valid:</p>
|
|
743
|
+
* <ul>
|
|
744
|
+
* <li>
|
|
745
|
+
* <p>
|
|
746
|
+
* <code>db.sql.id</code> for dimension group <code>db.sql</code> (Aurora and RDS only)</p>
|
|
747
|
+
* </li>
|
|
748
|
+
* <li>
|
|
749
|
+
* <p>
|
|
750
|
+
* <code>db.query.id</code> for dimension group <code>db.query</code> (DocumentDB only)</p>
|
|
751
|
+
* </li>
|
|
752
|
+
* </ul>
|
|
601
753
|
*/
|
|
602
754
|
GroupIdentifier: string | undefined;
|
|
603
755
|
/**
|
|
604
|
-
* <p>A list of dimensions to retrieve the detail data for within the given dimension group.
|
|
605
|
-
*
|
|
606
|
-
*
|
|
607
|
-
*
|
|
608
|
-
*
|
|
609
|
-
*
|
|
756
|
+
* <p>A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns
|
|
757
|
+
* all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:</p>
|
|
758
|
+
* <ul>
|
|
759
|
+
* <li>
|
|
760
|
+
* <p>
|
|
761
|
+
* <code>db.sql</code> - Specify either the full dimension name <code>db.sql.statement</code> or the short dimension name
|
|
762
|
+
* <code>statement</code> (Aurora and RDS only).</p>
|
|
763
|
+
* </li>
|
|
764
|
+
* <li>
|
|
765
|
+
* <p>
|
|
766
|
+
* <code>db.query</code> - Specify either the full dimension name <code>db.query.statement</code> or the short dimension name
|
|
767
|
+
* <code>statement</code> (DocumentDB only).</p>
|
|
768
|
+
* </li>
|
|
769
|
+
* </ul>
|
|
610
770
|
*/
|
|
611
771
|
RequestedDimensions?: string[];
|
|
612
772
|
}
|
|
@@ -679,24 +839,26 @@ export declare namespace GetResourceMetadataResponse {
|
|
|
679
839
|
export interface MetricQuery {
|
|
680
840
|
/**
|
|
681
841
|
* <p>The name of a Performance Insights metric to be measured.</p>
|
|
682
|
-
*
|
|
683
|
-
*
|
|
684
|
-
* <ul>
|
|
842
|
+
* <p>Valid values for <code>Metric</code> are:</p>
|
|
843
|
+
* <ul>
|
|
685
844
|
* <li>
|
|
686
|
-
*
|
|
687
|
-
* <code>db.load.avg</code> -
|
|
688
|
-
*
|
|
845
|
+
* <p>
|
|
846
|
+
* <code>db.load.avg</code> - A scaled representation of the number of active sessions for the
|
|
847
|
+
* database engine.</p>
|
|
689
848
|
* </li>
|
|
690
849
|
* <li>
|
|
691
|
-
*
|
|
692
|
-
* <code>db.sampledload.avg</code> -
|
|
693
|
-
*
|
|
850
|
+
* <p>
|
|
851
|
+
* <code>db.sampledload.avg</code> - The raw number of active sessions for the database engine.</p>
|
|
852
|
+
* </li>
|
|
853
|
+
* <li>
|
|
854
|
+
* <p>The counter metrics listed in <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.OS">Performance Insights
|
|
855
|
+
* operating system counters</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
694
856
|
* </li>
|
|
695
857
|
* </ul>
|
|
696
|
-
*
|
|
697
|
-
*
|
|
698
|
-
*
|
|
699
|
-
*
|
|
858
|
+
* <p>If the number of active sessions is less than an internal Performance Insights threshold, <code>db.load.avg</code> and <code>db.sampledload.avg</code> are the same
|
|
859
|
+
* value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with <code>db.load.avg</code> showing the
|
|
860
|
+
* scaled values, <code>db.sampledload.avg</code> showing the raw values, and <code>db.sampledload.avg</code> less than
|
|
861
|
+
* <code>db.load.avg</code>. For most use cases, you can query <code>db.load.avg</code> only.</p>
|
|
700
862
|
*/
|
|
701
863
|
Metric: string | undefined;
|
|
702
864
|
/**
|
|
@@ -729,79 +891,87 @@ export declare namespace MetricQuery {
|
|
|
729
891
|
}
|
|
730
892
|
export interface GetResourceMetricsRequest {
|
|
731
893
|
/**
|
|
732
|
-
* <p>The Amazon Web Services service for which Performance Insights returns metrics.
|
|
733
|
-
* <
|
|
894
|
+
* <p>The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:</p>
|
|
895
|
+
* <ul>
|
|
896
|
+
* <li>
|
|
897
|
+
* <p>
|
|
898
|
+
* <code>RDS</code>
|
|
899
|
+
* </p>
|
|
900
|
+
* </li>
|
|
901
|
+
* <li>
|
|
902
|
+
* <p>
|
|
903
|
+
* <code>DOCDB</code>
|
|
904
|
+
* </p>
|
|
905
|
+
* </li>
|
|
906
|
+
* </ul>
|
|
734
907
|
*/
|
|
735
908
|
ServiceType: ServiceType | string | undefined;
|
|
736
909
|
/**
|
|
737
|
-
* <p>An immutable
|
|
738
|
-
*
|
|
739
|
-
*
|
|
740
|
-
* <code>
|
|
910
|
+
* <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
|
|
911
|
+
* console, the identifier is shown as <i>ResourceID</i>. When you call <code>DescribeDBInstances</code>, the identifier is
|
|
912
|
+
* returned as <code>DbiResourceId</code>.</p>
|
|
913
|
+
* <p>To use a DB instance as a data source, specify its <code>DbiResourceId</code> value. For example, specify
|
|
914
|
+
* <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.</p>
|
|
741
915
|
*/
|
|
742
916
|
Identifier: string | undefined;
|
|
743
917
|
/**
|
|
744
|
-
* <p>An array of one or more queries to perform. Each query must specify a Performance Insights metric, and
|
|
745
|
-
*
|
|
918
|
+
* <p>An array of one or more queries to perform. Each query must specify a Performance Insights metric, and can optionally specify aggregation and filtering
|
|
919
|
+
* criteria.</p>
|
|
746
920
|
*/
|
|
747
921
|
MetricQueries: MetricQuery[] | undefined;
|
|
748
922
|
/**
|
|
749
|
-
* <p>The date and time specifying the beginning of the requested time series
|
|
750
|
-
*
|
|
751
|
-
*
|
|
752
|
-
*
|
|
753
|
-
*
|
|
923
|
+
* <p>The date and time specifying the beginning of the requested time series query range. You can't
|
|
924
|
+
* specify a <code>StartTime</code> that is earlier than 7 days ago. By default, Performance Insights has 7 days of
|
|
925
|
+
* retention, but you can extend this range up to 2 years. The value specified is
|
|
926
|
+
* <i>inclusive</i>. Thus, the command returns data points equal to or greater
|
|
927
|
+
* than <code>StartTime</code>.</p>
|
|
928
|
+
* <p>The value for <code>StartTime</code> must be earlier than the value for <code>EndTime</code>.</p>
|
|
754
929
|
*/
|
|
755
930
|
StartTime: Date | undefined;
|
|
756
931
|
/**
|
|
757
|
-
* <p>The date and time specifying the end of the requested time series
|
|
758
|
-
*
|
|
759
|
-
*
|
|
932
|
+
* <p>The date and time specifying the end of the requested time series query range. The value
|
|
933
|
+
* specified is <i>exclusive</i>. Thus, the command returns data points less than
|
|
934
|
+
* (but not equal to) <code>EndTime</code>.</p>
|
|
935
|
+
* <p>The value for <code>EndTime</code> must be later than the value for <code>StartTime</code>.</p>
|
|
760
936
|
*/
|
|
761
937
|
EndTime: Date | undefined;
|
|
762
938
|
/**
|
|
763
|
-
* <p>The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as
|
|
764
|
-
*
|
|
765
|
-
*
|
|
939
|
+
* <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
|
|
940
|
+
* seconds). Valid values are:</p>
|
|
766
941
|
* <ul>
|
|
767
942
|
* <li>
|
|
768
|
-
*
|
|
769
|
-
*
|
|
943
|
+
* <p>
|
|
944
|
+
* <code>1</code> (one second)</p>
|
|
770
945
|
* </li>
|
|
771
946
|
* <li>
|
|
772
|
-
*
|
|
773
|
-
*
|
|
947
|
+
* <p>
|
|
948
|
+
* <code>60</code> (one minute)</p>
|
|
774
949
|
* </li>
|
|
775
950
|
* <li>
|
|
776
|
-
*
|
|
777
|
-
*
|
|
951
|
+
* <p>
|
|
952
|
+
* <code>300</code> (five minutes)</p>
|
|
778
953
|
* </li>
|
|
779
954
|
* <li>
|
|
780
|
-
*
|
|
781
|
-
*
|
|
955
|
+
* <p>
|
|
956
|
+
* <code>3600</code> (one hour)</p>
|
|
782
957
|
* </li>
|
|
783
958
|
* <li>
|
|
784
|
-
*
|
|
785
|
-
*
|
|
959
|
+
* <p>
|
|
960
|
+
* <code>86400</code> (twenty-four hours)</p>
|
|
786
961
|
* </li>
|
|
787
962
|
* </ul>
|
|
788
|
-
*
|
|
789
|
-
*
|
|
790
|
-
* you, with a goal of returning roughly 100-200 data points in the response.</p>
|
|
963
|
+
* <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
|
|
964
|
+
* points in the response.</p>
|
|
791
965
|
*/
|
|
792
966
|
PeriodInSeconds?: number;
|
|
793
967
|
/**
|
|
794
|
-
* <p>The maximum number of items to return in the response.
|
|
795
|
-
*
|
|
796
|
-
* token is included in the response so that the remaining
|
|
797
|
-
* results can be retrieved.
|
|
798
|
-
* </p>
|
|
968
|
+
* <p>The maximum number of items to return in the response. If more items exist than the specified <code>MaxRecords</code> value, a
|
|
969
|
+
* pagination token is included in the response so that the remaining results can be retrieved. </p>
|
|
799
970
|
*/
|
|
800
971
|
MaxResults?: number;
|
|
801
972
|
/**
|
|
802
|
-
* <p>An optional pagination token provided by a previous request. If
|
|
803
|
-
*
|
|
804
|
-
* value specified by <code>MaxRecords</code>.</p>
|
|
973
|
+
* <p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond
|
|
974
|
+
* the token, up to the value specified by <code>MaxRecords</code>.</p>
|
|
805
975
|
*/
|
|
806
976
|
NextToken?: string;
|
|
807
977
|
}
|
|
@@ -817,18 +987,19 @@ export declare namespace GetResourceMetricsRequest {
|
|
|
817
987
|
export interface ResponseResourceMetricKey {
|
|
818
988
|
/**
|
|
819
989
|
* <p>The name of a Performance Insights metric to be measured.</p>
|
|
820
|
-
*
|
|
821
|
-
*
|
|
822
|
-
* <ul>
|
|
990
|
+
* <p>Valid values for <code>Metric</code> are:</p>
|
|
991
|
+
* <ul>
|
|
823
992
|
* <li>
|
|
824
|
-
*
|
|
825
|
-
* <code>db.load.avg</code> -
|
|
826
|
-
* for the database engine.</p>
|
|
993
|
+
* <p>
|
|
994
|
+
* <code>db.load.avg</code> - A scaled representation of the number of active sessions for the database engine.</p>
|
|
827
995
|
* </li>
|
|
828
996
|
* <li>
|
|
829
|
-
*
|
|
830
|
-
* <code>db.sampledload.avg</code> -
|
|
831
|
-
*
|
|
997
|
+
* <p>
|
|
998
|
+
* <code>db.sampledload.avg</code> - The raw number of active sessions for the database engine.</p>
|
|
999
|
+
* </li>
|
|
1000
|
+
* <li>
|
|
1001
|
+
* <p>The counter metrics listed in <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.OS">Performance Insights
|
|
1002
|
+
* operating system counters</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
832
1003
|
* </li>
|
|
833
1004
|
* </ul>
|
|
834
1005
|
* <p>If the number of active sessions is less than an internal Performance Insights threshold, <code>db.load.avg</code> and
|
|
@@ -874,28 +1045,24 @@ export declare namespace MetricKeyDataPoints {
|
|
|
874
1045
|
}
|
|
875
1046
|
export interface GetResourceMetricsResponse {
|
|
876
1047
|
/**
|
|
877
|
-
* <p>The start time for the returned metrics, after alignment to a granular boundary (as
|
|
878
|
-
*
|
|
879
|
-
* equal to the value of the user-specified <code>StartTime</code>.</p>
|
|
1048
|
+
* <p>The start time for the returned metrics, after alignment to a granular boundary (as specified by <code>PeriodInSeconds</code>).
|
|
1049
|
+
* <code>AlignedStartTime</code> will be less than or equal to the value of the user-specified <code>StartTime</code>.</p>
|
|
880
1050
|
*/
|
|
881
1051
|
AlignedStartTime?: Date;
|
|
882
1052
|
/**
|
|
883
|
-
* <p>The end time for the returned metrics, after alignment to a granular boundary (as
|
|
884
|
-
*
|
|
885
|
-
* or equal to the value of the user-specified <code>Endtime</code>.</p>
|
|
1053
|
+
* <p>The end time for the returned metrics, after alignment to a granular boundary (as specified by <code>PeriodInSeconds</code>).
|
|
1054
|
+
* <code>AlignedEndTime</code> will be greater than or equal to the value of the user-specified <code>Endtime</code>.</p>
|
|
886
1055
|
*/
|
|
887
1056
|
AlignedEndTime?: Date;
|
|
888
1057
|
/**
|
|
889
|
-
* <p>An immutable
|
|
890
|
-
*
|
|
891
|
-
*
|
|
892
|
-
* <p>To use a DB instance as a data source, you specify its <code>DbiResourceId</code> value -
|
|
893
|
-
* for example: <code>db-FAIHNTYBKTGAUSUZQYPDS2GW4A</code>
|
|
894
|
-
* </p>
|
|
1058
|
+
* <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
|
|
1059
|
+
* console, the identifier is shown as <i>ResourceID</i>. When you call <code>DescribeDBInstances</code>, the identifier is
|
|
1060
|
+
* returned as <code>DbiResourceId</code>.</p>
|
|
895
1061
|
*/
|
|
896
1062
|
Identifier?: string;
|
|
897
1063
|
/**
|
|
898
|
-
* <p>An array of metric results
|
|
1064
|
+
* <p>An array of metric results, where each array element contains all of the data points for a
|
|
1065
|
+
* particular dimension.</p>
|
|
899
1066
|
*/
|
|
900
1067
|
MetricList?: MetricKeyDataPoints[];
|
|
901
1068
|
/**
|
|
@@ -997,19 +1164,19 @@ export interface ListAvailableResourceMetricsRequest {
|
|
|
997
1164
|
* <ul>
|
|
998
1165
|
* <li>
|
|
999
1166
|
* <p>
|
|
1000
|
-
* <code>os</code> (OS counter metrics)</p>
|
|
1167
|
+
* <code>os</code> (OS counter metrics) - All engines</p>
|
|
1001
1168
|
* </li>
|
|
1002
1169
|
* <li>
|
|
1003
1170
|
* <p>
|
|
1004
|
-
* <code>db</code> (DB load metrics)</p>
|
|
1171
|
+
* <code>db</code> (DB load metrics) - All engines except for Amazon DocumentDB</p>
|
|
1005
1172
|
* </li>
|
|
1006
1173
|
* <li>
|
|
1007
1174
|
* <p>
|
|
1008
|
-
* <code>db.sql.stats</code> (per-SQL metrics)</p>
|
|
1175
|
+
* <code>db.sql.stats</code> (per-SQL metrics) - All engines except for Amazon DocumentDB</p>
|
|
1009
1176
|
* </li>
|
|
1010
1177
|
* <li>
|
|
1011
1178
|
* <p>
|
|
1012
|
-
* <code>db.sql_tokenized.stats</code> (per-SQL digest metrics)</p>
|
|
1179
|
+
* <code>db.sql_tokenized.stats</code> (per-SQL digest metrics) - All engines except for Amazon DocumentDB</p>
|
|
1013
1180
|
* </li>
|
|
1014
1181
|
* </ul>
|
|
1015
1182
|
*/
|
|
@@ -1021,9 +1188,8 @@ export interface ListAvailableResourceMetricsRequest {
|
|
|
1021
1188
|
*/
|
|
1022
1189
|
NextToken?: string;
|
|
1023
1190
|
/**
|
|
1024
|
-
* <p>The maximum number of items to return. If the <code>MaxRecords</code> value is less than the number
|
|
1025
|
-
*
|
|
1026
|
-
* </p>
|
|
1191
|
+
* <p>The maximum number of items to return. If the <code>MaxRecords</code> value is less than the number
|
|
1192
|
+
* of existing items, the response includes a pagination token. </p>
|
|
1027
1193
|
*/
|
|
1028
1194
|
MaxResults?: number;
|
|
1029
1195
|
}
|
|
@@ -1060,15 +1226,13 @@ export declare namespace ResponseResourceMetric {
|
|
|
1060
1226
|
export interface ListAvailableResourceMetricsResponse {
|
|
1061
1227
|
/**
|
|
1062
1228
|
* <p>An array of metrics available to query. Each array element contains the full name,
|
|
1063
|
-
*
|
|
1064
|
-
*
|
|
1229
|
+
* description, and unit of the metric.
|
|
1230
|
+
* </p>
|
|
1065
1231
|
*/
|
|
1066
1232
|
Metrics?: ResponseResourceMetric[];
|
|
1067
1233
|
/**
|
|
1068
|
-
* <p>A pagination token that indicates the response didn’t return all available records
|
|
1069
|
-
*
|
|
1070
|
-
* records, specify <code>NextToken</code> in a separate request with this value.
|
|
1071
|
-
* </p>
|
|
1234
|
+
* <p>A pagination token that indicates the response didn’t return all available records because <code>MaxRecords</code> was specified in the
|
|
1235
|
+
* previous request. To get the remaining records, specify <code>NextToken</code> in a separate request with this value. </p>
|
|
1072
1236
|
*/
|
|
1073
1237
|
NextToken?: string;
|
|
1074
1238
|
}
|