@aws-sdk/client-pi 3.35.0 → 3.38.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.
Files changed (92) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/dist-cjs/PI.js +0 -25
  3. package/dist-cjs/PIClient.js +0 -30
  4. package/dist-cjs/commands/DescribeDimensionKeysCommand.js +0 -30
  5. package/dist-cjs/commands/GetDimensionKeyDetailsCommand.js +0 -28
  6. package/dist-cjs/commands/GetResourceMetricsCommand.js +0 -31
  7. package/dist-cjs/commands/index.js +6 -0
  8. package/dist-cjs/endpoints.js +1 -2
  9. package/dist-cjs/index.js +3 -6
  10. package/dist-cjs/models/index.js +0 -1
  11. package/dist-cjs/models/models_0.js +0 -52
  12. package/dist-cjs/protocols/Aws_json1_1.js +0 -6
  13. package/dist-cjs/runtimeConfig.browser.js +1 -6
  14. package/dist-cjs/runtimeConfig.js +2 -7
  15. package/dist-cjs/runtimeConfig.native.js +0 -4
  16. package/dist-cjs/runtimeConfig.shared.js +0 -4
  17. package/dist-es/PI.js +0 -1
  18. package/dist-es/PIClient.js +0 -1
  19. package/dist-es/commands/DescribeDimensionKeysCommand.js +0 -1
  20. package/dist-es/commands/GetDimensionKeyDetailsCommand.js +0 -1
  21. package/dist-es/commands/GetResourceMetricsCommand.js +0 -1
  22. package/dist-es/commands/index.js +3 -0
  23. package/dist-es/endpoints.js +1 -2
  24. package/dist-es/index.js +3 -6
  25. package/dist-es/models/index.js +0 -1
  26. package/dist-es/models/models_0.js +0 -1
  27. package/dist-es/protocols/Aws_json1_1.js +0 -1
  28. package/dist-es/runtimeConfig.browser.js +1 -2
  29. package/dist-es/runtimeConfig.js +2 -3
  30. package/dist-es/runtimeConfig.native.js +0 -1
  31. package/dist-es/runtimeConfig.shared.js +0 -1
  32. package/dist-types/commands/index.d.ts +3 -0
  33. package/dist-types/index.d.ts +3 -5
  34. package/dist-types/ts3.4/PI.d.ts +4 -47
  35. package/dist-types/ts3.4/PIClient.d.ts +24 -110
  36. package/dist-types/ts3.4/commands/DescribeDimensionKeysCommand.d.ts +2 -25
  37. package/dist-types/ts3.4/commands/GetDimensionKeyDetailsCommand.d.ts +2 -23
  38. package/dist-types/ts3.4/commands/GetResourceMetricsCommand.d.ts +2 -26
  39. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  40. package/dist-types/ts3.4/index.d.ts +3 -5
  41. package/dist-types/ts3.4/models/models_0.d.ts +82 -588
  42. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  43. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  44. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  45. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  46. package/package.json +33 -30
  47. package/dist-cjs/PI.js.map +0 -1
  48. package/dist-cjs/PIClient.js.map +0 -1
  49. package/dist-cjs/commands/DescribeDimensionKeysCommand.js.map +0 -1
  50. package/dist-cjs/commands/GetDimensionKeyDetailsCommand.js.map +0 -1
  51. package/dist-cjs/commands/GetResourceMetricsCommand.js.map +0 -1
  52. package/dist-cjs/endpoints.js.map +0 -1
  53. package/dist-cjs/index.js.map +0 -1
  54. package/dist-cjs/models/index.js.map +0 -1
  55. package/dist-cjs/models/models_0.js.map +0 -1
  56. package/dist-cjs/protocols/Aws_json1_1.js.map +0 -1
  57. package/dist-cjs/runtimeConfig.browser.js.map +0 -1
  58. package/dist-cjs/runtimeConfig.js.map +0 -1
  59. package/dist-cjs/runtimeConfig.native.js.map +0 -1
  60. package/dist-cjs/runtimeConfig.shared.js.map +0 -1
  61. package/dist-es/PI.js.map +0 -1
  62. package/dist-es/PIClient.js.map +0 -1
  63. package/dist-es/commands/DescribeDimensionKeysCommand.js.map +0 -1
  64. package/dist-es/commands/GetDimensionKeyDetailsCommand.js.map +0 -1
  65. package/dist-es/commands/GetResourceMetricsCommand.js.map +0 -1
  66. package/dist-es/endpoints.js.map +0 -1
  67. package/dist-es/index.js.map +0 -1
  68. package/dist-es/models/index.js.map +0 -1
  69. package/dist-es/models/models_0.js.map +0 -1
  70. package/dist-es/protocols/Aws_json1_1.js.map +0 -1
  71. package/dist-es/runtimeConfig.browser.js.map +0 -1
  72. package/dist-es/runtimeConfig.js.map +0 -1
  73. package/dist-es/runtimeConfig.native.js.map +0 -1
  74. package/dist-es/runtimeConfig.shared.js.map +0 -1
  75. package/jest.config.js +0 -4
  76. package/src/PI.ts +0 -154
  77. package/src/PIClient.ts +0 -272
  78. package/src/commands/DescribeDimensionKeysCommand.ts +0 -100
  79. package/src/commands/GetDimensionKeyDetailsCommand.ts +0 -98
  80. package/src/commands/GetResourceMetricsCommand.ts +0 -101
  81. package/src/endpoints.ts +0 -57
  82. package/src/index.ts +0 -6
  83. package/src/models/index.ts +0 -1
  84. package/src/models/models_0.ts +0 -855
  85. package/src/protocols/Aws_json1_1.ts +0 -786
  86. package/src/runtimeConfig.browser.ts +0 -41
  87. package/src/runtimeConfig.native.ts +0 -17
  88. package/src/runtimeConfig.shared.ts +0 -17
  89. package/src/runtimeConfig.ts +0 -46
  90. package/tsconfig.es.json +0 -10
  91. package/tsconfig.json +0 -33
  92. package/tsconfig.types.json +0 -9
@@ -1,855 +0,0 @@
1
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
-
3
- /**
4
- * <p>A timestamp, and a single numerical value, which together represent a measurement at a particular point in time.</p>
5
- */
6
- export interface DataPoint {
7
- /**
8
- * <p>The time, in epoch format, associated with a particular <code>Value</code>.</p>
9
- */
10
- Timestamp: Date | undefined;
11
-
12
- /**
13
- * <p>The actual value associated with a particular <code>Timestamp</code>.</p>
14
- */
15
- Value: number | undefined;
16
- }
17
-
18
- export namespace DataPoint {
19
- /**
20
- * @internal
21
- */
22
- export const filterSensitiveLog = (obj: DataPoint): any => ({
23
- ...obj,
24
- });
25
- }
26
-
27
- /**
28
- * <p>A logical grouping of Performance Insights metrics for a related subject area. For example, the
29
- * <code>db.sql</code> dimension group consists of the following dimensions:
30
- * <code>db.sql.id</code>, <code>db.sql.db_id</code>, <code>db.sql.statement</code>, and
31
- * <code>db.sql.tokenized_id</code>.</p>
32
- * <note>
33
- * <p>Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements,
34
- * only the first 500 bytes are returned.</p>
35
- * </note>
36
- */
37
- export interface DimensionGroup {
38
- /**
39
- * <p>The name of the dimension group. Valid values are:</p>
40
- *
41
- * <ul>
42
- * <li>
43
- * <p>
44
- * <code>db</code> - The name of the database to which the client is connected (only Aurora PostgreSQL, RDS
45
- * PostgreSQL, Aurora MySQL, RDS MySQL, and MariaDB)</p>
46
- * </li>
47
- * <li>
48
- * <p>
49
- * <code>db.application</code> - The name of the application that is connected to the database (only Aurora
50
- * PostgreSQL and RDS PostgreSQL)</p>
51
- * </li>
52
- * <li>
53
- * <p>
54
- * <code>db.host</code> - The host name of the connected client (all engines)</p>
55
- * </li>
56
- * <li>
57
- * <p>
58
- * <code>db.session_type</code> - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)</p>
59
- * </li>
60
- * <li>
61
- * <p>
62
- * <code>db.sql</code> - The SQL that is currently executing (all engines)</p>
63
- * </li>
64
- * <li>
65
- * <p>
66
- * <code>db.sql_tokenized</code> - The SQL digest (all engines)</p>
67
- * </li>
68
- * <li>
69
- * <p>
70
- * <code>db.wait_event</code> - The event for which the database backend is waiting (all engines)</p>
71
- * </li>
72
- * <li>
73
- * <p>
74
- * <code>db.wait_event_type</code> - The type of event for which the database backend is waiting (all engines)</p>
75
- * </li>
76
- * <li>
77
- * <p>
78
- * <code>db.user</code> - The user logged in to the database (all engines)</p>
79
- * </li>
80
- * </ul>
81
- */
82
- Group: string | undefined;
83
-
84
- /**
85
- * <p>A list of specific dimensions from a dimension group. If this parameter is not present,
86
- * then it signifies that all of the dimensions in the group were requested, or are present in
87
- * the response.</p>
88
- * <p>Valid values for elements in the <code>Dimensions</code> array are:</p>
89
- *
90
- * <ul>
91
- * <li>
92
- * <p>
93
- * <code>db.application.name</code> - The name of the application that is connected to the database (only
94
- * Aurora PostgreSQL and RDS PostgreSQL)</p>
95
- * </li>
96
- * <li>
97
- * <p>
98
- * <code>db.host.id</code> - The host ID of the connected client (all engines)</p>
99
- * </li>
100
- * <li>
101
- * <p>
102
- * <code>db.host.name</code> - The host name of the connected client (all engines)</p>
103
- * </li>
104
- * <li>
105
- * <p>
106
- * <code>db.name</code> - The name of the database to which the client is connected (only Aurora
107
- * PostgreSQL, RDS PostgreSQL, Aurora MySQL, RDS MySQL, and MariaDB)</p>
108
- * </li>
109
- * <li>
110
- * <p>
111
- * <code>db.session_type.name</code> - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)</p>
112
- * </li>
113
- * <li>
114
- * <p>
115
- * <code>db.sql.id</code> - The SQL ID generated by Performance Insights (all engines)</p>
116
- * </li>
117
- * <li>
118
- * <p>
119
- * <code>db.sql.db_id</code> - The SQL ID generated by the database (all engines)</p>
120
- * </li>
121
- * <li>
122
- * <p>
123
- * <code>db.sql.statement</code> - The SQL text that is being executed (all engines)</p>
124
- * </li>
125
- * <li>
126
- * <p>
127
- * <code>db.sql.tokenized_id</code>
128
- * </p>
129
- * </li>
130
- * <li>
131
- * <p>
132
- * <code>db.sql_tokenized.id</code> - The SQL digest ID generated by Performance Insights (all engines)</p>
133
- * </li>
134
- * <li>
135
- * <p>
136
- * <code>db.sql_tokenized.db_id</code> - SQL digest ID generated by the database (all engines)</p>
137
- * </li>
138
- * <li>
139
- * <p>
140
- * <code>db.sql_tokenized.statement</code> - The SQL digest text (all engines)</p>
141
- * </li>
142
- * <li>
143
- * <p>
144
- * <code>db.user.id</code> - The ID of the user logged in to the database (all engines)</p>
145
- * </li>
146
- * <li>
147
- * <p>
148
- * <code>db.user.name</code> - The name of the user logged in to the database (all engines)</p>
149
- * </li>
150
- * <li>
151
- * <p>
152
- * <code>db.wait_event.name</code> - The event for which the backend is waiting (all engines)</p>
153
- * </li>
154
- * <li>
155
- * <p>
156
- * <code>db.wait_event.type</code> - The type of event for which the backend is waiting (all engines)</p>
157
- * </li>
158
- * <li>
159
- * <p>
160
- * <code>db.wait_event_type.name</code> - The name of the event type for which the backend is waiting (all
161
- * engines)</p>
162
- * </li>
163
- * </ul>
164
- */
165
- Dimensions?: string[];
166
-
167
- /**
168
- * <p>The maximum number of items to fetch for this dimension group.</p>
169
- */
170
- Limit?: number;
171
- }
172
-
173
- export namespace DimensionGroup {
174
- /**
175
- * @internal
176
- */
177
- export const filterSensitiveLog = (obj: DimensionGroup): any => ({
178
- ...obj,
179
- });
180
- }
181
-
182
- export enum ServiceType {
183
- RDS = "RDS",
184
- }
185
-
186
- export interface DescribeDimensionKeysRequest {
187
- /**
188
- * <p>The AWS service for which Performance Insights will return metrics. The only valid value for <i>ServiceType</i> is
189
- * <code>RDS</code>.</p>
190
- */
191
- ServiceType: ServiceType | string | undefined;
192
-
193
- /**
194
- * <p>An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from
195
- * this data source.</p>
196
- * <p>To use an Amazon RDS instance as a data source, you specify its <code>DbiResourceId</code> value. For example,
197
- * specify <code>db-FAIHNTYBKTGAUSUZQYPDS2GW4A</code>
198
- * </p>
199
- */
200
- Identifier: string | undefined;
201
-
202
- /**
203
- * <p>The date and time specifying the beginning of the requested time series data. You must specify a
204
- * <code>StartTime</code> within the past 7 days. The value specified is <i>inclusive</i>, which means
205
- * that data points equal to or greater than <code>StartTime</code> are returned.</p>
206
- * <p>The value for <code>StartTime</code> must be earlier than the value for
207
- * <code>EndTime</code>.</p>
208
- */
209
- StartTime: Date | undefined;
210
-
211
- /**
212
- * <p>The date and time specifying the end of the requested time series data. The value specified is
213
- * <i>exclusive</i>, which means that data points less than (but not equal to) <code>EndTime</code> are
214
- * returned.</p>
215
- * <p>The value for <code>EndTime</code> must be later than the value for
216
- * <code>StartTime</code>.</p>
217
- */
218
- EndTime: Date | undefined;
219
-
220
- /**
221
- * <p>The name of a Performance Insights metric to be measured.</p>
222
- * <p>Valid values for <code>Metric</code> are:</p>
223
- *
224
- * <ul>
225
- * <li>
226
- * <p>
227
- * <code>db.load.avg</code> - a scaled representation of the number of active sessions
228
- * for the database engine.</p>
229
- * </li>
230
- * <li>
231
- * <p>
232
- * <code>db.sampledload.avg</code> - the raw number of active sessions for the
233
- * database engine.</p>
234
- * </li>
235
- * </ul>
236
- * <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>
237
- * are the same 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>
238
- * showing the scaled values, <code>db.sampledload.avg</code> showing the raw values, and <code>db.sampledload.avg</code> less than <code>db.load.avg</code>.
239
- * For most use cases, you can query <code>db.load.avg</code> only. </p>
240
- */
241
- Metric: string | undefined;
242
-
243
- /**
244
- * <p>The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as
245
- * one second, or as long as one day (86400 seconds). Valid values are:</p>
246
- *
247
- * <ul>
248
- * <li>
249
- * <p>
250
- * <code>1</code> (one second)</p>
251
- * </li>
252
- * <li>
253
- * <p>
254
- * <code>60</code> (one minute)</p>
255
- * </li>
256
- * <li>
257
- * <p>
258
- * <code>300</code> (five minutes)</p>
259
- * </li>
260
- * <li>
261
- * <p>
262
- * <code>3600</code> (one hour)</p>
263
- * </li>
264
- * <li>
265
- * <p>
266
- * <code>86400</code> (twenty-four hours)</p>
267
- * </li>
268
- * </ul>
269
- *
270
- * <p>If you don't specify <code>PeriodInSeconds</code>, then Performance Insights chooses a value for you, with a goal of returning
271
- * roughly 100-200 data points in the response.</p>
272
- */
273
- PeriodInSeconds?: number;
274
-
275
- /**
276
- * <p>A specification for how to aggregate the data points from a query result. You must specify a valid dimension group.
277
- * Performance Insights returns all dimensions within this group, unless you provide the names of specific dimensions within this group.
278
- * You can also request that Performance Insights return a limited number of values for a dimension.</p>
279
- */
280
- GroupBy: DimensionGroup | undefined;
281
-
282
- /**
283
- * <p>For each dimension specified in
284
- * <code>GroupBy</code>, specify a secondary dimension to further subdivide the partition keys in the response.</p>
285
- */
286
- PartitionBy?: DimensionGroup;
287
-
288
- /**
289
- * <p>One or more filters to apply in the request. Restrictions:</p>
290
- * <ul>
291
- * <li>
292
- * <p>Any number of filters by the same dimension, as specified in the <code>GroupBy</code> or
293
- * <code>Partition</code> parameters.</p>
294
- * </li>
295
- * <li>
296
- * <p>A single filter for any other dimension in this dimension group.</p>
297
- * </li>
298
- * </ul>
299
- */
300
- Filter?: { [key: string]: string };
301
-
302
- /**
303
- * <p>The maximum number of items to return in the response.
304
- * If more items exist than the specified <code>MaxRecords</code> value, a pagination
305
- * token is included in the response so that the remaining
306
- * results can be retrieved.
307
- * </p>
308
- */
309
- MaxResults?: number;
310
-
311
- /**
312
- * <p>An optional pagination token provided by a previous request. If
313
- * this parameter is specified, the response includes only records beyond the token, up to the
314
- * value specified by <code>MaxRecords</code>.</p>
315
- */
316
- NextToken?: string;
317
- }
318
-
319
- export namespace DescribeDimensionKeysRequest {
320
- /**
321
- * @internal
322
- */
323
- export const filterSensitiveLog = (obj: DescribeDimensionKeysRequest): any => ({
324
- ...obj,
325
- });
326
- }
327
-
328
- /**
329
- * <p>An array of descriptions and aggregated values for
330
- * each dimension within a dimension group.</p>
331
- */
332
- export interface DimensionKeyDescription {
333
- /**
334
- * <p>A map of name-value pairs for the dimensions in the group.</p>
335
- */
336
- Dimensions?: { [key: string]: string };
337
-
338
- /**
339
- * <p>The aggregated metric value for the dimension(s), over the requested time range.</p>
340
- */
341
- Total?: number;
342
-
343
- /**
344
- * <p>If <code>PartitionBy</code> was specified, <code>PartitionKeys</code> contains the dimensions that were.</p>
345
- */
346
- Partitions?: number[];
347
- }
348
-
349
- export namespace DimensionKeyDescription {
350
- /**
351
- * @internal
352
- */
353
- export const filterSensitiveLog = (obj: DimensionKeyDescription): any => ({
354
- ...obj,
355
- });
356
- }
357
-
358
- /**
359
- * <p>If <code>PartitionBy</code> was specified in a <code>DescribeDimensionKeys</code>
360
- * request, the dimensions are returned in an array. Each element in the array specifies one
361
- * dimension. </p>
362
- */
363
- export interface ResponsePartitionKey {
364
- /**
365
- * <p>A dimension map that contains the dimension(s) for this partition.</p>
366
- */
367
- Dimensions: { [key: string]: string } | undefined;
368
- }
369
-
370
- export namespace ResponsePartitionKey {
371
- /**
372
- * @internal
373
- */
374
- export const filterSensitiveLog = (obj: ResponsePartitionKey): any => ({
375
- ...obj,
376
- });
377
- }
378
-
379
- export interface DescribeDimensionKeysResponse {
380
- /**
381
- * <p>The start time for the returned dimension keys, after alignment to a granular boundary (as
382
- * specified by <code>PeriodInSeconds</code>). <code>AlignedStartTime</code> will be less than or
383
- * equal to the value of the user-specified <code>StartTime</code>.</p>
384
- */
385
- AlignedStartTime?: Date;
386
-
387
- /**
388
- * <p>The end time for the returned dimension keys, after alignment to a granular boundary (as
389
- * specified by <code>PeriodInSeconds</code>). <code>AlignedEndTime</code> will be greater than
390
- * or equal to the value of the user-specified <code>Endtime</code>.</p>
391
- */
392
- AlignedEndTime?: Date;
393
-
394
- /**
395
- * <p>If <code>PartitionBy</code> was present in the request, <code>PartitionKeys</code> contains the breakdown of dimension keys by the specified partitions.</p>
396
- */
397
- PartitionKeys?: ResponsePartitionKey[];
398
-
399
- /**
400
- * <p>The dimension keys that were requested.</p>
401
- */
402
- Keys?: DimensionKeyDescription[];
403
-
404
- /**
405
- * <p>An optional pagination token provided by a previous request. If
406
- * this parameter is specified, the response includes only records beyond the token, up to the
407
- * value specified by <code>MaxRecords</code>.</p>
408
- */
409
- NextToken?: string;
410
- }
411
-
412
- export namespace DescribeDimensionKeysResponse {
413
- /**
414
- * @internal
415
- */
416
- export const filterSensitiveLog = (obj: DescribeDimensionKeysResponse): any => ({
417
- ...obj,
418
- });
419
- }
420
-
421
- /**
422
- * <p>The request failed due to an unknown error.</p>
423
- */
424
- export interface InternalServiceError extends __SmithyException, $MetadataBearer {
425
- name: "InternalServiceError";
426
- $fault: "server";
427
- Message?: string;
428
- }
429
-
430
- export namespace InternalServiceError {
431
- /**
432
- * @internal
433
- */
434
- export const filterSensitiveLog = (obj: InternalServiceError): any => ({
435
- ...obj,
436
- });
437
- }
438
-
439
- /**
440
- * <p>One of the arguments provided is invalid for this request.</p>
441
- */
442
- export interface InvalidArgumentException extends __SmithyException, $MetadataBearer {
443
- name: "InvalidArgumentException";
444
- $fault: "client";
445
- Message?: string;
446
- }
447
-
448
- export namespace InvalidArgumentException {
449
- /**
450
- * @internal
451
- */
452
- export const filterSensitiveLog = (obj: InvalidArgumentException): any => ({
453
- ...obj,
454
- });
455
- }
456
-
457
- /**
458
- * <p>The user is not authorized to perform this request.</p>
459
- */
460
- export interface NotAuthorizedException extends __SmithyException, $MetadataBearer {
461
- name: "NotAuthorizedException";
462
- $fault: "client";
463
- Message?: string;
464
- }
465
-
466
- export namespace NotAuthorizedException {
467
- /**
468
- * @internal
469
- */
470
- export const filterSensitiveLog = (obj: NotAuthorizedException): any => ({
471
- ...obj,
472
- });
473
- }
474
-
475
- export enum DetailStatus {
476
- AVAILABLE = "AVAILABLE",
477
- PROCESSING = "PROCESSING",
478
- UNAVAILABLE = "UNAVAILABLE",
479
- }
480
-
481
- /**
482
- * <p>An object that describes the details for a specified dimension.</p>
483
- */
484
- export interface DimensionKeyDetail {
485
- /**
486
- * <p>The value of the dimension detail data. For the <code>db.sql.statement</code> dimension, this value is either the
487
- * full or truncated SQL query, depending on the return status.</p>
488
- */
489
- Value?: string;
490
-
491
- /**
492
- * <p>The full name of the dimension. The full name includes the group name and key name. The only valid value is
493
- * <code>db.sql.statement</code>. </p>
494
- */
495
- Dimension?: string;
496
-
497
- /**
498
- * <p>The status of the dimension detail data. Possible values include the following:</p>
499
- * <ul>
500
- * <li>
501
- * <p>
502
- * <code>AVAILABLE</code> - The dimension detail data is ready to be retrieved.</p>
503
- * </li>
504
- * <li>
505
- * <p>
506
- * <code>PROCESSING</code> - The dimension detail data isn't ready to be retrieved because more processing time is
507
- * required. If the requested detail data for <code>db.sql.statement</code> has the status <code>PROCESSING</code>,
508
- * Performance Insights returns the truncated query.</p>
509
- * </li>
510
- * <li>
511
- * <p>
512
- * <code>UNAVAILABLE</code> - The dimension detail data could not be collected successfully.</p>
513
- * </li>
514
- * </ul>
515
- */
516
- Status?: DetailStatus | string;
517
- }
518
-
519
- export namespace DimensionKeyDetail {
520
- /**
521
- * @internal
522
- */
523
- export const filterSensitiveLog = (obj: DimensionKeyDetail): any => ({
524
- ...obj,
525
- });
526
- }
527
-
528
- export interface GetDimensionKeyDetailsRequest {
529
- /**
530
- * <p>The AWS service for which Performance Insights returns data. The only valid value is <code>RDS</code>.</p>
531
- */
532
- ServiceType: ServiceType | string | undefined;
533
-
534
- /**
535
- * <p>The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an AWS
536
- * Region. When a DB instance is the data source, specify its <code>DbiResourceId</code> value. For example, specify
537
- * <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>. </p>
538
- */
539
- Identifier: string | undefined;
540
-
541
- /**
542
- * <p>The name of the dimension group. The only valid value is <code>db.sql</code>. Performance Insights searches the
543
- * specified group for the dimension group ID.</p>
544
- */
545
- Group: string | undefined;
546
-
547
- /**
548
- * <p>The ID of the dimension group from which to retrieve dimension details. For dimension group <code>db.sql</code>,
549
- * the group ID is <code>db.sql.id</code>.</p>
550
- */
551
- GroupIdentifier: string | undefined;
552
-
553
- /**
554
- * <p>A list of dimensions to retrieve the detail data for within the given dimension group. For the dimension group
555
- * <code>db.sql</code>, specify either the full dimension name <code>db.sql.statement</code> or the short
556
- * dimension name <code>statement</code>. If you don't specify this parameter, Performance Insights returns all
557
- * dimension data within the specified dimension group.</p>
558
- */
559
- RequestedDimensions?: string[];
560
- }
561
-
562
- export namespace GetDimensionKeyDetailsRequest {
563
- /**
564
- * @internal
565
- */
566
- export const filterSensitiveLog = (obj: GetDimensionKeyDetailsRequest): any => ({
567
- ...obj,
568
- });
569
- }
570
-
571
- export interface GetDimensionKeyDetailsResponse {
572
- /**
573
- * <p>The details for the requested dimensions.</p>
574
- */
575
- Dimensions?: DimensionKeyDetail[];
576
- }
577
-
578
- export namespace GetDimensionKeyDetailsResponse {
579
- /**
580
- * @internal
581
- */
582
- export const filterSensitiveLog = (obj: GetDimensionKeyDetailsResponse): any => ({
583
- ...obj,
584
- });
585
- }
586
-
587
- /**
588
- * <p>A single query to be processed. You must provide the metric to query. If no other
589
- * parameters are specified, Performance Insights returns all of the data points for that metric. You can
590
- * optionally request that the data points be aggregated by dimension group (
591
- * <code>GroupBy</code>), and return only those data points that match your criteria (<code>Filter</code>).</p>
592
- */
593
- export interface MetricQuery {
594
- /**
595
- * <p>The name of a Performance Insights metric to be measured.</p>
596
- * <p>Valid values for <code>Metric</code> are:</p>
597
- *
598
- * <ul>
599
- * <li>
600
- * <p>
601
- * <code>db.load.avg</code> - a scaled representation of the number of active sessions
602
- * for the database engine.</p>
603
- * </li>
604
- * <li>
605
- * <p>
606
- * <code>db.sampledload.avg</code> - the raw number of active sessions for the
607
- * database engine.</p>
608
- * </li>
609
- * </ul>
610
- * <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>
611
- * are the same 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>
612
- * showing the scaled values, <code>db.sampledload.avg</code> showing the raw values, and <code>db.sampledload.avg</code> less than <code>db.load.avg</code>.
613
- * For most use cases, you can query <code>db.load.avg</code> only. </p>
614
- */
615
- Metric: string | undefined;
616
-
617
- /**
618
- * <p>A specification for how to aggregate the data points from a query result. You must
619
- * specify a valid dimension group. Performance Insights will return all of the dimensions within that group,
620
- * unless you provide the names of specific dimensions within that group. You can also request
621
- * that Performance Insights return a limited number of values for a dimension.</p>
622
- */
623
- GroupBy?: DimensionGroup;
624
-
625
- /**
626
- * <p>One or more filters to apply in the request. Restrictions:</p>
627
- * <ul>
628
- * <li>
629
- * <p>Any number of filters by the same dimension, as specified in the <code>GroupBy</code> parameter.</p>
630
- * </li>
631
- * <li>
632
- * <p>A single filter for any other dimension in this dimension group.</p>
633
- * </li>
634
- * </ul>
635
- */
636
- Filter?: { [key: string]: string };
637
- }
638
-
639
- export namespace MetricQuery {
640
- /**
641
- * @internal
642
- */
643
- export const filterSensitiveLog = (obj: MetricQuery): any => ({
644
- ...obj,
645
- });
646
- }
647
-
648
- export interface GetResourceMetricsRequest {
649
- /**
650
- * <p>The AWS service for which Performance Insights returns metrics. The only valid value for <i>ServiceType</i> is
651
- * <code>RDS</code>.</p>
652
- */
653
- ServiceType: ServiceType | string | undefined;
654
-
655
- /**
656
- * <p>An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from
657
- * this data source.</p>
658
- * <p>To use a DB instance as a data source, specify its <code>DbiResourceId</code> value. For example, specify
659
- * <code>db-FAIHNTYBKTGAUSUZQYPDS2GW4A</code>.</p>
660
- */
661
- Identifier: string | undefined;
662
-
663
- /**
664
- * <p>An array of one or more queries to perform. Each query must specify a Performance Insights metric, and
665
- * can optionally specify aggregation and filtering criteria.</p>
666
- */
667
- MetricQueries: MetricQuery[] | undefined;
668
-
669
- /**
670
- * <p>The date and time specifying the beginning of the requested time series data. You can't
671
- * specify a <code>StartTime</code> that's earlier than 7 days ago. The value specified is
672
- * <i>inclusive</i> - data points equal to or greater than <code>StartTime</code>
673
- * will be returned.</p>
674
- * <p>The value for <code>StartTime</code> must be earlier than the value for <code>EndTime</code>.</p>
675
- */
676
- StartTime: Date | undefined;
677
-
678
- /**
679
- * <p>The date and time specifying the end of the requested time series data. The value specified is
680
- * <i>exclusive</i> - data points less than (but not equal to) <code>EndTime</code> will be returned.</p>
681
- * <p>The value for <code>EndTime</code> must be later than the value for <code>StartTime</code>.</p>
682
- */
683
- EndTime: Date | undefined;
684
-
685
- /**
686
- * <p>The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as
687
- * one second, or as long as one day (86400 seconds). Valid values are:</p>
688
- *
689
- * <ul>
690
- * <li>
691
- * <p>
692
- * <code>1</code> (one second)</p>
693
- * </li>
694
- * <li>
695
- * <p>
696
- * <code>60</code> (one minute)</p>
697
- * </li>
698
- * <li>
699
- * <p>
700
- * <code>300</code> (five minutes)</p>
701
- * </li>
702
- * <li>
703
- * <p>
704
- * <code>3600</code> (one hour)</p>
705
- * </li>
706
- * <li>
707
- * <p>
708
- * <code>86400</code> (twenty-four hours)</p>
709
- * </li>
710
- * </ul>
711
- *
712
- * <p>If you don't specify <code>PeriodInSeconds</code>, then Performance Insights will choose a value for
713
- * you, with a goal of returning roughly 100-200 data points in the response.</p>
714
- */
715
- PeriodInSeconds?: number;
716
-
717
- /**
718
- * <p>The maximum number of items to return in the response.
719
- * If more items exist than the specified <code>MaxRecords</code> value, a pagination
720
- * token is included in the response so that the remaining
721
- * results can be retrieved.
722
- * </p>
723
- */
724
- MaxResults?: number;
725
-
726
- /**
727
- * <p>An optional pagination token provided by a previous request. If
728
- * this parameter is specified, the response includes only records beyond the token, up to the
729
- * value specified by <code>MaxRecords</code>.</p>
730
- */
731
- NextToken?: string;
732
- }
733
-
734
- export namespace GetResourceMetricsRequest {
735
- /**
736
- * @internal
737
- */
738
- export const filterSensitiveLog = (obj: GetResourceMetricsRequest): any => ({
739
- ...obj,
740
- });
741
- }
742
-
743
- /**
744
- * <p>An object describing a Performance Insights metric and one or more dimensions for that metric.</p>
745
- */
746
- export interface ResponseResourceMetricKey {
747
- /**
748
- * <p>The name of a Performance Insights metric to be measured.</p>
749
- * <p>Valid values for <code>Metric</code> are:</p>
750
- *
751
- * <ul>
752
- * <li>
753
- * <p>
754
- * <code>db.load.avg</code> - a scaled representation of the number of active sessions
755
- * for the database engine.</p>
756
- * </li>
757
- * <li>
758
- * <p>
759
- * <code>db.sampledload.avg</code> - the raw number of active sessions for the
760
- * database engine.</p>
761
- * </li>
762
- * </ul>
763
- * <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>
764
- * are the same 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>
765
- * showing the scaled values, <code>db.sampledload.avg</code> showing the raw values, and <code>db.sampledload.avg</code> less than <code>db.load.avg</code>.
766
- * For most use cases, you can query <code>db.load.avg</code> only. </p>
767
- */
768
- Metric: string | undefined;
769
-
770
- /**
771
- * <p>The valid dimensions for the metric.</p>
772
- */
773
- Dimensions?: { [key: string]: string };
774
- }
775
-
776
- export namespace ResponseResourceMetricKey {
777
- /**
778
- * @internal
779
- */
780
- export const filterSensitiveLog = (obj: ResponseResourceMetricKey): any => ({
781
- ...obj,
782
- });
783
- }
784
-
785
- /**
786
- * <p>A time-ordered series of data points, corresponding to a dimension of a Performance Insights
787
- * metric.</p>
788
- */
789
- export interface MetricKeyDataPoints {
790
- /**
791
- * <p>The dimension(s) to which the data points apply.</p>
792
- */
793
- Key?: ResponseResourceMetricKey;
794
-
795
- /**
796
- * <p>An array of timestamp-value pairs, representing measurements over a period of time.</p>
797
- */
798
- DataPoints?: DataPoint[];
799
- }
800
-
801
- export namespace MetricKeyDataPoints {
802
- /**
803
- * @internal
804
- */
805
- export const filterSensitiveLog = (obj: MetricKeyDataPoints): any => ({
806
- ...obj,
807
- });
808
- }
809
-
810
- export interface GetResourceMetricsResponse {
811
- /**
812
- * <p>The start time for the returned metrics, after alignment to a granular boundary (as
813
- * specified by <code>PeriodInSeconds</code>). <code>AlignedStartTime</code> will be less than or
814
- * equal to the value of the user-specified <code>StartTime</code>.</p>
815
- */
816
- AlignedStartTime?: Date;
817
-
818
- /**
819
- * <p>The end time for the returned metrics, after alignment to a granular boundary (as
820
- * specified by <code>PeriodInSeconds</code>). <code>AlignedEndTime</code> will be greater than
821
- * or equal to the value of the user-specified <code>Endtime</code>.</p>
822
- */
823
- AlignedEndTime?: Date;
824
-
825
- /**
826
- * <p>An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from
827
- * this data source.</p>
828
- * <p>To use a DB instance as a data source, you specify its
829
- * <code>DbiResourceId</code> value - for example:
830
- * <code>db-FAIHNTYBKTGAUSUZQYPDS2GW4A</code>
831
- * </p>
832
- */
833
- Identifier?: string;
834
-
835
- /**
836
- * <p>An array of metric results,, where each array element contains all of the data points for a particular dimension.</p>
837
- */
838
- MetricList?: MetricKeyDataPoints[];
839
-
840
- /**
841
- * <p>An optional pagination token provided by a previous request. If
842
- * this parameter is specified, the response includes only records beyond the token, up to the
843
- * value specified by <code>MaxRecords</code>.</p>
844
- */
845
- NextToken?: string;
846
- }
847
-
848
- export namespace GetResourceMetricsResponse {
849
- /**
850
- * @internal
851
- */
852
- export const filterSensitiveLog = (obj: GetResourceMetricsResponse): any => ({
853
- ...obj,
854
- });
855
- }