@aws-sdk/client-pi 3.46.0 → 3.48.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 (73) hide show
  1. package/CHANGELOG.md +38 -0
  2. package/README.md +18 -13
  3. package/dist-cjs/PI.js +45 -0
  4. package/dist-cjs/commands/GetResourceMetadataCommand.js +36 -0
  5. package/dist-cjs/commands/ListAvailableResourceDimensionsCommand.js +36 -0
  6. package/dist-cjs/commands/ListAvailableResourceMetricsCommand.js +36 -0
  7. package/dist-cjs/commands/index.js +3 -0
  8. package/dist-cjs/index.js +1 -0
  9. package/dist-cjs/models/models_0.js +77 -19
  10. package/dist-cjs/pagination/DescribeDimensionKeysPaginator.js +35 -0
  11. package/dist-cjs/pagination/GetResourceMetricsPaginator.js +35 -0
  12. package/dist-cjs/pagination/Interfaces.js +2 -0
  13. package/dist-cjs/pagination/ListAvailableResourceDimensionsPaginator.js +35 -0
  14. package/dist-cjs/pagination/ListAvailableResourceMetricsPaginator.js +35 -0
  15. package/dist-cjs/pagination/index.js +8 -0
  16. package/dist-cjs/protocols/Aws_json1_1.js +402 -1
  17. package/dist-cjs/runtimeConfig.browser.js +7 -2
  18. package/dist-cjs/runtimeConfig.js +10 -2
  19. package/dist-es/PI.js +45 -0
  20. package/dist-es/commands/GetResourceMetadataCommand.js +39 -0
  21. package/dist-es/commands/ListAvailableResourceDimensionsCommand.js +39 -0
  22. package/dist-es/commands/ListAvailableResourceMetricsCommand.js +39 -0
  23. package/dist-es/commands/index.js +3 -0
  24. package/dist-es/index.js +1 -0
  25. package/dist-es/models/models_0.js +54 -12
  26. package/dist-es/pagination/DescribeDimensionKeysPaginator.js +74 -0
  27. package/dist-es/pagination/GetResourceMetricsPaginator.js +74 -0
  28. package/dist-es/pagination/Interfaces.js +1 -0
  29. package/dist-es/pagination/ListAvailableResourceDimensionsPaginator.js +74 -0
  30. package/dist-es/pagination/ListAvailableResourceMetricsPaginator.js +74 -0
  31. package/dist-es/pagination/index.js +5 -0
  32. package/dist-es/protocols/Aws_json1_1.js +414 -1
  33. package/dist-es/runtimeConfig.browser.js +12 -3
  34. package/dist-es/runtimeConfig.js +13 -4
  35. package/dist-types/PI.d.ts +48 -18
  36. package/dist-types/PIClient.d.ts +27 -15
  37. package/dist-types/commands/DescribeDimensionKeysCommand.d.ts +2 -2
  38. package/dist-types/commands/GetDimensionKeyDetailsCommand.d.ts +5 -4
  39. package/dist-types/commands/GetResourceMetadataCommand.d.ts +37 -0
  40. package/dist-types/commands/ListAvailableResourceDimensionsCommand.d.ts +35 -0
  41. package/dist-types/commands/ListAvailableResourceMetricsCommand.d.ts +36 -0
  42. package/dist-types/commands/index.d.ts +3 -0
  43. package/dist-types/index.d.ts +1 -0
  44. package/dist-types/models/models_0.d.ts +413 -101
  45. package/dist-types/pagination/DescribeDimensionKeysPaginator.d.ts +4 -0
  46. package/dist-types/pagination/GetResourceMetricsPaginator.d.ts +4 -0
  47. package/dist-types/pagination/Interfaces.d.ts +6 -0
  48. package/dist-types/pagination/ListAvailableResourceDimensionsPaginator.d.ts +4 -0
  49. package/dist-types/pagination/ListAvailableResourceMetricsPaginator.d.ts +4 -0
  50. package/dist-types/pagination/index.d.ts +5 -0
  51. package/dist-types/protocols/Aws_json1_1.d.ts +9 -0
  52. package/dist-types/runtimeConfig.browser.d.ts +3 -2
  53. package/dist-types/runtimeConfig.d.ts +4 -3
  54. package/dist-types/runtimeConfig.native.d.ts +1 -0
  55. package/dist-types/ts3.4/PI.d.ts +15 -0
  56. package/dist-types/ts3.4/PIClient.d.ts +8 -3
  57. package/dist-types/ts3.4/commands/GetResourceMetadataCommand.d.ts +17 -0
  58. package/dist-types/ts3.4/commands/ListAvailableResourceDimensionsCommand.d.ts +17 -0
  59. package/dist-types/ts3.4/commands/ListAvailableResourceMetricsCommand.d.ts +17 -0
  60. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  61. package/dist-types/ts3.4/index.d.ts +1 -0
  62. package/dist-types/ts3.4/models/models_0.d.ts +142 -12
  63. package/dist-types/ts3.4/pagination/DescribeDimensionKeysPaginator.d.ts +4 -0
  64. package/dist-types/ts3.4/pagination/GetResourceMetricsPaginator.d.ts +4 -0
  65. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  66. package/dist-types/ts3.4/pagination/ListAvailableResourceDimensionsPaginator.d.ts +4 -0
  67. package/dist-types/ts3.4/pagination/ListAvailableResourceMetricsPaginator.d.ts +4 -0
  68. package/dist-types/ts3.4/pagination/index.d.ts +5 -0
  69. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +9 -0
  70. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +3 -2
  71. package/dist-types/ts3.4/runtimeConfig.d.ts +4 -3
  72. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -0
  73. package/package.json +35 -35
@@ -35,13 +35,13 @@ export interface DimensionGroup {
35
35
  * <ul>
36
36
  * <li>
37
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>
38
+ * <code>db</code> - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL,
39
+ * Aurora MySQL, Amazon RDS MySQL, and MariaDB)</p>
40
40
  * </li>
41
41
  * <li>
42
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>
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
45
  * </li>
46
46
  * <li>
47
47
  * <p>
@@ -49,7 +49,7 @@ export interface DimensionGroup {
49
49
  * </li>
50
50
  * <li>
51
51
  * <p>
52
- * <code>db.session_type</code> - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)</p>
52
+ * <code>db.session_type</code> - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)</p>
53
53
  * </li>
54
54
  * <li>
55
55
  * <p>
@@ -83,8 +83,8 @@ export interface DimensionGroup {
83
83
  * <ul>
84
84
  * <li>
85
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>
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
88
  * </li>
89
89
  * <li>
90
90
  * <p>
@@ -96,12 +96,12 @@ export interface DimensionGroup {
96
96
  * </li>
97
97
  * <li>
98
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>
99
+ * <code>db.name</code> - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS
100
+ * PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)</p>
101
101
  * </li>
102
102
  * <li>
103
103
  * <p>
104
- * <code>db.session_type.name</code> - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)</p>
104
+ * <code>db.session_type.name</code> - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)</p>
105
105
  * </li>
106
106
  * <li>
107
107
  * <p>
@@ -168,28 +168,31 @@ export declare namespace DimensionGroup {
168
168
  const filterSensitiveLog: (obj: DimensionGroup) => any;
169
169
  }
170
170
  export declare enum ServiceType {
171
+ DOCDB = "DOCDB",
171
172
  RDS = "RDS"
172
173
  }
173
174
  export interface DescribeDimensionKeysRequest {
174
175
  /**
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>
176
+ * <p>The Amazon Web Services service for which Performance Insights will return metrics. The only valid value for
177
+ * <i>ServiceType</i> is <code>RDS</code>.
178
+ * </p>
177
179
  */
178
180
  ServiceType: ServiceType | string | undefined;
179
181
  /**
180
- * <p>An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from
182
+ * <p>An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from
181
183
  * 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>
184
+ * <p>To use an Amazon RDS instance as a data source, you specify its <code>DbiResourceId</code> value.
185
+ * For example, specify <code>db-FAIHNTYBKTGAUSUZQYPDS2GW4A</code>.
186
+ * </p>
185
187
  */
186
188
  Identifier: string | undefined;
187
189
  /**
188
190
  * <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>
191
+ * <code>StartTime</code> within the past 7 days. The value specified is <i>inclusive</i>,
192
+ * which means that data points equal to or greater than <code>StartTime</code> are returned.
193
+ * </p>
194
+ * <p>The value for <code>StartTime</code> must be earlier than the value for <code>EndTime</code>.
195
+ * </p>
193
196
  */
194
197
  StartTime: Date | undefined;
195
198
  /**
@@ -207,25 +210,28 @@ export interface DescribeDimensionKeysRequest {
207
210
  * <ul>
208
211
  * <li>
209
212
  * <p>
210
- * <code>db.load.avg</code> - a scaled representation of the number of active sessions
211
- * for the database engine.</p>
213
+ * <code>db.load.avg</code> - a scaled representation of the number of active sessions for the database engine.
214
+ * </p>
212
215
  * </li>
213
216
  * <li>
214
217
  * <p>
215
- * <code>db.sampledload.avg</code> - the raw number of active sessions for the
216
- * database engine.</p>
218
+ * <code>db.sampledload.avg</code> - the raw number of active sessions for the database engine.
219
+ * </p>
217
220
  * </li>
218
221
  * </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>
222
+ * <p>If the number of active sessions is less than an internal Performance Insights threshold, <code>db.load.avg</code>
223
+ * and <code>db.sampledload.avg</code> are the same value. If the number of active sessions is greater than
224
+ * the internal threshold, Performance Insights samples the active sessions, with <code>db.load.avg</code>
225
+ * showing the scaled values, <code>db.sampledload.avg</code> showing the raw values, and
226
+ * <code>db.sampledload.avg</code> less than <code>db.load.avg</code>. For most use cases, you can
227
+ * query <code>db.load.avg</code> only.
228
+ * </p>
223
229
  */
224
230
  Metric: string | undefined;
225
231
  /**
226
232
  * <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
- *
233
+ * one second, or as long as one day (86400 seconds). Valid values are:
234
+ * </p>
229
235
  * <ul>
230
236
  * <li>
231
237
  * <p>
@@ -249,23 +255,36 @@ export interface DescribeDimensionKeysRequest {
249
255
  * </li>
250
256
  * </ul>
251
257
  *
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>
258
+ * <p>If you don't specify <code>PeriodInSeconds</code>, then Performance Insights chooses a value for you, with a
259
+ * goal of returning roughly 100-200 data points in the response.
260
+ * </p>
254
261
  */
255
262
  PeriodInSeconds?: number;
256
263
  /**
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>
264
+ * <p>A specification for how to aggregate the data points from a query result. You must specify
265
+ * a valid dimension group. Performance Insights returns all dimensions within this group, unless you provide
266
+ * the names of specific dimensions within this group. You can also request that Performance Insights return
267
+ * a limited number of values for a dimension.
268
+ * </p>
260
269
  */
261
270
  GroupBy: DimensionGroup | undefined;
262
271
  /**
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>
272
+ * <p>Additional metrics for the top <code>N</code> dimension keys.
273
+ * If the specified dimension group in the <code>GroupBy</code> parameter is <code>db.sql_tokenized</code>, you can
274
+ * specify per-SQL metrics to get the values for the top <code>N</code> SQL digests. The response syntax is
275
+ * <code>"AdditionalMetrics" : { "<i>string</i>" : "<i>string</i>" }</code>.
276
+ * </p>
277
+ * <p></p>
278
+ */
279
+ AdditionalMetrics?: string[];
280
+ /**
281
+ * <p>For each dimension specified in <code>GroupBy</code>, specify a secondary dimension
282
+ * to further subdivide the partition keys in the response.
283
+ * </p>
265
284
  */
266
285
  PartitionBy?: DimensionGroup;
267
286
  /**
268
- * <p>One or more filters to apply in the request. Restrictions:</p>
287
+ * <p>One or more filters to apply in the request. Restrictions:</p>
269
288
  * <ul>
270
289
  * <li>
271
290
  * <p>Any number of filters by the same dimension, as specified in the <code>GroupBy</code> or
@@ -280,17 +299,16 @@ export interface DescribeDimensionKeysRequest {
280
299
  [key: string]: string;
281
300
  };
282
301
  /**
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.
302
+ * <p>The maximum number of items to return in the response. If more items exist than the
303
+ * specified <code>MaxRecords</code> value, a pagination token is included in the response
304
+ * so that the remaining results can be retrieved.
287
305
  * </p>
288
306
  */
289
307
  MaxResults?: number;
290
308
  /**
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>
309
+ * <p>An optional pagination token provided by a previous request. If this parameter is specified,
310
+ * the response includes only records beyond the token, up to the value specified by <code>MaxRecords</code>.
311
+ * </p>
294
312
  */
295
313
  NextToken?: string;
296
314
  }
@@ -301,8 +319,8 @@ export declare namespace DescribeDimensionKeysRequest {
301
319
  const filterSensitiveLog: (obj: DescribeDimensionKeysRequest) => any;
302
320
  }
303
321
  /**
304
- * <p>An array of descriptions and aggregated values for
305
- * each dimension within a dimension group.</p>
322
+ * <p>An object that includes the requested dimension key values and aggregated metric values
323
+ * within a dimension group.</p>
306
324
  */
307
325
  export interface DimensionKeyDescription {
308
326
  /**
@@ -312,9 +330,15 @@ export interface DimensionKeyDescription {
312
330
  [key: string]: string;
313
331
  };
314
332
  /**
315
- * <p>The aggregated metric value for the dimension(s), over the requested time range.</p>
333
+ * <p>The aggregated metric value for the dimensions, over the requested time range.</p>
316
334
  */
317
335
  Total?: number;
336
+ /**
337
+ * <p>A map that contains the value for each additional metric.</p>
338
+ */
339
+ AdditionalMetrics?: {
340
+ [key: string]: number;
341
+ };
318
342
  /**
319
343
  * <p>If <code>PartitionBy</code> was specified, <code>PartitionKeys</code> contains the dimensions that were.</p>
320
344
  */
@@ -333,7 +357,7 @@ export declare namespace DimensionKeyDescription {
333
357
  */
334
358
  export interface ResponsePartitionKey {
335
359
  /**
336
- * <p>A dimension map that contains the dimension(s) for this partition.</p>
360
+ * <p>A dimension map that contains the dimensions for this partition.</p>
337
361
  */
338
362
  Dimensions: {
339
363
  [key: string]: string;
@@ -348,18 +372,22 @@ export declare namespace ResponsePartitionKey {
348
372
  export interface DescribeDimensionKeysResponse {
349
373
  /**
350
374
  * <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>
375
+ * specified by <code>PeriodInSeconds</code>). <code>AlignedStartTime</code> will be less than or
376
+ * equal to the value of the user-specified <code>StartTime</code>.
377
+ * </p>
353
378
  */
354
379
  AlignedStartTime?: Date;
355
380
  /**
356
381
  * <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>
382
+ * specified by <code>PeriodInSeconds</code>). <code>AlignedEndTime</code> will be greater than
383
+ * or equal to the value of the user-specified <code>Endtime</code>.
384
+ * </p>
359
385
  */
360
386
  AlignedEndTime?: Date;
361
387
  /**
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>
388
+ * <p>If <code>PartitionBy</code> was present in the request, <code>PartitionKeys</code> contains
389
+ * the breakdown of dimension keys by the specified partitions.
390
+ * </p>
363
391
  */
364
392
  PartitionKeys?: ResponsePartitionKey[];
365
393
  /**
@@ -367,9 +395,10 @@ export interface DescribeDimensionKeysResponse {
367
395
  */
368
396
  Keys?: DimensionKeyDescription[];
369
397
  /**
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>
398
+ * <p>A pagination token that indicates the response didn’t return all available records
399
+ * because <code>MaxRecords</code> was specified in the previous request. To get the
400
+ * remaining records, specify <code>NextToken</code> in a separate request with this value.
401
+ * </p>
373
402
  */
374
403
  NextToken?: string;
375
404
  }
@@ -387,12 +416,6 @@ export interface InternalServiceError extends __SmithyException, $MetadataBearer
387
416
  $fault: "server";
388
417
  Message?: string;
389
418
  }
390
- export declare namespace InternalServiceError {
391
- /**
392
- * @internal
393
- */
394
- const filterSensitiveLog: (obj: InternalServiceError) => any;
395
- }
396
419
  /**
397
420
  * <p>One of the arguments provided is invalid for this request.</p>
398
421
  */
@@ -401,12 +424,6 @@ export interface InvalidArgumentException extends __SmithyException, $MetadataBe
401
424
  $fault: "client";
402
425
  Message?: string;
403
426
  }
404
- export declare namespace InvalidArgumentException {
405
- /**
406
- * @internal
407
- */
408
- const filterSensitiveLog: (obj: InvalidArgumentException) => any;
409
- }
410
427
  /**
411
428
  * <p>The user is not authorized to perform this request.</p>
412
429
  */
@@ -415,17 +432,45 @@ export interface NotAuthorizedException extends __SmithyException, $MetadataBear
415
432
  $fault: "client";
416
433
  Message?: string;
417
434
  }
418
- export declare namespace NotAuthorizedException {
419
- /**
420
- * @internal
421
- */
422
- const filterSensitiveLog: (obj: NotAuthorizedException) => any;
423
- }
424
435
  export declare enum DetailStatus {
425
436
  AVAILABLE = "AVAILABLE",
426
437
  PROCESSING = "PROCESSING",
427
438
  UNAVAILABLE = "UNAVAILABLE"
428
439
  }
440
+ /**
441
+ * <p>The information about a dimension.</p>
442
+ */
443
+ export interface DimensionDetail {
444
+ /**
445
+ * <p>The identifier of a dimension.</p>
446
+ */
447
+ Identifier?: string;
448
+ }
449
+ export declare namespace DimensionDetail {
450
+ /**
451
+ * @internal
452
+ */
453
+ const filterSensitiveLog: (obj: DimensionDetail) => any;
454
+ }
455
+ /**
456
+ * <p>Information about dimensions within a dimension group.</p>
457
+ */
458
+ export interface DimensionGroupDetail {
459
+ /**
460
+ * <p>The name of the dimension group.</p>
461
+ */
462
+ Group?: string;
463
+ /**
464
+ * <p>The dimensions within a dimension group.</p>
465
+ */
466
+ Dimensions?: DimensionDetail[];
467
+ }
468
+ export declare namespace DimensionGroupDetail {
469
+ /**
470
+ * @internal
471
+ */
472
+ const filterSensitiveLog: (obj: DimensionGroupDetail) => any;
473
+ }
429
474
  /**
430
475
  * <p>An object that describes the details for a specified dimension.</p>
431
476
  */
@@ -467,15 +512,69 @@ export declare namespace DimensionKeyDetail {
467
512
  */
468
513
  const filterSensitiveLog: (obj: DimensionKeyDetail) => any;
469
514
  }
515
+ export declare enum FeatureStatus {
516
+ DISABLED = "DISABLED",
517
+ DISABLED_PENDING_REBOOT = "DISABLED_PENDING_REBOOT",
518
+ ENABLED = "ENABLED",
519
+ ENABLED_PENDING_REBOOT = "ENABLED_PENDING_REBOOT",
520
+ UNKNOWN = "UNKNOWN",
521
+ UNSUPPORTED = "UNSUPPORTED"
522
+ }
523
+ /**
524
+ * <p>The metadata for a feature. For example, the metadata might indicate that a feature is
525
+ * turned on or off on a specific DB instance.</p>
526
+ */
527
+ export interface FeatureMetadata {
528
+ /**
529
+ * <p>The status of the feature on the DB instance. Possible values include the following:
530
+ * </p>
531
+ * <ul>
532
+ * <li>
533
+ * <p>
534
+ * <code>ENABLED</code>: the feature is enabled on the instance.</p>
535
+ * </li>
536
+ * <li>
537
+ * <p>
538
+ * <code>DISABLED</code>: the feature is disabled on the instance.</p>
539
+ * </li>
540
+ * <li>
541
+ * <p>
542
+ * <code>UNSUPPORTED</code>: the feature isn't supported on the instance.</p>
543
+ * </li>
544
+ * <li>
545
+ * <p>
546
+ * <code>ENABLED_PENDING_REBOOT</code>: the feature is enabled on the instance but requires
547
+ * a reboot to take effect.</p>
548
+ * </li>
549
+ * <li>
550
+ * <p>
551
+ * <code>DISABLED_PENDING_REBOOT</code>: the feature is disabled on the instance but requires
552
+ * a reboot to take effect.</p>
553
+ * </li>
554
+ * <li>
555
+ * <p>
556
+ * <code>UNKNOWN</code>: the feature status couldn't be determined.</p>
557
+ * </li>
558
+ * </ul>
559
+ */
560
+ Status?: FeatureStatus | string;
561
+ }
562
+ export declare namespace FeatureMetadata {
563
+ /**
564
+ * @internal
565
+ */
566
+ const filterSensitiveLog: (obj: FeatureMetadata) => any;
567
+ }
470
568
  export interface GetDimensionKeyDetailsRequest {
471
569
  /**
472
- * <p>The AWS service for which Performance Insights returns data. The only valid value is <code>RDS</code>.</p>
570
+ * <p>The Amazon Web Services service for which Performance Insights returns data. The only valid value is <code>RDS</code>.</p>
473
571
  */
474
572
  ServiceType: ServiceType | string | undefined;
475
573
  /**
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>
574
+ * <p>The ID for a data source from which to gather dimension data. This ID must be immutable and
575
+ * unique within an Amazon Web Services Region. When a DB instance is the data source, specify its
576
+ * <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.
577
+ * </p>
479
578
  */
480
579
  Identifier: string | undefined;
481
580
  /**
@@ -489,10 +588,12 @@ export interface GetDimensionKeyDetailsRequest {
489
588
  */
490
589
  GroupIdentifier: string | undefined;
491
590
  /**
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>
591
+ * <p>A list of dimensions to retrieve the detail data for within the given dimension group.
592
+ * For the dimension group <code>db.sql</code>, specify either the full dimension name
593
+ * <code>db.sql.statement</code> or the short dimension name <code>statement</code>.
594
+ * If you don't specify this parameter, Performance Insights returns all
595
+ * dimension data within the specified dimension group.
596
+ * </p>
496
597
  */
497
598
  RequestedDimensions?: string[];
498
599
  }
@@ -514,11 +615,53 @@ export declare namespace GetDimensionKeyDetailsResponse {
514
615
  */
515
616
  const filterSensitiveLog: (obj: GetDimensionKeyDetailsResponse) => any;
516
617
  }
618
+ export interface GetResourceMetadataRequest {
619
+ /**
620
+ * <p>The Amazon Web Services service for which Performance Insights returns metrics.</p>
621
+ */
622
+ ServiceType: ServiceType | string | undefined;
623
+ /**
624
+ * <p>An immutable identifier for a data source that is unique for an Amazon Web Services Region.
625
+ * Performance Insights gathers metrics from this data source. To use a DB instance as a data source,
626
+ * specify its <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.
627
+ * </p>
628
+ */
629
+ Identifier: string | undefined;
630
+ }
631
+ export declare namespace GetResourceMetadataRequest {
632
+ /**
633
+ * @internal
634
+ */
635
+ const filterSensitiveLog: (obj: GetResourceMetadataRequest) => any;
636
+ }
637
+ export interface GetResourceMetadataResponse {
638
+ /**
639
+ * <p>An immutable identifier for a data source that is unique for an Amazon Web Services Region.
640
+ *
641
+ * Performance Insights gathers metrics from this data source. To use a DB instance as a data source,
642
+ * specify its <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.
643
+ * </p>
644
+ */
645
+ Identifier?: string;
646
+ /**
647
+ * <p>The metadata for different features. For example, the metadata might indicate that a feature is
648
+ * turned on or off on a specific DB instance.</p>
649
+ */
650
+ Features?: {
651
+ [key: string]: FeatureMetadata;
652
+ };
653
+ }
654
+ export declare namespace GetResourceMetadataResponse {
655
+ /**
656
+ * @internal
657
+ */
658
+ const filterSensitiveLog: (obj: GetResourceMetadataResponse) => any;
659
+ }
517
660
  /**
518
661
  * <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>
662
+ * parameters are specified, Performance Insights returns all data points for the specified metric. Optionally, you can
663
+ * request that the data points be aggregated by dimension group (<code>GroupBy</code>), and return only
664
+ * those data points that match your criteria (<code>Filter</code>).</p>
522
665
  */
523
666
  export interface MetricQuery {
524
667
  /**
@@ -573,12 +716,12 @@ export declare namespace MetricQuery {
573
716
  }
574
717
  export interface GetResourceMetricsRequest {
575
718
  /**
576
- * <p>The AWS service for which Performance Insights returns metrics. The only valid value for <i>ServiceType</i> is
719
+ * <p>The Amazon Web Services service for which Performance Insights returns metrics. The only valid value for <i>ServiceType</i> is
577
720
  * <code>RDS</code>.</p>
578
721
  */
579
722
  ServiceType: ServiceType | string | undefined;
580
723
  /**
581
- * <p>An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from
724
+ * <p>An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from
582
725
  * this data source.</p>
583
726
  * <p>To use a DB instance as a data source, specify its <code>DbiResourceId</code> value. For example, specify
584
727
  * <code>db-FAIHNTYBKTGAUSUZQYPDS2GW4A</code>.</p>
@@ -675,10 +818,12 @@ export interface ResponseResourceMetricKey {
675
818
  * database engine.</p>
676
819
  * </li>
677
820
  * </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>
821
+ * <p>If the number of active sessions is less than an internal Performance Insights threshold, <code>db.load.avg</code> and
822
+ * <code>db.sampledload.avg</code> are the same value. If the number of active sessions is greater than the
823
+ * internal threshold, Performance Insights samples the active sessions, with <code>db.load.avg</code> showing the scaled values,
824
+ * <code>db.sampledload.avg</code> showing the raw values, and <code>db.sampledload.avg</code> less
825
+ * than <code>db.load.avg</code>. For most use cases, you can query <code>db.load.avg</code> only.
826
+ * </p>
682
827
  */
683
828
  Metric: string | undefined;
684
829
  /**
@@ -700,7 +845,7 @@ export declare namespace ResponseResourceMetricKey {
700
845
  */
701
846
  export interface MetricKeyDataPoints {
702
847
  /**
703
- * <p>The dimension(s) to which the data points apply.</p>
848
+ * <p>The dimensions to which the data points apply.</p>
704
849
  */
705
850
  Key?: ResponseResourceMetricKey;
706
851
  /**
@@ -728,11 +873,11 @@ export interface GetResourceMetricsResponse {
728
873
  */
729
874
  AlignedEndTime?: Date;
730
875
  /**
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>
876
+ * <p>An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from
877
+ * this data source.
878
+ * </p>
879
+ * <p>To use a DB instance as a data source, you specify its <code>DbiResourceId</code> value -
880
+ * for example: <code>db-FAIHNTYBKTGAUSUZQYPDS2GW4A</code>
736
881
  * </p>
737
882
  */
738
883
  Identifier?: string;
@@ -741,9 +886,9 @@ export interface GetResourceMetricsResponse {
741
886
  */
742
887
  MetricList?: MetricKeyDataPoints[];
743
888
  /**
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>
889
+ * <p>An optional pagination token provided by a previous request. If this parameter is specified,
890
+ * the response includes only records beyond the token, up to the value specified by <code>MaxRecords</code>.
891
+ * </p>
747
892
  */
748
893
  NextToken?: string;
749
894
  }
@@ -753,3 +898,170 @@ export declare namespace GetResourceMetricsResponse {
753
898
  */
754
899
  const filterSensitiveLog: (obj: GetResourceMetricsResponse) => any;
755
900
  }
901
+ export interface ListAvailableResourceDimensionsRequest {
902
+ /**
903
+ * <p>The Amazon Web Services service for which Performance Insights returns metrics.</p>
904
+ */
905
+ ServiceType: ServiceType | string | undefined;
906
+ /**
907
+ * <p>An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers
908
+ * metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its
909
+ * <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VWZ</code>. </p>
910
+ */
911
+ Identifier: string | undefined;
912
+ /**
913
+ * <p>The types of metrics for which to retrieve dimensions. Valid values include <code>db.load</code>.</p>
914
+ */
915
+ Metrics: string[] | undefined;
916
+ /**
917
+ * <p>The maximum number of items to return in the response. If more items exist than the specified
918
+ * <code>MaxRecords</code> value, a pagination token is included in the response so that the remaining
919
+ * results can be retrieved.</p>
920
+ */
921
+ MaxResults?: number;
922
+ /**
923
+ * <p>An optional pagination token provided by a previous request. If this parameter is specified,
924
+ * the response includes only records beyond the token, up to the value specified by <code>MaxRecords</code>.
925
+ * </p>
926
+ */
927
+ NextToken?: string;
928
+ }
929
+ export declare namespace ListAvailableResourceDimensionsRequest {
930
+ /**
931
+ * @internal
932
+ */
933
+ const filterSensitiveLog: (obj: ListAvailableResourceDimensionsRequest) => any;
934
+ }
935
+ /**
936
+ * <p>The available dimension information for a metric type.</p>
937
+ */
938
+ export interface MetricDimensionGroups {
939
+ /**
940
+ * <p>The metric type to which the dimension information belongs.</p>
941
+ */
942
+ Metric?: string;
943
+ /**
944
+ * <p>The available dimension groups for a metric type.</p>
945
+ */
946
+ Groups?: DimensionGroupDetail[];
947
+ }
948
+ export declare namespace MetricDimensionGroups {
949
+ /**
950
+ * @internal
951
+ */
952
+ const filterSensitiveLog: (obj: MetricDimensionGroups) => any;
953
+ }
954
+ export interface ListAvailableResourceDimensionsResponse {
955
+ /**
956
+ * <p>The dimension information returned for requested metric types.</p>
957
+ */
958
+ MetricDimensions?: MetricDimensionGroups[];
959
+ /**
960
+ * <p>An optional pagination token provided by a previous request. If this parameter is specified,
961
+ * the response includes only records beyond the token, up to the value specified by <code>MaxRecords</code>.</p>
962
+ */
963
+ NextToken?: string;
964
+ }
965
+ export declare namespace ListAvailableResourceDimensionsResponse {
966
+ /**
967
+ * @internal
968
+ */
969
+ const filterSensitiveLog: (obj: ListAvailableResourceDimensionsResponse) => any;
970
+ }
971
+ export interface ListAvailableResourceMetricsRequest {
972
+ /**
973
+ * <p>The Amazon Web Services service for which Performance Insights returns metrics.</p>
974
+ */
975
+ ServiceType: ServiceType | string | undefined;
976
+ /**
977
+ * <p>An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers
978
+ * metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its
979
+ * <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VWZ</code>. </p>
980
+ */
981
+ Identifier: string | undefined;
982
+ /**
983
+ * <p>The types of metrics to return in the response. Valid values in the array include the following:</p>
984
+ * <ul>
985
+ * <li>
986
+ * <p>
987
+ * <code>os</code> (OS counter metrics)</p>
988
+ * </li>
989
+ * <li>
990
+ * <p>
991
+ * <code>db</code> (DB load metrics)</p>
992
+ * </li>
993
+ * <li>
994
+ * <p>
995
+ * <code>db.sql.stats</code> (per-SQL metrics)</p>
996
+ * </li>
997
+ * <li>
998
+ * <p>
999
+ * <code>db.sql_tokenized.stats</code> (per-SQL digest metrics)</p>
1000
+ * </li>
1001
+ * </ul>
1002
+ */
1003
+ MetricTypes: string[] | undefined;
1004
+ /**
1005
+ * <p>An optional pagination token provided by a previous request. If this parameter is specified,
1006
+ * the response includes only records beyond the token, up to the value specified by <code>MaxRecords</code>.
1007
+ * </p>
1008
+ */
1009
+ NextToken?: string;
1010
+ /**
1011
+ * <p>The maximum number of items to return. If the <code>MaxRecords</code> value is less than the number of
1012
+ * existing items, the response includes a pagination token.
1013
+ * </p>
1014
+ */
1015
+ MaxResults?: number;
1016
+ }
1017
+ export declare namespace ListAvailableResourceMetricsRequest {
1018
+ /**
1019
+ * @internal
1020
+ */
1021
+ const filterSensitiveLog: (obj: ListAvailableResourceMetricsRequest) => any;
1022
+ }
1023
+ /**
1024
+ * <p>An object that contains the full name, description, and unit of a metric.
1025
+ * </p>
1026
+ */
1027
+ export interface ResponseResourceMetric {
1028
+ /**
1029
+ * <p>The full name of the metric.</p>
1030
+ */
1031
+ Metric?: string;
1032
+ /**
1033
+ * <p>The description of the metric.</p>
1034
+ */
1035
+ Description?: string;
1036
+ /**
1037
+ * <p>The unit of the metric.</p>
1038
+ */
1039
+ Unit?: string;
1040
+ }
1041
+ export declare namespace ResponseResourceMetric {
1042
+ /**
1043
+ * @internal
1044
+ */
1045
+ const filterSensitiveLog: (obj: ResponseResourceMetric) => any;
1046
+ }
1047
+ export interface ListAvailableResourceMetricsResponse {
1048
+ /**
1049
+ * <p>An array of metrics available to query. Each array element contains the full name,
1050
+ * description, and unit of the metric.
1051
+ * </p>
1052
+ */
1053
+ Metrics?: ResponseResourceMetric[];
1054
+ /**
1055
+ * <p>A pagination token that indicates the response didn’t return all available records
1056
+ * because <code>MaxRecords</code> was specified in the previous request. To get the remaining
1057
+ * records, specify <code>NextToken</code> in a separate request with this value.
1058
+ * </p>
1059
+ */
1060
+ NextToken?: string;
1061
+ }
1062
+ export declare namespace ListAvailableResourceMetricsResponse {
1063
+ /**
1064
+ * @internal
1065
+ */
1066
+ const filterSensitiveLog: (obj: ListAvailableResourceMetricsResponse) => any;
1067
+ }