Skip to content

Commit fde0d56

Browse files
author
AWS
committed
Amazon Lookout for Metrics Update: This release is to make GetDataQualityMetrics API publicly available.
1 parent 84a2ba0 commit fde0d56

File tree

2 files changed

+139
-3
lines changed

2 files changed

+139
-3
lines changed

‎.changes/next-release/feature-AmazonLookoutforMetrics-b1aa4db.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon Lookout for Metrics",
4+
"contributor": "",
5+
"description": "This release is to make GetDataQualityMetrics API publicly available."
6+
}

‎services/lookoutmetrics/src/main/resources/codegen-resources/service-2.json

Lines changed: 133 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -260,6 +260,23 @@
260260
],
261261
"documentation":"<p>Returns details about a group of anomalous metrics.</p>"
262262
},
263+
"GetDataQualityMetrics":{
264+
"name":"GetDataQualityMetrics",
265+
"http":{
266+
"method":"POST",
267+
"requestUri":"/GetDataQualityMetrics"
268+
},
269+
"input":{"shape":"GetDataQualityMetricsRequest"},
270+
"output":{"shape":"GetDataQualityMetricsResponse"},
271+
"errors":[
272+
{"shape":"ResourceNotFoundException"},
273+
{"shape":"ValidationException"},
274+
{"shape":"AccessDeniedException"},
275+
{"shape":"TooManyRequestsException"},
276+
{"shape":"InternalServerException"}
277+
],
278+
"documentation":"<p>Returns details about the requested data quality metrics.</p>"
279+
},
263280
"GetFeedback":{
264281
"name":"GetFeedback",
265282
"http":{
@@ -732,6 +749,24 @@
732749
},
733750
"documentation":"<p>Contains information about a detector's configuration.</p>"
734751
},
752+
"AnomalyDetectorDataQualityMetric":{
753+
"type":"structure",
754+
"members":{
755+
"StartTimestamp":{
756+
"shape":"Timestamp",
757+
"documentation":"<p>The start time for the data quality metrics collection.</p>"
758+
},
759+
"MetricSetDataQualityMetricList":{
760+
"shape":"MetricSetDataQualityMetricList",
761+
"documentation":"<p>An array of <code>DataQualityMetricList</code> objects. Each object in the array contains information about a data quality metric.</p>"
762+
}
763+
},
764+
"documentation":"<p>Aggregated details about the data quality metrics collected for the <code>AnomalyDetectorArn</code> provided in the <a>GetDataQualityMetrics</a> object.</p>"
765+
},
766+
"AnomalyDetectorDataQualityMetricList":{
767+
"type":"list",
768+
"member":{"shape":"AnomalyDetectorDataQualityMetric"}
769+
},
735770
"AnomalyDetectorDescription":{
736771
"type":"string",
737772
"max":256,
@@ -1271,7 +1306,7 @@
12711306
},
12721307
"Offset":{
12731308
"shape":"Offset",
1274-
"documentation":"<p>After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3 and Redshift datasources.</p>",
1309+
"documentation":"<p>After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.</p>",
12751310
"box":true
12761311
},
12771312
"TimestampColumn":{
@@ -1340,6 +1375,53 @@
13401375
"documentation":"<p>Contains information about how a source CSV data file should be analyzed.</p>"
13411376
},
13421377
"DataItem":{"type":"string"},
1378+
"DataQualityMetric":{
1379+
"type":"structure",
1380+
"members":{
1381+
"MetricType":{
1382+
"shape":"DataQualityMetricType",
1383+
"documentation":"<p>The name of the data quality metric.</p>"
1384+
},
1385+
"MetricDescription":{
1386+
"shape":"DataQualityMetricDescription",
1387+
"documentation":"<p>A description of the data quality metric.</p>"
1388+
},
1389+
"RelatedColumnName":{
1390+
"shape":"RelatedColumnName",
1391+
"documentation":"<p>The column that is being monitored.</p>"
1392+
},
1393+
"MetricValue":{
1394+
"shape":"Double",
1395+
"documentation":"<p>The value of the data quality metric.</p>"
1396+
}
1397+
},
1398+
"documentation":"<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>"
1399+
},
1400+
"DataQualityMetricDescription":{
1401+
"type":"string",
1402+
"max":256,
1403+
"min":1,
1404+
"pattern":".*\\S.*"
1405+
},
1406+
"DataQualityMetricList":{
1407+
"type":"list",
1408+
"member":{"shape":"DataQualityMetric"}
1409+
},
1410+
"DataQualityMetricType":{
1411+
"type":"string",
1412+
"enum":[
1413+
"COLUMN_COMPLETENESS",
1414+
"DIMENSION_UNIQUENESS",
1415+
"TIME_SERIES_COUNT",
1416+
"ROWS_PROCESSED",
1417+
"ROWS_PARTIAL_COMPLIANCE",
1418+
"INVALID_ROWS_COMPLIANCE",
1419+
"BACKTEST_TRAINING_DATA_START_TIME_STAMP",
1420+
"BACKTEST_TRAINING_DATA_END_TIME_STAMP",
1421+
"BACKTEST_INFERENCE_DATA_START_TIME_STAMP",
1422+
"BACKTEST_INFERENCE_DATA_END_TIME_STAMP"
1423+
]
1424+
},
13431425
"DatabaseHost":{
13441426
"type":"string",
13451427
"max":253,
@@ -1555,7 +1637,7 @@
15551637
},
15561638
"Offset":{
15571639
"shape":"Offset",
1558-
"documentation":"<p>The offset in seconds. Only supported for S3 and Redshift datasources.</p>",
1640+
"documentation":"<p>After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.</p>",
15591641
"box":true
15601642
},
15611643
"MetricList":{
@@ -1814,6 +1896,7 @@
18141896
"max":10,
18151897
"min":1
18161898
},
1899+
"Double":{"type":"double"},
18171900
"ErrorMessage":{
18181901
"type":"string",
18191902
"max":256
@@ -1895,6 +1978,29 @@
18951978
}
18961979
}
18971980
},
1981+
"GetDataQualityMetricsRequest":{
1982+
"type":"structure",
1983+
"required":["AnomalyDetectorArn"],
1984+
"members":{
1985+
"AnomalyDetectorArn":{
1986+
"shape":"Arn",
1987+
"documentation":"<p>The Amazon Resource Name (ARN) of the anomaly detector that you want to investigate.</p>"
1988+
},
1989+
"MetricSetArn":{
1990+
"shape":"Arn",
1991+
"documentation":"<p>The Amazon Resource Name (ARN) of a specific data quality metric set.</p>"
1992+
}
1993+
}
1994+
},
1995+
"GetDataQualityMetricsResponse":{
1996+
"type":"structure",
1997+
"members":{
1998+
"AnomalyDetectorDataQualityMetricList":{
1999+
"shape":"AnomalyDetectorDataQualityMetricList",
2000+
"documentation":"<p>A list of the data quality metrics for the <code>AnomalyDetectorArn</code> that you requested.</p>"
2001+
}
2002+
}
2003+
},
18982004
"GetFeedbackRequest":{
18992005
"type":"structure",
19002006
"required":[
@@ -2401,6 +2507,24 @@
24012507
"max":5,
24022508
"min":1
24032509
},
2510+
"MetricSetDataQualityMetric":{
2511+
"type":"structure",
2512+
"members":{
2513+
"MetricSetArn":{
2514+
"shape":"Arn",
2515+
"documentation":"<p>The Amazon Resource Name (ARN) of the data quality metric array.</p>"
2516+
},
2517+
"DataQualityMetricList":{
2518+
"shape":"DataQualityMetricList",
2519+
"documentation":"<p>The array of data quality metrics contained in the data quality metric set.</p>"
2520+
}
2521+
},
2522+
"documentation":"<p>An array of <code>DataQualityMetric</code> objects that describes one or more data quality metrics.</p>"
2523+
},
2524+
"MetricSetDataQualityMetricList":{
2525+
"type":"list",
2526+
"member":{"shape":"MetricSetDataQualityMetric"}
2527+
},
24042528
"MetricSetDescription":{
24052529
"type":"string",
24062530
"max":256,
@@ -2640,6 +2764,12 @@
26402764
},
26412765
"documentation":"<p>Provides information about the Amazon Redshift database configuration.</p>"
26422766
},
2767+
"RelatedColumnName":{
2768+
"type":"string",
2769+
"max":256,
2770+
"min":1,
2771+
"pattern":".*\\S.*"
2772+
},
26432773
"RelationshipType":{
26442774
"type":"string",
26452775
"enum":[
@@ -3079,7 +3209,7 @@
30793209
},
30803210
"Offset":{
30813211
"shape":"Offset",
3082-
"documentation":"<p>After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3 and Redshift datasources.</p>",
3212+
"documentation":"<p>After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.</p>",
30833213
"box":true
30843214
},
30853215
"TimestampColumn":{

0 commit comments

Comments
 (0)