forked from aws/aws-sdk-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
docs-2.json
2188 lines (2188 loc) · 152 KB
/
docs-2.json
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
{
"version": "2.0",
"service": "<p> Amazon DevOps Guru is a fully managed service that helps you identify anomalous behavior in business critical operational applications. You specify the Amazon Web Services resources that you want DevOps Guru to cover, then the Amazon CloudWatch metrics and Amazon Web Services CloudTrail events related to those resources are analyzed. When anomalous behavior is detected, DevOps Guru creates an <i>insight</i> that includes recommendations, related events, and related metrics that can help you improve your operational applications. For more information, see <a href=\"https://docs.aws.amazon.com/devops-guru/latest/userguide/welcome.html\">What is Amazon DevOps Guru</a>. </p> <p> You can specify 1 or 2 Amazon Simple Notification Service topics so you are notified every time a new insight is created. You can also enable DevOps Guru to generate an OpsItem in Amazon Web Services Systems Manager for each insight to help you manage and track your work addressing insights. </p> <p> To learn about the DevOps Guru workflow, see <a href=\"https://docs.aws.amazon.com/devops-guru/latest/userguide/welcome.html#how-it-works\">How DevOps Guru works</a>. To learn about DevOps Guru concepts, see <a href=\"https://docs.aws.amazon.com/devops-guru/latest/userguide/concepts.html\">Concepts in DevOps Guru</a>. </p>",
"operations": {
"AddNotificationChannel": "<p> Adds a notification channel to DevOps Guru. A notification channel is used to notify you about important DevOps Guru events, such as when an insight is generated. </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>",
"DeleteInsight": "<p>Deletes the insight along with the associated anomalies, events and recommendations.</p>",
"DescribeAccountHealth": "<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>",
"DescribeAccountOverview": "<p> For the time range passed in, returns the number of open reactive insight that were created, the number of open proactive insights that were created, and the Mean Time to Recover (MTTR) for all closed reactive insights. </p>",
"DescribeAnomaly": "<p> Returns details about an anomaly that you specify using its ID. </p>",
"DescribeEventSourcesConfig": "<p>Returns the integration status of services that are integrated with DevOps Guru as Consumer via EventBridge. The one service that can be integrated with DevOps Guru is Amazon CodeGuru Profiler, which can produce proactive recommendations which can be stored and viewed in DevOps Guru.</p>",
"DescribeFeedback": "<p> Returns the most recent feedback submitted in the current Amazon Web Services account and Region. </p>",
"DescribeInsight": "<p> Returns details about an insight that you specify using its ID. </p>",
"DescribeOrganizationHealth": "<p>Returns active insights, predictive insights, and resource hours analyzed in last hour.</p>",
"DescribeOrganizationOverview": "<p>Returns an overview of your organization's history based on the specified time range. The overview includes the total reactive and proactive insights.</p>",
"DescribeOrganizationResourceCollectionHealth": "<p>Provides an overview of your system's health. If additional member accounts are part of your organization, you can filter those accounts using the <code>AccountIds</code> field.</p>",
"DescribeResourceCollectionHealth": "<p> Returns the number of open proactive insights, open reactive insights, and the Mean Time to Recover (MTTR) for all closed insights in resource collections in your account. You specify the type of Amazon Web Services resources collection. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag <i>key</i>. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>",
"DescribeServiceIntegration": "<p> Returns the integration status of services that are integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is Amazon Web Services Systems Manager, which can be used to create an OpsItem for each generated insight. </p>",
"GetCostEstimation": "<p>Returns an estimate of the monthly cost for DevOps Guru to analyze your Amazon Web Services resources. For more information, see <a href=\"https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html\">Estimate your Amazon DevOps Guru costs</a> and <a href=\"http://aws.amazon.com/devops-guru/pricing/\">Amazon DevOps Guru pricing</a>.</p>",
"GetResourceCollection": "<p> Returns lists Amazon Web Services resources that are of the specified resource collection type. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag <i>key</i>. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>",
"ListAnomaliesForInsight": "<p> Returns a list of the anomalies that belong to an insight that you specify using its ID. </p>",
"ListAnomalousLogGroups": "<p> Returns the list of log groups that contain log anomalies. </p>",
"ListEvents": "<p> Returns a list of the events emitted by the resources that are evaluated by DevOps Guru. You can use filters to specify which events are returned. </p>",
"ListInsights": "<p> Returns a list of insights in your Amazon Web Services account. You can specify which insights are returned by their start time and status (<code>ONGOING</code>, <code>CLOSED</code>, or <code>ANY</code>). </p>",
"ListMonitoredResources": "<p> Returns the list of all log groups that are being monitored and tagged by DevOps Guru. </p>",
"ListNotificationChannels": "<p> Returns a list of notification channels configured for DevOps Guru. Each notification channel is used to notify you when DevOps Guru generates an insight that contains information about how to improve your operations. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS). </p>",
"ListOrganizationInsights": "<p>Returns a list of insights associated with the account or OU Id.</p>",
"ListRecommendations": "<p> Returns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events. </p>",
"PutFeedback": "<p> Collects customer feedback about the specified insight. </p>",
"RemoveNotificationChannel": "<p> Removes a notification channel from DevOps Guru. A notification channel is used to notify you when DevOps Guru generates an insight that contains information about how to improve your operations. </p>",
"SearchInsights": "<p> Returns a list of insights in your Amazon Web Services account. You can specify which insights are returned by their start time, one or more statuses (<code>ONGOING</code>, <code>CLOSED</code>, and <code>CLOSED</code>), one or more severities (<code>LOW</code>, <code>MEDIUM</code>, and <code>HIGH</code>), and type (<code>REACTIVE</code> or <code>PROACTIVE</code>). </p> <p> Use the <code>Filters</code> parameter to specify status and severity search parameters. Use the <code>Type</code> parameter to specify <code>REACTIVE</code> or <code>PROACTIVE</code> in your search. </p>",
"SearchOrganizationInsights": "<p> Returns a list of insights in your organization. You can specify which insights are returned by their start time, one or more statuses (<code>ONGOING</code>, <code>CLOSED</code>, and <code>CLOSED</code>), one or more severities (<code>LOW</code>, <code>MEDIUM</code>, and <code>HIGH</code>), and type (<code>REACTIVE</code> or <code>PROACTIVE</code>). </p> <p> Use the <code>Filters</code> parameter to specify status and severity search parameters. Use the <code>Type</code> parameter to specify <code>REACTIVE</code> or <code>PROACTIVE</code> in your search. </p>",
"StartCostEstimation": "<p>Starts the creation of an estimate of the monthly cost to analyze your Amazon Web Services resources.</p>",
"UpdateEventSourcesConfig": "<p>Enables or disables integration with a service that can be integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is Amazon CodeGuru Profiler, which can produce proactive recommendations which can be stored and viewed in DevOps Guru.</p>",
"UpdateResourceCollection": "<p> Updates the collection of resources that DevOps Guru analyzes. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag <i>key</i>. You can specify up to 500 Amazon Web Services CloudFormation stacks. This method also creates the IAM role required for you to use DevOps Guru. </p>",
"UpdateServiceIntegration": "<p> Enables or disables integration with a service that can be integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is Amazon Web Services Systems Manager, which can be used to create an OpsItem for each generated insight. </p>"
},
"shapes": {
"AccessDeniedException": {
"base": "<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>",
"refs": {
}
},
"AccountHealth": {
"base": "<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>",
"refs": {
"AccountHealths$member": null
}
},
"AccountHealths": {
"base": null,
"refs": {
"DescribeOrganizationResourceCollectionHealthResponse$Account": "<p>The name of the organization's account.</p>"
}
},
"AccountIdList": {
"base": null,
"refs": {
"DescribeOrganizationHealthRequest$AccountIds": "<p>The ID of the Amazon Web Services account.</p>",
"DescribeOrganizationOverviewRequest$AccountIds": "<p>The ID of the Amazon Web Services account.</p>",
"DescribeOrganizationResourceCollectionHealthRequest$AccountIds": "<p>The ID of the Amazon Web Services account.</p>"
}
},
"AccountInsightHealth": {
"base": "<p> Information about the number of open reactive and proactive insights that can be used to gauge the health of your system. </p>",
"refs": {
"AccountHealth$Insight": "<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>"
}
},
"AddNotificationChannelRequest": {
"base": null,
"refs": {
}
},
"AddNotificationChannelResponse": {
"base": null,
"refs": {
}
},
"AmazonCodeGuruProfilerIntegration": {
"base": "<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>",
"refs": {
"EventSourcesConfig$AmazonCodeGuruProfiler": "<p>Information about whether DevOps Guru is configured to consume recommendations which are generated from AWS CodeGuru Profiler.</p>"
}
},
"AnomalousLogGroup": {
"base": "<p> An Amazon CloudWatch log group that contains log anomalies and is used to generate an insight. </p>",
"refs": {
"AnomalousLogGroups$member": null
}
},
"AnomalousLogGroups": {
"base": null,
"refs": {
"ListAnomalousLogGroupsResponse$AnomalousLogGroups": "<p> The list of Amazon CloudWatch log groups that are related to an insight. </p>"
}
},
"AnomalyDescription": {
"base": null,
"refs": {
"ReactiveAnomaly$Description": "<p>A description of the reactive anomaly.</p>",
"ReactiveAnomalySummary$Description": "<p>A description of the reactive anomaly.</p>"
}
},
"AnomalyId": {
"base": null,
"refs": {
"DescribeAnomalyRequest$Id": "<p> The ID of the anomaly. </p>",
"ProactiveAnomaly$Id": "<p> The ID of a proactive anomaly. </p>",
"ProactiveAnomalySummary$Id": "<p>The ID of the anomaly.</p>",
"ReactiveAnomaly$Id": "<p>The ID of the reactive anomaly. </p>",
"ReactiveAnomaly$CausalAnomalyId": "<p>The ID of the causal anomaly that is associated with this reactive anomaly. The ID of a `CAUSAL` anomaly is always `NULL`.</p>",
"ReactiveAnomalySummary$Id": "<p> The ID of the reactive anomaly. </p>",
"ReactiveAnomalySummary$CausalAnomalyId": "<p>The ID of the causal anomaly that is associated with this reactive anomaly. The ID of a `CAUSAL` anomaly is always `NULL`.</p>",
"RecommendationRelatedAnomaly$AnomalyId": "<p>The ID of an anomaly that generated the insight with this recommendation.</p>"
}
},
"AnomalyLimit": {
"base": null,
"refs": {
"ProactiveAnomaly$Limit": "<p> A threshold that was exceeded by behavior in analyzed resources. Exceeding this threshold is related to the anomalous behavior that generated this anomaly. </p>",
"ProactiveAnomalySummary$Limit": "<p> A threshold that was exceeded by behavior in analyzed resources. Exceeding this threshold is related to the anomalous behavior that generated this anomaly. </p>"
}
},
"AnomalyName": {
"base": null,
"refs": {
"ReactiveAnomaly$Name": "<p>The name of the reactive anomaly.</p>",
"ReactiveAnomalySummary$Name": "<p>The name of the reactive anomaly.</p>"
}
},
"AnomalyReportedTimeRange": {
"base": "<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>",
"refs": {
"ProactiveAnomaly$AnomalyReportedTimeRange": "<p> An <code>AnomalyReportedTimeRange</code> object that specifies the time range between when the anomaly is opened and the time when it is closed. </p>",
"ProactiveAnomalySummary$AnomalyReportedTimeRange": "<p> An <code>AnomalyReportedTimeRange</code> object that specifies the time range between when the anomaly is opened and the time when it is closed. </p>",
"ReactiveAnomaly$AnomalyReportedTimeRange": "<p> An <code>AnomalyReportedTimeRange</code> object that specifies the time range between when the anomaly is opened and the time when it is closed. </p>",
"ReactiveAnomalySummary$AnomalyReportedTimeRange": "<p> An <code>AnomalyReportedTimeRange</code> object that specifies the time range between when the anomaly is opened and the time when it is closed. </p>"
}
},
"AnomalyResource": {
"base": "<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>",
"refs": {
"AnomalyResources$member": null
}
},
"AnomalyResources": {
"base": null,
"refs": {
"ProactiveAnomaly$AnomalyResources": "<p>Information about a resource in which DevOps Guru detected anomalous behavior.</p>",
"ProactiveAnomalySummary$AnomalyResources": "<p>Information about a resource in which DevOps Guru detected anomalous behavior.</p>",
"ReactiveAnomaly$AnomalyResources": "<p>The Amazon Web Services resources in which anomalous behavior was detected by DevOps Guru.</p>",
"ReactiveAnomalySummary$AnomalyResources": "<p>The Amazon Web Services resources in which anomalous behavior was detected by DevOps Guru.</p>"
}
},
"AnomalySeverity": {
"base": null,
"refs": {
"ProactiveAnomaly$Severity": "<p>The severity of the anomaly. The severity of anomalies that generate an insight determine that insight's severity. 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> in the <i>Amazon DevOps Guru User Guide</i>.</p>",
"ProactiveAnomalySummary$Severity": "<p>The severity of the anomaly. The severity of anomalies that generate an insight determine that insight's severity. 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> in the <i>Amazon DevOps Guru User Guide</i>.</p>",
"ReactiveAnomaly$Severity": "<p>The severity of the anomaly. The severity of anomalies that generate an insight determine that insight's severity. 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> in the <i>Amazon DevOps Guru User Guide</i>.</p>",
"ReactiveAnomalySummary$Severity": "<p>The severity of the anomaly. The severity of anomalies that generate an insight determine that insight's severity. 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> in the <i>Amazon DevOps Guru User Guide</i>.</p>"
}
},
"AnomalySource": {
"base": null,
"refs": {
"AnomalySourceMetadata$Source": "<p>The source of the anomaly.</p>"
}
},
"AnomalySourceDetails": {
"base": "<p> Details about the source of the anomalous operational data that triggered the anomaly.</p>",
"refs": {
"ProactiveAnomaly$SourceDetails": "<p> Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics. </p>",
"ProactiveAnomalySummary$SourceDetails": "<p> Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics. </p>",
"ReactiveAnomaly$SourceDetails": "<p> Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics. </p>",
"ReactiveAnomalySummary$SourceDetails": "<p> Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics. </p>"
}
},
"AnomalySourceMetadata": {
"base": "<p>Metadata about the detection source that generates proactive anomalies. The anomaly is detected using analysis of the metric data
 over a period of time</p>",
"refs": {
"ProactiveAnomaly$SourceMetadata": "<p>The metadata for the anomaly.</p>",
"ProactiveAnomalySummary$SourceMetadata": "<p>The metadata of the source which detects proactive anomalies.</p>"
}
},
"AnomalyStatus": {
"base": null,
"refs": {
"ProactiveAnomaly$Status": "<p> The status of a proactive anomaly. </p>",
"ProactiveAnomalySummary$Status": "<p>The status of the anomaly.</p>",
"ReactiveAnomaly$Status": "<p> The status of the anomaly. </p>",
"ReactiveAnomalySummary$Status": "<p> The status of the reactive anomaly. </p>"
}
},
"AnomalyTimeRange": {
"base": "<p> A time range that specifies when the observed unusual behavior in an anomaly started and ended. This is different from <code>AnomalyReportedTimeRange</code>, which specifies the time range when DevOps Guru opens and then closes an anomaly. </p>",
"refs": {
"ProactiveAnomaly$AnomalyTimeRange": null,
"ProactiveAnomalySummary$AnomalyTimeRange": null,
"ReactiveAnomaly$AnomalyTimeRange": null,
"ReactiveAnomalySummary$AnomalyTimeRange": null
}
},
"AnomalyType": {
"base": null,
"refs": {
"ReactiveAnomaly$Type": "<p>The type of the reactive anomaly. It can be one of the following types.</p> <ul> <li> <p> <code>CAUSAL</code> - the anomaly can cause a new insight.</p> </li> <li> <p> <code>CONTEXTUAL</code> - the anomaly contains additional information about an insight or its causal anomaly.</p> </li> </ul>",
"ReactiveAnomalySummary$Type": "<p>The type of the reactive anomaly. It can be one of the following types.</p> <ul> <li> <p> <code>CAUSAL</code> - the anomaly can cause a new insight.</p> </li> <li> <p> <code>CONTEXTUAL</code> - the anomaly contains additional information about an insight or its causal anomaly.</p> </li> </ul>"
}
},
"AppBoundaryKey": {
"base": null,
"refs": {
"TagCollection$AppBoundaryKey": "<p>An Amazon Web Services tag <i>key</i> that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this <i>key</i> make up your DevOps Guru application and analysis boundary.</p> <important> <p>The string used for a <i>key</i> in a tag that you use to define your resource coverage must begin with the prefix <code>Devops-guru-</code>. The tag <i>key</i> might be <code>DevOps-Guru-deployment-application</code> or <code>devops-guru-rds-application</code>. When you create a <i>key</i>, the case of characters in the <i>key</i> can be whatever you choose. After you create a <i>key</i>, it is case-sensitive. For example, DevOps Guru works with a <i>key</i> named <code>devops-guru-rds</code> and a <i>key</i> named <code>DevOps-Guru-RDS</code>, and these act as two different <i>keys</i>. Possible <i>key</i>/<i>value</i> pairs in your application might be <code>Devops-Guru-production-application/RDS</code> or <code>Devops-Guru-production-application/containers</code>.</p> </important>",
"TagCollectionFilter$AppBoundaryKey": "<p>An Amazon Web Services tag <i>key</i> that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this <i>key</i> make up your DevOps Guru application and analysis boundary.</p> <important> <p>The string used for a <i>key</i> in a tag that you use to define your resource coverage must begin with the prefix <code>Devops-guru-</code>. The tag <i>key</i> might be <code>DevOps-Guru-deployment-application</code> or <code>devops-guru-rds-application</code>. When you create a <i>key</i>, the case of characters in the <i>key</i> can be whatever you choose. After you create a <i>key</i>, it is case-sensitive. For example, DevOps Guru works with a <i>key</i> named <code>devops-guru-rds</code> and a <i>key</i> named <code>DevOps-Guru-RDS</code>, and these act as two different <i>keys</i>. Possible <i>key</i>/<i>value</i> pairs in your application might be <code>Devops-Guru-production-application/RDS</code> or <code>Devops-Guru-production-application/containers</code>.</p> </important>",
"TagCostEstimationResourceCollectionFilter$AppBoundaryKey": "<p>An Amazon Web Services tag <i>key</i> that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this <i>key</i> make up your DevOps Guru application and analysis boundary.</p> <important> <p>The string used for a <i>key</i> in a tag that you use to define your resource coverage must begin with the prefix <code>Devops-guru-</code>. The tag <i>key</i> might be <code>DevOps-Guru-deployment-application</code> or <code>devops-guru-rds-application</code>. When you create a <i>key</i>, the case of characters in the <i>key</i> can be whatever you choose. After you create a <i>key</i>, it is case-sensitive. For example, DevOps Guru works with a <i>key</i> named <code>devops-guru-rds</code> and a <i>key</i> named <code>DevOps-Guru-RDS</code>, and these act as two different <i>keys</i>. Possible <i>key</i>/<i>value</i> pairs in your application might be <code>Devops-Guru-production-application/RDS</code> or <code>Devops-Guru-production-application/containers</code>.</p> </important>",
"TagHealth$AppBoundaryKey": "<p>An Amazon Web Services tag <i>key</i> that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this <i>key</i> make up your DevOps Guru application and analysis boundary.</p> <important> <p>The string used for a <i>key</i> in a tag that you use to define your resource coverage must begin with the prefix <code>Devops-guru-</code>. The tag <i>key</i> might be <code>DevOps-Guru-deployment-application</code> or <code>devops-guru-rds-application</code>. When you create a <i>key</i>, the case of characters in the <i>key</i> can be whatever you choose. After you create a <i>key</i>, it is case-sensitive. For example, DevOps Guru works with a <i>key</i> named <code>devops-guru-rds</code> and a <i>key</i> named <code>DevOps-Guru-RDS</code>, and these act as two different <i>keys</i>. Possible <i>key</i>/<i>value</i> pairs in your application might be <code>Devops-Guru-production-application/RDS</code> or <code>Devops-Guru-production-application/containers</code>.</p> </important>",
"UpdateTagCollectionFilter$AppBoundaryKey": "<p>An Amazon Web Services tag <i>key</i> that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this <i>key</i> make up your DevOps Guru application and analysis boundary.</p> <important> <p>The string used for a <i>key</i> in a tag that you use to define your resource coverage must begin with the prefix <code>Devops-guru-</code>. The tag <i>key</i> might be <code>DevOps-Guru-deployment-application</code> or <code>devops-guru-rds-application</code>. When you create a <i>key</i>, the case of characters in the <i>key</i> can be whatever you choose. After you create a <i>key</i>, it is case-sensitive. For example, DevOps Guru works with a <i>key</i> named <code>devops-guru-rds</code> and a <i>key</i> named <code>DevOps-Guru-RDS</code>, and these act as two different <i>keys</i>. Possible <i>key</i>/<i>value</i> pairs in your application might be <code>Devops-Guru-production-application/RDS</code> or <code>Devops-Guru-production-application/containers</code>.</p> </important>"
}
},
"AssociatedResourceArns": {
"base": null,
"refs": {
"ProactiveInsightSummary$AssociatedResourceArns": "<p>The Amazon Resource Names (ARNs) of the Amazon Web Services resources that generated this insight.</p>",
"ReactiveInsightSummary$AssociatedResourceArns": "<p>The Amazon Resource Names (ARNs) of the Amazon Web Services resources that generated this insight.</p>"
}
},
"AwsAccountId": {
"base": null,
"refs": {
"AccountHealth$AccountId": "<p>The ID of the Amazon Web Services account. </p>",
"AccountIdList$member": null,
"DescribeAnomalyRequest$AccountId": "<p>The ID of the member account.</p>",
"DescribeInsightRequest$AccountId": "<p>The ID of the member account in the organization.</p>",
"ListAnomaliesForInsightRequest$AccountId": "<p>The ID of the Amazon Web Services account. </p>",
"ListEventsRequest$AccountId": "<p>The ID of the Amazon Web Services account. </p>",
"ListInsightsAccountIdList$member": null,
"ListRecommendationsRequest$AccountId": "<p>The ID of the Amazon Web Services account. </p>",
"ProactiveOrganizationInsightSummary$AccountId": "<p>The ID of the Amazon Web Services account.</p>",
"ReactiveOrganizationInsightSummary$AccountId": "<p>The ID of the Amazon Web Services account. </p>",
"SearchInsightsAccountIdList$member": null
}
},
"Channels": {
"base": null,
"refs": {
"ListNotificationChannelsResponse$Channels": "<p> An array that contains the requested notification channels. </p>"
}
},
"ClientToken": {
"base": null,
"refs": {
"StartCostEstimationRequest$ClientToken": "<p>The idempotency token used to identify each cost estimate request.</p>"
}
},
"CloudFormationCollection": {
"base": "<p> Information about Amazon Web Services CloudFormation stacks. You can use up to 500 stacks to specify which Amazon Web Services resources in your account to analyze. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html\">Stacks</a> in the <i>Amazon Web Services CloudFormation User Guide</i>. </p>",
"refs": {
"ResourceCollection$CloudFormation": "<p> An array of the names of Amazon Web Services CloudFormation stacks. The stacks define Amazon Web Services resources that DevOps Guru analyzes. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>"
}
},
"CloudFormationCollectionFilter": {
"base": "<p> Information about Amazon Web Services CloudFormation stacks. You can use up to 500 stacks to specify which Amazon Web Services resources in your account to analyze. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html\">Stacks</a> in the <i>Amazon Web Services CloudFormation User Guide</i>. </p>",
"refs": {
"ResourceCollectionFilter$CloudFormation": "<p> Information about Amazon Web Services CloudFormation stacks. You can use up to 500 stacks to specify which Amazon Web Services resources in your account to analyze. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html\">Stacks</a> in the <i>Amazon Web Services CloudFormation User Guide</i>. </p>"
}
},
"CloudFormationCostEstimationResourceCollectionFilter": {
"base": "<p>Information about an Amazon Web Services CloudFormation stack used to create a monthly cost estimate for DevOps Guru to analyze Amazon Web Services resources. The maximum number of stacks you can specify for a cost estimate is one. The estimate created is for the cost to analyze the Amazon Web Services resources defined by the stack. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html\">Stacks</a> in the <i>Amazon Web Services CloudFormation User Guide</i>.</p>",
"refs": {
"CostEstimationResourceCollectionFilter$CloudFormation": "<p>An object that specifies the CloudFormation stack that defines the Amazon Web Services resources used to create a monthly estimate for DevOps Guru.</p>"
}
},
"CloudFormationHealth": {
"base": "<p> Information about the health of Amazon Web Services resources in your account that are specified by an Amazon Web Services CloudFormation stack. </p>",
"refs": {
"CloudFormationHealths$member": null
}
},
"CloudFormationHealths": {
"base": null,
"refs": {
"DescribeOrganizationResourceCollectionHealthResponse$CloudFormation": "<p>The returned <code>CloudFormationHealthOverview</code> object that contains an <code>InsightHealthOverview</code> object with the requested system health information.</p>",
"DescribeResourceCollectionHealthResponse$CloudFormation": "<p> The returned <code>CloudFormationHealthOverview</code> object that contains an <code>InsightHealthOverview</code> object with the requested system health information. </p>"
}
},
"CloudWatchMetricDataStatusCode": {
"base": null,
"refs": {
"CloudWatchMetricsDataSummary$StatusCode": "<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>"
}
},
"CloudWatchMetricsDataSummary": {
"base": "<p>Contains information about the analyzed metrics that displayed anomalous behavior. </p>",
"refs": {
"CloudWatchMetricsDetail$MetricDataSummary": "<p>This object returns anomaly metric data.</p>"
}
},
"CloudWatchMetricsDetail": {
"base": "<p> Information about an Amazon CloudWatch metric. </p>",
"refs": {
"CloudWatchMetricsDetails$member": null
}
},
"CloudWatchMetricsDetails": {
"base": null,
"refs": {
"AnomalySourceDetails$CloudWatchMetrics": "<p>An array of <code>CloudWatchMetricsDetail</code> objects that contain information about analyzed CloudWatch metrics that show anomalous behavior. </p>"
}
},
"CloudWatchMetricsDimension": {
"base": "<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>",
"refs": {
"CloudWatchMetricsDimensions$member": null
}
},
"CloudWatchMetricsDimensionName": {
"base": null,
"refs": {
"CloudWatchMetricsDimension$Name": "<p> The name of the CloudWatch dimension. </p>"
}
},
"CloudWatchMetricsDimensionValue": {
"base": null,
"refs": {
"CloudWatchMetricsDimension$Value": "<p> The value of the CloudWatch dimension. </p>"
}
},
"CloudWatchMetricsDimensions": {
"base": null,
"refs": {
"CloudWatchMetricsDetail$Dimensions": "<p> An array of CloudWatch dimensions associated with </p>"
}
},
"CloudWatchMetricsMetricName": {
"base": null,
"refs": {
"CloudWatchMetricsDetail$MetricName": "<p> The name of the CloudWatch metric. </p>"
}
},
"CloudWatchMetricsNamespace": {
"base": null,
"refs": {
"CloudWatchMetricsDetail$Namespace": "<p> The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics. </p>"
}
},
"CloudWatchMetricsPeriod": {
"base": null,
"refs": {
"CloudWatchMetricsDetail$Period": "<p> The length of time associated with the CloudWatch metric in number of seconds. </p>"
}
},
"CloudWatchMetricsStat": {
"base": null,
"refs": {
"CloudWatchMetricsDetail$Stat": "<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>"
}
},
"CloudWatchMetricsUnit": {
"base": null,
"refs": {
"CloudWatchMetricsDetail$Unit": "<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>"
}
},
"ConflictException": {
"base": "<p> An exception that is thrown when a conflict occurs. </p>",
"refs": {
}
},
"Cost": {
"base": null,
"refs": {
"GetCostEstimationResponse$TotalCost": "<p>The estimated monthly cost to analyze the Amazon Web Services resources. This value is the sum of the estimated costs to analyze each resource in the <code>Costs</code> object in this response.</p>",
"ServiceResourceCost$UnitCost": "<p>The price per hour to analyze the resources in the service. For more information, see <a href=\"https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html\">Estimate your Amazon DevOps Guru costs</a> and <a href=\"http://aws.amazon.com/devops-guru/pricing/\">Amazon DevOps Guru pricing</a>.</p>",
"ServiceResourceCost$Cost": "<p>The total estimated monthly cost to analyze the active resources for this resource.</p>"
}
},
"CostEstimationResourceCollectionFilter": {
"base": "<p>Information about a filter used to specify which Amazon Web Services resources are analyzed to create a monthly DevOps Guru cost estimate. For more information, see <a href=\"https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html\">Estimate your Amazon DevOps Guru costs</a> and <a href=\"http://aws.amazon.com/devops-guru/pricing/\">Amazon DevOps Guru pricing</a>. </p>",
"refs": {
"GetCostEstimationResponse$ResourceCollection": "<p>The collection of the Amazon Web Services resources used to create your monthly DevOps Guru cost estimate.</p>",
"StartCostEstimationRequest$ResourceCollection": "<p>The collection of Amazon Web Services resources used to create a monthly DevOps Guru cost estimate.</p>"
}
},
"CostEstimationServiceResourceCount": {
"base": null,
"refs": {
"ServiceResourceCost$Count": "<p>The number of active resources analyzed for this service to create a monthly cost estimate.</p>"
}
},
"CostEstimationServiceResourceState": {
"base": null,
"refs": {
"ServiceResourceCost$State": "<p>The state of the resource. The resource is <code>ACTIVE</code> if it produces metrics, events, or logs within an hour, otherwise it is <code>INACTIVE</code>. You pay for the number of active Amazon Web Services resource hours analyzed for each resource. Inactive resources are not charged. </p>"
}
},
"CostEstimationStackNames": {
"base": null,
"refs": {
"CloudFormationCostEstimationResourceCollectionFilter$StackNames": "<p>An array of CloudFormation stack names. Its size is fixed at 1 item.</p>"
}
},
"CostEstimationStatus": {
"base": null,
"refs": {
"GetCostEstimationResponse$Status": "<p>The status of creating this cost estimate. If it's still in progress, the status <code>ONGOING</code> is returned. If it is finished, the status <code>COMPLETED</code> is returned.</p>"
}
},
"CostEstimationTagValues": {
"base": null,
"refs": {
"TagCostEstimationResourceCollectionFilter$TagValues": "<p>The values in an Amazon Web Services tag collection.</p> <p>The tag's <i>value</i> is an optional field used to associate a string with the tag <i>key</i> (for example, <code>111122223333</code>, <code>Production</code>, or a team name). The <i>key</i> and <i>value</i> are the tag's <i>key</i> pair. Omitting the tag <i>value</i> is the same as using an empty string. Like tag <i>keys</i>, tag <i>values</i> are case-sensitive. You can specify a maximum of 256 characters for a tag value.</p>"
}
},
"CostEstimationTimeRange": {
"base": "<p>The time range of a cost estimation.</p>",
"refs": {
"GetCostEstimationResponse$TimeRange": "<p>The start and end time of the cost estimation.</p>"
}
},
"DeleteInsightRequest": {
"base": null,
"refs": {
}
},
"DeleteInsightResponse": {
"base": null,
"refs": {
}
},
"DescribeAccountHealthRequest": {
"base": null,
"refs": {
}
},
"DescribeAccountHealthResponse": {
"base": null,
"refs": {
}
},
"DescribeAccountOverviewRequest": {
"base": null,
"refs": {
}
},
"DescribeAccountOverviewResponse": {
"base": null,
"refs": {
}
},
"DescribeAnomalyRequest": {
"base": null,
"refs": {
}
},
"DescribeAnomalyResponse": {
"base": null,
"refs": {
}
},
"DescribeEventSourcesConfigRequest": {
"base": null,
"refs": {
}
},
"DescribeEventSourcesConfigResponse": {
"base": null,
"refs": {
}
},
"DescribeFeedbackRequest": {
"base": null,
"refs": {
}
},
"DescribeFeedbackResponse": {
"base": null,
"refs": {
}
},
"DescribeInsightRequest": {
"base": null,
"refs": {
}
},
"DescribeInsightResponse": {
"base": null,
"refs": {
}
},
"DescribeOrganizationHealthRequest": {
"base": null,
"refs": {
}
},
"DescribeOrganizationHealthResponse": {
"base": null,
"refs": {
}
},
"DescribeOrganizationOverviewRequest": {
"base": null,
"refs": {
}
},
"DescribeOrganizationOverviewResponse": {
"base": null,
"refs": {
}
},
"DescribeOrganizationResourceCollectionHealthRequest": {
"base": null,
"refs": {
}
},
"DescribeOrganizationResourceCollectionHealthResponse": {
"base": null,
"refs": {
}
},
"DescribeResourceCollectionHealthRequest": {
"base": null,
"refs": {
}
},
"DescribeResourceCollectionHealthResponse": {
"base": null,
"refs": {
}
},
"DescribeServiceIntegrationRequest": {
"base": null,
"refs": {
}
},
"DescribeServiceIntegrationResponse": {
"base": null,
"refs": {
}
},
"EndTimeRange": {
"base": "<p> A range of time that specifies when anomalous behavior in an anomaly or insight ended. </p>",
"refs": {
"ListInsightsClosedStatusFilter$EndTimeRange": "<p> A time range used to specify when the behavior of the filtered insights ended. </p>"
}
},
"ErrorMessageString": {
"base": null,
"refs": {
"AccessDeniedException$Message": null,
"ConflictException$Message": null,
"InternalServerException$Message": null,
"ResourceNotFoundException$Message": null,
"ServiceQuotaExceededException$Message": null,
"ThrottlingException$Message": null,
"ValidationException$Message": "<p> A message that describes the validation exception. </p>",
"ValidationExceptionField$Message": "<p> The message associated with the validation exception with information to help determine its cause. </p>"
}
},
"ErrorNameString": {
"base": null,
"refs": {
"ValidationExceptionField$Name": "<p> The name of the field. </p>"
}
},
"ErrorQuotaCodeString": {
"base": null,
"refs": {
"ThrottlingException$QuotaCode": "<p> The code of the quota that was exceeded, causing the throttling exception. </p>"
}
},
"ErrorServiceCodeString": {
"base": null,
"refs": {
"ThrottlingException$ServiceCode": "<p> The code of the service that caused the throttling exception. </p>"
}
},
"Event": {
"base": "<p> An Amazon Web Services resource event. Amazon Web Services resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions. </p>",
"refs": {
"Events$member": null
}
},
"EventClass": {
"base": null,
"refs": {
"Event$EventClass": "<p> The class of the event. The class specifies what the event is related to, such as an infrastructure change, a deployment, or a schema change. </p>",
"ListEventsFilters$EventClass": "<p> The class of the events you want to filter for, such as an infrastructure change, a deployment, or a schema change. </p>"
}
},
"EventDataSource": {
"base": null,
"refs": {
"Event$DataSource": "<p> The source, <code>AWS_CLOUD_TRAIL</code> or <code>AWS_CODE_DEPLOY</code>, where DevOps Guru analysis found the event. </p>",
"ListEventsFilters$DataSource": "<p> The source, <code>AWS_CLOUD_TRAIL</code> or <code>AWS_CODE_DEPLOY</code>, of the events you want returned. </p>"
}
},
"EventId": {
"base": null,
"refs": {
"Event$Id": "<p> The ID of the event. </p>"
}
},
"EventName": {
"base": null,
"refs": {
"Event$Name": "<p> The name of the event. </p>"
}
},
"EventResource": {
"base": "<p> The Amazon Web Services resource that emitted an event. Amazon Web Services resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions. </p>",
"refs": {
"EventResources$member": null
}
},
"EventResourceArn": {
"base": null,
"refs": {
"EventResource$Arn": "<p> The Amazon Resource Name (ARN) of the resource that emitted an event. </p>"
}
},
"EventResourceName": {
"base": null,
"refs": {
"EventResource$Name": "<p> The name of the resource that emitted an event. </p>"
}
},
"EventResourceType": {
"base": null,
"refs": {
"EventResource$Type": "<p> The type of resource that emitted an event. </p>"
}
},
"EventResources": {
"base": null,
"refs": {
"Event$Resources": "<p> An <code>EventResource</code> object that contains information about the resource that emitted the event. </p>"
}
},
"EventSource": {
"base": null,
"refs": {
"Event$EventSource": "<p> The Amazon Web Services source that emitted the event. </p>",
"ListEventsFilters$EventSource": "<p> The Amazon Web Services source that emitted the events you want to filter for. </p>"
}
},
"EventSourceOptInStatus": {
"base": null,
"refs": {
"AmazonCodeGuruProfilerIntegration$Status": "<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>"
}
},
"EventSourcesConfig": {
"base": "<p>Information about the integration of DevOps Guru as consumer with another AWS service, such as AWS CodeGuru Profiler via EventBridge.</p>",
"refs": {
"DescribeEventSourcesConfigResponse$EventSources": "<p>Lists the event sources in the configuration.</p>",
"UpdateEventSourcesConfigRequest$EventSources": "<p>Configuration information about the integration of DevOps Guru as the Consumer via EventBridge with another AWS Service.</p>"
}
},
"EventTimeRange": {
"base": "<p> The time range during which an Amazon Web Services event occurred. Amazon Web Services resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions. </p>",
"refs": {
"ListEventsFilters$EventTimeRange": "<p> A time range during which you want the filtered events to have occurred. </p>"
}
},
"Events": {
"base": null,
"refs": {
"ListEventsResponse$Events": "<p> A list of the requested events. </p>"
}
},
"Explanation": {
"base": null,
"refs": {
"LogAnomalyClass$Explanation": "<p> The explanation for why the log event is considered an anomaly. </p>"
}
},
"GetCostEstimationRequest": {
"base": null,
"refs": {
}
},
"GetCostEstimationResponse": {
"base": null,
"refs": {
}
},
"GetResourceCollectionRequest": {
"base": null,
"refs": {
}
},
"GetResourceCollectionResponse": {
"base": null,
"refs": {
}
},
"InsightDescription": {
"base": null,
"refs": {
"ProactiveInsight$Description": "<p>Describes the proactive insight.</p>",
"ReactiveInsight$Description": "<p>Describes the reactive insight.</p>"
}
},
"InsightFeedback": {
"base": "<p> Information about insight feedback received from a customer. </p>",
"refs": {
"DescribeFeedbackResponse$InsightFeedback": null,
"PutFeedbackRequest$InsightFeedback": "<p> The feedback from customers is about the recommendations in this insight. </p>"
}
},
"InsightFeedbackOption": {
"base": null,
"refs": {
"InsightFeedback$Feedback": "<p> The feedback provided by the customer. </p>"
}
},
"InsightHealth": {
"base": "<p> Information about the number of open reactive and proactive insights that can be used to gauge the health of your system. </p>",
"refs": {
"CloudFormationHealth$Insight": "<p> Information about the health of the Amazon Web Services resources in your account that are specified by an Amazon Web Services CloudFormation stack, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights. </p>",
"TagHealth$Insight": "<p>Information about the health of the Amazon Web Services resources in your account that are specified by an Amazon Web Services tag, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights. </p>"
}
},
"InsightId": {
"base": null,
"refs": {
"DeleteInsightRequest$Id": "<p>The ID of the insight.</p>",
"DescribeFeedbackRequest$InsightId": "<p> The ID of the insight for which the feedback was provided. </p>",
"DescribeInsightRequest$Id": "<p> The ID of the insight. </p>",
"InsightFeedback$Id": "<p> The insight feedback ID. </p>",
"ListAnomaliesForInsightRequest$InsightId": "<p> The ID of the insight. The returned anomalies belong to this insight. </p>",
"ListAnomalousLogGroupsRequest$InsightId": "<p> The ID of the insight containing the log groups. </p>",
"ListAnomalousLogGroupsResponse$InsightId": "<p> The ID of the insight containing the log groups. </p>",
"ListEventsFilters$InsightId": "<p> An ID of an insight that is related to the events you want to filter for. </p>",
"ListRecommendationsRequest$InsightId": "<p> The ID of the requested insight. </p>",
"ProactiveAnomaly$AssociatedInsightId": "<p> The ID of the insight that contains this anomaly. An insight is composed of related anomalies. </p>",
"ProactiveAnomalySummary$AssociatedInsightId": "<p> The ID of the insight that contains this anomaly. An insight is composed of related anomalies. </p>",
"ProactiveInsight$Id": "<p>The ID of the proactive insight. </p>",
"ProactiveInsightSummary$Id": "<p>The ID of the proactive insight. </p>",
"ProactiveOrganizationInsightSummary$Id": "<p>The ID of the insight summary.</p>",
"ReactiveAnomaly$AssociatedInsightId": "<p> The ID of the insight that contains this anomaly. An insight is composed of related anomalies. </p>",
"ReactiveAnomalySummary$AssociatedInsightId": "<p> The ID of the insight that contains this anomaly. An insight is composed of related anomalies. </p>",
"ReactiveInsight$Id": "<p> The ID of a reactive insight. </p>",
"ReactiveInsightSummary$Id": "<p> The ID of a reactive summary. </p>",
"ReactiveOrganizationInsightSummary$Id": "<p>The ID of the insight summary.</p>"
}
},
"InsightName": {
"base": null,
"refs": {
"ProactiveInsight$Name": "<p>The name of the proactive insight. </p>",
"ProactiveInsightSummary$Name": "<p>The name of the proactive insight. </p>",
"ProactiveOrganizationInsightSummary$Name": "<p>The name of the insight summary.</p>",
"ReactiveInsight$Name": "<p> The name of a reactive insight. </p>",
"ReactiveInsightSummary$Name": "<p> The name of a reactive insight. </p>",
"ReactiveOrganizationInsightSummary$Name": "<p>The name of the insight summary.</p>"
}
},
"InsightSeverities": {
"base": null,
"refs": {
"NotificationFilterConfig$Severities": "<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>",
"SearchInsightsFilters$Severities": "<p> An array of severity values used to search for insights. </p>",
"SearchOrganizationInsightsFilters$Severities": "<p> An array of severity values used to search for insights. </p>"
}
},
"InsightSeverity": {
"base": null,
"refs": {
"InsightSeverities$member": null,
"ProactiveInsight$Severity": "<p>The severity of the insight. 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> in the <i>Amazon DevOps Guru User Guide</i>.</p>",
"ProactiveInsightSummary$Severity": "<p>The severity of the insight. 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> in the <i>Amazon DevOps Guru User Guide</i>.</p>",
"ProactiveOrganizationInsightSummary$Severity": "<p> An array of severity values used to search for insights. 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> in the <i>Amazon DevOps Guru User Guide</i>.</p>",
"ReactiveInsight$Severity": "<p>The severity of the insight. 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> in the <i>Amazon DevOps Guru User Guide</i>.</p>",
"ReactiveInsightSummary$Severity": "<p>The severity of the insight. 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> in the <i>Amazon DevOps Guru User Guide</i>.</p>",
"ReactiveOrganizationInsightSummary$Severity": "<p> An array of severity values used to search for insights. 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> in the <i>Amazon DevOps Guru User Guide</i>.</p>"
}
},
"InsightStatus": {
"base": null,
"refs": {
"InsightStatuses$member": null,
"ProactiveInsight$Status": "<p>The status of the proactive insight. </p>",
"ProactiveInsightSummary$Status": "<p>The status of the proactive insight. </p>",
"ProactiveOrganizationInsightSummary$Status": "<p> An array of status values used to search for insights. </p>",
"ReactiveInsight$Status": "<p> The status of a reactive insight. </p>",
"ReactiveInsightSummary$Status": "<p> The status of a reactive insight. </p>",
"ReactiveOrganizationInsightSummary$Status": "<p> An array of status values used to search for insights. </p>"
}
},
"InsightStatuses": {
"base": null,
"refs": {
"SearchInsightsFilters$Statuses": "<p> An array of status values used to search for insights. </p>",
"SearchOrganizationInsightsFilters$Statuses": "<p> An array of status values used to search for insights. </p>"
}
},
"InsightTimeRange": {
"base": "<p> A time ranged that specifies when the observed behavior in an insight started and ended. </p>",
"refs": {
"ProactiveInsight$InsightTimeRange": null,
"ProactiveInsightSummary$InsightTimeRange": null,
"ProactiveOrganizationInsightSummary$InsightTimeRange": null,
"ReactiveInsight$InsightTimeRange": null,
"ReactiveInsightSummary$InsightTimeRange": null,
"ReactiveOrganizationInsightSummary$InsightTimeRange": null
}
},
"InsightType": {
"base": null,
"refs": {
"ListInsightsAnyStatusFilter$Type": "<p> Use to filter for either <code>REACTIVE</code> or <code>PROACTIVE</code> insights. </p>",
"ListInsightsClosedStatusFilter$Type": "<p> Use to filter for either <code>REACTIVE</code> or <code>PROACTIVE</code> insights. </p>",
"ListInsightsOngoingStatusFilter$Type": "<p> Use to filter for either <code>REACTIVE</code> or <code>PROACTIVE</code> insights. </p>",
"SearchInsightsRequest$Type": "<p> The type of insights you are searching for (<code>REACTIVE</code> or <code>PROACTIVE</code>). </p>",
"SearchOrganizationInsightsRequest$Type": "<p> The type of insights you are searching for (<code>REACTIVE</code> or <code>PROACTIVE</code>). </p>"
}
},
"InternalServerException": {
"base": "<p>An internal failure in an Amazon service occurred.</p>",
"refs": {
}
},
"ListAnomaliesForInsightMaxResults": {
"base": null,
"refs": {
"ListAnomaliesForInsightRequest$MaxResults": "<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>"
}
},
"ListAnomaliesForInsightRequest": {
"base": null,
"refs": {
}
},
"ListAnomaliesForInsightResponse": {
"base": null,
"refs": {
}
},
"ListAnomalousLogGroupsMaxResults": {
"base": null,
"refs": {
"ListAnomalousLogGroupsRequest$MaxResults": "<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>"
}
},
"ListAnomalousLogGroupsRequest": {
"base": null,
"refs": {
}
},
"ListAnomalousLogGroupsResponse": {
"base": null,
"refs": {
}
},
"ListEventsFilters": {
"base": "<p> Filters you can use to specify which events are returned when <code>ListEvents</code> is called. </p>",
"refs": {
"ListEventsRequest$Filters": "<p> A <code>ListEventsFilters</code> object used to specify which events to return. </p>"
}
},
"ListEventsMaxResults": {
"base": null,
"refs": {
"ListEventsRequest$MaxResults": "<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>"
}
},
"ListEventsRequest": {
"base": null,
"refs": {
}
},
"ListEventsResponse": {
"base": null,
"refs": {
}
},
"ListInsightsAccountIdList": {
"base": null,
"refs": {
"ListOrganizationInsightsRequest$AccountIds": "<p>The ID of the Amazon Web Services account. </p>"
}
},
"ListInsightsAnyStatusFilter": {
"base": "<p> Used to filter for insights that have any status. </p>",
"refs": {
"ListInsightsStatusFilter$Any": "<p> A <code>ListInsightsAnyStatusFilter</code> that specifies insights of any status that are either <code>REACTIVE</code> or <code>PROACTIVE</code>. </p>"
}
},
"ListInsightsClosedStatusFilter": {
"base": "<p> Used to filter for insights that have the status <code>CLOSED</code>. </p>",
"refs": {
"ListInsightsStatusFilter$Closed": "<p> A <code>ListInsightsClosedStatusFilter</code> that specifies closed insights that are either <code>REACTIVE</code> or <code>PROACTIVE</code>. </p>"
}
},
"ListInsightsMaxResults": {
"base": null,
"refs": {
"ListInsightsRequest$MaxResults": "<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>",
"ListOrganizationInsightsRequest$MaxResults": "<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>"
}
},
"ListInsightsOngoingStatusFilter": {
"base": "<p> Used to filter for insights that have the status <code>ONGOING</code>. </p>",
"refs": {
"ListInsightsStatusFilter$Ongoing": "<p> A <code>ListInsightsAnyStatusFilter</code> that specifies ongoing insights that are either <code>REACTIVE</code> or <code>PROACTIVE</code>. </p>"
}
},
"ListInsightsOrganizationalUnitIdList": {
"base": null,
"refs": {
"ListOrganizationInsightsRequest$OrganizationalUnitIds": "<p>The ID of the organizational unit.</p>"
}
},
"ListInsightsRequest": {
"base": null,
"refs": {
}
},
"ListInsightsResponse": {
"base": null,
"refs": {
}
},
"ListInsightsStatusFilter": {
"base": "<p> A filter used by <code>ListInsights</code> to specify which insights to return. </p>",
"refs": {
"ListInsightsRequest$StatusFilter": "<p> A filter used to filter the returned insights by their status. You can specify one status filter. </p>",
"ListOrganizationInsightsRequest$StatusFilter": null
}
},
"ListMonitoredResourcesFilters": {
"base": "<p> Filters to determine which monitored resources you want to retrieve. You can filter by resource type or resource permission status. </p>",
"refs": {
"ListMonitoredResourcesRequest$Filters": "<p> Filters to determine which monitored resources you want to retrieve. You can filter by resource type or resource permission status. </p>"
}
},
"ListMonitoredResourcesMaxResults": {
"base": null,
"refs": {
"ListMonitoredResourcesRequest$MaxResults": "<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>"
}
},
"ListMonitoredResourcesRequest": {
"base": null,
"refs": {
}
},
"ListMonitoredResourcesResponse": {
"base": null,
"refs": {
}
},
"ListNotificationChannelsRequest": {
"base": null,
"refs": {
}
},
"ListNotificationChannelsResponse": {
"base": null,
"refs": {
}
},
"ListOrganizationInsightsRequest": {
"base": null,
"refs": {
}
},
"ListOrganizationInsightsResponse": {
"base": null,
"refs": {
}
},
"ListRecommendationsRequest": {
"base": null,
"refs": {
}
},
"ListRecommendationsResponse": {
"base": null,
"refs": {
}
},
"Locale": {
"base": null,
"refs": {
"ListRecommendationsRequest$Locale": "<p>A locale that specifies the language to use for recommendations.</p>"
}
},
"LogAnomalyClass": {
"base": "<p> Information about an anomalous log event found within a log group. </p>",
"refs": {
"LogAnomalyClasses$member": null
}
},
"LogAnomalyClasses": {
"base": null,
"refs": {
"LogAnomalyShowcase$LogAnomalyClasses": "<p> A list of anomalous log events that may be related. </p>"