/
models_0.ts
5286 lines (4656 loc) · 170 KB
/
models_0.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// smithy-typescript generated code
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
import { DevOpsGuruServiceException as __BaseException } from "./DevOpsGuruServiceException";
/**
* <p> You don't have permissions to perform the requested operation. The user or role that
* is making the request must have at least one IAM permissions policy attached that grants
* the required permissions. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access Management</a> in the
* <i>IAM User Guide</i>. </p>
*/
export class AccessDeniedException extends __BaseException {
readonly name: "AccessDeniedException" = "AccessDeniedException";
readonly $fault: "client" = "client";
Message: string | undefined;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>) {
super({
name: "AccessDeniedException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, AccessDeniedException.prototype);
this.Message = opts.Message;
}
}
/**
* <p> Information about the number of open reactive and proactive insights that can be used
* to gauge the health of your system. </p>
*/
export interface AccountInsightHealth {
/**
* <p>An integer that specifies the number of open proactive insights in your Amazon Web Services
* account.</p>
*/
OpenProactiveInsights?: number;
/**
* <p>An integer that specifies the number of open reactive insights in your Amazon Web Services
* account.</p>
*/
OpenReactiveInsights?: number;
}
/**
* <p> Returns the number of open reactive insights, the number of open proactive insights,
* and the number of metrics analyzed in your Amazon Web Services account. Use these numbers to gauge the
* health of operations in your Amazon Web Services account. </p>
*/
export interface AccountHealth {
/**
* <p>The ID of the Amazon Web Services account. </p>
*/
AccountId?: string;
/**
* <p> Information about the health of the Amazon Web Services resources in your account, including the
* number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights.
* </p>
*/
Insight?: AccountInsightHealth;
}
export enum NotificationMessageType {
CLOSED_INSIGHT = "CLOSED_INSIGHT",
NEW_ASSOCIATION = "NEW_ASSOCIATION",
NEW_INSIGHT = "NEW_INSIGHT",
NEW_RECOMMENDATION = "NEW_RECOMMENDATION",
SEVERITY_UPGRADED = "SEVERITY_UPGRADED",
}
export enum InsightSeverity {
HIGH = "HIGH",
LOW = "LOW",
MEDIUM = "MEDIUM",
}
/**
* <p>
* The filter configurations for the Amazon SNS notification topic you use with DevOps Guru. You can choose to specify which events or message types to receive notifications for.
* You can also choose to specify which severity levels to receive notifications for.
* </p>
*/
export interface NotificationFilterConfig {
/**
* <p>
* The severity levels that you want to receive notifications for. For example, you can choose to receive notifications only for insights with <code>HIGH</code> and <code>MEDIUM</code> severity levels.
* For more information, see <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding insight severities</a>.
* </p>
*/
Severities?: (InsightSeverity | string)[];
/**
* <p>
* The events that you want to receive notifications for. For example, you can choose to receive notifications only when the severity level is upgraded or a new insight is created.
* </p>
*/
MessageTypes?: (NotificationMessageType | string)[];
}
/**
* <p> Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic. </p>
* <p>If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission
* to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics.
* For more information, see <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html">Permissions
* for cross account Amazon SNS topics</a>.</p>
* <p>If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.</p>
* <p>If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions
* to the CMK. For more information, see <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html">Permissions for
* Amazon Web Services KMS–encrypted Amazon SNS topics</a>.</p>
*/
export interface SnsChannelConfig {
/**
* <p> The Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic. </p>
*/
TopicArn?: string;
}
/**
* <p> Information about notification channels you have configured with DevOps Guru.
* The one
* supported notification channel is Amazon Simple Notification Service (Amazon SNS).</p>
*/
export interface NotificationChannelConfig {
/**
* <p> Information about a notification channel configured in DevOps Guru to send notifications
* when insights are created. </p>
* <p>If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission
* to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics.
* For more information, see <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html">Permissions
* for cross account Amazon SNS topics</a>.</p>
* <p>If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.</p>
* <p>If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions
* to the CMK. For more information, see <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html">Permissions for
* Amazon Web Services KMS–encrypted Amazon SNS topics</a>.</p>
*/
Sns: SnsChannelConfig | undefined;
/**
* <p>
* The filter configurations for the Amazon SNS notification topic you use with DevOps Guru.
* If you do not provide filter configurations, the default configurations are to receive notifications for all message types of <code>High</code> or <code>Medium</code> severity.
* </p>
*/
Filters?: NotificationFilterConfig;
}
export interface AddNotificationChannelRequest {
/**
* <p> A <code>NotificationChannelConfig</code> object that specifies what type of
* notification channel to add. The one
* supported notification channel is Amazon Simple Notification Service (Amazon SNS). </p>
*/
Config: NotificationChannelConfig | undefined;
}
export interface AddNotificationChannelResponse {
/**
* <p> The ID of the added notification channel. </p>
*/
Id: string | undefined;
}
/**
* <p> An exception that is thrown when a conflict occurs. </p>
*/
export class ConflictException extends __BaseException {
readonly name: "ConflictException" = "ConflictException";
readonly $fault: "client" = "client";
Message: string | undefined;
/**
* <p> The ID of the Amazon Web Services resource in which a conflict occurred. </p>
*/
ResourceId: string | undefined;
/**
* <p> The type of the Amazon Web Services resource in which a conflict occurred. </p>
*/
ResourceType: string | undefined;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>) {
super({
name: "ConflictException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ConflictException.prototype);
this.Message = opts.Message;
this.ResourceId = opts.ResourceId;
this.ResourceType = opts.ResourceType;
}
}
/**
* <p>An internal failure in an Amazon service occurred.</p>
*/
export class InternalServerException extends __BaseException {
readonly name: "InternalServerException" = "InternalServerException";
readonly $fault: "server" = "server";
Message: string | undefined;
/**
* <p> The number of seconds after which the action that caused the internal server
* exception can be retried. </p>
*/
RetryAfterSeconds?: number;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>) {
super({
name: "InternalServerException",
$fault: "server",
...opts,
});
Object.setPrototypeOf(this, InternalServerException.prototype);
this.Message = opts.Message;
this.RetryAfterSeconds = opts.RetryAfterSeconds;
}
}
/**
* <p>A requested resource could not be found</p>
*/
export class ResourceNotFoundException extends __BaseException {
readonly name: "ResourceNotFoundException" = "ResourceNotFoundException";
readonly $fault: "client" = "client";
Message: string | undefined;
/**
* <p> The ID of the Amazon Web Services resource that could not be found. </p>
*/
ResourceId: string | undefined;
/**
* <p> The type of the Amazon Web Services resource that could not be found. </p>
*/
ResourceType: string | undefined;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>) {
super({
name: "ResourceNotFoundException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ResourceNotFoundException.prototype);
this.Message = opts.Message;
this.ResourceId = opts.ResourceId;
this.ResourceType = opts.ResourceType;
}
}
/**
* <p>The request contains a value that exceeds a maximum quota.</p>
*/
export class ServiceQuotaExceededException extends __BaseException {
readonly name: "ServiceQuotaExceededException" = "ServiceQuotaExceededException";
readonly $fault: "client" = "client";
Message?: string;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>) {
super({
name: "ServiceQuotaExceededException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ServiceQuotaExceededException.prototype);
this.Message = opts.Message;
}
}
/**
* <p>The request was denied due to a request throttling.</p>
*/
export class ThrottlingException extends __BaseException {
readonly name: "ThrottlingException" = "ThrottlingException";
readonly $fault: "client" = "client";
Message: string | undefined;
/**
* <p> The code of the quota that was exceeded, causing the throttling exception. </p>
*/
QuotaCode?: string;
/**
* <p> The code of the service that caused the throttling exception. </p>
*/
ServiceCode?: string;
/**
* <p> The number of seconds after which the action that caused the throttling exception can
* be retried. </p>
*/
RetryAfterSeconds?: number;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>) {
super({
name: "ThrottlingException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ThrottlingException.prototype);
this.Message = opts.Message;
this.QuotaCode = opts.QuotaCode;
this.ServiceCode = opts.ServiceCode;
this.RetryAfterSeconds = opts.RetryAfterSeconds;
}
}
/**
* <p> The field associated with the validation exception. </p>
*/
export interface ValidationExceptionField {
/**
* <p> The name of the field. </p>
*/
Name: string | undefined;
/**
* <p> The message associated with the validation exception with information to help
* determine its cause. </p>
*/
Message: string | undefined;
}
export enum ValidationExceptionReason {
CANNOT_PARSE = "CANNOT_PARSE",
FIELD_VALIDATION_FAILED = "FIELD_VALIDATION_FAILED",
INVALID_PARAMETER_COMBINATION = "INVALID_PARAMETER_COMBINATION",
OTHER = "OTHER",
PARAMETER_INCONSISTENT_WITH_SERVICE_STATE = "PARAMETER_INCONSISTENT_WITH_SERVICE_STATE",
UNKNOWN_OPERATION = "UNKNOWN_OPERATION",
}
/**
* <p> Contains information about data passed in to a field during a request that is not
* valid. </p>
*/
export class ValidationException extends __BaseException {
readonly name: "ValidationException" = "ValidationException";
readonly $fault: "client" = "client";
/**
* <p> A message that describes the validation exception. </p>
*/
Message: string | undefined;
/**
* <p> The reason the validation exception was thrown. </p>
*/
Reason?: ValidationExceptionReason | string;
/**
* <p> An array of fields that are associated with the validation exception. </p>
*/
Fields?: ValidationExceptionField[];
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>) {
super({
name: "ValidationException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ValidationException.prototype);
this.Message = opts.Message;
this.Reason = opts.Reason;
this.Fields = opts.Fields;
}
}
export enum EventSourceOptInStatus {
DISABLED = "DISABLED",
ENABLED = "ENABLED",
}
/**
* <p>Information about your account's integration with Amazon CodeGuru Profiler. This
* returns whether DevOps Guru is configured to consume recommendations generated from Amazon
* CodeGuru Profiler.</p>
*/
export interface AmazonCodeGuruProfilerIntegration {
/**
* <p>The status of the CodeGuru Profiler integration. Specifies if DevOps Guru is enabled to
* consume recommendations that are generated from Amazon CodeGuru Profiler.</p>
*/
Status?: EventSourceOptInStatus | string;
}
export enum LogAnomalyType {
BLOCK_FORMAT = "BLOCK_FORMAT",
FORMAT = "FORMAT",
HTTP_CODE = "HTTP_CODE",
KEYWORD = "KEYWORD",
KEYWORD_TOKEN = "KEYWORD_TOKEN",
NEW_FIELD_NAME = "NEW_FIELD_NAME",
NUMERICAL_NAN = "NUMERICAL_NAN",
NUMERICAL_POINT = "NUMERICAL_POINT",
}
/**
* <p>
* Information about an anomalous log event found within a log group.
* </p>
*/
export interface LogAnomalyClass {
/**
* <p>
* The name of the Amazon CloudWatch log stream that the anomalous log event belongs to. A log stream is a sequence of log events that share the same source.
* </p>
*/
LogStreamName?: string;
/**
* <p>
* The type of log anomaly that has been detected.
* </p>
*/
LogAnomalyType?: LogAnomalyType | string;
/**
* <p>
* The token where the anomaly was detected. This may refer to an exception or another location, or it may be blank for log anomalies such as format anomalies.
* </p>
*/
LogAnomalyToken?: string;
/**
* <p>
* The ID of the log event.
* </p>
*/
LogEventId?: string;
/**
* <p>
* The explanation for why the log event is considered an anomaly.
* </p>
*/
Explanation?: string;
/**
* <p>
* The number of log lines where this anomalous log event occurs.
* </p>
*/
NumberOfLogLinesOccurrences?: number;
/**
* <p>
* The time of the first occurrence of the anomalous log event.
* </p>
*/
LogEventTimestamp?: Date;
}
/**
* <p>
* A cluster of similar anomalous log events found within a log group.
* </p>
*/
export interface LogAnomalyShowcase {
/**
* <p>
* A list of anomalous log events that may be related.
* </p>
*/
LogAnomalyClasses?: LogAnomalyClass[];
}
/**
* <p>
* An Amazon CloudWatch log group that contains log anomalies and is used to generate an insight.
* </p>
*/
export interface AnomalousLogGroup {
/**
* <p>
* The name of the CloudWatch log group.
* </p>
*/
LogGroupName?: string;
/**
* <p>
* The time the anomalous log events began. The impact start time indicates the time of the first log anomaly event that occurs.
* </p>
*/
ImpactStartTime?: Date;
/**
* <p>
* The time the anomalous log events stopped.
* </p>
*/
ImpactEndTime?: Date;
/**
* <p>
* The number of log lines that were scanned for anomalous log events.
* </p>
*/
NumberOfLogLinesScanned?: number;
/**
* <p>
* The log anomalies in the log group. Each log anomaly displayed represents a cluster of similar anomalous log events.
* </p>
*/
LogAnomalyShowcases?: LogAnomalyShowcase[];
}
/**
* <p> A time range that specifies when DevOps Guru opens and then closes an anomaly. This
* is different from <code>AnomalyTimeRange</code>, which specifies the time range when
* DevOps Guru actually observes the anomalous behavior. </p>
*/
export interface AnomalyReportedTimeRange {
/**
* <p> The time when an anomaly is opened. </p>
*/
OpenTime: Date | undefined;
/**
* <p> The time when an anomaly is closed. </p>
*/
CloseTime?: Date;
}
/**
* <p>The Amazon Web Services resources in which DevOps Guru detected unusual behavior that resulted in the
* generation of an anomaly. When DevOps Guru detects multiple related anomalies, it creates and
* insight with details about the anomalous behavior and suggestions about how to correct
* the problem.</p>
*/
export interface AnomalyResource {
/**
* <p>The name of the Amazon Web Services resource.</p>
*/
Name?: string;
/**
* <p>The type of the Amazon Web Services resource.</p>
*/
Type?: string;
}
export enum AnomalySeverity {
HIGH = "HIGH",
LOW = "LOW",
MEDIUM = "MEDIUM",
}
/**
* <p> The dimension of an Amazon CloudWatch metric that is used when DevOps Guru analyzes the resources in
* your account for operational problems and anomalous behavior. A dimension is a
* name/value pair that is part of the identity of a metric. A metric can have up to 10
* dimensions. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Dimension">Dimensions</a> in the <i>Amazon CloudWatch User Guide</i>. </p>
*/
export interface CloudWatchMetricsDimension {
/**
* <p> The name of the CloudWatch dimension. </p>
*/
Name?: string;
/**
* <p> The value of the CloudWatch dimension. </p>
*/
Value?: string;
}
export enum CloudWatchMetricDataStatusCode {
COMPLETE = "Complete",
INTERNAL_ERROR = "InternalError",
PARTIAL_DATA = "PartialData",
}
/**
* <p>A pair that contains metric values at the respective timestamp.</p>
*/
export interface TimestampMetricValuePair {
/**
* <p>A <code>Timestamp</code> that specifies the time the event occurred. </p>
*/
Timestamp?: Date;
/**
* <p>Value of the anomalous metric data point at respective Timestamp.</p>
*/
MetricValue?: number;
}
/**
* <p>Contains information about the analyzed metrics that displayed anomalous behavior.
* </p>
*/
export interface CloudWatchMetricsDataSummary {
/**
* <p>This is a list of Amazon CloudWatch metric values at given timestamp.</p>
*/
TimestampMetricValuePairList?: TimestampMetricValuePair[];
/**
* <p>This is an enum of the status showing whether the metric value pair list has partial
* or complete data, or if there was an error.</p>
*/
StatusCode?: CloudWatchMetricDataStatusCode | string;
}
export enum CloudWatchMetricsStat {
AVERAGE = "Average",
MAXIMUM = "Maximum",
MINIMUM = "Minimum",
P50 = "p50",
P90 = "p90",
P99 = "p99",
SAMPLE_COUNT = "SampleCount",
SUM = "Sum",
}
/**
* <p> Information about an Amazon CloudWatch metric. </p>
*/
export interface CloudWatchMetricsDetail {
/**
* <p> The name of the CloudWatch metric. </p>
*/
MetricName?: string;
/**
* <p> The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.
* </p>
*/
Namespace?: string;
/**
* <p> An array of CloudWatch dimensions associated with </p>
*/
Dimensions?: CloudWatchMetricsDimension[];
/**
* <p> The type of statistic associated with the CloudWatch metric. For more information, see
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic">Statistics</a> in the <i>Amazon CloudWatch User Guide</i>. </p>
*/
Stat?: CloudWatchMetricsStat | string;
/**
* <p> The unit of measure used for the CloudWatch metric. For example, <code>Bytes</code>,
* <code>Seconds</code>, <code>Count</code>, and <code>Percent</code>. </p>
*/
Unit?: string;
/**
* <p> The length of time associated with the CloudWatch metric in number of seconds. </p>
*/
Period?: number;
/**
* <p>This object returns anomaly metric data.</p>
*/
MetricDataSummary?: CloudWatchMetricsDataSummary;
}
/**
* <p>A logical grouping of Performance Insights metrics for a related subject area. For example, the
* <code>db.sql</code> dimension group consists of the following dimensions:
* <code>db.sql.id</code>, <code>db.sql.db_id</code>, <code>db.sql.statement</code>,
* and <code>db.sql.tokenized_id</code>.</p>
* <note>
* <p>Each response element returns a maximum of 500 bytes. For larger elements, such as
* SQL statements, only the first 500 bytes are returned.</p>
* </note>
* <p>Amazon RDS Performance Insights enables you to monitor and explore different
* dimensions of database load based on data captured from a running DB instance.
* DB load is measured as average active sessions. Performance Insights provides the
* data to API consumers as a two-dimensional time-series dataset. The time dimension
* provides DB load data for each time point in the queried time range. Each time point
* decomposes overall load in relation to the requested dimensions, measured at that
* time point. Examples include SQL, Wait event, User, and Host. </p>
*
* <ul>
* <li>
* <p>To learn more about Performance Insights and Amazon Aurora DB instances, go to the <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html"> Amazon Aurora User Guide</a>.
* </p>
* </li>
* <li>
* <p>To learn more about Performance Insights and Amazon RDS DB instances, go to the <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html"> Amazon RDS User Guide</a>.
* </p>
* </li>
* </ul>
*/
export interface PerformanceInsightsMetricDimensionGroup {
/**
* <p>The name of the dimension group. Its valid values are:</p>
*
* <ul>
* <li>
* <p>
* <code>db</code> - The name of the database to which the client is connected
* (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)</p>
* </li>
* <li>
* <p>
* <code>db.application</code> - The name of the application that is connected to
* the database (only Aurora PostgreSQL and RDS PostgreSQL)</p>
* </li>
* <li>
* <p>
* <code>db.host</code> - The host name of the connected client (all
* engines)</p>
* </li>
* <li>
* <p>
* <code>db.session_type</code> - The type of the current session (only Aurora PostgreSQL
* and RDS PostgreSQL)</p>
* </li>
* <li>
* <p>
* <code>db.sql</code> - The SQL that is currently executing (all engines)</p>
* </li>
* <li>
* <p>
* <code>db.sql_tokenized</code> - The SQL digest (all engines)</p>
* </li>
* <li>
* <p>
* <code>db.wait_event</code> - The event for which the database backend is waiting
* (all engines)</p>
* </li>
* <li>
* <p>
* <code>db.wait_event_type</code> - The type of event for which the database
* backend is waiting (all engines)</p>
* </li>
* <li>
* <p>
* <code>db.user</code> - The user logged in to the database (all engines)</p>
* </li>
* </ul>
*/
Group?: string;
/**
* <p>A list of specific dimensions from a dimension group. If this parameter is not
* present, then it signifies that all of the dimensions in the group were requested or are
* present in the response.</p>
* <p>Valid values for elements in the <code>Dimensions</code> array are:</p>
*
* <ul>
* <li>
* <p>
* <code>db.application.name</code> - The name of the application that is connected
* to the database (only Aurora PostgreSQL and RDS PostgreSQL)</p>
* </li>
* <li>
* <p>
* <code>db.host.id</code> - The host ID of the connected client (all
* engines)</p>
* </li>
* <li>
* <p>
* <code>db.host.name</code> - The host name of the connected client (all
* engines)</p>
* </li>
* <li>
* <p>
* <code>db.name</code> - The name of the database to which the client is connected
* (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)</p>
* </li>
* <li>
* <p>
* <code>db.session_type.name</code> - The type of the current session (only Aurora
* PostgreSQL and RDS PostgreSQL)</p>
* </li>
* <li>
* <p>
* <code>db.sql.id</code> - The SQL ID generated by Performance Insights (all engines)</p>
* </li>
* <li>
* <p>
* <code>db.sql.db_id</code> - The SQL ID generated by the database (all
* engines)</p>
* </li>
* <li>
* <p>
* <code>db.sql.statement</code> - The SQL text that is being executed (all
* engines)</p>
* </li>
* <li>
* <p>
* <code>db.sql.tokenized_id</code>
* </p>
* </li>
* <li>
* <p>
* <code>db.sql_tokenized.id</code> - The SQL digest ID generated by Performance Insights (all
* engines)</p>
* </li>
* <li>
* <p>
* <code>db.sql_tokenized.db_id</code> - SQL digest ID generated by the database
* (all engines)</p>
* </li>
* <li>
* <p>
* <code>db.sql_tokenized.statement</code> - The SQL digest text (all
* engines)</p>
* </li>
* <li>
* <p>
* <code>db.user.id</code> - The ID of the user logged in to the database (all
* engines)</p>
* </li>
* <li>
* <p>
* <code>db.user.name</code> - The name of the user logged in to the database (all
* engines)</p>
* </li>
* <li>
* <p>
* <code>db.wait_event.name</code> - The event for which the backend is waiting
* (all engines)</p>
* </li>
* <li>
* <p>
* <code>db.wait_event.type</code> - The type of event for which the backend is
* waiting (all engines)</p>
* </li>
* <li>
* <p>
* <code>db.wait_event_type.name</code> - The name of the event type for which the
* backend is waiting (all engines)</p>
* </li>
* </ul>
*/
Dimensions?: string[];
/**
* <p>The maximum number of items to fetch for this dimension group.</p>
*/
Limit?: number;
}
/**
* <p>A single query to be processed. Use these parameters to query the Performance Insights
* <code>GetResourceMetrics</code> API to retrieve the metrics for an anomaly. For more
* information, see <code>
* <a href="https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_GetResourceMetrics.html">GetResourceMetrics</a>
* </code> in the <i>Amazon RDS Performance Insights API
* Reference</i>.</p>
* <p>Amazon RDS Performance Insights enables you to monitor and explore different
* dimensions of database load based on data captured from a running DB instance.
* DB load is measured as average active sessions. Performance Insights provides the
* data to API consumers as a two-dimensional time-series dataset. The time dimension
* provides DB load data for each time point in the queried time range. Each time point
* decomposes overall load in relation to the requested dimensions, measured at that
* time point. Examples include SQL, Wait event, User, and Host. </p>
*
* <ul>
* <li>
* <p>To learn more about Performance Insights and Amazon Aurora DB instances, go to the <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html"> Amazon Aurora User Guide</a>.
* </p>
* </li>
* <li>
* <p>To learn more about Performance Insights and Amazon RDS DB instances, go to the <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html"> Amazon RDS User Guide</a>.
* </p>
* </li>
* </ul>
*/
export interface PerformanceInsightsMetricQuery {
/**
* <p>The name of the meteric used used when querying an Performance Insights
* <code>GetResourceMetrics</code> API for anomaly metrics.</p>
*
* <p>Valid values for <code>Metric</code> are:</p>
*
* <ul>
* <li>
* <p>
* <code>db.load.avg</code> - a scaled representation of the number of active sessions for the
* database engine.</p>
* </li>
* <li>
* <p>
* <code>db.sampledload.avg</code> - the raw number of active sessions for the database
* engine.</p>
* </li>
* </ul>
* <p>If the number of active sessions is less than an internal Performance Insights threshold,
* <code>db.load.avg</code> and <code>db.sampledload.avg</code> are the same 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 scaled values, <code>db.sampledload.avg</code>
* showing the raw values, and <code>db.sampledload.avg</code> less than
* <code>db.load.avg</code>. For most use cases, you can query <code>db.load.avg</code>
* only. </p>
*/
Metric?: string;
/**
* <p>The specification for how to aggregate the data points from a Performance Insights
* <code>GetResourceMetrics</code> API query. The Performance Insights query returns all of the
* dimensions within that group, unless you provide the names of specific dimensions within
* that group. You can also request that Performance Insights return a limited number of values for a
* dimension.</p>
*/
GroupBy?: PerformanceInsightsMetricDimensionGroup;
/**
* <p>One or more filters to apply to a Performance Insights <code>GetResourceMetrics</code> API query.
* Restrictions:</p>
* <ul>
* <li>
* <p>Any number of filters by the same dimension, as specified in the
* <code>GroupBy</code> parameter.</p>
* </li>
* <li>
* <p>A single filter for any other dimension in this dimension group.</p>
* </li>
* </ul>
*/
Filter?: Record<string, string>;
}
/**
* <p>Information about a reference metric used to evaluate Performance Insights.</p>
*/
export interface PerformanceInsightsReferenceMetric {
/**
* <p>A query to be processed on the metric.</p>
*/
MetricQuery?: PerformanceInsightsMetricQuery;
}
/**
* <p>A reference value to compare Performance Insights metrics against to determine if the metrics
* demonstrate anomalous behavior.</p>
*/
export interface PerformanceInsightsReferenceScalar {
/**
* <p>The reference value.</p>
*/
Value?: number;
}
/**
* <p>Reference scalar values and other metrics that DevOps Guru displays on a graph in its
* console along with the actual metrics it analyzed. Compare these reference values to
* your actual metrics to help you understand anomalous behavior that DevOps Guru
* detected.</p>
*/
export interface PerformanceInsightsReferenceComparisonValues {
/**
* <p>A scalar value DevOps Guru for a metric that DevOps Guru compares to actual metric values. This
* reference value is used to determine if an actual metric value should be considered
* anomalous.</p>
*/
ReferenceScalar?: PerformanceInsightsReferenceScalar;
/**
* <p>A metric that DevOps Guru compares to actual metric values. This reference metric is used to
* determine if an actual metric should be considered anomalous.</p>
*/
ReferenceMetric?: PerformanceInsightsReferenceMetric;
}
/**
* <p>Reference data used to evaluate Performance Insights to determine if its performance is anomalous or
* not.</p>
*/
export interface PerformanceInsightsReferenceData {
/**
* <p>The name of the reference data.</p>
*/
Name?: string;
/**
* <p>The specific reference values used to evaluate the Performance Insights. For more information, see
* <code>
* <a href="https://docs.aws.amazon.com/devops-guru/latest/APIReference/API_PerformanceInsightsReferenceComparisonValues.html">PerformanceInsightsReferenceComparisonValues</a>
* </code>. </p>
*/
ComparisonValues?: PerformanceInsightsReferenceComparisonValues;
}
/**
* <p>A statistic in a Performance Insights collection.</p>
*/
export interface PerformanceInsightsStat {
/**
* <p>The statistic type.</p>
*/
Type?: string;