/
docs-2.json
1656 lines (1656 loc) · 67.4 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>This is the <i>Amazon Lookout for Metrics API Reference</i>. For an introduction to the service with tutorials for getting started, visit <a href=\"https://docs.aws.amazon.com/lookoutmetrics/latest/dev\">Amazon Lookout for Metrics Developer Guide</a>.</p>",
"operations": {
"ActivateAnomalyDetector": "<p>Activates an anomaly detector.</p>",
"BackTestAnomalyDetector": "<p>Runs a backtest for anomaly detection for the specified resource.</p>",
"CreateAlert": "<p>Creates an alert for an anomaly detector.</p>",
"CreateAnomalyDetector": "<p>Creates an anomaly detector.</p>",
"CreateMetricSet": "<p>Creates a dataset.</p>",
"DeactivateAnomalyDetector": "<p>Deactivates an anomaly detector.</p>",
"DeleteAlert": "<p>Deletes an alert.</p>",
"DeleteAnomalyDetector": "<p>Deletes a detector. Deleting an anomaly detector will delete all of its corresponding resources including any configured datasets and alerts.</p>",
"DescribeAlert": "<p>Describes an alert.</p> <p>Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.</p>",
"DescribeAnomalyDetectionExecutions": "<p>Returns information about the status of the specified anomaly detection jobs.</p>",
"DescribeAnomalyDetector": "<p>Describes a detector.</p> <p>Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.</p>",
"DescribeMetricSet": "<p>Describes a dataset.</p> <p>Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.</p>",
"DetectMetricSetConfig": "<p>Detects an Amazon S3 dataset's file format, interval, and offset.</p>",
"GetAnomalyGroup": "<p>Returns details about a group of anomalous metrics.</p>",
"GetDataQualityMetrics": "<p>Returns details about the requested data quality metrics.</p>",
"GetFeedback": "<p>Get feedback for an anomaly group.</p>",
"GetSampleData": "<p>Returns a selection of sample records from an Amazon S3 datasource.</p>",
"ListAlerts": "<p>Lists the alerts attached to a detector.</p> <p>Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.</p>",
"ListAnomalyDetectors": "<p>Lists the detectors in the current AWS Region.</p> <p>Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.</p>",
"ListAnomalyGroupRelatedMetrics": "<p>Returns a list of measures that are potential causes or effects of an anomaly group.</p>",
"ListAnomalyGroupSummaries": "<p>Returns a list of anomaly groups.</p>",
"ListAnomalyGroupTimeSeries": "<p>Gets a list of anomalous metrics for a measure in an anomaly group.</p>",
"ListMetricSets": "<p>Lists the datasets in the current AWS Region.</p> <p>Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.</p>",
"ListTagsForResource": "<p>Gets a list of <a href=\"https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html\">tags</a> for a detector, dataset, or alert.</p>",
"PutFeedback": "<p>Add feedback for an anomalous metric.</p>",
"TagResource": "<p>Adds <a href=\"https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html\">tags</a> to a detector, dataset, or alert.</p>",
"UntagResource": "<p>Removes <a href=\"https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html\">tags</a> from a detector, dataset, or alert.</p>",
"UpdateAlert": "<p>Make changes to an existing alert.</p>",
"UpdateAnomalyDetector": "<p>Updates a detector. After activation, you can only change a detector's ingestion delay and description.</p>",
"UpdateMetricSet": "<p>Updates a dataset.</p>"
},
"shapes": {
"AccessDeniedException": {
"base": "<p>You do not have sufficient permissions to perform this action.</p>",
"refs": {
}
},
"Action": {
"base": "<p>A configuration that specifies the action to perform when anomalies are detected.</p>",
"refs": {
"Alert$Action": "<p>Action that will be triggered when there is an alert.</p>",
"CreateAlertRequest$Action": "<p>Action that will be triggered when there is an alert.</p>",
"UpdateAlertRequest$Action": "<p>Action that will be triggered when there is an alert.</p>"
}
},
"ActivateAnomalyDetectorRequest": {
"base": null,
"refs": {
}
},
"ActivateAnomalyDetectorResponse": {
"base": null,
"refs": {
}
},
"AggregationFunction": {
"base": null,
"refs": {
"Metric$AggregationFunction": "<p>The function with which the metric is calculated.</p>"
}
},
"Alert": {
"base": "<p>A configuration for Amazon SNS-integrated notifications.</p>",
"refs": {
"DescribeAlertResponse$Alert": "<p>Contains information about an alert.</p>"
}
},
"AlertDescription": {
"base": null,
"refs": {
"Alert$AlertDescription": "<p>A description of the alert.</p>",
"CreateAlertRequest$AlertDescription": "<p>A description of the alert.</p>",
"UpdateAlertRequest$AlertDescription": "<p>A description of the alert.</p>"
}
},
"AlertFilters": {
"base": "<p>The configuration of the alert filters.</p>",
"refs": {
"Alert$AlertFilters": "<p>The configuration of the alert filters, containing MetricList and DimensionFilter.</p>",
"CreateAlertRequest$AlertFilters": "<p>The configuration of the alert filters, containing MetricList and DimensionFilterList.</p>",
"UpdateAlertRequest$AlertFilters": "<p>The configuration of the alert filters, containing MetricList and DimensionFilterList.</p>"
}
},
"AlertName": {
"base": null,
"refs": {
"Alert$AlertName": "<p>The name of the alert.</p>",
"AlertSummary$AlertName": "<p>The name of the alert.</p>",
"CreateAlertRequest$AlertName": "<p>The name of the alert.</p>"
}
},
"AlertStatus": {
"base": null,
"refs": {
"Alert$AlertStatus": "<p>The status of the alert.</p>",
"AlertSummary$AlertStatus": "<p>The status of the alert.</p>"
}
},
"AlertSummary": {
"base": "<p>Provides a summary of an alert's configuration.</p>",
"refs": {
"AlertSummaryList$member": null
}
},
"AlertSummaryList": {
"base": null,
"refs": {
"ListAlertsResponse$AlertSummaryList": "<p>Contains information about an alert.</p>"
}
},
"AlertType": {
"base": null,
"refs": {
"Alert$AlertType": "<p>The type of the alert.</p>",
"AlertSummary$AlertType": "<p>The type of the alert.</p>"
}
},
"AnomalyDetectionTaskStatus": {
"base": null,
"refs": {
"ExecutionStatus$Status": "<p>The run's status.</p>"
}
},
"AnomalyDetectionTaskStatusMessage": {
"base": null,
"refs": {
"ExecutionStatus$FailureReason": "<p>The reason that the run failed, if applicable.</p>"
}
},
"AnomalyDetectorConfig": {
"base": "<p>Contains information about a detector's configuration.</p>",
"refs": {
"CreateAnomalyDetectorRequest$AnomalyDetectorConfig": "<p>Contains information about the configuration of the anomaly detector.</p>",
"UpdateAnomalyDetectorRequest$AnomalyDetectorConfig": "<p>Contains information about the configuration to which the detector will be updated.</p>"
}
},
"AnomalyDetectorConfigSummary": {
"base": "<p>Contains information about a detector's configuration.</p>",
"refs": {
"DescribeAnomalyDetectorResponse$AnomalyDetectorConfig": "<p>Contains information about the detector's configuration.</p>"
}
},
"AnomalyDetectorDataQualityMetric": {
"base": "<p>Aggregated details about the data quality metrics collected for the <code>AnomalyDetectorArn</code> provided in the <a>GetDataQualityMetrics</a> object.</p>",
"refs": {
"AnomalyDetectorDataQualityMetricList$member": null
}
},
"AnomalyDetectorDataQualityMetricList": {
"base": null,
"refs": {
"GetDataQualityMetricsResponse$AnomalyDetectorDataQualityMetricList": "<p>A list of the data quality metrics for the <code>AnomalyDetectorArn</code> that you requested.</p>"
}
},
"AnomalyDetectorDescription": {
"base": null,
"refs": {
"AnomalyDetectorSummary$AnomalyDetectorDescription": "<p>A description of the detector.</p>",
"CreateAnomalyDetectorRequest$AnomalyDetectorDescription": "<p>A description of the detector.</p>",
"DescribeAnomalyDetectorResponse$AnomalyDetectorDescription": "<p>A description of the detector.</p>",
"UpdateAnomalyDetectorRequest$AnomalyDetectorDescription": "<p>The updated detector description.</p>"
}
},
"AnomalyDetectorFailureType": {
"base": null,
"refs": {
"DescribeAnomalyDetectorResponse$FailureType": "<p>The process that caused the detector to fail.</p>"
}
},
"AnomalyDetectorName": {
"base": null,
"refs": {
"AnomalyDetectorSummary$AnomalyDetectorName": "<p>The name of the detector.</p>",
"CreateAnomalyDetectorRequest$AnomalyDetectorName": "<p>The name of the detector.</p>",
"DescribeAnomalyDetectorResponse$AnomalyDetectorName": "<p>The name of the detector.</p>"
}
},
"AnomalyDetectorStatus": {
"base": null,
"refs": {
"AnomalyDetectorSummary$Status": "<p>The status of detector.</p>",
"DescribeAnomalyDetectorResponse$Status": "<p>The status of the detector.</p>"
}
},
"AnomalyDetectorSummary": {
"base": "<p>Contains information about an an anomaly detector.</p>",
"refs": {
"AnomalyDetectorSummaryList$member": null
}
},
"AnomalyDetectorSummaryList": {
"base": null,
"refs": {
"ListAnomalyDetectorsResponse$AnomalyDetectorSummaryList": "<p>A list of anomaly detectors in the account in the current region.</p>"
}
},
"AnomalyGroup": {
"base": "<p>A group of anomalous metrics</p>",
"refs": {
"GetAnomalyGroupResponse$AnomalyGroup": "<p>Details about the anomaly group.</p>"
}
},
"AnomalyGroupStatistics": {
"base": "<p>Aggregated statistics for a group of anomalous metrics.</p>",
"refs": {
"ListAnomalyGroupSummariesResponse$AnomalyGroupStatistics": "<p>Aggregated details about the anomaly groups.</p>"
}
},
"AnomalyGroupSummary": {
"base": "<p>Details about a group of anomalous metrics.</p>",
"refs": {
"AnomalyGroupSummaryList$member": null
}
},
"AnomalyGroupSummaryList": {
"base": null,
"refs": {
"ListAnomalyGroupSummariesResponse$AnomalyGroupSummaryList": "<p>A list of anomaly group summaries.</p>"
}
},
"AnomalyGroupTimeSeries": {
"base": "<p>An anomalous metric in an anomaly group.</p>",
"refs": {
"GetFeedbackRequest$AnomalyGroupTimeSeriesFeedback": "<p>The anomalous metric and group ID.</p>"
}
},
"AnomalyGroupTimeSeriesFeedback": {
"base": "<p>Feedback for an anomalous metric.</p>",
"refs": {
"PutFeedbackRequest$AnomalyGroupTimeSeriesFeedback": "<p>Feedback for an anomalous metric.</p>"
}
},
"AppFlowConfig": {
"base": "<p>Details about an Amazon AppFlow flow datasource.</p>",
"refs": {
"MetricSource$AppFlowConfig": "<p>Details about an AppFlow datasource.</p>"
}
},
"Arn": {
"base": null,
"refs": {
"ActivateAnomalyDetectorRequest$AnomalyDetectorArn": "<p>The ARN of the anomaly detector.</p>",
"Alert$AlertArn": "<p>The ARN of the alert.</p>",
"Alert$AnomalyDetectorArn": "<p>The ARN of the detector to which the alert is attached.</p>",
"AlertSummary$AlertArn": "<p>The ARN of the alert.</p>",
"AlertSummary$AnomalyDetectorArn": "<p>The ARN of the detector to which the alert is attached.</p>",
"AnomalyDetectorSummary$AnomalyDetectorArn": "<p>The ARN of the detector.</p>",
"AppFlowConfig$RoleArn": "<p>An IAM role that gives Amazon Lookout for Metrics permission to access the flow.</p>",
"AthenaSourceConfig$RoleArn": "<p>An IAM role that gives Amazon Lookout for Metrics permission to access the data.</p>",
"BackTestAnomalyDetectorRequest$AnomalyDetectorArn": "<p>The Amazon Resource Name (ARN) of the anomaly detector.</p>",
"CloudWatchConfig$RoleArn": "<p>An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.</p>",
"CreateAlertRequest$AnomalyDetectorArn": "<p>The ARN of the detector to which the alert is attached.</p>",
"CreateAlertResponse$AlertArn": "<p>The ARN of the alert.</p>",
"CreateAnomalyDetectorResponse$AnomalyDetectorArn": "<p>The ARN of the detector.</p>",
"CreateMetricSetRequest$AnomalyDetectorArn": "<p>The ARN of the anomaly detector that will use the dataset.</p>",
"CreateMetricSetResponse$MetricSetArn": "<p>The ARN of the dataset.</p>",
"DeactivateAnomalyDetectorRequest$AnomalyDetectorArn": "<p>The Amazon Resource Name (ARN) of the anomaly detector.</p>",
"DeleteAlertRequest$AlertArn": "<p>The ARN of the alert to delete.</p>",
"DeleteAnomalyDetectorRequest$AnomalyDetectorArn": "<p>The ARN of the detector to delete.</p>",
"DescribeAlertRequest$AlertArn": "<p>The ARN of the alert to describe.</p>",
"DescribeAnomalyDetectionExecutionsRequest$AnomalyDetectorArn": "<p>The Amazon Resource Name (ARN) of the anomaly detector.</p>",
"DescribeAnomalyDetectorRequest$AnomalyDetectorArn": "<p>The ARN of the detector to describe.</p>",
"DescribeAnomalyDetectorResponse$AnomalyDetectorArn": "<p>The ARN of the detector.</p>",
"DescribeMetricSetRequest$MetricSetArn": "<p>The ARN of the dataset.</p>",
"DescribeMetricSetResponse$MetricSetArn": "<p>The ARN of the dataset.</p>",
"DescribeMetricSetResponse$AnomalyDetectorArn": "<p>The ARN of the detector that contains the dataset.</p>",
"DetectMetricSetConfigRequest$AnomalyDetectorArn": "<p>An anomaly detector ARN.</p>",
"GetAnomalyGroupRequest$AnomalyDetectorArn": "<p>The Amazon Resource Name (ARN) of the anomaly detector.</p>",
"GetDataQualityMetricsRequest$AnomalyDetectorArn": "<p>The Amazon Resource Name (ARN) of the anomaly detector that you want to investigate.</p>",
"GetDataQualityMetricsRequest$MetricSetArn": "<p>The Amazon Resource Name (ARN) of a specific data quality metric set.</p>",
"GetFeedbackRequest$AnomalyDetectorArn": "<p>The Amazon Resource Name (ARN) of the anomaly detector.</p>",
"LambdaConfiguration$RoleArn": "<p>The ARN of an IAM role that has permission to invoke the Lambda function.</p>",
"LambdaConfiguration$LambdaArn": "<p>The ARN of the Lambda function.</p>",
"ListAlertsRequest$AnomalyDetectorArn": "<p>The ARN of the alert's detector.</p>",
"ListAnomalyGroupRelatedMetricsRequest$AnomalyDetectorArn": "<p>The Amazon Resource Name (ARN) of the anomaly detector.</p>",
"ListAnomalyGroupSummariesRequest$AnomalyDetectorArn": "<p>The Amazon Resource Name (ARN) of the anomaly detector.</p>",
"ListAnomalyGroupTimeSeriesRequest$AnomalyDetectorArn": "<p>The Amazon Resource Name (ARN) of the anomaly detector.</p>",
"ListMetricSetsRequest$AnomalyDetectorArn": "<p>The ARN of the anomaly detector containing the metrics sets to list.</p>",
"ListTagsForResourceRequest$ResourceArn": "<p>The resource's Amazon Resource Name (ARN).</p>",
"MetricSetDataQualityMetric$MetricSetArn": "<p>The Amazon Resource Name (ARN) of the data quality metric array.</p>",
"MetricSetSummary$MetricSetArn": "<p>The ARN of the dataset.</p>",
"MetricSetSummary$AnomalyDetectorArn": "<p>The ARN of the detector to which the dataset belongs.</p>",
"PutFeedbackRequest$AnomalyDetectorArn": "<p>The Amazon Resource Name (ARN) of the anomaly detector.</p>",
"RDSSourceConfig$RoleArn": "<p>The Amazon Resource Name (ARN) of the role.</p>",
"RedshiftSourceConfig$RoleArn": "<p>The Amazon Resource Name (ARN) of the role providing access to the database.</p>",
"S3SourceConfig$RoleArn": "<p>The ARN of an IAM role that has read and write access permissions to the source S3 bucket.</p>",
"SNSConfiguration$RoleArn": "<p>The ARN of the IAM role that has access to the target SNS topic.</p>",
"SNSConfiguration$SnsTopicArn": "<p>The ARN of the target SNS topic.</p>",
"SampleDataS3SourceConfig$RoleArn": "<p>The Amazon Resource Name (ARN) of the role.</p>",
"TagResourceRequest$ResourceArn": "<p>The resource's Amazon Resource Name (ARN).</p>",
"UntagResourceRequest$ResourceArn": "<p>The resource's Amazon Resource Name (ARN).</p>",
"UpdateAlertRequest$AlertArn": "<p>The ARN of the alert to update.</p>",
"UpdateAlertResponse$AlertArn": "<p>The ARN of the updated alert.</p>",
"UpdateAnomalyDetectorRequest$AnomalyDetectorArn": "<p>The ARN of the detector to update.</p>",
"UpdateAnomalyDetectorResponse$AnomalyDetectorArn": "<p>The ARN of the updated detector.</p>",
"UpdateMetricSetRequest$MetricSetArn": "<p>The ARN of the dataset to update.</p>",
"UpdateMetricSetResponse$MetricSetArn": "<p>The ARN of the dataset.</p>"
}
},
"AthenaDataCatalog": {
"base": null,
"refs": {
"AthenaSourceConfig$DataCatalog": "<p>The database's data catalog.</p>"
}
},
"AthenaDatabaseName": {
"base": null,
"refs": {
"AthenaSourceConfig$DatabaseName": "<p>The database's name.</p>"
}
},
"AthenaS3ResultsPath": {
"base": null,
"refs": {
"AthenaSourceConfig$S3ResultsPath": "<p>The database's results path.</p>"
}
},
"AthenaSourceConfig": {
"base": "<p>Details about an Amazon Athena datasource.</p>",
"refs": {
"MetricSource$AthenaSourceConfig": "<p>Details about an Amazon Athena datasource.</p>"
}
},
"AthenaTableName": {
"base": null,
"refs": {
"AthenaSourceConfig$TableName": "<p>The database's table name.</p>"
}
},
"AthenaWorkGroupName": {
"base": null,
"refs": {
"AthenaSourceConfig$WorkGroupName": "<p>The database's work group name.</p>"
}
},
"AttributeValue": {
"base": "<p>An attribute value.</p>",
"refs": {
"DetectedField$Value": "<p>The field's value.</p>"
}
},
"AutoDetectionMetricSource": {
"base": "<p>An auto detection metric source.</p>",
"refs": {
"DetectMetricSetConfigRequest$AutoDetectionMetricSource": "<p>A data source.</p>"
}
},
"AutoDetectionS3SourceConfig": {
"base": "<p>An auto detection source config.</p>",
"refs": {
"AutoDetectionMetricSource$S3SourceConfig": "<p>The source's source config.</p>"
}
},
"BackTestAnomalyDetectorRequest": {
"base": null,
"refs": {
}
},
"BackTestAnomalyDetectorResponse": {
"base": null,
"refs": {
}
},
"BackTestConfiguration": {
"base": "<p>Settings for backtest mode.</p>",
"refs": {
"AthenaSourceConfig$BackTestConfiguration": "<p>Settings for backtest mode.</p>",
"CloudWatchConfig$BackTestConfiguration": "<p>Settings for backtest mode.</p>"
}
},
"BinaryAttributeValue": {
"base": null,
"refs": {
"AttributeValue$B": "<p>A binary value.</p>",
"BinaryListAttributeValue$member": null
}
},
"BinaryListAttributeValue": {
"base": null,
"refs": {
"AttributeValue$BS": "<p>A list of binary values.</p>"
}
},
"Boolean": {
"base": null,
"refs": {
"AnomalyGroupTimeSeriesFeedback$IsAnomaly": "<p>Feedback on whether the metric is a legitimate anomaly.</p>",
"BackTestConfiguration$RunBackTestMode": "<p>Run a backtest instead of monitoring new data.</p>",
"CsvFormatDescriptor$ContainsHeader": "<p>Whether or not the source CSV file contains a header.</p>",
"TimeSeriesFeedback$IsAnomaly": "<p>Feedback on whether the metric is a legitimate anomaly.</p>"
}
},
"CSVFileCompression": {
"base": null,
"refs": {
"CsvFormatDescriptor$FileCompression": "<p>The level of compression of the source CSV file.</p>"
}
},
"Charset": {
"base": null,
"refs": {
"CsvFormatDescriptor$Charset": "<p>The character set in which the source CSV file is written.</p>",
"JsonFormatDescriptor$Charset": "<p>The character set in which the source JSON file is written.</p>"
}
},
"CloudWatchConfig": {
"base": "<p>Details about an Amazon CloudWatch datasource.</p>",
"refs": {
"MetricSource$CloudWatchConfig": "<p>Details about an Amazon CloudWatch monitoring datasource.</p>"
}
},
"ColumnName": {
"base": null,
"refs": {
"DimensionContribution$DimensionName": "<p>The name of the dimension.</p>",
"DimensionFilter$DimensionName": "<p>The name of the dimension to filter on.</p>",
"DimensionList$member": null,
"DimensionNameValue$DimensionName": "<p>The name of the dimension.</p>",
"HeaderList$member": null,
"ItemizedMetricStats$MetricName": "<p>The name of the measure.</p>",
"Metric$MetricName": "<p>The name of the metric.</p>",
"MetricSetDimensionFilter$Name": "<p>The dimension that you want to filter on.</p>",
"TimestampColumn$ColumnName": "<p>The name of the timestamp column.</p>"
}
},
"Confidence": {
"base": null,
"refs": {
"DetectedField$Confidence": "<p>The field's confidence.</p>"
}
},
"ConflictException": {
"base": "<p>There was a conflict processing the request. Try your request again.</p>",
"refs": {
}
},
"ContributionMatrix": {
"base": "<p>Details about dimensions that contributed to an anomaly.</p>",
"refs": {
"MetricLevelImpact$ContributionMatrix": "<p>Details about the dimensions that contributed to the anomaly.</p>"
}
},
"CreateAlertRequest": {
"base": null,
"refs": {
}
},
"CreateAlertResponse": {
"base": null,
"refs": {
}
},
"CreateAnomalyDetectorRequest": {
"base": null,
"refs": {
}
},
"CreateAnomalyDetectorResponse": {
"base": null,
"refs": {
}
},
"CreateMetricSetRequest": {
"base": null,
"refs": {
}
},
"CreateMetricSetResponse": {
"base": null,
"refs": {
}
},
"CsvFormatDescriptor": {
"base": "<p>Contains information about how a source CSV data file should be analyzed.</p>",
"refs": {
"FileFormatDescriptor$CsvFormatDescriptor": "<p>Contains information about how a source CSV data file should be analyzed.</p>"
}
},
"DataItem": {
"base": null,
"refs": {
"SampleRow$member": null
}
},
"DataQualityMetric": {
"base": "<p>An array that describes a data quality metric. Each <code>DataQualityMetric</code> object contains the data quality metric name, its value, a description of the metric, and the affected column.</p>",
"refs": {
"DataQualityMetricList$member": null
}
},
"DataQualityMetricDescription": {
"base": null,
"refs": {
"DataQualityMetric$MetricDescription": "<p>A description of the data quality metric.</p>"
}
},
"DataQualityMetricList": {
"base": null,
"refs": {
"MetricSetDataQualityMetric$DataQualityMetricList": "<p>The array of data quality metrics contained in the data quality metric set.</p>"
}
},
"DataQualityMetricType": {
"base": null,
"refs": {
"DataQualityMetric$MetricType": "<p>The name of the data quality metric.</p>"
}
},
"DatabaseHost": {
"base": null,
"refs": {
"RDSSourceConfig$DatabaseHost": "<p>The host name of the database.</p>",
"RedshiftSourceConfig$DatabaseHost": "<p>The name of the database host.</p>"
}
},
"DatabasePort": {
"base": null,
"refs": {
"RDSSourceConfig$DatabasePort": "<p>The port number where the database can be accessed.</p>",
"RedshiftSourceConfig$DatabasePort": "<p>The port number where the database can be accessed.</p>"
}
},
"DateTimeFormat": {
"base": null,
"refs": {
"TimestampColumn$ColumnFormat": "<p>The format of the timestamp column.</p>"
}
},
"DeactivateAnomalyDetectorRequest": {
"base": null,
"refs": {
}
},
"DeactivateAnomalyDetectorResponse": {
"base": null,
"refs": {
}
},
"DeleteAlertRequest": {
"base": null,
"refs": {
}
},
"DeleteAlertResponse": {
"base": null,
"refs": {
}
},
"DeleteAnomalyDetectorRequest": {
"base": null,
"refs": {
}
},
"DeleteAnomalyDetectorResponse": {
"base": null,
"refs": {
}
},
"Delimiter": {
"base": null,
"refs": {
"CsvFormatDescriptor$Delimiter": "<p>The character used to delimit the source CSV file.</p>"
}
},
"DescribeAlertRequest": {
"base": null,
"refs": {
}
},
"DescribeAlertResponse": {
"base": null,
"refs": {
}
},
"DescribeAnomalyDetectionExecutionsRequest": {
"base": null,
"refs": {
}
},
"DescribeAnomalyDetectionExecutionsResponse": {
"base": null,
"refs": {
}
},
"DescribeAnomalyDetectorRequest": {
"base": null,
"refs": {
}
},
"DescribeAnomalyDetectorResponse": {
"base": null,
"refs": {
}
},
"DescribeMetricSetRequest": {
"base": null,
"refs": {
}
},
"DescribeMetricSetResponse": {
"base": null,
"refs": {
}
},
"DetectMetricSetConfigRequest": {
"base": null,
"refs": {
}
},
"DetectMetricSetConfigResponse": {
"base": null,
"refs": {
}
},
"DetectedCsvFormatDescriptor": {
"base": "<p>Properties of an inferred CSV format.</p>",
"refs": {
"DetectedFileFormatDescriptor$CsvFormatDescriptor": "<p>Details about a CSV format.</p>"
}
},
"DetectedField": {
"base": "<p>An inferred field.</p>",
"refs": {
"DetectedCsvFormatDescriptor$FileCompression": "<p>The format's file compression.</p>",
"DetectedCsvFormatDescriptor$Charset": "<p>The format's charset.</p>",
"DetectedCsvFormatDescriptor$ContainsHeader": "<p>Whether the format includes a header.</p>",
"DetectedCsvFormatDescriptor$Delimiter": "<p>The format's delimiter.</p>",
"DetectedCsvFormatDescriptor$HeaderList": "<p>The format's header list.</p>",
"DetectedCsvFormatDescriptor$QuoteSymbol": "<p>The format's quote symbol.</p>",
"DetectedJsonFormatDescriptor$FileCompression": "<p>The format's file compression.</p>",
"DetectedJsonFormatDescriptor$Charset": "<p>The format's character set.</p>",
"DetectedMetricSetConfig$Offset": "<p>The dataset's offset.</p>",
"DetectedMetricSetConfig$MetricSetFrequency": "<p>The dataset's interval.</p>"
}
},
"DetectedFileFormatDescriptor": {
"base": "<p>Properties of an inferred data format.</p>",
"refs": {
"DetectedS3SourceConfig$FileFormatDescriptor": "<p>The source's file format descriptor.</p>"
}
},
"DetectedJsonFormatDescriptor": {
"base": "<p>A detected JSON format descriptor.</p>",
"refs": {
"DetectedFileFormatDescriptor$JsonFormatDescriptor": "<p>Details about a JSON format.</p>"
}
},
"DetectedMetricSetConfig": {
"base": "<p>An inferred dataset configuration.</p>",
"refs": {
"DetectMetricSetConfigResponse$DetectedMetricSetConfig": "<p>The inferred dataset configuration for the datasource.</p>"
}
},
"DetectedMetricSource": {
"base": "<p>An inferred data source.</p>",
"refs": {
"DetectedMetricSetConfig$MetricSource": "<p>The dataset's data source.</p>"
}
},
"DetectedS3SourceConfig": {
"base": "<p>An inferred source configuration.</p>",
"refs": {
"DetectedMetricSource$S3SourceConfig": "<p>The data source's source configuration.</p>"
}
},
"DimensionContribution": {
"base": "<p>Details about a dimension that contributed to an anomaly.</p>",
"refs": {
"DimensionContributionList$member": null
}
},
"DimensionContributionList": {
"base": null,
"refs": {
"ContributionMatrix$DimensionContributionList": "<p>A list of contributing dimensions.</p>"
}
},
"DimensionFilter": {
"base": "<p>The dimension filter, containing DimensionName and DimensionValueList.</p>",
"refs": {
"DimensionFilterList$member": null
}
},
"DimensionFilterList": {
"base": null,
"refs": {
"AlertFilters$DimensionFilterList": "<p>The list of DimensionFilter objects that are used for dimension-based filtering.</p>"
}
},
"DimensionList": {
"base": null,
"refs": {
"CreateMetricSetRequest$DimensionList": "<p>A list of the fields you want to treat as dimensions.</p>",
"DescribeMetricSetResponse$DimensionList": "<p>A list of the dimensions chosen for analysis.</p>",
"UpdateMetricSetRequest$DimensionList": "<p>The dimension list.</p>"
}
},
"DimensionNameValue": {
"base": "<p>A dimension name and value.</p>",
"refs": {
"DimensionNameValueList$member": null
}
},
"DimensionNameValueList": {
"base": null,
"refs": {
"TimeSeries$DimensionList": "<p>The dimensions of the metric.</p>"
}
},
"DimensionValue": {
"base": null,
"refs": {
"DimensionNameValue$DimensionValue": "<p>The value of the dimension.</p>",
"DimensionValueContribution$DimensionValue": "<p>The value of the dimension.</p>",
"DimensionValueList$member": null,
"Filter$DimensionValue": "<p>The value that you want to include in the filter.</p>"
}
},
"DimensionValueContribution": {
"base": "<p>The severity of a value of a dimension that contributed to an anomaly.</p>",
"refs": {
"DimensionValueContributionList$member": null
}
},
"DimensionValueContributionList": {
"base": null,
"refs": {
"DimensionContribution$DimensionValueContributionList": "<p>A list of dimension values that contributed to the anomaly.</p>"
}
},
"DimensionValueList": {
"base": null,
"refs": {
"DimensionFilter$DimensionValueList": "<p>The list of values for the dimension specified in DimensionName that you want to filter on.</p>"
}
},
"Double": {
"base": null,
"refs": {
"DataQualityMetric$MetricValue": "<p>The value of the data quality metric.</p>"
}
},
"ErrorMessage": {
"base": null,
"refs": {
"DescribeAnomalyDetectorResponse$FailureReason": "<p>The reason that the detector failed.</p>"
}
},
"ExecutionList": {
"base": null,
"refs": {
"DescribeAnomalyDetectionExecutionsResponse$ExecutionList": "<p>A list of detection jobs.</p>"
}
},
"ExecutionStatus": {
"base": "<p>The status of an anomaly detector run.</p>",
"refs": {
"ExecutionList$member": null
}
},
"FieldName": {
"base": null,
"refs": {
"ValidationExceptionField$Name": "<p>The name of the field.</p>"
}
},
"FileFormatDescriptor": {
"base": "<p>Contains information about a source file's formatting.</p>",
"refs": {
"S3SourceConfig$FileFormatDescriptor": "<p>Contains information about a source file's formatting.</p>",
"SampleDataS3SourceConfig$FileFormatDescriptor": null
}
},
"Filter": {
"base": "<p>Describes a filter for choosing a subset of dimension values. Each filter consists of the dimension that you want to include and the condition statement. The condition statement is specified in the <code>FilterOperation</code> object.</p>",
"refs": {
"FilterList$member": null
}
},
"FilterList": {
"base": null,
"refs": {
"MetricSetDimensionFilter$FilterList": "<p>The list of filters that you are applying.</p>"
}
},
"FilterOperation": {
"base": null,
"refs": {
"Filter$FilterOperation": "<p>The condition to apply.</p>"
}
},
"FlowName": {
"base": null,
"refs": {
"AppFlowConfig$FlowName": "<p> name of the flow.</p>"
}
},
"Frequency": {
"base": null,
"refs": {
"AnomalyDetectorConfig$AnomalyDetectorFrequency": "<p>The frequency at which the detector analyzes its source data.</p>",
"AnomalyDetectorConfigSummary$AnomalyDetectorFrequency": "<p>The interval at which the detector analyzes its source data.</p>",
"CreateMetricSetRequest$MetricSetFrequency": "<p>The frequency with which the source data will be analyzed for anomalies.</p>",
"DescribeMetricSetResponse$MetricSetFrequency": "<p>The interval at which the data will be analyzed for anomalies.</p>",
"UpdateMetricSetRequest$MetricSetFrequency": "<p>The dataset's interval.</p>"
}
},
"GetAnomalyGroupRequest": {
"base": null,
"refs": {
}
},
"GetAnomalyGroupResponse": {
"base": null,
"refs": {
}
},
"GetDataQualityMetricsRequest": {
"base": null,
"refs": {
}
},
"GetDataQualityMetricsResponse": {
"base": null,
"refs": {
}
},
"GetFeedbackRequest": {
"base": null,
"refs": {
}
},
"GetFeedbackResponse": {
"base": null,
"refs": {
}
},
"GetSampleDataRequest": {
"base": null,
"refs": {
}
},
"GetSampleDataResponse": {
"base": null,
"refs": {
}
},
"HeaderList": {
"base": null,
"refs": {
"CsvFormatDescriptor$HeaderList": "<p>A list of the source CSV file's headers, if any.</p>"
}
},
"HeaderValue": {
"base": null,
"refs": {
"HeaderValueList$member": null
}
},
"HeaderValueList": {
"base": null,
"refs": {
"GetSampleDataResponse$HeaderValues": "<p>A list of header labels for the records.</p>"
}
},
"HistoricalDataPath": {
"base": null,
"refs": {
"HistoricalDataPathList$member": null
}
},
"HistoricalDataPathList": {
"base": null,
"refs": {
"AutoDetectionS3SourceConfig$HistoricalDataPathList": "<p>The config's historical data path list.</p>",
"S3SourceConfig$HistoricalDataPathList": "<p>A list of paths to the historical data files.</p>",
"SampleDataS3SourceConfig$HistoricalDataPathList": "<p>An array of strings containing the historical set of data paths.</p>"
}
},
"Integer": {
"base": null,
"refs": {
"AnomalyGroupStatistics$TotalCount": "<p>The number of groups found.</p>",
"ItemizedMetricStats$OccurrenceCount": "<p>The number of times that the measure appears.</p>",
"MetricLevelImpact$NumTimeSeries": "<p>The number of anomalous metrics for the measure.</p>"
}
},
"InterMetricImpactDetails": {
"base": "<p>Aggregated details about the measures contributing to the anomaly group, and the measures potentially impacted by the anomaly group.</p> <p/>",
"refs": {
"InterMetricImpactList$member": null
}
},
"InterMetricImpactList": {
"base": null,
"refs": {
"ListAnomalyGroupRelatedMetricsResponse$InterMetricImpactList": "<p>Aggregated details about the measures contributing to the anomaly group, and the measures potentially impacted by the anomaly group.</p>"
}
},
"InternalServerException": {
"base": "<p>The request processing has failed because of an unknown error, exception, or failure.</p>",
"refs": {
}
},
"ItemizedMetricStats": {
"base": "<p>Aggregated statistics about a measure affected by an anomaly.</p>",
"refs": {
"ItemizedMetricStatsList$member": null
}
},
"ItemizedMetricStatsList": {
"base": null,
"refs": {
"AnomalyGroupStatistics$ItemizedMetricStatsList": "<p>Statistics for individual metrics within the group.</p>"
}
},
"JsonFileCompression": {
"base": null,
"refs": {
"JsonFormatDescriptor$FileCompression": "<p>The level of compression of the source CSV file.</p>"
}
},
"JsonFormatDescriptor": {
"base": "<p>Contains information about how a source JSON data file should be analyzed.</p>",
"refs": {
"FileFormatDescriptor$JsonFormatDescriptor": "<p>Contains information about how a source JSON data file should be analyzed.</p>"
}
},
"KmsKeyArn": {
"base": null,
"refs": {
"CreateAnomalyDetectorRequest$KmsKeyArn": "<p>The ARN of the KMS key to use to encrypt your data.</p>",
"DescribeAnomalyDetectorResponse$KmsKeyArn": "<p>The ARN of the KMS key to use to encrypt your data.</p>",
"UpdateAnomalyDetectorRequest$KmsKeyArn": "<p>The Amazon Resource Name (ARN) of an AWS KMS encryption key.</p>"
}
},
"LambdaConfiguration": {
"base": "<p>Contains information about a Lambda configuration.</p>",
"refs": {
"Action$LambdaConfiguration": "<p>A configuration for an AWS Lambda channel.</p>"
}
},
"ListAlertsRequest": {
"base": null,
"refs": {
}
},
"ListAlertsResponse": {
"base": null,
"refs": {
}
},
"ListAnomalyDetectorsRequest": {
"base": null,
"refs": {
}
},
"ListAnomalyDetectorsResponse": {
"base": null,
"refs": {
}
},
"ListAnomalyGroupRelatedMetricsRequest": {
"base": null,
"refs": {
}
},
"ListAnomalyGroupRelatedMetricsResponse": {
"base": null,
"refs": {
}
},
"ListAnomalyGroupSummariesRequest": {
"base": null,
"refs": {
}
},
"ListAnomalyGroupSummariesResponse": {
"base": null,
"refs": {
}
},
"ListAnomalyGroupTimeSeriesRequest": {
"base": null,
"refs": {
}
},
"ListAnomalyGroupTimeSeriesResponse": {
"base": null,
"refs": {
}
},
"ListMetricSetsRequest": {
"base": null,
"refs": {
}