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