aws-sdk-lookoutmetrics 1.18.0 → 1.21.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-lookoutmetrics/client.rb +137 -7
- data/lib/aws-sdk-lookoutmetrics/client_api.rb +100 -1
- data/lib/aws-sdk-lookoutmetrics/types.rb +307 -10
- data/lib/aws-sdk-lookoutmetrics.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 611a3e0012b1c5023741f17f98742e04436de07023d2222dc17ba9be64a59ab7
|
4
|
+
data.tar.gz: c499352aafe83441dd1fdc09ba545c3289602d00ea635d3162bb23807b958e9b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a59f5e5e360406d787dc3b9eb96e672a37e2d84486817ff9962b8684e37003c17b4efdd28818c968028224483c76e60590fa8893d9cbcee5dc56e3e7f63d2c0c
|
7
|
+
data.tar.gz: ebc173c6018884e92b2098436cea40a8f3b891bfd9c7213cd2ff5b039bf0b7af7bc6a3777c8290cef6b35cc333e1fd0654ab59189d17c59bb6ff48f8ebff5fcd
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,21 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.21.0 (2022-08-19)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release is to make GetDataQualityMetrics API publicly available.
|
8
|
+
|
9
|
+
1.20.0 (2022-06-14)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Adding filters to Alert and adding new UpdateAlert API.
|
13
|
+
|
14
|
+
1.19.0 (2022-05-31)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Adding backtest mode to detectors using the Cloudwatch data source.
|
18
|
+
|
4
19
|
1.18.0 (2022-05-25)
|
5
20
|
------------------
|
6
21
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.21.0
|
@@ -400,7 +400,7 @@ module Aws::LookoutMetrics
|
|
400
400
|
# @option params [required, String] :alert_name
|
401
401
|
# The name of the alert.
|
402
402
|
#
|
403
|
-
# @option params [
|
403
|
+
# @option params [Integer] :alert_sensitivity_threshold
|
404
404
|
# An integer from 0 to 100 specifying the alert sensitivity threshold.
|
405
405
|
#
|
406
406
|
# @option params [String] :alert_description
|
@@ -419,6 +419,10 @@ module Aws::LookoutMetrics
|
|
419
419
|
#
|
420
420
|
# [1]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html
|
421
421
|
#
|
422
|
+
# @option params [Types::AlertFilters] :alert_filters
|
423
|
+
# The configuration of the alert filters, containing MetricList and
|
424
|
+
# DimensionFilterList.
|
425
|
+
#
|
422
426
|
# @return [Types::CreateAlertResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
423
427
|
#
|
424
428
|
# * {Types::CreateAlertResponse#alert_arn #alert_arn} => String
|
@@ -427,7 +431,7 @@ module Aws::LookoutMetrics
|
|
427
431
|
#
|
428
432
|
# resp = client.create_alert({
|
429
433
|
# alert_name: "AlertName", # required
|
430
|
-
# alert_sensitivity_threshold: 1,
|
434
|
+
# alert_sensitivity_threshold: 1,
|
431
435
|
# alert_description: "AlertDescription",
|
432
436
|
# anomaly_detector_arn: "Arn", # required
|
433
437
|
# action: { # required
|
@@ -444,6 +448,15 @@ module Aws::LookoutMetrics
|
|
444
448
|
# tags: {
|
445
449
|
# "TagKey" => "TagValue",
|
446
450
|
# },
|
451
|
+
# alert_filters: {
|
452
|
+
# metric_list: ["MetricName"],
|
453
|
+
# dimension_filter_list: [
|
454
|
+
# {
|
455
|
+
# dimension_name: "ColumnName",
|
456
|
+
# dimension_value_list: ["DimensionValue"],
|
457
|
+
# },
|
458
|
+
# ],
|
459
|
+
# },
|
447
460
|
# })
|
448
461
|
#
|
449
462
|
# @example Response structure
|
@@ -527,8 +540,8 @@ module Aws::LookoutMetrics
|
|
527
540
|
#
|
528
541
|
# @option params [Integer] :offset
|
529
542
|
# After an interval ends, the amount of seconds that the detector waits
|
530
|
-
# before importing data. Offset is only supported for S3
|
531
|
-
# datasources.
|
543
|
+
# before importing data. Offset is only supported for S3, Redshift,
|
544
|
+
# Athena and datasources.
|
532
545
|
#
|
533
546
|
# @option params [Types::TimestampColumn] :timestamp_column
|
534
547
|
# Contains information about the column used for tracking time in your
|
@@ -604,6 +617,9 @@ module Aws::LookoutMetrics
|
|
604
617
|
# },
|
605
618
|
# cloud_watch_config: {
|
606
619
|
# role_arn: "Arn",
|
620
|
+
# back_test_configuration: {
|
621
|
+
# run_back_test_mode: false, # required
|
622
|
+
# },
|
607
623
|
# },
|
608
624
|
# rds_source_config: {
|
609
625
|
# db_instance_identifier: "RDSDatabaseIdentifier",
|
@@ -766,6 +782,12 @@ module Aws::LookoutMetrics
|
|
766
782
|
# resp.alert.alert_status #=> String, one of "ACTIVE", "INACTIVE"
|
767
783
|
# resp.alert.last_modification_time #=> Time
|
768
784
|
# resp.alert.creation_time #=> Time
|
785
|
+
# resp.alert.alert_filters.metric_list #=> Array
|
786
|
+
# resp.alert.alert_filters.metric_list[0] #=> String
|
787
|
+
# resp.alert.alert_filters.dimension_filter_list #=> Array
|
788
|
+
# resp.alert.alert_filters.dimension_filter_list[0].dimension_name #=> String
|
789
|
+
# resp.alert.alert_filters.dimension_filter_list[0].dimension_value_list #=> Array
|
790
|
+
# resp.alert.alert_filters.dimension_filter_list[0].dimension_value_list[0] #=> String
|
769
791
|
#
|
770
792
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DescribeAlert AWS API Documentation
|
771
793
|
#
|
@@ -944,6 +966,7 @@ module Aws::LookoutMetrics
|
|
944
966
|
# resp.metric_source.app_flow_config.role_arn #=> String
|
945
967
|
# resp.metric_source.app_flow_config.flow_name #=> String
|
946
968
|
# resp.metric_source.cloud_watch_config.role_arn #=> String
|
969
|
+
# resp.metric_source.cloud_watch_config.back_test_configuration.run_back_test_mode #=> Boolean
|
947
970
|
# resp.metric_source.rds_source_config.db_instance_identifier #=> String
|
948
971
|
# resp.metric_source.rds_source_config.database_host #=> String
|
949
972
|
# resp.metric_source.rds_source_config.database_port #=> Integer
|
@@ -1093,6 +1116,47 @@ module Aws::LookoutMetrics
|
|
1093
1116
|
req.send_request(options)
|
1094
1117
|
end
|
1095
1118
|
|
1119
|
+
# Returns details about the requested data quality metrics.
|
1120
|
+
#
|
1121
|
+
# @option params [required, String] :anomaly_detector_arn
|
1122
|
+
# The Amazon Resource Name (ARN) of the anomaly detector that you want
|
1123
|
+
# to investigate.
|
1124
|
+
#
|
1125
|
+
# @option params [String] :metric_set_arn
|
1126
|
+
# The Amazon Resource Name (ARN) of a specific data quality metric set.
|
1127
|
+
#
|
1128
|
+
# @return [Types::GetDataQualityMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1129
|
+
#
|
1130
|
+
# * {Types::GetDataQualityMetricsResponse#anomaly_detector_data_quality_metric_list #anomaly_detector_data_quality_metric_list} => Array<Types::AnomalyDetectorDataQualityMetric>
|
1131
|
+
#
|
1132
|
+
# @example Request syntax with placeholder values
|
1133
|
+
#
|
1134
|
+
# resp = client.get_data_quality_metrics({
|
1135
|
+
# anomaly_detector_arn: "Arn", # required
|
1136
|
+
# metric_set_arn: "Arn",
|
1137
|
+
# })
|
1138
|
+
#
|
1139
|
+
# @example Response structure
|
1140
|
+
#
|
1141
|
+
# resp.anomaly_detector_data_quality_metric_list #=> Array
|
1142
|
+
# resp.anomaly_detector_data_quality_metric_list[0].start_timestamp #=> Time
|
1143
|
+
# resp.anomaly_detector_data_quality_metric_list[0].metric_set_data_quality_metric_list #=> Array
|
1144
|
+
# resp.anomaly_detector_data_quality_metric_list[0].metric_set_data_quality_metric_list[0].metric_set_arn #=> String
|
1145
|
+
# resp.anomaly_detector_data_quality_metric_list[0].metric_set_data_quality_metric_list[0].data_quality_metric_list #=> Array
|
1146
|
+
# resp.anomaly_detector_data_quality_metric_list[0].metric_set_data_quality_metric_list[0].data_quality_metric_list[0].metric_type #=> String, one of "COLUMN_COMPLETENESS", "DIMENSION_UNIQUENESS", "TIME_SERIES_COUNT", "ROWS_PROCESSED", "ROWS_PARTIAL_COMPLIANCE", "INVALID_ROWS_COMPLIANCE", "BACKTEST_TRAINING_DATA_START_TIME_STAMP", "BACKTEST_TRAINING_DATA_END_TIME_STAMP", "BACKTEST_INFERENCE_DATA_START_TIME_STAMP", "BACKTEST_INFERENCE_DATA_END_TIME_STAMP"
|
1147
|
+
# resp.anomaly_detector_data_quality_metric_list[0].metric_set_data_quality_metric_list[0].data_quality_metric_list[0].metric_description #=> String
|
1148
|
+
# resp.anomaly_detector_data_quality_metric_list[0].metric_set_data_quality_metric_list[0].data_quality_metric_list[0].related_column_name #=> String
|
1149
|
+
# resp.anomaly_detector_data_quality_metric_list[0].metric_set_data_quality_metric_list[0].data_quality_metric_list[0].metric_value #=> Float
|
1150
|
+
#
|
1151
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/GetDataQualityMetrics AWS API Documentation
|
1152
|
+
#
|
1153
|
+
# @overload get_data_quality_metrics(params = {})
|
1154
|
+
# @param [Hash] params ({})
|
1155
|
+
def get_data_quality_metrics(params = {}, options = {})
|
1156
|
+
req = build_request(:get_data_quality_metrics, params)
|
1157
|
+
req.send_request(options)
|
1158
|
+
end
|
1159
|
+
|
1096
1160
|
# Get feedback for an anomaly group.
|
1097
1161
|
#
|
1098
1162
|
# @option params [required, String] :anomaly_detector_arn
|
@@ -1657,6 +1721,69 @@ module Aws::LookoutMetrics
|
|
1657
1721
|
req.send_request(options)
|
1658
1722
|
end
|
1659
1723
|
|
1724
|
+
# Make changes to an existing alert.
|
1725
|
+
#
|
1726
|
+
# @option params [required, String] :alert_arn
|
1727
|
+
# The ARN of the alert to update.
|
1728
|
+
#
|
1729
|
+
# @option params [String] :alert_description
|
1730
|
+
# A description of the alert.
|
1731
|
+
#
|
1732
|
+
# @option params [Integer] :alert_sensitivity_threshold
|
1733
|
+
# An integer from 0 to 100 specifying the alert sensitivity threshold.
|
1734
|
+
#
|
1735
|
+
# @option params [Types::Action] :action
|
1736
|
+
# Action that will be triggered when there is an alert.
|
1737
|
+
#
|
1738
|
+
# @option params [Types::AlertFilters] :alert_filters
|
1739
|
+
# The configuration of the alert filters, containing MetricList and
|
1740
|
+
# DimensionFilterList.
|
1741
|
+
#
|
1742
|
+
# @return [Types::UpdateAlertResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1743
|
+
#
|
1744
|
+
# * {Types::UpdateAlertResponse#alert_arn #alert_arn} => String
|
1745
|
+
#
|
1746
|
+
# @example Request syntax with placeholder values
|
1747
|
+
#
|
1748
|
+
# resp = client.update_alert({
|
1749
|
+
# alert_arn: "Arn", # required
|
1750
|
+
# alert_description: "AlertDescription",
|
1751
|
+
# alert_sensitivity_threshold: 1,
|
1752
|
+
# action: {
|
1753
|
+
# sns_configuration: {
|
1754
|
+
# role_arn: "Arn", # required
|
1755
|
+
# sns_topic_arn: "Arn", # required
|
1756
|
+
# sns_format: "LONG_TEXT", # accepts LONG_TEXT, SHORT_TEXT, JSON
|
1757
|
+
# },
|
1758
|
+
# lambda_configuration: {
|
1759
|
+
# role_arn: "Arn", # required
|
1760
|
+
# lambda_arn: "Arn", # required
|
1761
|
+
# },
|
1762
|
+
# },
|
1763
|
+
# alert_filters: {
|
1764
|
+
# metric_list: ["MetricName"],
|
1765
|
+
# dimension_filter_list: [
|
1766
|
+
# {
|
1767
|
+
# dimension_name: "ColumnName",
|
1768
|
+
# dimension_value_list: ["DimensionValue"],
|
1769
|
+
# },
|
1770
|
+
# ],
|
1771
|
+
# },
|
1772
|
+
# })
|
1773
|
+
#
|
1774
|
+
# @example Response structure
|
1775
|
+
#
|
1776
|
+
# resp.alert_arn #=> String
|
1777
|
+
#
|
1778
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/UpdateAlert AWS API Documentation
|
1779
|
+
#
|
1780
|
+
# @overload update_alert(params = {})
|
1781
|
+
# @param [Hash] params ({})
|
1782
|
+
def update_alert(params = {}, options = {})
|
1783
|
+
req = build_request(:update_alert, params)
|
1784
|
+
req.send_request(options)
|
1785
|
+
end
|
1786
|
+
|
1660
1787
|
# Updates a detector. After activation, you can only change a
|
1661
1788
|
# detector's ingestion delay and description.
|
1662
1789
|
#
|
@@ -1714,8 +1841,8 @@ module Aws::LookoutMetrics
|
|
1714
1841
|
#
|
1715
1842
|
# @option params [Integer] :offset
|
1716
1843
|
# After an interval ends, the amount of seconds that the detector waits
|
1717
|
-
# before importing data. Offset is only supported for S3
|
1718
|
-
# datasources.
|
1844
|
+
# before importing data. Offset is only supported for S3, Redshift,
|
1845
|
+
# Athena and datasources.
|
1719
1846
|
#
|
1720
1847
|
# @option params [Types::TimestampColumn] :timestamp_column
|
1721
1848
|
# The timestamp column.
|
@@ -1778,6 +1905,9 @@ module Aws::LookoutMetrics
|
|
1778
1905
|
# },
|
1779
1906
|
# cloud_watch_config: {
|
1780
1907
|
# role_arn: "Arn",
|
1908
|
+
# back_test_configuration: {
|
1909
|
+
# run_back_test_mode: false, # required
|
1910
|
+
# },
|
1781
1911
|
# },
|
1782
1912
|
# rds_source_config: {
|
1783
1913
|
# db_instance_identifier: "RDSDatabaseIdentifier",
|
@@ -1845,7 +1975,7 @@ module Aws::LookoutMetrics
|
|
1845
1975
|
params: params,
|
1846
1976
|
config: config)
|
1847
1977
|
context[:gem_name] = 'aws-sdk-lookoutmetrics'
|
1848
|
-
context[:gem_version] = '1.
|
1978
|
+
context[:gem_version] = '1.21.0'
|
1849
1979
|
Seahorse::Client::Request.new(handlers, context)
|
1850
1980
|
end
|
1851
1981
|
|
@@ -20,6 +20,7 @@ module Aws::LookoutMetrics
|
|
20
20
|
AggregationFunction = Shapes::StringShape.new(name: 'AggregationFunction')
|
21
21
|
Alert = Shapes::StructureShape.new(name: 'Alert')
|
22
22
|
AlertDescription = Shapes::StringShape.new(name: 'AlertDescription')
|
23
|
+
AlertFilters = Shapes::StructureShape.new(name: 'AlertFilters')
|
23
24
|
AlertName = Shapes::StringShape.new(name: 'AlertName')
|
24
25
|
AlertStatus = Shapes::StringShape.new(name: 'AlertStatus')
|
25
26
|
AlertSummary = Shapes::StructureShape.new(name: 'AlertSummary')
|
@@ -29,6 +30,8 @@ module Aws::LookoutMetrics
|
|
29
30
|
AnomalyDetectionTaskStatusMessage = Shapes::StringShape.new(name: 'AnomalyDetectionTaskStatusMessage')
|
30
31
|
AnomalyDetectorConfig = Shapes::StructureShape.new(name: 'AnomalyDetectorConfig')
|
31
32
|
AnomalyDetectorConfigSummary = Shapes::StructureShape.new(name: 'AnomalyDetectorConfigSummary')
|
33
|
+
AnomalyDetectorDataQualityMetric = Shapes::StructureShape.new(name: 'AnomalyDetectorDataQualityMetric')
|
34
|
+
AnomalyDetectorDataQualityMetricList = Shapes::ListShape.new(name: 'AnomalyDetectorDataQualityMetricList')
|
32
35
|
AnomalyDetectorDescription = Shapes::StringShape.new(name: 'AnomalyDetectorDescription')
|
33
36
|
AnomalyDetectorFailureType = Shapes::StringShape.new(name: 'AnomalyDetectorFailureType')
|
34
37
|
AnomalyDetectorName = Shapes::StringShape.new(name: 'AnomalyDetectorName')
|
@@ -73,6 +76,10 @@ module Aws::LookoutMetrics
|
|
73
76
|
CreateMetricSetResponse = Shapes::StructureShape.new(name: 'CreateMetricSetResponse')
|
74
77
|
CsvFormatDescriptor = Shapes::StructureShape.new(name: 'CsvFormatDescriptor')
|
75
78
|
DataItem = Shapes::StringShape.new(name: 'DataItem')
|
79
|
+
DataQualityMetric = Shapes::StructureShape.new(name: 'DataQualityMetric')
|
80
|
+
DataQualityMetricDescription = Shapes::StringShape.new(name: 'DataQualityMetricDescription')
|
81
|
+
DataQualityMetricList = Shapes::ListShape.new(name: 'DataQualityMetricList')
|
82
|
+
DataQualityMetricType = Shapes::StringShape.new(name: 'DataQualityMetricType')
|
76
83
|
DatabaseHost = Shapes::StringShape.new(name: 'DatabaseHost')
|
77
84
|
DatabasePort = Shapes::IntegerShape.new(name: 'DatabasePort')
|
78
85
|
DateTimeFormat = Shapes::StringShape.new(name: 'DateTimeFormat')
|
@@ -102,12 +109,16 @@ module Aws::LookoutMetrics
|
|
102
109
|
DetectedS3SourceConfig = Shapes::StructureShape.new(name: 'DetectedS3SourceConfig')
|
103
110
|
DimensionContribution = Shapes::StructureShape.new(name: 'DimensionContribution')
|
104
111
|
DimensionContributionList = Shapes::ListShape.new(name: 'DimensionContributionList')
|
112
|
+
DimensionFilter = Shapes::StructureShape.new(name: 'DimensionFilter')
|
113
|
+
DimensionFilterList = Shapes::ListShape.new(name: 'DimensionFilterList')
|
105
114
|
DimensionList = Shapes::ListShape.new(name: 'DimensionList')
|
106
115
|
DimensionNameValue = Shapes::StructureShape.new(name: 'DimensionNameValue')
|
107
116
|
DimensionNameValueList = Shapes::ListShape.new(name: 'DimensionNameValueList')
|
108
117
|
DimensionValue = Shapes::StringShape.new(name: 'DimensionValue')
|
109
118
|
DimensionValueContribution = Shapes::StructureShape.new(name: 'DimensionValueContribution')
|
110
119
|
DimensionValueContributionList = Shapes::ListShape.new(name: 'DimensionValueContributionList')
|
120
|
+
DimensionValueList = Shapes::ListShape.new(name: 'DimensionValueList')
|
121
|
+
Double = Shapes::FloatShape.new(name: 'Double')
|
111
122
|
ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
|
112
123
|
ExecutionList = Shapes::ListShape.new(name: 'ExecutionList')
|
113
124
|
ExecutionStatus = Shapes::StructureShape.new(name: 'ExecutionStatus')
|
@@ -117,6 +128,8 @@ module Aws::LookoutMetrics
|
|
117
128
|
Frequency = Shapes::StringShape.new(name: 'Frequency')
|
118
129
|
GetAnomalyGroupRequest = Shapes::StructureShape.new(name: 'GetAnomalyGroupRequest')
|
119
130
|
GetAnomalyGroupResponse = Shapes::StructureShape.new(name: 'GetAnomalyGroupResponse')
|
131
|
+
GetDataQualityMetricsRequest = Shapes::StructureShape.new(name: 'GetDataQualityMetricsRequest')
|
132
|
+
GetDataQualityMetricsResponse = Shapes::StructureShape.new(name: 'GetDataQualityMetricsResponse')
|
120
133
|
GetFeedbackRequest = Shapes::StructureShape.new(name: 'GetFeedbackRequest')
|
121
134
|
GetFeedbackResponse = Shapes::StructureShape.new(name: 'GetFeedbackResponse')
|
122
135
|
GetSampleDataRequest = Shapes::StructureShape.new(name: 'GetSampleDataRequest')
|
@@ -158,6 +171,9 @@ module Aws::LookoutMetrics
|
|
158
171
|
MetricLevelImpactList = Shapes::ListShape.new(name: 'MetricLevelImpactList')
|
159
172
|
MetricList = Shapes::ListShape.new(name: 'MetricList')
|
160
173
|
MetricName = Shapes::StringShape.new(name: 'MetricName')
|
174
|
+
MetricNameList = Shapes::ListShape.new(name: 'MetricNameList')
|
175
|
+
MetricSetDataQualityMetric = Shapes::StructureShape.new(name: 'MetricSetDataQualityMetric')
|
176
|
+
MetricSetDataQualityMetricList = Shapes::ListShape.new(name: 'MetricSetDataQualityMetricList')
|
161
177
|
MetricSetDescription = Shapes::StringShape.new(name: 'MetricSetDescription')
|
162
178
|
MetricSetName = Shapes::StringShape.new(name: 'MetricSetName')
|
163
179
|
MetricSetSummary = Shapes::StructureShape.new(name: 'MetricSetSummary')
|
@@ -181,6 +197,7 @@ module Aws::LookoutMetrics
|
|
181
197
|
RedshiftClusterIdentifier = Shapes::StringShape.new(name: 'RedshiftClusterIdentifier')
|
182
198
|
RedshiftDatabaseName = Shapes::StringShape.new(name: 'RedshiftDatabaseName')
|
183
199
|
RedshiftSourceConfig = Shapes::StructureShape.new(name: 'RedshiftSourceConfig')
|
200
|
+
RelatedColumnName = Shapes::StringShape.new(name: 'RelatedColumnName')
|
184
201
|
RelationshipType = Shapes::StringShape.new(name: 'RelationshipType')
|
185
202
|
ResourceId = Shapes::StringShape.new(name: 'ResourceId')
|
186
203
|
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
@@ -224,6 +241,8 @@ module Aws::LookoutMetrics
|
|
224
241
|
UUID = Shapes::StringShape.new(name: 'UUID')
|
225
242
|
UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
|
226
243
|
UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
|
244
|
+
UpdateAlertRequest = Shapes::StructureShape.new(name: 'UpdateAlertRequest')
|
245
|
+
UpdateAlertResponse = Shapes::StructureShape.new(name: 'UpdateAlertResponse')
|
227
246
|
UpdateAnomalyDetectorRequest = Shapes::StructureShape.new(name: 'UpdateAnomalyDetectorRequest')
|
228
247
|
UpdateAnomalyDetectorResponse = Shapes::StructureShape.new(name: 'UpdateAnomalyDetectorResponse')
|
229
248
|
UpdateMetricSetRequest = Shapes::StructureShape.new(name: 'UpdateMetricSetRequest')
|
@@ -256,8 +275,13 @@ module Aws::LookoutMetrics
|
|
256
275
|
Alert.add_member(:alert_status, Shapes::ShapeRef.new(shape: AlertStatus, location_name: "AlertStatus"))
|
257
276
|
Alert.add_member(:last_modification_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastModificationTime"))
|
258
277
|
Alert.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreationTime"))
|
278
|
+
Alert.add_member(:alert_filters, Shapes::ShapeRef.new(shape: AlertFilters, location_name: "AlertFilters"))
|
259
279
|
Alert.struct_class = Types::Alert
|
260
280
|
|
281
|
+
AlertFilters.add_member(:metric_list, Shapes::ShapeRef.new(shape: MetricNameList, location_name: "MetricList"))
|
282
|
+
AlertFilters.add_member(:dimension_filter_list, Shapes::ShapeRef.new(shape: DimensionFilterList, location_name: "DimensionFilterList"))
|
283
|
+
AlertFilters.struct_class = Types::AlertFilters
|
284
|
+
|
261
285
|
AlertSummary.add_member(:alert_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "AlertArn"))
|
262
286
|
AlertSummary.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "AnomalyDetectorArn"))
|
263
287
|
AlertSummary.add_member(:alert_name, Shapes::ShapeRef.new(shape: AlertName, location_name: "AlertName"))
|
@@ -277,6 +301,12 @@ module Aws::LookoutMetrics
|
|
277
301
|
AnomalyDetectorConfigSummary.add_member(:anomaly_detector_frequency, Shapes::ShapeRef.new(shape: Frequency, location_name: "AnomalyDetectorFrequency"))
|
278
302
|
AnomalyDetectorConfigSummary.struct_class = Types::AnomalyDetectorConfigSummary
|
279
303
|
|
304
|
+
AnomalyDetectorDataQualityMetric.add_member(:start_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "StartTimestamp"))
|
305
|
+
AnomalyDetectorDataQualityMetric.add_member(:metric_set_data_quality_metric_list, Shapes::ShapeRef.new(shape: MetricSetDataQualityMetricList, location_name: "MetricSetDataQualityMetricList"))
|
306
|
+
AnomalyDetectorDataQualityMetric.struct_class = Types::AnomalyDetectorDataQualityMetric
|
307
|
+
|
308
|
+
AnomalyDetectorDataQualityMetricList.member = Shapes::ShapeRef.new(shape: AnomalyDetectorDataQualityMetric)
|
309
|
+
|
280
310
|
AnomalyDetectorSummary.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "AnomalyDetectorArn"))
|
281
311
|
AnomalyDetectorSummary.add_member(:anomaly_detector_name, Shapes::ShapeRef.new(shape: AnomalyDetectorName, location_name: "AnomalyDetectorName"))
|
282
312
|
AnomalyDetectorSummary.add_member(:anomaly_detector_description, Shapes::ShapeRef.new(shape: AnomalyDetectorDescription, location_name: "AnomalyDetectorDescription"))
|
@@ -358,6 +388,7 @@ module Aws::LookoutMetrics
|
|
358
388
|
BinaryListAttributeValue.member = Shapes::ShapeRef.new(shape: BinaryAttributeValue)
|
359
389
|
|
360
390
|
CloudWatchConfig.add_member(:role_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "RoleArn"))
|
391
|
+
CloudWatchConfig.add_member(:back_test_configuration, Shapes::ShapeRef.new(shape: BackTestConfiguration, location_name: "BackTestConfiguration"))
|
361
392
|
CloudWatchConfig.struct_class = Types::CloudWatchConfig
|
362
393
|
|
363
394
|
ConflictException.add_member(:message, Shapes::ShapeRef.new(shape: Message, required: true, location_name: "Message"))
|
@@ -369,11 +400,12 @@ module Aws::LookoutMetrics
|
|
369
400
|
ContributionMatrix.struct_class = Types::ContributionMatrix
|
370
401
|
|
371
402
|
CreateAlertRequest.add_member(:alert_name, Shapes::ShapeRef.new(shape: AlertName, required: true, location_name: "AlertName"))
|
372
|
-
CreateAlertRequest.add_member(:alert_sensitivity_threshold, Shapes::ShapeRef.new(shape: SensitivityThreshold,
|
403
|
+
CreateAlertRequest.add_member(:alert_sensitivity_threshold, Shapes::ShapeRef.new(shape: SensitivityThreshold, location_name: "AlertSensitivityThreshold"))
|
373
404
|
CreateAlertRequest.add_member(:alert_description, Shapes::ShapeRef.new(shape: AlertDescription, location_name: "AlertDescription"))
|
374
405
|
CreateAlertRequest.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "AnomalyDetectorArn"))
|
375
406
|
CreateAlertRequest.add_member(:action, Shapes::ShapeRef.new(shape: Action, required: true, location_name: "Action"))
|
376
407
|
CreateAlertRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
|
408
|
+
CreateAlertRequest.add_member(:alert_filters, Shapes::ShapeRef.new(shape: AlertFilters, location_name: "AlertFilters"))
|
377
409
|
CreateAlertRequest.struct_class = Types::CreateAlertRequest
|
378
410
|
|
379
411
|
CreateAlertResponse.add_member(:alert_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "AlertArn"))
|
@@ -413,6 +445,14 @@ module Aws::LookoutMetrics
|
|
413
445
|
CsvFormatDescriptor.add_member(:quote_symbol, Shapes::ShapeRef.new(shape: QuoteSymbol, location_name: "QuoteSymbol"))
|
414
446
|
CsvFormatDescriptor.struct_class = Types::CsvFormatDescriptor
|
415
447
|
|
448
|
+
DataQualityMetric.add_member(:metric_type, Shapes::ShapeRef.new(shape: DataQualityMetricType, location_name: "MetricType"))
|
449
|
+
DataQualityMetric.add_member(:metric_description, Shapes::ShapeRef.new(shape: DataQualityMetricDescription, location_name: "MetricDescription"))
|
450
|
+
DataQualityMetric.add_member(:related_column_name, Shapes::ShapeRef.new(shape: RelatedColumnName, location_name: "RelatedColumnName"))
|
451
|
+
DataQualityMetric.add_member(:metric_value, Shapes::ShapeRef.new(shape: Double, location_name: "MetricValue"))
|
452
|
+
DataQualityMetric.struct_class = Types::DataQualityMetric
|
453
|
+
|
454
|
+
DataQualityMetricList.member = Shapes::ShapeRef.new(shape: DataQualityMetric)
|
455
|
+
|
416
456
|
DeactivateAnomalyDetectorRequest.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "AnomalyDetectorArn"))
|
417
457
|
DeactivateAnomalyDetectorRequest.struct_class = Types::DeactivateAnomalyDetectorRequest
|
418
458
|
|
@@ -522,6 +562,12 @@ module Aws::LookoutMetrics
|
|
522
562
|
|
523
563
|
DimensionContributionList.member = Shapes::ShapeRef.new(shape: DimensionContribution)
|
524
564
|
|
565
|
+
DimensionFilter.add_member(:dimension_name, Shapes::ShapeRef.new(shape: ColumnName, location_name: "DimensionName"))
|
566
|
+
DimensionFilter.add_member(:dimension_value_list, Shapes::ShapeRef.new(shape: DimensionValueList, location_name: "DimensionValueList"))
|
567
|
+
DimensionFilter.struct_class = Types::DimensionFilter
|
568
|
+
|
569
|
+
DimensionFilterList.member = Shapes::ShapeRef.new(shape: DimensionFilter)
|
570
|
+
|
525
571
|
DimensionList.member = Shapes::ShapeRef.new(shape: ColumnName)
|
526
572
|
|
527
573
|
DimensionNameValue.add_member(:dimension_name, Shapes::ShapeRef.new(shape: ColumnName, required: true, location_name: "DimensionName"))
|
@@ -536,6 +582,8 @@ module Aws::LookoutMetrics
|
|
536
582
|
|
537
583
|
DimensionValueContributionList.member = Shapes::ShapeRef.new(shape: DimensionValueContribution)
|
538
584
|
|
585
|
+
DimensionValueList.member = Shapes::ShapeRef.new(shape: DimensionValue)
|
586
|
+
|
539
587
|
ExecutionList.member = Shapes::ShapeRef.new(shape: ExecutionStatus)
|
540
588
|
|
541
589
|
ExecutionStatus.add_member(:timestamp, Shapes::ShapeRef.new(shape: TimestampString, location_name: "Timestamp"))
|
@@ -554,6 +602,13 @@ module Aws::LookoutMetrics
|
|
554
602
|
GetAnomalyGroupResponse.add_member(:anomaly_group, Shapes::ShapeRef.new(shape: AnomalyGroup, location_name: "AnomalyGroup"))
|
555
603
|
GetAnomalyGroupResponse.struct_class = Types::GetAnomalyGroupResponse
|
556
604
|
|
605
|
+
GetDataQualityMetricsRequest.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "AnomalyDetectorArn"))
|
606
|
+
GetDataQualityMetricsRequest.add_member(:metric_set_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "MetricSetArn"))
|
607
|
+
GetDataQualityMetricsRequest.struct_class = Types::GetDataQualityMetricsRequest
|
608
|
+
|
609
|
+
GetDataQualityMetricsResponse.add_member(:anomaly_detector_data_quality_metric_list, Shapes::ShapeRef.new(shape: AnomalyDetectorDataQualityMetricList, location_name: "AnomalyDetectorDataQualityMetricList"))
|
610
|
+
GetDataQualityMetricsResponse.struct_class = Types::GetDataQualityMetricsResponse
|
611
|
+
|
557
612
|
GetFeedbackRequest.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "AnomalyDetectorArn"))
|
558
613
|
GetFeedbackRequest.add_member(:anomaly_group_time_series_feedback, Shapes::ShapeRef.new(shape: AnomalyGroupTimeSeries, required: true, location_name: "AnomalyGroupTimeSeriesFeedback"))
|
559
614
|
GetFeedbackRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults", metadata: {"box"=>true}))
|
@@ -684,6 +739,14 @@ module Aws::LookoutMetrics
|
|
684
739
|
|
685
740
|
MetricList.member = Shapes::ShapeRef.new(shape: Metric)
|
686
741
|
|
742
|
+
MetricNameList.member = Shapes::ShapeRef.new(shape: MetricName)
|
743
|
+
|
744
|
+
MetricSetDataQualityMetric.add_member(:metric_set_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "MetricSetArn"))
|
745
|
+
MetricSetDataQualityMetric.add_member(:data_quality_metric_list, Shapes::ShapeRef.new(shape: DataQualityMetricList, location_name: "DataQualityMetricList"))
|
746
|
+
MetricSetDataQualityMetric.struct_class = Types::MetricSetDataQualityMetric
|
747
|
+
|
748
|
+
MetricSetDataQualityMetricList.member = Shapes::ShapeRef.new(shape: MetricSetDataQualityMetric)
|
749
|
+
|
687
750
|
MetricSetSummary.add_member(:metric_set_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "MetricSetArn"))
|
688
751
|
MetricSetSummary.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "AnomalyDetectorArn"))
|
689
752
|
MetricSetSummary.add_member(:metric_set_description, Shapes::ShapeRef.new(shape: MetricSetDescription, location_name: "MetricSetDescription"))
|
@@ -813,6 +876,16 @@ module Aws::LookoutMetrics
|
|
813
876
|
|
814
877
|
UntagResourceResponse.struct_class = Types::UntagResourceResponse
|
815
878
|
|
879
|
+
UpdateAlertRequest.add_member(:alert_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "AlertArn"))
|
880
|
+
UpdateAlertRequest.add_member(:alert_description, Shapes::ShapeRef.new(shape: AlertDescription, location_name: "AlertDescription"))
|
881
|
+
UpdateAlertRequest.add_member(:alert_sensitivity_threshold, Shapes::ShapeRef.new(shape: SensitivityThreshold, location_name: "AlertSensitivityThreshold"))
|
882
|
+
UpdateAlertRequest.add_member(:action, Shapes::ShapeRef.new(shape: Action, location_name: "Action"))
|
883
|
+
UpdateAlertRequest.add_member(:alert_filters, Shapes::ShapeRef.new(shape: AlertFilters, location_name: "AlertFilters"))
|
884
|
+
UpdateAlertRequest.struct_class = Types::UpdateAlertRequest
|
885
|
+
|
886
|
+
UpdateAlertResponse.add_member(:alert_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "AlertArn"))
|
887
|
+
UpdateAlertResponse.struct_class = Types::UpdateAlertResponse
|
888
|
+
|
816
889
|
UpdateAnomalyDetectorRequest.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "AnomalyDetectorArn"))
|
817
890
|
UpdateAnomalyDetectorRequest.add_member(:kms_key_arn, Shapes::ShapeRef.new(shape: KmsKeyArn, location_name: "KmsKeyArn"))
|
818
891
|
UpdateAnomalyDetectorRequest.add_member(:anomaly_detector_description, Shapes::ShapeRef.new(shape: AnomalyDetectorDescription, location_name: "AnomalyDetectorDescription"))
|
@@ -1066,6 +1139,19 @@ module Aws::LookoutMetrics
|
|
1066
1139
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1067
1140
|
end)
|
1068
1141
|
|
1142
|
+
api.add_operation(:get_data_quality_metrics, Seahorse::Model::Operation.new.tap do |o|
|
1143
|
+
o.name = "GetDataQualityMetrics"
|
1144
|
+
o.http_method = "POST"
|
1145
|
+
o.http_request_uri = "/GetDataQualityMetrics"
|
1146
|
+
o.input = Shapes::ShapeRef.new(shape: GetDataQualityMetricsRequest)
|
1147
|
+
o.output = Shapes::ShapeRef.new(shape: GetDataQualityMetricsResponse)
|
1148
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1149
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1150
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1151
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1152
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1153
|
+
end)
|
1154
|
+
|
1069
1155
|
api.add_operation(:get_feedback, Seahorse::Model::Operation.new.tap do |o|
|
1070
1156
|
o.name = "GetFeedback"
|
1071
1157
|
o.http_method = "POST"
|
@@ -1258,6 +1344,19 @@ module Aws::LookoutMetrics
|
|
1258
1344
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1259
1345
|
end)
|
1260
1346
|
|
1347
|
+
api.add_operation(:update_alert, Seahorse::Model::Operation.new.tap do |o|
|
1348
|
+
o.name = "UpdateAlert"
|
1349
|
+
o.http_method = "POST"
|
1350
|
+
o.http_request_uri = "/UpdateAlert"
|
1351
|
+
o.input = Shapes::ShapeRef.new(shape: UpdateAlertRequest)
|
1352
|
+
o.output = Shapes::ShapeRef.new(shape: UpdateAlertResponse)
|
1353
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1354
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1355
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1356
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1357
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1358
|
+
end)
|
1359
|
+
|
1261
1360
|
api.add_operation(:update_anomaly_detector, Seahorse::Model::Operation.new.tap do |o|
|
1262
1361
|
o.name = "UpdateAnomalyDetector"
|
1263
1362
|
o.http_method = "POST"
|
@@ -123,6 +123,11 @@ module Aws::LookoutMetrics
|
|
123
123
|
# The time at which the alert was created.
|
124
124
|
# @return [Time]
|
125
125
|
#
|
126
|
+
# @!attribute [rw] alert_filters
|
127
|
+
# The configuration of the alert filters, containing MetricList and
|
128
|
+
# DimensionFilter.
|
129
|
+
# @return [Types::AlertFilters]
|
130
|
+
#
|
126
131
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/Alert AWS API Documentation
|
127
132
|
#
|
128
133
|
class Alert < Struct.new(
|
@@ -135,7 +140,41 @@ module Aws::LookoutMetrics
|
|
135
140
|
:alert_type,
|
136
141
|
:alert_status,
|
137
142
|
:last_modification_time,
|
138
|
-
:creation_time
|
143
|
+
:creation_time,
|
144
|
+
:alert_filters)
|
145
|
+
SENSITIVE = []
|
146
|
+
include Aws::Structure
|
147
|
+
end
|
148
|
+
|
149
|
+
# The configuration of the alert filters.
|
150
|
+
#
|
151
|
+
# @note When making an API call, you may pass AlertFilters
|
152
|
+
# data as a hash:
|
153
|
+
#
|
154
|
+
# {
|
155
|
+
# metric_list: ["MetricName"],
|
156
|
+
# dimension_filter_list: [
|
157
|
+
# {
|
158
|
+
# dimension_name: "ColumnName",
|
159
|
+
# dimension_value_list: ["DimensionValue"],
|
160
|
+
# },
|
161
|
+
# ],
|
162
|
+
# }
|
163
|
+
#
|
164
|
+
# @!attribute [rw] metric_list
|
165
|
+
# The list of measures that you want to get alerts for.
|
166
|
+
# @return [Array<String>]
|
167
|
+
#
|
168
|
+
# @!attribute [rw] dimension_filter_list
|
169
|
+
# The list of DimensionFilter objects that are used for
|
170
|
+
# dimension-based filtering.
|
171
|
+
# @return [Array<Types::DimensionFilter>]
|
172
|
+
#
|
173
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/AlertFilters AWS API Documentation
|
174
|
+
#
|
175
|
+
class AlertFilters < Struct.new(
|
176
|
+
:metric_list,
|
177
|
+
:dimension_filter_list)
|
139
178
|
SENSITIVE = []
|
140
179
|
include Aws::Structure
|
141
180
|
end
|
@@ -233,6 +272,27 @@ module Aws::LookoutMetrics
|
|
233
272
|
include Aws::Structure
|
234
273
|
end
|
235
274
|
|
275
|
+
# Aggregated details about the data quality metrics collected for the
|
276
|
+
# `AnomalyDetectorArn` provided in the GetDataQualityMetrics object.
|
277
|
+
#
|
278
|
+
# @!attribute [rw] start_timestamp
|
279
|
+
# The start time for the data quality metrics collection.
|
280
|
+
# @return [Time]
|
281
|
+
#
|
282
|
+
# @!attribute [rw] metric_set_data_quality_metric_list
|
283
|
+
# An array of `DataQualityMetricList` objects. Each object in the
|
284
|
+
# array contains information about a data quality metric.
|
285
|
+
# @return [Array<Types::MetricSetDataQualityMetric>]
|
286
|
+
#
|
287
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/AnomalyDetectorDataQualityMetric AWS API Documentation
|
288
|
+
#
|
289
|
+
class AnomalyDetectorDataQualityMetric < Struct.new(
|
290
|
+
:start_timestamp,
|
291
|
+
:metric_set_data_quality_metric_list)
|
292
|
+
SENSITIVE = []
|
293
|
+
include Aws::Structure
|
294
|
+
end
|
295
|
+
|
236
296
|
# Contains information about an an anomaly detector.
|
237
297
|
#
|
238
298
|
# @!attribute [rw] anomaly_detector_arn
|
@@ -667,6 +727,9 @@ module Aws::LookoutMetrics
|
|
667
727
|
#
|
668
728
|
# {
|
669
729
|
# role_arn: "Arn",
|
730
|
+
# back_test_configuration: {
|
731
|
+
# run_back_test_mode: false, # required
|
732
|
+
# },
|
670
733
|
# }
|
671
734
|
#
|
672
735
|
# @!attribute [rw] role_arn
|
@@ -674,10 +737,15 @@ module Aws::LookoutMetrics
|
|
674
737
|
# access data in Amazon CloudWatch.
|
675
738
|
# @return [String]
|
676
739
|
#
|
740
|
+
# @!attribute [rw] back_test_configuration
|
741
|
+
# Settings for backtest mode.
|
742
|
+
# @return [Types::BackTestConfiguration]
|
743
|
+
#
|
677
744
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/CloudWatchConfig AWS API Documentation
|
678
745
|
#
|
679
746
|
class CloudWatchConfig < Struct.new(
|
680
|
-
:role_arn
|
747
|
+
:role_arn,
|
748
|
+
:back_test_configuration)
|
681
749
|
SENSITIVE = []
|
682
750
|
include Aws::Structure
|
683
751
|
end
|
@@ -724,7 +792,7 @@ module Aws::LookoutMetrics
|
|
724
792
|
#
|
725
793
|
# {
|
726
794
|
# alert_name: "AlertName", # required
|
727
|
-
# alert_sensitivity_threshold: 1,
|
795
|
+
# alert_sensitivity_threshold: 1,
|
728
796
|
# alert_description: "AlertDescription",
|
729
797
|
# anomaly_detector_arn: "Arn", # required
|
730
798
|
# action: { # required
|
@@ -741,6 +809,15 @@ module Aws::LookoutMetrics
|
|
741
809
|
# tags: {
|
742
810
|
# "TagKey" => "TagValue",
|
743
811
|
# },
|
812
|
+
# alert_filters: {
|
813
|
+
# metric_list: ["MetricName"],
|
814
|
+
# dimension_filter_list: [
|
815
|
+
# {
|
816
|
+
# dimension_name: "ColumnName",
|
817
|
+
# dimension_value_list: ["DimensionValue"],
|
818
|
+
# },
|
819
|
+
# ],
|
820
|
+
# },
|
744
821
|
# }
|
745
822
|
#
|
746
823
|
# @!attribute [rw] alert_name
|
@@ -771,6 +848,11 @@ module Aws::LookoutMetrics
|
|
771
848
|
# [1]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html
|
772
849
|
# @return [Hash<String,String>]
|
773
850
|
#
|
851
|
+
# @!attribute [rw] alert_filters
|
852
|
+
# The configuration of the alert filters, containing MetricList and
|
853
|
+
# DimensionFilterList.
|
854
|
+
# @return [Types::AlertFilters]
|
855
|
+
#
|
774
856
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/CreateAlertRequest AWS API Documentation
|
775
857
|
#
|
776
858
|
class CreateAlertRequest < Struct.new(
|
@@ -779,7 +861,8 @@ module Aws::LookoutMetrics
|
|
779
861
|
:alert_description,
|
780
862
|
:anomaly_detector_arn,
|
781
863
|
:action,
|
782
|
-
:tags
|
864
|
+
:tags,
|
865
|
+
:alert_filters)
|
783
866
|
SENSITIVE = []
|
784
867
|
include Aws::Structure
|
785
868
|
end
|
@@ -907,6 +990,9 @@ module Aws::LookoutMetrics
|
|
907
990
|
# },
|
908
991
|
# cloud_watch_config: {
|
909
992
|
# role_arn: "Arn",
|
993
|
+
# back_test_configuration: {
|
994
|
+
# run_back_test_mode: false, # required
|
995
|
+
# },
|
910
996
|
# },
|
911
997
|
# rds_source_config: {
|
912
998
|
# db_instance_identifier: "RDSDatabaseIdentifier",
|
@@ -970,8 +1056,8 @@ module Aws::LookoutMetrics
|
|
970
1056
|
#
|
971
1057
|
# @!attribute [rw] offset
|
972
1058
|
# After an interval ends, the amount of seconds that the detector
|
973
|
-
# waits before importing data. Offset is only supported for S3
|
974
|
-
# Redshift datasources.
|
1059
|
+
# waits before importing data. Offset is only supported for S3,
|
1060
|
+
# Redshift, Athena and datasources.
|
975
1061
|
# @return [Integer]
|
976
1062
|
#
|
977
1063
|
# @!attribute [rw] timestamp_column
|
@@ -1087,6 +1173,37 @@ module Aws::LookoutMetrics
|
|
1087
1173
|
include Aws::Structure
|
1088
1174
|
end
|
1089
1175
|
|
1176
|
+
# An array that describes a data quality metric. Each
|
1177
|
+
# `DataQualityMetric` object contains the data quality metric name, its
|
1178
|
+
# value, a description of the metric, and the affected column.
|
1179
|
+
#
|
1180
|
+
# @!attribute [rw] metric_type
|
1181
|
+
# The name of the data quality metric.
|
1182
|
+
# @return [String]
|
1183
|
+
#
|
1184
|
+
# @!attribute [rw] metric_description
|
1185
|
+
# A description of the data quality metric.
|
1186
|
+
# @return [String]
|
1187
|
+
#
|
1188
|
+
# @!attribute [rw] related_column_name
|
1189
|
+
# The column that is being monitored.
|
1190
|
+
# @return [String]
|
1191
|
+
#
|
1192
|
+
# @!attribute [rw] metric_value
|
1193
|
+
# The value of the data quality metric.
|
1194
|
+
# @return [Float]
|
1195
|
+
#
|
1196
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DataQualityMetric AWS API Documentation
|
1197
|
+
#
|
1198
|
+
class DataQualityMetric < Struct.new(
|
1199
|
+
:metric_type,
|
1200
|
+
:metric_description,
|
1201
|
+
:related_column_name,
|
1202
|
+
:metric_value)
|
1203
|
+
SENSITIVE = []
|
1204
|
+
include Aws::Structure
|
1205
|
+
end
|
1206
|
+
|
1090
1207
|
# @note When making an API call, you may pass DeactivateAnomalyDetectorRequest
|
1091
1208
|
# data as a hash:
|
1092
1209
|
#
|
@@ -1362,8 +1479,9 @@ module Aws::LookoutMetrics
|
|
1362
1479
|
# @return [Time]
|
1363
1480
|
#
|
1364
1481
|
# @!attribute [rw] offset
|
1365
|
-
#
|
1366
|
-
#
|
1482
|
+
# After an interval ends, the amount of seconds that the detector
|
1483
|
+
# waits before importing data. Offset is only supported for S3,
|
1484
|
+
# Redshift, Athena and datasources.
|
1367
1485
|
# @return [Integer]
|
1368
1486
|
#
|
1369
1487
|
# @!attribute [rw] metric_list
|
@@ -1625,6 +1743,34 @@ module Aws::LookoutMetrics
|
|
1625
1743
|
include Aws::Structure
|
1626
1744
|
end
|
1627
1745
|
|
1746
|
+
# The dimension filter, containing DimensionName and DimensionValueList.
|
1747
|
+
#
|
1748
|
+
# @note When making an API call, you may pass DimensionFilter
|
1749
|
+
# data as a hash:
|
1750
|
+
#
|
1751
|
+
# {
|
1752
|
+
# dimension_name: "ColumnName",
|
1753
|
+
# dimension_value_list: ["DimensionValue"],
|
1754
|
+
# }
|
1755
|
+
#
|
1756
|
+
# @!attribute [rw] dimension_name
|
1757
|
+
# The name of the dimension to filter on.
|
1758
|
+
# @return [String]
|
1759
|
+
#
|
1760
|
+
# @!attribute [rw] dimension_value_list
|
1761
|
+
# The list of values for the dimension specified in DimensionName that
|
1762
|
+
# you want to filter on.
|
1763
|
+
# @return [Array<String>]
|
1764
|
+
#
|
1765
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DimensionFilter AWS API Documentation
|
1766
|
+
#
|
1767
|
+
class DimensionFilter < Struct.new(
|
1768
|
+
:dimension_name,
|
1769
|
+
:dimension_value_list)
|
1770
|
+
SENSITIVE = []
|
1771
|
+
include Aws::Structure
|
1772
|
+
end
|
1773
|
+
|
1628
1774
|
# A dimension name and value.
|
1629
1775
|
#
|
1630
1776
|
# @!attribute [rw] dimension_name
|
@@ -1763,6 +1909,46 @@ module Aws::LookoutMetrics
|
|
1763
1909
|
include Aws::Structure
|
1764
1910
|
end
|
1765
1911
|
|
1912
|
+
# @note When making an API call, you may pass GetDataQualityMetricsRequest
|
1913
|
+
# data as a hash:
|
1914
|
+
#
|
1915
|
+
# {
|
1916
|
+
# anomaly_detector_arn: "Arn", # required
|
1917
|
+
# metric_set_arn: "Arn",
|
1918
|
+
# }
|
1919
|
+
#
|
1920
|
+
# @!attribute [rw] anomaly_detector_arn
|
1921
|
+
# The Amazon Resource Name (ARN) of the anomaly detector that you want
|
1922
|
+
# to investigate.
|
1923
|
+
# @return [String]
|
1924
|
+
#
|
1925
|
+
# @!attribute [rw] metric_set_arn
|
1926
|
+
# The Amazon Resource Name (ARN) of a specific data quality metric
|
1927
|
+
# set.
|
1928
|
+
# @return [String]
|
1929
|
+
#
|
1930
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/GetDataQualityMetricsRequest AWS API Documentation
|
1931
|
+
#
|
1932
|
+
class GetDataQualityMetricsRequest < Struct.new(
|
1933
|
+
:anomaly_detector_arn,
|
1934
|
+
:metric_set_arn)
|
1935
|
+
SENSITIVE = []
|
1936
|
+
include Aws::Structure
|
1937
|
+
end
|
1938
|
+
|
1939
|
+
# @!attribute [rw] anomaly_detector_data_quality_metric_list
|
1940
|
+
# A list of the data quality metrics for the `AnomalyDetectorArn` that
|
1941
|
+
# you requested.
|
1942
|
+
# @return [Array<Types::AnomalyDetectorDataQualityMetric>]
|
1943
|
+
#
|
1944
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/GetDataQualityMetricsResponse AWS API Documentation
|
1945
|
+
#
|
1946
|
+
class GetDataQualityMetricsResponse < Struct.new(
|
1947
|
+
:anomaly_detector_data_quality_metric_list)
|
1948
|
+
SENSITIVE = []
|
1949
|
+
include Aws::Structure
|
1950
|
+
end
|
1951
|
+
|
1766
1952
|
# @note When making an API call, you may pass GetFeedbackRequest
|
1767
1953
|
# data as a hash:
|
1768
1954
|
#
|
@@ -2436,6 +2622,27 @@ module Aws::LookoutMetrics
|
|
2436
2622
|
include Aws::Structure
|
2437
2623
|
end
|
2438
2624
|
|
2625
|
+
# An array of `DataQualityMetric` objects that describes one or more
|
2626
|
+
# data quality metrics.
|
2627
|
+
#
|
2628
|
+
# @!attribute [rw] metric_set_arn
|
2629
|
+
# The Amazon Resource Name (ARN) of the data quality metric array.
|
2630
|
+
# @return [String]
|
2631
|
+
#
|
2632
|
+
# @!attribute [rw] data_quality_metric_list
|
2633
|
+
# The array of data quality metrics contained in the data quality
|
2634
|
+
# metric set.
|
2635
|
+
# @return [Array<Types::DataQualityMetric>]
|
2636
|
+
#
|
2637
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/MetricSetDataQualityMetric AWS API Documentation
|
2638
|
+
#
|
2639
|
+
class MetricSetDataQualityMetric < Struct.new(
|
2640
|
+
:metric_set_arn,
|
2641
|
+
:data_quality_metric_list)
|
2642
|
+
SENSITIVE = []
|
2643
|
+
include Aws::Structure
|
2644
|
+
end
|
2645
|
+
|
2439
2646
|
# Contains information about a dataset.
|
2440
2647
|
#
|
2441
2648
|
# @!attribute [rw] metric_set_arn
|
@@ -2515,6 +2722,9 @@ module Aws::LookoutMetrics
|
|
2515
2722
|
# },
|
2516
2723
|
# cloud_watch_config: {
|
2517
2724
|
# role_arn: "Arn",
|
2725
|
+
# back_test_configuration: {
|
2726
|
+
# run_back_test_mode: false, # required
|
2727
|
+
# },
|
2518
2728
|
# },
|
2519
2729
|
# rds_source_config: {
|
2520
2730
|
# db_instance_identifier: "RDSDatabaseIdentifier",
|
@@ -2863,6 +3073,16 @@ module Aws::LookoutMetrics
|
|
2863
3073
|
#
|
2864
3074
|
# @!attribute [rw] sns_format
|
2865
3075
|
# The format of the SNS topic.
|
3076
|
+
#
|
3077
|
+
# * `JSON` – Send JSON alerts with an anomaly ID and a link to the
|
3078
|
+
# anomaly detail page. This is the default.
|
3079
|
+
#
|
3080
|
+
# * `LONG_TEXT` – Send human-readable alerts with information about
|
3081
|
+
# the impacted timeseries and a link to the anomaly detail page. We
|
3082
|
+
# recommend this for email.
|
3083
|
+
#
|
3084
|
+
# * `SHORT_TEXT` – Send human-readable alerts with a link to the
|
3085
|
+
# anomaly detail page. We recommend this for SMS.
|
2866
3086
|
# @return [String]
|
2867
3087
|
#
|
2868
3088
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/SNSConfiguration AWS API Documentation
|
@@ -3109,6 +3329,80 @@ module Aws::LookoutMetrics
|
|
3109
3329
|
#
|
3110
3330
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
3111
3331
|
|
3332
|
+
# @note When making an API call, you may pass UpdateAlertRequest
|
3333
|
+
# data as a hash:
|
3334
|
+
#
|
3335
|
+
# {
|
3336
|
+
# alert_arn: "Arn", # required
|
3337
|
+
# alert_description: "AlertDescription",
|
3338
|
+
# alert_sensitivity_threshold: 1,
|
3339
|
+
# action: {
|
3340
|
+
# sns_configuration: {
|
3341
|
+
# role_arn: "Arn", # required
|
3342
|
+
# sns_topic_arn: "Arn", # required
|
3343
|
+
# sns_format: "LONG_TEXT", # accepts LONG_TEXT, SHORT_TEXT, JSON
|
3344
|
+
# },
|
3345
|
+
# lambda_configuration: {
|
3346
|
+
# role_arn: "Arn", # required
|
3347
|
+
# lambda_arn: "Arn", # required
|
3348
|
+
# },
|
3349
|
+
# },
|
3350
|
+
# alert_filters: {
|
3351
|
+
# metric_list: ["MetricName"],
|
3352
|
+
# dimension_filter_list: [
|
3353
|
+
# {
|
3354
|
+
# dimension_name: "ColumnName",
|
3355
|
+
# dimension_value_list: ["DimensionValue"],
|
3356
|
+
# },
|
3357
|
+
# ],
|
3358
|
+
# },
|
3359
|
+
# }
|
3360
|
+
#
|
3361
|
+
# @!attribute [rw] alert_arn
|
3362
|
+
# The ARN of the alert to update.
|
3363
|
+
# @return [String]
|
3364
|
+
#
|
3365
|
+
# @!attribute [rw] alert_description
|
3366
|
+
# A description of the alert.
|
3367
|
+
# @return [String]
|
3368
|
+
#
|
3369
|
+
# @!attribute [rw] alert_sensitivity_threshold
|
3370
|
+
# An integer from 0 to 100 specifying the alert sensitivity threshold.
|
3371
|
+
# @return [Integer]
|
3372
|
+
#
|
3373
|
+
# @!attribute [rw] action
|
3374
|
+
# Action that will be triggered when there is an alert.
|
3375
|
+
# @return [Types::Action]
|
3376
|
+
#
|
3377
|
+
# @!attribute [rw] alert_filters
|
3378
|
+
# The configuration of the alert filters, containing MetricList and
|
3379
|
+
# DimensionFilterList.
|
3380
|
+
# @return [Types::AlertFilters]
|
3381
|
+
#
|
3382
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/UpdateAlertRequest AWS API Documentation
|
3383
|
+
#
|
3384
|
+
class UpdateAlertRequest < Struct.new(
|
3385
|
+
:alert_arn,
|
3386
|
+
:alert_description,
|
3387
|
+
:alert_sensitivity_threshold,
|
3388
|
+
:action,
|
3389
|
+
:alert_filters)
|
3390
|
+
SENSITIVE = []
|
3391
|
+
include Aws::Structure
|
3392
|
+
end
|
3393
|
+
|
3394
|
+
# @!attribute [rw] alert_arn
|
3395
|
+
# The ARN of the updated alert.
|
3396
|
+
# @return [String]
|
3397
|
+
#
|
3398
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/UpdateAlertResponse AWS API Documentation
|
3399
|
+
#
|
3400
|
+
class UpdateAlertResponse < Struct.new(
|
3401
|
+
:alert_arn)
|
3402
|
+
SENSITIVE = []
|
3403
|
+
include Aws::Structure
|
3404
|
+
end
|
3405
|
+
|
3112
3406
|
# @note When making an API call, you may pass UpdateAnomalyDetectorRequest
|
3113
3407
|
# data as a hash:
|
3114
3408
|
#
|
@@ -3207,6 +3501,9 @@ module Aws::LookoutMetrics
|
|
3207
3501
|
# },
|
3208
3502
|
# cloud_watch_config: {
|
3209
3503
|
# role_arn: "Arn",
|
3504
|
+
# back_test_configuration: {
|
3505
|
+
# run_back_test_mode: false, # required
|
3506
|
+
# },
|
3210
3507
|
# },
|
3211
3508
|
# rds_source_config: {
|
3212
3509
|
# db_instance_identifier: "RDSDatabaseIdentifier",
|
@@ -3262,8 +3559,8 @@ module Aws::LookoutMetrics
|
|
3262
3559
|
#
|
3263
3560
|
# @!attribute [rw] offset
|
3264
3561
|
# After an interval ends, the amount of seconds that the detector
|
3265
|
-
# waits before importing data. Offset is only supported for S3
|
3266
|
-
# Redshift datasources.
|
3562
|
+
# waits before importing data. Offset is only supported for S3,
|
3563
|
+
# Redshift, Athena and datasources.
|
3267
3564
|
# @return [Integer]
|
3268
3565
|
#
|
3269
3566
|
# @!attribute [rw] timestamp_column
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-lookoutmetrics
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.21.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-08-19 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|