@aws-sdk/client-pi 3.533.0 → 3.540.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 (36) hide show
  1. package/dist-cjs/endpoint/endpointResolver.js +4 -2
  2. package/dist-cjs/index.js +0 -3
  3. package/dist-es/endpoint/endpointResolver.js +3 -1
  4. package/dist-es/index.js +0 -1
  5. package/dist-types/PI.d.ts +1 -1
  6. package/dist-types/PIClient.d.ts +1 -1
  7. package/dist-types/commands/CreatePerformanceAnalysisReportCommand.d.ts +2 -1
  8. package/dist-types/commands/DeletePerformanceAnalysisReportCommand.d.ts +2 -1
  9. package/dist-types/commands/DescribeDimensionKeysCommand.d.ts +2 -1
  10. package/dist-types/commands/GetDimensionKeyDetailsCommand.d.ts +2 -1
  11. package/dist-types/commands/GetPerformanceAnalysisReportCommand.d.ts +2 -1
  12. package/dist-types/commands/GetResourceMetadataCommand.d.ts +2 -1
  13. package/dist-types/commands/GetResourceMetricsCommand.d.ts +2 -1
  14. package/dist-types/commands/ListAvailableResourceDimensionsCommand.d.ts +2 -1
  15. package/dist-types/commands/ListAvailableResourceMetricsCommand.d.ts +2 -1
  16. package/dist-types/commands/ListPerformanceAnalysisReportsCommand.d.ts +2 -1
  17. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  18. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  19. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  20. package/dist-types/index.d.ts +0 -1
  21. package/dist-types/models/models_0.d.ts +172 -172
  22. package/dist-types/ts3.4/commands/CreatePerformanceAnalysisReportCommand.d.ts +9 -0
  23. package/dist-types/ts3.4/commands/DeletePerformanceAnalysisReportCommand.d.ts +9 -0
  24. package/dist-types/ts3.4/commands/DescribeDimensionKeysCommand.d.ts +9 -0
  25. package/dist-types/ts3.4/commands/GetDimensionKeyDetailsCommand.d.ts +9 -0
  26. package/dist-types/ts3.4/commands/GetPerformanceAnalysisReportCommand.d.ts +9 -0
  27. package/dist-types/ts3.4/commands/GetResourceMetadataCommand.d.ts +9 -0
  28. package/dist-types/ts3.4/commands/GetResourceMetricsCommand.d.ts +9 -0
  29. package/dist-types/ts3.4/commands/ListAvailableResourceDimensionsCommand.d.ts +9 -0
  30. package/dist-types/ts3.4/commands/ListAvailableResourceMetricsCommand.d.ts +9 -0
  31. package/dist-types/ts3.4/commands/ListPerformanceAnalysisReportsCommand.d.ts +9 -0
  32. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  33. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  34. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  35. package/dist-types/ts3.4/index.d.ts +0 -1
  36. package/package.json +40 -40
@@ -12,45 +12,45 @@ export declare const AcceptLanguage: {
12
12
  */
13
13
  export type AcceptLanguage = (typeof AcceptLanguage)[keyof typeof AcceptLanguage];
14
14
  /**
15
- * @public
16
15
  * <p>This data type helps to determine Performance Insights metric to render for the insight.</p>
16
+ * @public
17
17
  */
18
18
  export interface PerformanceInsightsMetric {
19
19
  /**
20
- * @public
21
20
  * <p>The Performance Insights metric.</p>
21
+ * @public
22
22
  */
23
23
  Metric?: string;
24
24
  /**
25
- * @public
26
25
  * <p>The Performance Insights metric name.</p>
26
+ * @public
27
27
  */
28
28
  DisplayName?: string;
29
29
  /**
30
- * @public
31
30
  * <p>A dimension map that contains the dimensions for this partition.</p>
31
+ * @public
32
32
  */
33
33
  Dimensions?: Record<string, string>;
34
34
  /**
35
- * @public
36
35
  * <p>The value of the metric. For example, <code>9</code> for <code>db.load.avg</code>.</p>
36
+ * @public
37
37
  */
38
38
  Value?: number;
39
39
  }
40
40
  /**
41
- * @public
42
41
  * <p>List of data objects which provide details about source metrics.
43
42
  * This field can be used to determine the PI metric to render
44
43
  * for the insight. This data type also includes static values
45
44
  * for the metrics for the Insight that were calculated and included
46
45
  * in text and annotations on the DB load chart.</p>
46
+ * @public
47
47
  */
48
48
  export interface Data {
49
49
  /**
50
- * @public
51
50
  * <p>This field determines the Performance Insights metric to render
52
51
  * for the insight. The <code>name</code> field refers to a Performance Insights metric.
53
52
  * </p>
53
+ * @public
54
54
  */
55
55
  PerformanceInsightsMetric?: PerformanceInsightsMetric;
56
56
  }
@@ -67,20 +67,20 @@ export declare const ContextType: {
67
67
  */
68
68
  export type ContextType = (typeof ContextType)[keyof typeof ContextType];
69
69
  /**
70
- * @public
71
70
  * <p>The list of recommendations for the insight.</p>
71
+ * @public
72
72
  */
73
73
  export interface Recommendation {
74
74
  /**
75
- * @public
76
75
  * <p>The unique identifier for the recommendation.</p>
76
+ * @public
77
77
  */
78
78
  RecommendationId?: string;
79
79
  /**
80
- * @public
81
80
  * <p>The recommendation details to help resolve the performance issue. For example,
82
81
  * <code>Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id</code>
83
82
  * </p>
83
+ * @public
84
84
  */
85
85
  RecommendationDescription?: string;
86
86
  }
@@ -123,60 +123,60 @@ export declare const AnalysisStatus: {
123
123
  */
124
124
  export type AnalysisStatus = (typeof AnalysisStatus)[keyof typeof AnalysisStatus];
125
125
  /**
126
- * @public
127
126
  * <p>Metadata assigned to an Amazon RDS resource consisting of a key-value pair.</p>
127
+ * @public
128
128
  */
129
129
  export interface Tag {
130
130
  /**
131
- * @public
132
131
  * <p>A key is the required name of the tag. The string value can be from 1 to 128 Unicode
133
132
  * characters in length and can't be prefixed with <code>aws:</code> or <code>rds:</code>.
134
133
  * The string can only contain only the set of Unicode letters, digits,
135
134
  * white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: <code>"^([\\p\{L\}\\p\{Z\}\\p\{N\}_.:/=+\\-@]*)$"</code>).</p>
135
+ * @public
136
136
  */
137
137
  Key: string | undefined;
138
138
  /**
139
- * @public
140
139
  * <p>A value is the optional value of the tag. The string value can be from 1 to 256
141
140
  * Unicode characters in length and can't be prefixed with <code>aws:</code> or <code>rds:</code>.
142
141
  * The string can only contain only the set of Unicode letters, digits,
143
142
  * white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p\{L\}\\p\{Z\}\\p\{N\}_.:/=+\\-@]*)$").</p>
143
+ * @public
144
144
  */
145
145
  Value: string | undefined;
146
146
  }
147
147
  /**
148
- * @public
149
148
  * <p>Retrieves the details of the performance analysis report.</p>
149
+ * @public
150
150
  */
151
151
  export interface AnalysisReportSummary {
152
152
  /**
153
- * @public
154
153
  * <p>The name of the analysis report.</p>
154
+ * @public
155
155
  */
156
156
  AnalysisReportId?: string;
157
157
  /**
158
- * @public
159
158
  * <p>The time you created the analysis report.</p>
159
+ * @public
160
160
  */
161
161
  CreateTime?: Date;
162
162
  /**
163
- * @public
164
163
  * <p>The start time of the analysis in the report.</p>
164
+ * @public
165
165
  */
166
166
  StartTime?: Date;
167
167
  /**
168
- * @public
169
168
  * <p>The end time of the analysis in the report.</p>
169
+ * @public
170
170
  */
171
171
  EndTime?: Date;
172
172
  /**
173
- * @public
174
173
  * <p>The status of the analysis report.</p>
174
+ * @public
175
175
  */
176
176
  Status?: AnalysisStatus;
177
177
  /**
178
- * @public
179
178
  * <p>List of all the tags added to the analysis report.</p>
179
+ * @public
180
180
  */
181
181
  Tags?: Tag[];
182
182
  }
@@ -185,31 +185,31 @@ export interface AnalysisReportSummary {
185
185
  */
186
186
  export interface CreatePerformanceAnalysisReportRequest {
187
187
  /**
188
- * @public
189
188
  * <p>The Amazon Web Services service for which Performance Insights will return metrics. Valid value is <code>RDS</code>.</p>
189
+ * @public
190
190
  */
191
191
  ServiceType: ServiceType | undefined;
192
192
  /**
193
- * @public
194
193
  * <p>An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from
195
194
  * this data source.</p>
196
195
  * <p>To use an Amazon RDS instance as a data source, you specify its <code>DbiResourceId</code> value.
197
196
  * For example, specify <code>db-ADECBTYHKTSAUMUZQYPDS2GW4A</code>.</p>
197
+ * @public
198
198
  */
199
199
  Identifier: string | undefined;
200
200
  /**
201
- * @public
202
201
  * <p>The start time defined for the analysis report.</p>
202
+ * @public
203
203
  */
204
204
  StartTime: Date | undefined;
205
205
  /**
206
- * @public
207
206
  * <p>The end time defined for the analysis report.</p>
207
+ * @public
208
208
  */
209
209
  EndTime: Date | undefined;
210
210
  /**
211
- * @public
212
211
  * <p>The metadata assigned to the analysis report consisting of a key-value pair.</p>
212
+ * @public
213
213
  */
214
214
  Tags?: Tag[];
215
215
  }
@@ -218,14 +218,14 @@ export interface CreatePerformanceAnalysisReportRequest {
218
218
  */
219
219
  export interface CreatePerformanceAnalysisReportResponse {
220
220
  /**
221
- * @public
222
221
  * <p>A unique identifier for the created analysis report.</p>
222
+ * @public
223
223
  */
224
224
  AnalysisReportId?: string;
225
225
  }
226
226
  /**
227
- * @public
228
227
  * <p>The request failed due to an unknown error.</p>
228
+ * @public
229
229
  */
230
230
  export declare class InternalServiceError extends __BaseException {
231
231
  readonly name: "InternalServiceError";
@@ -237,8 +237,8 @@ export declare class InternalServiceError extends __BaseException {
237
237
  constructor(opts: __ExceptionOptionType<InternalServiceError, __BaseException>);
238
238
  }
239
239
  /**
240
- * @public
241
240
  * <p>One of the arguments provided is invalid for this request.</p>
241
+ * @public
242
242
  */
243
243
  export declare class InvalidArgumentException extends __BaseException {
244
244
  readonly name: "InvalidArgumentException";
@@ -250,8 +250,8 @@ export declare class InvalidArgumentException extends __BaseException {
250
250
  constructor(opts: __ExceptionOptionType<InvalidArgumentException, __BaseException>);
251
251
  }
252
252
  /**
253
- * @public
254
253
  * <p>The user is not authorized to perform this request.</p>
254
+ * @public
255
255
  */
256
256
  export declare class NotAuthorizedException extends __BaseException {
257
257
  readonly name: "NotAuthorizedException";
@@ -263,18 +263,18 @@ export declare class NotAuthorizedException extends __BaseException {
263
263
  constructor(opts: __ExceptionOptionType<NotAuthorizedException, __BaseException>);
264
264
  }
265
265
  /**
266
- * @public
267
266
  * <p>A timestamp, and a single numerical value, which together represent a measurement at a particular point in time.</p>
267
+ * @public
268
268
  */
269
269
  export interface DataPoint {
270
270
  /**
271
- * @public
272
271
  * <p>The time, in epoch format, associated with a particular <code>Value</code>.</p>
272
+ * @public
273
273
  */
274
274
  Timestamp: Date | undefined;
275
275
  /**
276
- * @public
277
276
  * <p>The actual value associated with a particular <code>Timestamp</code>.</p>
277
+ * @public
278
278
  */
279
279
  Value: number | undefined;
280
280
  }
@@ -283,22 +283,22 @@ export interface DataPoint {
283
283
  */
284
284
  export interface DeletePerformanceAnalysisReportRequest {
285
285
  /**
286
- * @public
287
286
  * <p>The Amazon Web Services service for which Performance Insights will return metrics. Valid value is <code>RDS</code>.</p>
287
+ * @public
288
288
  */
289
289
  ServiceType: ServiceType | undefined;
290
290
  /**
291
- * @public
292
291
  * <p>An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source.
293
292
  * In the console, the identifier is shown as <i>ResourceID</i>. When you
294
293
  * call <code>DescribeDBInstances</code>, the identifier is returned as <code>DbiResourceId</code>.</p>
295
294
  * <p>To use a DB instance as a data source, specify its <code>DbiResourceId</code> value. For example, specify
296
295
  * <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.</p>
296
+ * @public
297
297
  */
298
298
  Identifier: string | undefined;
299
299
  /**
300
- * @public
301
300
  * <p>The unique identifier of the analysis report for deletion.</p>
301
+ * @public
302
302
  */
303
303
  AnalysisReportId: string | undefined;
304
304
  }
@@ -308,7 +308,6 @@ export interface DeletePerformanceAnalysisReportRequest {
308
308
  export interface DeletePerformanceAnalysisReportResponse {
309
309
  }
310
310
  /**
311
- * @public
312
311
  * <p>A logical grouping of Performance Insights metrics for a related subject area. For example, the
313
312
  * <code>db.sql</code> dimension group consists of the following dimensions:</p>
314
313
  * <ul>
@@ -335,10 +334,10 @@ export interface DeletePerformanceAnalysisReportResponse {
335
334
  * <p>Each response element returns a maximum of 500 bytes. For larger elements, such as SQL
336
335
  * statements, only the first 500 bytes are returned.</p>
337
336
  * </note>
337
+ * @public
338
338
  */
339
339
  export interface DimensionGroup {
340
340
  /**
341
- * @public
342
341
  * <p>The name of the dimension group. Valid values are as follows:</p>
343
342
  * <ul>
344
343
  * <li>
@@ -422,10 +421,10 @@ export interface DimensionGroup {
422
421
  * <code>db.wait_state</code> - The event for which the database backend is waiting (only Amazon DocumentDB).</p>
423
422
  * </li>
424
423
  * </ul>
424
+ * @public
425
425
  */
426
426
  Group: string | undefined;
427
427
  /**
428
- * @public
429
428
  * <p>A list of specific dimensions from a dimension group. If this parameter is not present,
430
429
  * then it signifies that all of the dimensions in the group were requested, or are present in
431
430
  * the response.</p>
@@ -572,11 +571,12 @@ export interface DimensionGroup {
572
571
  * <code>db.wait_state.name</code> - The event for which the backend is waiting (only Amazon DocumentDB).</p>
573
572
  * </li>
574
573
  * </ul>
574
+ * @public
575
575
  */
576
576
  Dimensions?: string[];
577
577
  /**
578
- * @public
579
578
  * <p>The maximum number of items to fetch for this dimension group.</p>
579
+ * @public
580
580
  */
581
581
  Limit?: number;
582
582
  }
@@ -585,7 +585,6 @@ export interface DimensionGroup {
585
585
  */
586
586
  export interface DescribeDimensionKeysRequest {
587
587
  /**
588
- * @public
589
588
  * <p>The Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows:</p>
590
589
  * <ul>
591
590
  * <li>
@@ -599,37 +598,37 @@ export interface DescribeDimensionKeysRequest {
599
598
  * </p>
600
599
  * </li>
601
600
  * </ul>
601
+ * @public
602
602
  */
603
603
  ServiceType: ServiceType | undefined;
604
604
  /**
605
- * @public
606
605
  * <p>An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from
607
606
  * this data source.</p>
608
607
  * <p>To use an Amazon RDS instance as a data source, you specify its <code>DbiResourceId</code> value.
609
608
  * For example, specify <code>db-FAIHNTYBKTGAUSUZQYPDS2GW4A</code>.
610
609
  * </p>
610
+ * @public
611
611
  */
612
612
  Identifier: string | undefined;
613
613
  /**
614
- * @public
615
614
  * <p>The date and time specifying the beginning of the requested time series data. You must specify a
616
615
  * <code>StartTime</code> within the past 7 days. The value specified is <i>inclusive</i>,
617
616
  * which means that data points equal to or greater than <code>StartTime</code> are returned.
618
617
  * </p>
619
618
  * <p>The value for <code>StartTime</code> must be earlier than the value for <code>EndTime</code>.
620
619
  * </p>
620
+ * @public
621
621
  */
622
622
  StartTime: Date | undefined;
623
623
  /**
624
- * @public
625
624
  * <p>The date and time specifying the end of the requested time series data. The value specified is
626
625
  * <i>exclusive</i>, which means that data points less than (but not equal to) <code>EndTime</code> are
627
626
  * returned.</p>
628
627
  * <p>The value for <code>EndTime</code> must be later than the value for <code>StartTime</code>.</p>
628
+ * @public
629
629
  */
630
630
  EndTime: Date | undefined;
631
631
  /**
632
- * @public
633
632
  * <p>The name of a Performance Insights metric to be measured.</p>
634
633
  * <p>Valid values for <code>Metric</code> are:</p>
635
634
  * <ul>
@@ -649,10 +648,10 @@ export interface DescribeDimensionKeysRequest {
649
648
  * <code>db.sampledload.avg</code> less than <code>db.load.avg</code>. For most use cases, you can
650
649
  * query <code>db.load.avg</code> only.
651
650
  * </p>
651
+ * @public
652
652
  */
653
653
  Metric: string | undefined;
654
654
  /**
655
- * @public
656
655
  * <p>The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as
657
656
  * one second, or as long as one day (86400 seconds). Valid values are:
658
657
  * </p>
@@ -681,31 +680,31 @@ export interface DescribeDimensionKeysRequest {
681
680
  * <p>If you don't specify <code>PeriodInSeconds</code>, then Performance Insights chooses a value for you, with a
682
681
  * goal of returning roughly 100-200 data points in the response.
683
682
  * </p>
683
+ * @public
684
684
  */
685
685
  PeriodInSeconds?: number;
686
686
  /**
687
- * @public
688
687
  * <p>A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all
689
688
  * dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return
690
689
  * a limited number of values for a dimension. </p>
690
+ * @public
691
691
  */
692
692
  GroupBy: DimensionGroup | undefined;
693
693
  /**
694
- * @public
695
694
  * <p>Additional metrics for the top <code>N</code> dimension keys. If the specified dimension group in the <code>GroupBy</code> parameter is
696
695
  * <code>db.sql_tokenized</code>, you can specify per-SQL metrics to get the values for the top <code>N</code> SQL digests. The response
697
696
  * syntax is as follows: <code>"AdditionalMetrics" : \{ "<i>string</i>" : "<i>string</i>" \}</code>. </p>
697
+ * @public
698
698
  */
699
699
  AdditionalMetrics?: string[];
700
700
  /**
701
- * @public
702
701
  * <p>For each dimension specified in <code>GroupBy</code>, specify a secondary dimension
703
702
  * to further subdivide the partition keys in the response.
704
703
  * </p>
704
+ * @public
705
705
  */
706
706
  PartitionBy?: DimensionGroup;
707
707
  /**
708
- * @public
709
708
  * <p>One or more filters to apply in the request. Restrictions:</p>
710
709
  * <ul>
711
710
  * <li>
@@ -716,58 +715,59 @@ export interface DescribeDimensionKeysRequest {
716
715
  * <p>A single filter for any other dimension in this dimension group.</p>
717
716
  * </li>
718
717
  * </ul>
718
+ * @public
719
719
  */
720
720
  Filter?: Record<string, string>;
721
721
  /**
722
- * @public
723
722
  * <p>The maximum number of items to return in the response. If more items exist than the specified <code>MaxRecords</code> value, a
724
723
  * pagination token is included in the response so that the remaining results can be retrieved. </p>
724
+ * @public
725
725
  */
726
726
  MaxResults?: number;
727
727
  /**
728
- * @public
729
728
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond
730
729
  * the token, up to the value specified by <code>MaxRecords</code>.</p>
730
+ * @public
731
731
  */
732
732
  NextToken?: string;
733
733
  }
734
734
  /**
735
- * @public
736
735
  * <p>An object that includes the requested dimension key values and aggregated metric values
737
736
  * within a dimension group.</p>
737
+ * @public
738
738
  */
739
739
  export interface DimensionKeyDescription {
740
740
  /**
741
- * @public
742
741
  * <p>A map of name-value pairs for the dimensions in the group.</p>
742
+ * @public
743
743
  */
744
744
  Dimensions?: Record<string, string>;
745
745
  /**
746
- * @public
747
746
  * <p>The aggregated metric value for the dimensions, over the requested time range.</p>
747
+ * @public
748
748
  */
749
749
  Total?: number;
750
750
  /**
751
- * @public
752
751
  * <p>A map that contains the value for each additional metric.</p>
752
+ * @public
753
753
  */
754
754
  AdditionalMetrics?: Record<string, number>;
755
755
  /**
756
- * @public
757
756
  * <p>If <code>PartitionBy</code> was specified, <code>PartitionKeys</code> contains the dimensions that were.</p>
757
+ * @public
758
758
  */
759
759
  Partitions?: number[];
760
760
  }
761
761
  /**
762
- * @public
763
762
  * <p>If <code>PartitionBy</code> was specified in a <code>DescribeDimensionKeys</code>
764
763
  * request, the dimensions are returned in an array. Each element in the array specifies one
765
764
  * dimension. </p>
765
+ * @public
766
766
  */
767
767
  export interface ResponsePartitionKey {
768
768
  /**
769
- * @public
770
769
  * <p>A dimension map that contains the dimensions for this partition.</p>
770
+ * @public
771
771
  */
772
772
  Dimensions: Record<string, string> | undefined;
773
773
  }
@@ -776,32 +776,32 @@ export interface ResponsePartitionKey {
776
776
  */
777
777
  export interface DescribeDimensionKeysResponse {
778
778
  /**
779
- * @public
780
779
  * <p>The start time for the returned dimension keys, after alignment to a granular boundary (as specified by <code>PeriodInSeconds</code>).
781
780
  * <code>AlignedStartTime</code> will be less than or equal to the value of the user-specified <code>StartTime</code>. </p>
781
+ * @public
782
782
  */
783
783
  AlignedStartTime?: Date;
784
784
  /**
785
- * @public
786
785
  * <p>The end time for the returned dimension keys, after alignment to a granular boundary (as specified by <code>PeriodInSeconds</code>).
787
786
  * <code>AlignedEndTime</code> will be greater than or equal to the value of the user-specified <code>Endtime</code>. </p>
787
+ * @public
788
788
  */
789
789
  AlignedEndTime?: Date;
790
790
  /**
791
- * @public
792
791
  * <p>If <code>PartitionBy</code> was present in the request, <code>PartitionKeys</code> contains the breakdown of dimension keys by the
793
792
  * specified partitions. </p>
793
+ * @public
794
794
  */
795
795
  PartitionKeys?: ResponsePartitionKey[];
796
796
  /**
797
- * @public
798
797
  * <p>The dimension keys that were requested.</p>
798
+ * @public
799
799
  */
800
800
  Keys?: DimensionKeyDescription[];
801
801
  /**
802
- * @public
803
802
  * <p>A pagination token that indicates the response didn’t return all available records because <code>MaxRecords</code> was specified in the
804
803
  * previous request. To get the remaining records, specify <code>NextToken</code> in a separate request with this value. </p>
804
+ * @public
805
805
  */
806
806
  NextToken?: string;
807
807
  }
@@ -819,39 +819,38 @@ export declare const DetailStatus: {
819
819
  */
820
820
  export type DetailStatus = (typeof DetailStatus)[keyof typeof DetailStatus];
821
821
  /**
822
- * @public
823
822
  * <p>The information about a dimension.</p>
823
+ * @public
824
824
  */
825
825
  export interface DimensionDetail {
826
826
  /**
827
- * @public
828
827
  * <p>The identifier of a dimension.</p>
828
+ * @public
829
829
  */
830
830
  Identifier?: string;
831
831
  }
832
832
  /**
833
- * @public
834
833
  * <p>Information about dimensions within a dimension group.</p>
834
+ * @public
835
835
  */
836
836
  export interface DimensionGroupDetail {
837
837
  /**
838
- * @public
839
838
  * <p>The name of the dimension group.</p>
839
+ * @public
840
840
  */
841
841
  Group?: string;
842
842
  /**
843
- * @public
844
843
  * <p>The dimensions within a dimension group.</p>
844
+ * @public
845
845
  */
846
846
  Dimensions?: DimensionDetail[];
847
847
  }
848
848
  /**
849
- * @public
850
849
  * <p>An object that describes the details for a specified dimension.</p>
850
+ * @public
851
851
  */
852
852
  export interface DimensionKeyDetail {
853
853
  /**
854
- * @public
855
854
  * <p>The value of the dimension detail data. Depending on the return status, this value is either the
856
855
  * full or truncated SQL query for the following dimensions:</p>
857
856
  * <ul>
@@ -864,10 +863,10 @@ export interface DimensionKeyDetail {
864
863
  * <code>db.sql.statement</code> (Amazon RDS and Aurora)</p>
865
864
  * </li>
866
865
  * </ul>
866
+ * @public
867
867
  */
868
868
  Value?: string;
869
869
  /**
870
- * @public
871
870
  * <p>The full name of the dimension. The full name includes the group name and key name. The following values are valid:</p>
872
871
  * <ul>
873
872
  * <li>
@@ -879,10 +878,10 @@ export interface DimensionKeyDetail {
879
878
  * <code>db.sql.statement</code> (Amazon RDS and Aurora)</p>
880
879
  * </li>
881
880
  * </ul>
881
+ * @public
882
882
  */
883
883
  Dimension?: string;
884
884
  /**
885
- * @public
886
885
  * <p>The status of the dimension detail data. Possible values include the following:</p>
887
886
  * <ul>
888
887
  * <li>
@@ -899,6 +898,7 @@ export interface DimensionKeyDetail {
899
898
  * <code>UNAVAILABLE</code> - The dimension detail data could not be collected successfully.</p>
900
899
  * </li>
901
900
  * </ul>
901
+ * @public
902
902
  */
903
903
  Status?: DetailStatus;
904
904
  }
@@ -919,13 +919,12 @@ export declare const FeatureStatus: {
919
919
  */
920
920
  export type FeatureStatus = (typeof FeatureStatus)[keyof typeof FeatureStatus];
921
921
  /**
922
- * @public
923
922
  * <p>The metadata for a feature. For example, the metadata might indicate that a feature is
924
923
  * turned on or off on a specific DB instance.</p>
924
+ * @public
925
925
  */
926
926
  export interface FeatureMetadata {
927
927
  /**
928
- * @public
929
928
  * <p>The status of the feature on the DB instance. Possible values include the following:</p>
930
929
  * <ul>
931
930
  * <li>
@@ -953,6 +952,7 @@ export interface FeatureMetadata {
953
952
  * <code>UNKNOWN</code> - The feature status couldn't be determined.</p>
954
953
  * </li>
955
954
  * </ul>
955
+ * @public
956
956
  */
957
957
  Status?: FeatureStatus;
958
958
  }
@@ -961,20 +961,19 @@ export interface FeatureMetadata {
961
961
  */
962
962
  export interface GetDimensionKeyDetailsRequest {
963
963
  /**
964
- * @public
965
964
  * <p>The Amazon Web Services service for which Performance Insights returns data. The only valid value is <code>RDS</code>.</p>
965
+ * @public
966
966
  */
967
967
  ServiceType: ServiceType | undefined;
968
968
  /**
969
- * @public
970
969
  * <p>The ID for a data source from which to gather dimension data. This ID must be immutable and
971
970
  * unique within an Amazon Web Services Region. When a DB instance is the data source, specify its
972
971
  * <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.
973
972
  * </p>
973
+ * @public
974
974
  */
975
975
  Identifier: string | undefined;
976
976
  /**
977
- * @public
978
977
  * <p>The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are
979
978
  * valid:</p>
980
979
  * <ul>
@@ -987,10 +986,10 @@ export interface GetDimensionKeyDetailsRequest {
987
986
  * <code>db.sql</code> (Amazon RDS and Aurora only)</p>
988
987
  * </li>
989
988
  * </ul>
989
+ * @public
990
990
  */
991
991
  Group: string | undefined;
992
992
  /**
993
- * @public
994
993
  * <p>The ID of the dimension group from which to retrieve dimension details. For dimension group <code>db.sql</code>, the group ID is
995
994
  * <code>db.sql.id</code>. The following group ID values are valid:</p>
996
995
  * <ul>
@@ -1003,10 +1002,10 @@ export interface GetDimensionKeyDetailsRequest {
1003
1002
  * <code>db.query.id</code> for dimension group <code>db.query</code> (DocumentDB only)</p>
1004
1003
  * </li>
1005
1004
  * </ul>
1005
+ * @public
1006
1006
  */
1007
1007
  GroupIdentifier: string | undefined;
1008
1008
  /**
1009
- * @public
1010
1009
  * <p>A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns
1011
1010
  * all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:</p>
1012
1011
  * <ul>
@@ -1021,6 +1020,7 @@ export interface GetDimensionKeyDetailsRequest {
1021
1020
  * <code>statement</code> (DocumentDB only).</p>
1022
1021
  * </li>
1023
1022
  * </ul>
1023
+ * @public
1024
1024
  */
1025
1025
  RequestedDimensions?: string[];
1026
1026
  }
@@ -1029,8 +1029,8 @@ export interface GetDimensionKeyDetailsRequest {
1029
1029
  */
1030
1030
  export interface GetDimensionKeyDetailsResponse {
1031
1031
  /**
1032
- * @public
1033
1032
  * <p>The details for the requested dimensions.</p>
1033
+ * @public
1034
1034
  */
1035
1035
  Dimensions?: DimensionKeyDetail[];
1036
1036
  }
@@ -1051,38 +1051,38 @@ export type TextFormat = (typeof TextFormat)[keyof typeof TextFormat];
1051
1051
  */
1052
1052
  export interface GetPerformanceAnalysisReportRequest {
1053
1053
  /**
1054
- * @public
1055
1054
  * <p>The Amazon Web Services service for which Performance Insights will return metrics. Valid value is
1056
1055
  * <code>RDS</code>.</p>
1056
+ * @public
1057
1057
  */
1058
1058
  ServiceType: ServiceType | undefined;
1059
1059
  /**
1060
- * @public
1061
1060
  * <p>An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers
1062
1061
  * metrics from this data source. In the console, the identifier is shown as
1063
1062
  * <i>ResourceID</i>. When you call <code>DescribeDBInstances</code>, the identifier is
1064
1063
  * returned as <code>DbiResourceId</code>.</p>
1065
1064
  * <p>To use a DB instance as a data source, specify its <code>DbiResourceId</code> value. For example, specify
1066
1065
  * <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.</p>
1066
+ * @public
1067
1067
  */
1068
1068
  Identifier: string | undefined;
1069
1069
  /**
1070
- * @public
1071
1070
  * <p>A unique identifier of the created analysis report. For example,
1072
1071
  * <code>report-12345678901234567</code>
1073
1072
  * </p>
1073
+ * @public
1074
1074
  */
1075
1075
  AnalysisReportId: string | undefined;
1076
1076
  /**
1077
- * @public
1078
1077
  * <p>Indicates the text format in the report. The options are <code>PLAIN_TEXT</code> or <code>MARKDOWN</code>. The default
1079
1078
  * value is <code>plain text</code>.</p>
1079
+ * @public
1080
1080
  */
1081
1081
  TextFormat?: TextFormat;
1082
1082
  /**
1083
- * @public
1084
1083
  * <p>The text language in the report. The default language is <code>EN_US</code> (English).
1085
1084
  * </p>
1085
+ * @public
1086
1086
  */
1087
1087
  AcceptLanguage?: AcceptLanguage;
1088
1088
  }
@@ -1091,16 +1091,16 @@ export interface GetPerformanceAnalysisReportRequest {
1091
1091
  */
1092
1092
  export interface GetResourceMetadataRequest {
1093
1093
  /**
1094
- * @public
1095
1094
  * <p>The Amazon Web Services service for which Performance Insights returns metrics.</p>
1095
+ * @public
1096
1096
  */
1097
1097
  ServiceType: ServiceType | undefined;
1098
1098
  /**
1099
- * @public
1100
1099
  * <p>An immutable identifier for a data source that is unique for an Amazon Web Services Region.
1101
1100
  * Performance Insights gathers metrics from this data source. To use a DB instance as a data source,
1102
1101
  * specify its <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.
1103
1102
  * </p>
1103
+ * @public
1104
1104
  */
1105
1105
  Identifier: string | undefined;
1106
1106
  }
@@ -1109,31 +1109,30 @@ export interface GetResourceMetadataRequest {
1109
1109
  */
1110
1110
  export interface GetResourceMetadataResponse {
1111
1111
  /**
1112
- * @public
1113
1112
  * <p>An immutable identifier for a data source that is unique for an Amazon Web Services Region.
1114
1113
  *
1115
1114
  * Performance Insights gathers metrics from this data source. To use a DB instance as a data source,
1116
1115
  * specify its <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.
1117
1116
  * </p>
1117
+ * @public
1118
1118
  */
1119
1119
  Identifier?: string;
1120
1120
  /**
1121
- * @public
1122
1121
  * <p>The metadata for different features. For example, the metadata might indicate that a feature is
1123
1122
  * turned on or off on a specific DB instance.</p>
1123
+ * @public
1124
1124
  */
1125
1125
  Features?: Record<string, FeatureMetadata>;
1126
1126
  }
1127
1127
  /**
1128
- * @public
1129
1128
  * <p>A single query to be processed. You must provide the metric to query. If no other
1130
1129
  * parameters are specified, Performance Insights returns all data points for the specified metric. Optionally, you can
1131
1130
  * request that the data points be aggregated by dimension group (<code>GroupBy</code>), and return only
1132
1131
  * those data points that match your criteria (<code>Filter</code>).</p>
1132
+ * @public
1133
1133
  */
1134
1134
  export interface MetricQuery {
1135
1135
  /**
1136
- * @public
1137
1136
  * <p>The name of a Performance Insights metric to be measured.</p>
1138
1137
  * <p>Valid values for <code>Metric</code> are:</p>
1139
1138
  * <ul>
@@ -1155,18 +1154,18 @@ export interface MetricQuery {
1155
1154
  * value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with <code>db.load.avg</code> showing the
1156
1155
  * scaled values, <code>db.sampledload.avg</code> showing the raw values, and <code>db.sampledload.avg</code> less than
1157
1156
  * <code>db.load.avg</code>. For most use cases, you can query <code>db.load.avg</code> only.</p>
1157
+ * @public
1158
1158
  */
1159
1159
  Metric: string | undefined;
1160
1160
  /**
1161
- * @public
1162
1161
  * <p>A specification for how to aggregate the data points from a query result. You must
1163
1162
  * specify a valid dimension group. Performance Insights will return all of the dimensions within that group,
1164
1163
  * unless you provide the names of specific dimensions within that group. You can also request
1165
1164
  * that Performance Insights return a limited number of values for a dimension.</p>
1165
+ * @public
1166
1166
  */
1167
1167
  GroupBy?: DimensionGroup;
1168
1168
  /**
1169
- * @public
1170
1169
  * <p>One or more filters to apply in the request. Restrictions:</p>
1171
1170
  * <ul>
1172
1171
  * <li>
@@ -1176,6 +1175,7 @@ export interface MetricQuery {
1176
1175
  * <p>A single filter for any other dimension in this dimension group.</p>
1177
1176
  * </li>
1178
1177
  * </ul>
1178
+ * @public
1179
1179
  */
1180
1180
  Filter?: Record<string, string>;
1181
1181
  }
@@ -1196,7 +1196,6 @@ export type PeriodAlignment = (typeof PeriodAlignment)[keyof typeof PeriodAlignm
1196
1196
  */
1197
1197
  export interface GetResourceMetricsRequest {
1198
1198
  /**
1199
- * @public
1200
1199
  * <p>The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:</p>
1201
1200
  * <ul>
1202
1201
  * <li>
@@ -1210,43 +1209,43 @@ export interface GetResourceMetricsRequest {
1210
1209
  * </p>
1211
1210
  * </li>
1212
1211
  * </ul>
1212
+ * @public
1213
1213
  */
1214
1214
  ServiceType: ServiceType | undefined;
1215
1215
  /**
1216
- * @public
1217
1216
  * <p>An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the
1218
1217
  * console, the identifier is shown as <i>ResourceID</i>. When you call <code>DescribeDBInstances</code>, the identifier is
1219
1218
  * returned as <code>DbiResourceId</code>.</p>
1220
1219
  * <p>To use a DB instance as a data source, specify its <code>DbiResourceId</code> value. For example, specify
1221
1220
  * <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.</p>
1221
+ * @public
1222
1222
  */
1223
1223
  Identifier: string | undefined;
1224
1224
  /**
1225
- * @public
1226
1225
  * <p>An array of one or more queries to perform. Each query must specify a Performance Insights metric, and can optionally specify aggregation and filtering
1227
1226
  * criteria.</p>
1227
+ * @public
1228
1228
  */
1229
1229
  MetricQueries: MetricQuery[] | undefined;
1230
1230
  /**
1231
- * @public
1232
1231
  * <p>The date and time specifying the beginning of the requested time series query range. You can't
1233
1232
  * specify a <code>StartTime</code> that is earlier than 7 days ago. By default, Performance Insights has 7 days of
1234
1233
  * retention, but you can extend this range up to 2 years. The value specified is
1235
1234
  * <i>inclusive</i>. Thus, the command returns data points equal to or greater
1236
1235
  * than <code>StartTime</code>.</p>
1237
1236
  * <p>The value for <code>StartTime</code> must be earlier than the value for <code>EndTime</code>.</p>
1237
+ * @public
1238
1238
  */
1239
1239
  StartTime: Date | undefined;
1240
1240
  /**
1241
- * @public
1242
1241
  * <p>The date and time specifying the end of the requested time series query range. The value
1243
1242
  * specified is <i>exclusive</i>. Thus, the command returns data points less than
1244
1243
  * (but not equal to) <code>EndTime</code>.</p>
1245
1244
  * <p>The value for <code>EndTime</code> must be later than the value for <code>StartTime</code>.</p>
1245
+ * @public
1246
1246
  */
1247
1247
  EndTime: Date | undefined;
1248
1248
  /**
1249
- * @public
1250
1249
  * <p>The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400
1251
1250
  * seconds). Valid values are:</p>
1252
1251
  * <ul>
@@ -1273,33 +1272,33 @@ export interface GetResourceMetricsRequest {
1273
1272
  * </ul>
1274
1273
  * <p>If you don't specify <code>PeriodInSeconds</code>, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data
1275
1274
  * points in the response.</p>
1275
+ * @public
1276
1276
  */
1277
1277
  PeriodInSeconds?: number;
1278
1278
  /**
1279
- * @public
1280
1279
  * <p>The maximum number of items to return in the response. If more items exist than the specified <code>MaxRecords</code> value, a
1281
1280
  * pagination token is included in the response so that the remaining results can be retrieved. </p>
1281
+ * @public
1282
1282
  */
1283
1283
  MaxResults?: number;
1284
1284
  /**
1285
- * @public
1286
1285
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond
1287
1286
  * the token, up to the value specified by <code>MaxRecords</code>.</p>
1287
+ * @public
1288
1288
  */
1289
1289
  NextToken?: string;
1290
1290
  /**
1291
- * @public
1292
1291
  * <p>The returned timestamp which is the start or end time of the time periods. The default value is <code>END_TIME</code>.</p>
1292
+ * @public
1293
1293
  */
1294
1294
  PeriodAlignment?: PeriodAlignment;
1295
1295
  }
1296
1296
  /**
1297
- * @public
1298
1297
  * <p>An object describing a Performance Insights metric and one or more dimensions for that metric.</p>
1298
+ * @public
1299
1299
  */
1300
1300
  export interface ResponseResourceMetricKey {
1301
1301
  /**
1302
- * @public
1303
1302
  * <p>The name of a Performance Insights metric to be measured.</p>
1304
1303
  * <p>Valid values for <code>Metric</code> are:</p>
1305
1304
  * <ul>
@@ -1322,28 +1321,29 @@ export interface ResponseResourceMetricKey {
1322
1321
  * <code>db.sampledload.avg</code> showing the raw values, and <code>db.sampledload.avg</code> less
1323
1322
  * than <code>db.load.avg</code>. For most use cases, you can query <code>db.load.avg</code> only.
1324
1323
  * </p>
1324
+ * @public
1325
1325
  */
1326
1326
  Metric: string | undefined;
1327
1327
  /**
1328
- * @public
1329
1328
  * <p>The valid dimensions for the metric.</p>
1329
+ * @public
1330
1330
  */
1331
1331
  Dimensions?: Record<string, string>;
1332
1332
  }
1333
1333
  /**
1334
- * @public
1335
1334
  * <p>A time-ordered series of data points, corresponding to a dimension of a Performance Insights
1336
1335
  * metric.</p>
1336
+ * @public
1337
1337
  */
1338
1338
  export interface MetricKeyDataPoints {
1339
1339
  /**
1340
- * @public
1341
1340
  * <p>The dimensions to which the data points apply.</p>
1341
+ * @public
1342
1342
  */
1343
1343
  Key?: ResponseResourceMetricKey;
1344
1344
  /**
1345
- * @public
1346
1345
  * <p>An array of timestamp-value pairs, representing measurements over a period of time.</p>
1346
+ * @public
1347
1347
  */
1348
1348
  DataPoints?: DataPoint[];
1349
1349
  }
@@ -1352,35 +1352,35 @@ export interface MetricKeyDataPoints {
1352
1352
  */
1353
1353
  export interface GetResourceMetricsResponse {
1354
1354
  /**
1355
- * @public
1356
1355
  * <p>The start time for the returned metrics, after alignment to a granular boundary (as specified by <code>PeriodInSeconds</code>).
1357
1356
  * <code>AlignedStartTime</code> will be less than or equal to the value of the user-specified <code>StartTime</code>.</p>
1357
+ * @public
1358
1358
  */
1359
1359
  AlignedStartTime?: Date;
1360
1360
  /**
1361
- * @public
1362
1361
  * <p>The end time for the returned metrics, after alignment to a granular boundary (as specified by <code>PeriodInSeconds</code>).
1363
1362
  * <code>AlignedEndTime</code> will be greater than or equal to the value of the user-specified <code>Endtime</code>.</p>
1363
+ * @public
1364
1364
  */
1365
1365
  AlignedEndTime?: Date;
1366
1366
  /**
1367
- * @public
1368
1367
  * <p>An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the
1369
1368
  * console, the identifier is shown as <i>ResourceID</i>. When you call <code>DescribeDBInstances</code>, the identifier is
1370
1369
  * returned as <code>DbiResourceId</code>.</p>
1370
+ * @public
1371
1371
  */
1372
1372
  Identifier?: string;
1373
1373
  /**
1374
- * @public
1375
1374
  * <p>An array of metric results, where each array element contains all of the data points for a
1376
1375
  * particular dimension.</p>
1376
+ * @public
1377
1377
  */
1378
1378
  MetricList?: MetricKeyDataPoints[];
1379
1379
  /**
1380
- * @public
1381
1380
  * <p>An optional pagination token provided by a previous request. If this parameter is specified,
1382
1381
  * the response includes only records beyond the token, up to the value specified by <code>MaxRecords</code>.
1383
1382
  * </p>
1383
+ * @public
1384
1384
  */
1385
1385
  NextToken?: string;
1386
1386
  }
@@ -1389,50 +1389,50 @@ export interface GetResourceMetricsResponse {
1389
1389
  */
1390
1390
  export interface ListAvailableResourceDimensionsRequest {
1391
1391
  /**
1392
- * @public
1393
1392
  * <p>The Amazon Web Services service for which Performance Insights returns metrics.</p>
1393
+ * @public
1394
1394
  */
1395
1395
  ServiceType: ServiceType | undefined;
1396
1396
  /**
1397
- * @public
1398
1397
  * <p>An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers
1399
1398
  * metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its
1400
1399
  * <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VWZ</code>. </p>
1400
+ * @public
1401
1401
  */
1402
1402
  Identifier: string | undefined;
1403
1403
  /**
1404
- * @public
1405
1404
  * <p>The types of metrics for which to retrieve dimensions. Valid values include <code>db.load</code>.</p>
1405
+ * @public
1406
1406
  */
1407
1407
  Metrics: string[] | undefined;
1408
1408
  /**
1409
- * @public
1410
1409
  * <p>The maximum number of items to return in the response. If more items exist than the specified
1411
1410
  * <code>MaxRecords</code> value, a pagination token is included in the response so that the remaining
1412
1411
  * results can be retrieved.</p>
1412
+ * @public
1413
1413
  */
1414
1414
  MaxResults?: number;
1415
1415
  /**
1416
- * @public
1417
1416
  * <p>An optional pagination token provided by a previous request. If this parameter is specified,
1418
1417
  * the response includes only records beyond the token, up to the value specified by <code>MaxRecords</code>.
1419
1418
  * </p>
1419
+ * @public
1420
1420
  */
1421
1421
  NextToken?: string;
1422
1422
  }
1423
1423
  /**
1424
- * @public
1425
1424
  * <p>The available dimension information for a metric type.</p>
1425
+ * @public
1426
1426
  */
1427
1427
  export interface MetricDimensionGroups {
1428
1428
  /**
1429
- * @public
1430
1429
  * <p>The metric type to which the dimension information belongs.</p>
1430
+ * @public
1431
1431
  */
1432
1432
  Metric?: string;
1433
1433
  /**
1434
- * @public
1435
1434
  * <p>The available dimension groups for a metric type.</p>
1435
+ * @public
1436
1436
  */
1437
1437
  Groups?: DimensionGroupDetail[];
1438
1438
  }
@@ -1441,14 +1441,14 @@ export interface MetricDimensionGroups {
1441
1441
  */
1442
1442
  export interface ListAvailableResourceDimensionsResponse {
1443
1443
  /**
1444
- * @public
1445
1444
  * <p>The dimension information returned for requested metric types.</p>
1445
+ * @public
1446
1446
  */
1447
1447
  MetricDimensions?: MetricDimensionGroups[];
1448
1448
  /**
1449
- * @public
1450
1449
  * <p>An optional pagination token provided by a previous request. If this parameter is specified,
1451
1450
  * the response includes only records beyond the token, up to the value specified by <code>MaxRecords</code>.</p>
1451
+ * @public
1452
1452
  */
1453
1453
  NextToken?: string;
1454
1454
  }
@@ -1457,19 +1457,18 @@ export interface ListAvailableResourceDimensionsResponse {
1457
1457
  */
1458
1458
  export interface ListAvailableResourceMetricsRequest {
1459
1459
  /**
1460
- * @public
1461
1460
  * <p>The Amazon Web Services service for which Performance Insights returns metrics.</p>
1461
+ * @public
1462
1462
  */
1463
1463
  ServiceType: ServiceType | undefined;
1464
1464
  /**
1465
- * @public
1466
1465
  * <p>An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers
1467
1466
  * metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its
1468
1467
  * <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VWZ</code>. </p>
1468
+ * @public
1469
1469
  */
1470
1470
  Identifier: string | undefined;
1471
1471
  /**
1472
- * @public
1473
1472
  * <p>The types of metrics to return in the response. Valid values in the array include the following:</p>
1474
1473
  * <ul>
1475
1474
  * <li>
@@ -1489,41 +1488,42 @@ export interface ListAvailableResourceMetricsRequest {
1489
1488
  * <code>db.sql_tokenized.stats</code> (per-SQL digest metrics) - All engines except for Amazon DocumentDB</p>
1490
1489
  * </li>
1491
1490
  * </ul>
1491
+ * @public
1492
1492
  */
1493
1493
  MetricTypes: string[] | undefined;
1494
1494
  /**
1495
- * @public
1496
1495
  * <p>An optional pagination token provided by a previous request. If this parameter is specified,
1497
1496
  * the response includes only records beyond the token, up to the value specified by <code>MaxRecords</code>.
1498
1497
  * </p>
1498
+ * @public
1499
1499
  */
1500
1500
  NextToken?: string;
1501
1501
  /**
1502
- * @public
1503
1502
  * <p>The maximum number of items to return. If the <code>MaxRecords</code> value is less than the number
1504
1503
  * of existing items, the response includes a pagination token. </p>
1504
+ * @public
1505
1505
  */
1506
1506
  MaxResults?: number;
1507
1507
  }
1508
1508
  /**
1509
- * @public
1510
1509
  * <p>An object that contains the full name, description, and unit of a metric.
1511
1510
  * </p>
1511
+ * @public
1512
1512
  */
1513
1513
  export interface ResponseResourceMetric {
1514
1514
  /**
1515
- * @public
1516
1515
  * <p>The full name of the metric.</p>
1516
+ * @public
1517
1517
  */
1518
1518
  Metric?: string;
1519
1519
  /**
1520
- * @public
1521
1520
  * <p>The description of the metric.</p>
1521
+ * @public
1522
1522
  */
1523
1523
  Description?: string;
1524
1524
  /**
1525
- * @public
1526
1525
  * <p>The unit of the metric.</p>
1526
+ * @public
1527
1527
  */
1528
1528
  Unit?: string;
1529
1529
  }
@@ -1532,16 +1532,16 @@ export interface ResponseResourceMetric {
1532
1532
  */
1533
1533
  export interface ListAvailableResourceMetricsResponse {
1534
1534
  /**
1535
- * @public
1536
1535
  * <p>An array of metrics available to query. Each array element contains the full name,
1537
1536
  * description, and unit of the metric.
1538
1537
  * </p>
1538
+ * @public
1539
1539
  */
1540
1540
  Metrics?: ResponseResourceMetric[];
1541
1541
  /**
1542
- * @public
1543
1542
  * <p>A pagination token that indicates the response didn’t return all available records because <code>MaxRecords</code> was specified in the
1544
1543
  * previous request. To get the remaining records, specify <code>NextToken</code> in a separate request with this value. </p>
1544
+ * @public
1545
1545
  */
1546
1546
  NextToken?: string;
1547
1547
  }
@@ -1550,36 +1550,36 @@ export interface ListAvailableResourceMetricsResponse {
1550
1550
  */
1551
1551
  export interface ListPerformanceAnalysisReportsRequest {
1552
1552
  /**
1553
- * @public
1554
1553
  * <p>The Amazon Web Services service for which Performance Insights returns metrics. Valid value is
1555
1554
  * <code>RDS</code>.</p>
1555
+ * @public
1556
1556
  */
1557
1557
  ServiceType: ServiceType | undefined;
1558
1558
  /**
1559
- * @public
1560
1559
  * <p>An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the
1561
1560
  * console, the identifier is shown as <i>ResourceID</i>. When you call <code>DescribeDBInstances</code>, the identifier is
1562
1561
  * returned as <code>DbiResourceId</code>.</p>
1563
1562
  * <p>To use a DB instance as a data source, specify its <code>DbiResourceId</code> value. For example, specify
1564
1563
  * <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.</p>
1564
+ * @public
1565
1565
  */
1566
1566
  Identifier: string | undefined;
1567
1567
  /**
1568
- * @public
1569
1568
  * <p>An optional pagination token provided by a previous request.
1570
1569
  * If this parameter is specified, the response includes only records beyond
1571
1570
  * the token, up to the value specified by <code>MaxResults</code>.</p>
1571
+ * @public
1572
1572
  */
1573
1573
  NextToken?: string;
1574
1574
  /**
1575
- * @public
1576
1575
  * <p>The maximum number of items to return in the response. If more items exist than the specified <code>MaxResults</code> value, a
1577
1576
  * pagination token is included in the response so that the remaining results can be retrieved. </p>
1577
+ * @public
1578
1578
  */
1579
1579
  MaxResults?: number;
1580
1580
  /**
1581
- * @public
1582
1581
  * <p>Specifies whether or not to include the list of tags in the response.</p>
1582
+ * @public
1583
1583
  */
1584
1584
  ListTags?: boolean;
1585
1585
  }
@@ -1588,16 +1588,16 @@ export interface ListPerformanceAnalysisReportsRequest {
1588
1588
  */
1589
1589
  export interface ListPerformanceAnalysisReportsResponse {
1590
1590
  /**
1591
- * @public
1592
1591
  * <p>List of reports including the report identifier, start and end time, creation time,
1593
1592
  * and status.</p>
1593
+ * @public
1594
1594
  */
1595
1595
  AnalysisReports?: AnalysisReportSummary[];
1596
1596
  /**
1597
- * @public
1598
1597
  * <p>An optional pagination token provided by a previous request.
1599
1598
  * If this parameter is specified, the response includes only records beyond the token,
1600
1599
  * up to the value specified by <code>MaxResults</code>.</p>
1600
+ * @public
1601
1601
  */
1602
1602
  NextToken?: string;
1603
1603
  }
@@ -1606,16 +1606,16 @@ export interface ListPerformanceAnalysisReportsResponse {
1606
1606
  */
1607
1607
  export interface ListTagsForResourceRequest {
1608
1608
  /**
1609
- * @public
1610
1609
  * <p>List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is <code>RDS</code>.</p>
1610
+ * @public
1611
1611
  */
1612
1612
  ServiceType: ServiceType | undefined;
1613
1613
  /**
1614
- * @public
1615
1614
  * <p>Lists all the tags for the Amazon RDS Performance Insights resource. This value is an
1616
1615
  * Amazon Resource Name (ARN). For information about creating an ARN,
1617
1616
  * see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing">
1618
1617
  * Constructing an RDS Amazon Resource Name (ARN)</a>.</p>
1618
+ * @public
1619
1619
  */
1620
1620
  ResourceARN: string | undefined;
1621
1621
  }
@@ -1624,8 +1624,8 @@ export interface ListTagsForResourceRequest {
1624
1624
  */
1625
1625
  export interface ListTagsForResourceResponse {
1626
1626
  /**
1627
- * @public
1628
1627
  * <p>The metadata assigned to an Amazon RDS resource consisting of a key-value pair.</p>
1628
+ * @public
1629
1629
  */
1630
1630
  Tags?: Tag[];
1631
1631
  }
@@ -1634,20 +1634,20 @@ export interface ListTagsForResourceResponse {
1634
1634
  */
1635
1635
  export interface TagResourceRequest {
1636
1636
  /**
1637
- * @public
1638
1637
  * <p>The Amazon Web Services service for which Performance Insights returns metrics. Valid value is <code>RDS</code>.</p>
1638
+ * @public
1639
1639
  */
1640
1640
  ServiceType: ServiceType | undefined;
1641
1641
  /**
1642
- * @public
1643
1642
  * <p>The Amazon RDS Performance Insights resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about
1644
1643
  * creating an ARN, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing">
1645
1644
  * Constructing an RDS Amazon Resource Name (ARN)</a>.</p>
1645
+ * @public
1646
1646
  */
1647
1647
  ResourceARN: string | undefined;
1648
1648
  /**
1649
- * @public
1650
1649
  * <p>The metadata assigned to an Amazon RDS resource consisting of a key-value pair.</p>
1650
+ * @public
1651
1651
  */
1652
1652
  Tags: Tag[] | undefined;
1653
1653
  }
@@ -1661,20 +1661,20 @@ export interface TagResourceResponse {
1661
1661
  */
1662
1662
  export interface UntagResourceRequest {
1663
1663
  /**
1664
- * @public
1665
1664
  * <p>List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is <code>RDS</code>.</p>
1665
+ * @public
1666
1666
  */
1667
1667
  ServiceType: ServiceType | undefined;
1668
1668
  /**
1669
- * @public
1670
1669
  * <p>The Amazon RDS Performance Insights resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about
1671
1670
  * creating an ARN, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing">
1672
1671
  * Constructing an RDS Amazon Resource Name (ARN)</a>.</p>
1672
+ * @public
1673
1673
  */
1674
1674
  ResourceARN: string | undefined;
1675
1675
  /**
1676
- * @public
1677
1676
  * <p>The metadata assigned to an Amazon RDS Performance Insights resource consisting of a key-value pair.</p>
1677
+ * @public
1678
1678
  */
1679
1679
  TagKeys: string[] | undefined;
1680
1680
  }
@@ -1684,90 +1684,89 @@ export interface UntagResourceRequest {
1684
1684
  export interface UntagResourceResponse {
1685
1685
  }
1686
1686
  /**
1687
- * @public
1688
1687
  * <p>Retrieves the list of performance issues which are identified.</p>
1688
+ * @public
1689
1689
  */
1690
1690
  export interface Insight {
1691
1691
  /**
1692
- * @public
1693
1692
  * <p>The unique identifier for the insight. For example, <code>insight-12345678901234567</code>.</p>
1693
+ * @public
1694
1694
  */
1695
1695
  InsightId: string | undefined;
1696
1696
  /**
1697
- * @public
1698
1697
  * <p>The type of insight. For example, <code>HighDBLoad</code>, <code>HighCPU</code>, or <code>DominatingSQLs</code>.</p>
1698
+ * @public
1699
1699
  */
1700
1700
  InsightType?: string;
1701
1701
  /**
1702
- * @public
1703
1702
  * <p>Indicates if the insight is causal or correlated insight.</p>
1703
+ * @public
1704
1704
  */
1705
1705
  Context?: ContextType;
1706
1706
  /**
1707
- * @public
1708
1707
  * <p>The start time of the insight. For example, <code>2018-10-30T00:00:00Z</code>.</p>
1708
+ * @public
1709
1709
  */
1710
1710
  StartTime?: Date;
1711
1711
  /**
1712
- * @public
1713
1712
  * <p>The end time of the insight. For example, <code>2018-10-30T00:00:00Z</code>.</p>
1713
+ * @public
1714
1714
  */
1715
1715
  EndTime?: Date;
1716
1716
  /**
1717
- * @public
1718
1717
  * <p>The severity of the insight. The values are: <code>Low</code>, <code>Medium</code>, or <code>High</code>.</p>
1718
+ * @public
1719
1719
  */
1720
1720
  Severity?: Severity;
1721
1721
  /**
1722
- * @public
1723
1722
  * <p>List of supporting insights that provide additional factors for the insight.</p>
1723
+ * @public
1724
1724
  */
1725
1725
  SupportingInsights?: Insight[];
1726
1726
  /**
1727
- * @public
1728
1727
  * <p>Description of the insight. For example:
1729
1728
  * <code>A high severity Insight found between 02:00 to 02:30,
1730
1729
  * where there was an unusually high DB load 600x above baseline.
1731
1730
  * Likely performance impact</code>.</p>
1731
+ * @public
1732
1732
  */
1733
1733
  Description?: string;
1734
1734
  /**
1735
- * @public
1736
1735
  * <p>List of recommendations for the insight.
1737
1736
  * For example, <code>Investigate the following SQLs that contributed
1738
1737
  * to 100% of the total DBLoad during that time period: sql-id</code>.</p>
1738
+ * @public
1739
1739
  */
1740
1740
  Recommendations?: Recommendation[];
1741
1741
  /**
1742
- * @public
1743
1742
  * <p>List of data objects containing metrics and references from the time range while generating the insight.</p>
1743
+ * @public
1744
1744
  */
1745
1745
  InsightData?: Data[];
1746
1746
  /**
1747
- * @public
1748
1747
  * <p>
1749
1748
  * Metric names and values from the timeframe
1750
1749
  * used as baseline to generate the insight.</p>
1750
+ * @public
1751
1751
  */
1752
1752
  BaselineData?: Data[];
1753
1753
  }
1754
1754
  /**
1755
- * @public
1756
1755
  * <p>Retrieves the summary of the performance analysis report created for a time period.</p>
1756
+ * @public
1757
1757
  */
1758
1758
  export interface AnalysisReport {
1759
1759
  /**
1760
- * @public
1761
1760
  * <p>The name of the analysis report.</p>
1761
+ * @public
1762
1762
  */
1763
1763
  AnalysisReportId: string | undefined;
1764
1764
  /**
1765
- * @public
1766
1765
  * <p>The unique identifier of the analysis report.</p>
1766
+ * @public
1767
1767
  */
1768
1768
  Identifier?: string;
1769
1769
  /**
1770
- * @public
1771
1770
  * <p>List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:</p>
1772
1771
  * <ul>
1773
1772
  * <li>
@@ -1781,31 +1780,32 @@ export interface AnalysisReport {
1781
1780
  * </p>
1782
1781
  * </li>
1783
1782
  * </ul>
1783
+ * @public
1784
1784
  */
1785
1785
  ServiceType?: ServiceType;
1786
1786
  /**
1787
- * @public
1788
1787
  * <p>The time you created the analysis report.</p>
1788
+ * @public
1789
1789
  */
1790
1790
  CreateTime?: Date;
1791
1791
  /**
1792
- * @public
1793
1792
  * <p>The analysis start time in the report.</p>
1793
+ * @public
1794
1794
  */
1795
1795
  StartTime?: Date;
1796
1796
  /**
1797
- * @public
1798
1797
  * <p>The analysis end time in the report.</p>
1798
+ * @public
1799
1799
  */
1800
1800
  EndTime?: Date;
1801
1801
  /**
1802
- * @public
1803
1802
  * <p>The status of the created analysis report.</p>
1803
+ * @public
1804
1804
  */
1805
1805
  Status?: AnalysisStatus;
1806
1806
  /**
1807
- * @public
1808
1807
  * <p>The list of identified insights in the analysis report.</p>
1808
+ * @public
1809
1809
  */
1810
1810
  Insights?: Insight[];
1811
1811
  }
@@ -1814,8 +1814,8 @@ export interface AnalysisReport {
1814
1814
  */
1815
1815
  export interface GetPerformanceAnalysisReportResponse {
1816
1816
  /**
1817
- * @public
1818
1817
  * <p>The summary of the performance analysis report created for a time period.</p>
1818
+ * @public
1819
1819
  */
1820
1820
  AnalysisReport?: AnalysisReport;
1821
1821
  }