aws-sdk-lookoutmetrics 1.19.0 → 1.22.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 59345fbf66785eff41ce5e27028071fd1692386ccf4971410d915ffbc37da532
4
- data.tar.gz: '0794e1c7b207ce9f080c79d38dbf6e68e281d72661b94686b65e4cd62ee999be'
3
+ metadata.gz: 184a3c6d40963d05d0d1e671784f841a895c2a42763c215f5bc7bc230676bf57
4
+ data.tar.gz: 1903e4ed0c6cdfc69c5389b47da85e5985f0424bc12442477413b8ba0b370572
5
5
  SHA512:
6
- metadata.gz: d1cca1445efe1da70413424dc0eeaeb9178b96920e8f0b3e7a0a707e050e6489c1a097e28601fddc4213a0c86da4634c2c8a797e78ebcf911fff41a3323e4bc4
7
- data.tar.gz: b57f73391239f67a394106874fa974cf9a0be128439d9667bdcd91b3ece1e4d910b85979a5296fed44179db304a1a63459659ccb7ed4ea9f6a1c650ce503f597
6
+ metadata.gz: d32cf83d2bee7f42754e7f7a6b46cb23bc497d1376493b892a1ba0f5861939df37bc35e2b54698c39e08127000fc1147f8286b071255f86ff6c33d9907c9eb98
7
+ data.tar.gz: '0290662b53fe16bddb621f4354d836131ed08177e5fcd78962f5e62a99090494fe0ce11a317709881eaf0119711662a927508c1f9c0ec61680f0904a6136edbd'
data/CHANGELOG.md CHANGED
@@ -1,6 +1,21 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.22.0 (2022-09-08)
5
+ ------------------
6
+
7
+ * Feature - Release dimension value filtering feature to allow customers to define dimension filters for including only a subset of their dataset to be used by LookoutMetrics.
8
+
9
+ 1.21.0 (2022-08-19)
10
+ ------------------
11
+
12
+ * Feature - This release is to make GetDataQualityMetrics API publicly available.
13
+
14
+ 1.20.0 (2022-06-14)
15
+ ------------------
16
+
17
+ * Feature - Adding filters to Alert and adding new UpdateAlert API.
18
+
4
19
  1.19.0 (2022-05-31)
5
20
  ------------------
6
21
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.19.0
1
+ 1.22.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 [required, Integer] :alert_sensitivity_threshold
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, # required
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 and Redshift
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
@@ -554,6 +567,10 @@ module Aws::LookoutMetrics
554
567
  #
555
568
  # [1]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html
556
569
  #
570
+ # @option params [Array<Types::MetricSetDimensionFilter>] :dimension_filter_list
571
+ # A list of filters that specify which data is kept for anomaly
572
+ # detection.
573
+ #
557
574
  # @return [Types::CreateMetricSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
558
575
  #
559
576
  # * {Types::CreateMetricSetResponse#metric_set_arn #metric_set_arn} => String
@@ -650,6 +667,17 @@ module Aws::LookoutMetrics
650
667
  # tags: {
651
668
  # "TagKey" => "TagValue",
652
669
  # },
670
+ # dimension_filter_list: [
671
+ # {
672
+ # name: "ColumnName",
673
+ # filter_list: [
674
+ # {
675
+ # dimension_value: "DimensionValue",
676
+ # filter_operation: "EQUALS", # accepts EQUALS
677
+ # },
678
+ # ],
679
+ # },
680
+ # ],
653
681
  # })
654
682
  #
655
683
  # @example Response structure
@@ -769,6 +797,12 @@ module Aws::LookoutMetrics
769
797
  # resp.alert.alert_status #=> String, one of "ACTIVE", "INACTIVE"
770
798
  # resp.alert.last_modification_time #=> Time
771
799
  # resp.alert.creation_time #=> Time
800
+ # resp.alert.alert_filters.metric_list #=> Array
801
+ # resp.alert.alert_filters.metric_list[0] #=> String
802
+ # resp.alert.alert_filters.dimension_filter_list #=> Array
803
+ # resp.alert.alert_filters.dimension_filter_list[0].dimension_name #=> String
804
+ # resp.alert.alert_filters.dimension_filter_list[0].dimension_value_list #=> Array
805
+ # resp.alert.alert_filters.dimension_filter_list[0].dimension_value_list[0] #=> String
772
806
  #
773
807
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DescribeAlert AWS API Documentation
774
808
  #
@@ -904,6 +938,7 @@ module Aws::LookoutMetrics
904
938
  # * {Types::DescribeMetricSetResponse#metric_set_frequency #metric_set_frequency} => String
905
939
  # * {Types::DescribeMetricSetResponse#timezone #timezone} => String
906
940
  # * {Types::DescribeMetricSetResponse#metric_source #metric_source} => Types::MetricSource
941
+ # * {Types::DescribeMetricSetResponse#dimension_filter_list #dimension_filter_list} => Array&lt;Types::MetricSetDimensionFilter&gt;
907
942
  #
908
943
  # @example Request syntax with placeholder values
909
944
  #
@@ -977,6 +1012,11 @@ module Aws::LookoutMetrics
977
1012
  # resp.metric_source.athena_source_config.work_group_name #=> String
978
1013
  # resp.metric_source.athena_source_config.s3_results_path #=> String
979
1014
  # resp.metric_source.athena_source_config.back_test_configuration.run_back_test_mode #=> Boolean
1015
+ # resp.dimension_filter_list #=> Array
1016
+ # resp.dimension_filter_list[0].name #=> String
1017
+ # resp.dimension_filter_list[0].filter_list #=> Array
1018
+ # resp.dimension_filter_list[0].filter_list[0].dimension_value #=> String
1019
+ # resp.dimension_filter_list[0].filter_list[0].filter_operation #=> String, one of "EQUALS"
980
1020
  #
981
1021
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DescribeMetricSet AWS API Documentation
982
1022
  #
@@ -1097,6 +1137,47 @@ module Aws::LookoutMetrics
1097
1137
  req.send_request(options)
1098
1138
  end
1099
1139
 
1140
+ # Returns details about the requested data quality metrics.
1141
+ #
1142
+ # @option params [required, String] :anomaly_detector_arn
1143
+ # The Amazon Resource Name (ARN) of the anomaly detector that you want
1144
+ # to investigate.
1145
+ #
1146
+ # @option params [String] :metric_set_arn
1147
+ # The Amazon Resource Name (ARN) of a specific data quality metric set.
1148
+ #
1149
+ # @return [Types::GetDataQualityMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1150
+ #
1151
+ # * {Types::GetDataQualityMetricsResponse#anomaly_detector_data_quality_metric_list #anomaly_detector_data_quality_metric_list} => Array&lt;Types::AnomalyDetectorDataQualityMetric&gt;
1152
+ #
1153
+ # @example Request syntax with placeholder values
1154
+ #
1155
+ # resp = client.get_data_quality_metrics({
1156
+ # anomaly_detector_arn: "Arn", # required
1157
+ # metric_set_arn: "Arn",
1158
+ # })
1159
+ #
1160
+ # @example Response structure
1161
+ #
1162
+ # resp.anomaly_detector_data_quality_metric_list #=> Array
1163
+ # resp.anomaly_detector_data_quality_metric_list[0].start_timestamp #=> Time
1164
+ # resp.anomaly_detector_data_quality_metric_list[0].metric_set_data_quality_metric_list #=> Array
1165
+ # resp.anomaly_detector_data_quality_metric_list[0].metric_set_data_quality_metric_list[0].metric_set_arn #=> String
1166
+ # resp.anomaly_detector_data_quality_metric_list[0].metric_set_data_quality_metric_list[0].data_quality_metric_list #=> Array
1167
+ # 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"
1168
+ # resp.anomaly_detector_data_quality_metric_list[0].metric_set_data_quality_metric_list[0].data_quality_metric_list[0].metric_description #=> String
1169
+ # resp.anomaly_detector_data_quality_metric_list[0].metric_set_data_quality_metric_list[0].data_quality_metric_list[0].related_column_name #=> String
1170
+ # resp.anomaly_detector_data_quality_metric_list[0].metric_set_data_quality_metric_list[0].data_quality_metric_list[0].metric_value #=> Float
1171
+ #
1172
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/GetDataQualityMetrics AWS API Documentation
1173
+ #
1174
+ # @overload get_data_quality_metrics(params = {})
1175
+ # @param [Hash] params ({})
1176
+ def get_data_quality_metrics(params = {}, options = {})
1177
+ req = build_request(:get_data_quality_metrics, params)
1178
+ req.send_request(options)
1179
+ end
1180
+
1100
1181
  # Get feedback for an anomaly group.
1101
1182
  #
1102
1183
  # @option params [required, String] :anomaly_detector_arn
@@ -1661,6 +1742,69 @@ module Aws::LookoutMetrics
1661
1742
  req.send_request(options)
1662
1743
  end
1663
1744
 
1745
+ # Make changes to an existing alert.
1746
+ #
1747
+ # @option params [required, String] :alert_arn
1748
+ # The ARN of the alert to update.
1749
+ #
1750
+ # @option params [String] :alert_description
1751
+ # A description of the alert.
1752
+ #
1753
+ # @option params [Integer] :alert_sensitivity_threshold
1754
+ # An integer from 0 to 100 specifying the alert sensitivity threshold.
1755
+ #
1756
+ # @option params [Types::Action] :action
1757
+ # Action that will be triggered when there is an alert.
1758
+ #
1759
+ # @option params [Types::AlertFilters] :alert_filters
1760
+ # The configuration of the alert filters, containing MetricList and
1761
+ # DimensionFilterList.
1762
+ #
1763
+ # @return [Types::UpdateAlertResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1764
+ #
1765
+ # * {Types::UpdateAlertResponse#alert_arn #alert_arn} => String
1766
+ #
1767
+ # @example Request syntax with placeholder values
1768
+ #
1769
+ # resp = client.update_alert({
1770
+ # alert_arn: "Arn", # required
1771
+ # alert_description: "AlertDescription",
1772
+ # alert_sensitivity_threshold: 1,
1773
+ # action: {
1774
+ # sns_configuration: {
1775
+ # role_arn: "Arn", # required
1776
+ # sns_topic_arn: "Arn", # required
1777
+ # sns_format: "LONG_TEXT", # accepts LONG_TEXT, SHORT_TEXT, JSON
1778
+ # },
1779
+ # lambda_configuration: {
1780
+ # role_arn: "Arn", # required
1781
+ # lambda_arn: "Arn", # required
1782
+ # },
1783
+ # },
1784
+ # alert_filters: {
1785
+ # metric_list: ["MetricName"],
1786
+ # dimension_filter_list: [
1787
+ # {
1788
+ # dimension_name: "ColumnName",
1789
+ # dimension_value_list: ["DimensionValue"],
1790
+ # },
1791
+ # ],
1792
+ # },
1793
+ # })
1794
+ #
1795
+ # @example Response structure
1796
+ #
1797
+ # resp.alert_arn #=> String
1798
+ #
1799
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/UpdateAlert AWS API Documentation
1800
+ #
1801
+ # @overload update_alert(params = {})
1802
+ # @param [Hash] params ({})
1803
+ def update_alert(params = {}, options = {})
1804
+ req = build_request(:update_alert, params)
1805
+ req.send_request(options)
1806
+ end
1807
+
1664
1808
  # Updates a detector. After activation, you can only change a
1665
1809
  # detector's ingestion delay and description.
1666
1810
  #
@@ -1718,8 +1862,8 @@ module Aws::LookoutMetrics
1718
1862
  #
1719
1863
  # @option params [Integer] :offset
1720
1864
  # After an interval ends, the amount of seconds that the detector waits
1721
- # before importing data. Offset is only supported for S3 and Redshift
1722
- # datasources.
1865
+ # before importing data. Offset is only supported for S3, Redshift,
1866
+ # Athena and datasources.
1723
1867
  #
1724
1868
  # @option params [Types::TimestampColumn] :timestamp_column
1725
1869
  # The timestamp column.
@@ -1733,6 +1877,13 @@ module Aws::LookoutMetrics
1733
1877
  # @option params [Types::MetricSource] :metric_source
1734
1878
  # Contains information about source data used to generate metrics.
1735
1879
  #
1880
+ # @option params [Array<Types::MetricSetDimensionFilter>] :dimension_filter_list
1881
+ # Describes a list of filters for choosing specific dimensions and
1882
+ # specific values. Each filter consists of the dimension and one of its
1883
+ # values that you want to include. When multiple dimensions or values
1884
+ # are specified, the dimensions are joined with an AND operation and the
1885
+ # values are joined with an OR operation.
1886
+ #
1736
1887
  # @return [Types::UpdateMetricSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1737
1888
  #
1738
1889
  # * {Types::UpdateMetricSetResponse#metric_set_arn #metric_set_arn} => String
@@ -1824,6 +1975,17 @@ module Aws::LookoutMetrics
1824
1975
  # },
1825
1976
  # },
1826
1977
  # },
1978
+ # dimension_filter_list: [
1979
+ # {
1980
+ # name: "ColumnName",
1981
+ # filter_list: [
1982
+ # {
1983
+ # dimension_value: "DimensionValue",
1984
+ # filter_operation: "EQUALS", # accepts EQUALS
1985
+ # },
1986
+ # ],
1987
+ # },
1988
+ # ],
1827
1989
  # })
1828
1990
  #
1829
1991
  # @example Response structure
@@ -1852,7 +2014,7 @@ module Aws::LookoutMetrics
1852
2014
  params: params,
1853
2015
  config: config)
1854
2016
  context[:gem_name] = 'aws-sdk-lookoutmetrics'
1855
- context[:gem_version] = '1.19.0'
2017
+ context[:gem_version] = '1.22.0'
1856
2018
  Seahorse::Client::Request.new(handlers, context)
1857
2019
  end
1858
2020
 
@@ -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,21 +109,30 @@ 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')
114
125
  FieldName = Shapes::StringShape.new(name: 'FieldName')
115
126
  FileFormatDescriptor = Shapes::StructureShape.new(name: 'FileFormatDescriptor')
127
+ Filter = Shapes::StructureShape.new(name: 'Filter')
128
+ FilterList = Shapes::ListShape.new(name: 'FilterList')
129
+ FilterOperation = Shapes::StringShape.new(name: 'FilterOperation')
116
130
  FlowName = Shapes::StringShape.new(name: 'FlowName')
117
131
  Frequency = Shapes::StringShape.new(name: 'Frequency')
118
132
  GetAnomalyGroupRequest = Shapes::StructureShape.new(name: 'GetAnomalyGroupRequest')
119
133
  GetAnomalyGroupResponse = Shapes::StructureShape.new(name: 'GetAnomalyGroupResponse')
134
+ GetDataQualityMetricsRequest = Shapes::StructureShape.new(name: 'GetDataQualityMetricsRequest')
135
+ GetDataQualityMetricsResponse = Shapes::StructureShape.new(name: 'GetDataQualityMetricsResponse')
120
136
  GetFeedbackRequest = Shapes::StructureShape.new(name: 'GetFeedbackRequest')
121
137
  GetFeedbackResponse = Shapes::StructureShape.new(name: 'GetFeedbackResponse')
122
138
  GetSampleDataRequest = Shapes::StructureShape.new(name: 'GetSampleDataRequest')
@@ -158,7 +174,12 @@ module Aws::LookoutMetrics
158
174
  MetricLevelImpactList = Shapes::ListShape.new(name: 'MetricLevelImpactList')
159
175
  MetricList = Shapes::ListShape.new(name: 'MetricList')
160
176
  MetricName = Shapes::StringShape.new(name: 'MetricName')
177
+ MetricNameList = Shapes::ListShape.new(name: 'MetricNameList')
178
+ MetricSetDataQualityMetric = Shapes::StructureShape.new(name: 'MetricSetDataQualityMetric')
179
+ MetricSetDataQualityMetricList = Shapes::ListShape.new(name: 'MetricSetDataQualityMetricList')
161
180
  MetricSetDescription = Shapes::StringShape.new(name: 'MetricSetDescription')
181
+ MetricSetDimensionFilter = Shapes::StructureShape.new(name: 'MetricSetDimensionFilter')
182
+ MetricSetDimensionFilterList = Shapes::ListShape.new(name: 'MetricSetDimensionFilterList')
162
183
  MetricSetName = Shapes::StringShape.new(name: 'MetricSetName')
163
184
  MetricSetSummary = Shapes::StructureShape.new(name: 'MetricSetSummary')
164
185
  MetricSetSummaryList = Shapes::ListShape.new(name: 'MetricSetSummaryList')
@@ -181,6 +202,7 @@ module Aws::LookoutMetrics
181
202
  RedshiftClusterIdentifier = Shapes::StringShape.new(name: 'RedshiftClusterIdentifier')
182
203
  RedshiftDatabaseName = Shapes::StringShape.new(name: 'RedshiftDatabaseName')
183
204
  RedshiftSourceConfig = Shapes::StructureShape.new(name: 'RedshiftSourceConfig')
205
+ RelatedColumnName = Shapes::StringShape.new(name: 'RelatedColumnName')
184
206
  RelationshipType = Shapes::StringShape.new(name: 'RelationshipType')
185
207
  ResourceId = Shapes::StringShape.new(name: 'ResourceId')
186
208
  ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
@@ -224,6 +246,8 @@ module Aws::LookoutMetrics
224
246
  UUID = Shapes::StringShape.new(name: 'UUID')
225
247
  UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
226
248
  UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
249
+ UpdateAlertRequest = Shapes::StructureShape.new(name: 'UpdateAlertRequest')
250
+ UpdateAlertResponse = Shapes::StructureShape.new(name: 'UpdateAlertResponse')
227
251
  UpdateAnomalyDetectorRequest = Shapes::StructureShape.new(name: 'UpdateAnomalyDetectorRequest')
228
252
  UpdateAnomalyDetectorResponse = Shapes::StructureShape.new(name: 'UpdateAnomalyDetectorResponse')
229
253
  UpdateMetricSetRequest = Shapes::StructureShape.new(name: 'UpdateMetricSetRequest')
@@ -256,8 +280,13 @@ module Aws::LookoutMetrics
256
280
  Alert.add_member(:alert_status, Shapes::ShapeRef.new(shape: AlertStatus, location_name: "AlertStatus"))
257
281
  Alert.add_member(:last_modification_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastModificationTime"))
258
282
  Alert.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreationTime"))
283
+ Alert.add_member(:alert_filters, Shapes::ShapeRef.new(shape: AlertFilters, location_name: "AlertFilters"))
259
284
  Alert.struct_class = Types::Alert
260
285
 
286
+ AlertFilters.add_member(:metric_list, Shapes::ShapeRef.new(shape: MetricNameList, location_name: "MetricList"))
287
+ AlertFilters.add_member(:dimension_filter_list, Shapes::ShapeRef.new(shape: DimensionFilterList, location_name: "DimensionFilterList"))
288
+ AlertFilters.struct_class = Types::AlertFilters
289
+
261
290
  AlertSummary.add_member(:alert_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "AlertArn"))
262
291
  AlertSummary.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "AnomalyDetectorArn"))
263
292
  AlertSummary.add_member(:alert_name, Shapes::ShapeRef.new(shape: AlertName, location_name: "AlertName"))
@@ -277,6 +306,12 @@ module Aws::LookoutMetrics
277
306
  AnomalyDetectorConfigSummary.add_member(:anomaly_detector_frequency, Shapes::ShapeRef.new(shape: Frequency, location_name: "AnomalyDetectorFrequency"))
278
307
  AnomalyDetectorConfigSummary.struct_class = Types::AnomalyDetectorConfigSummary
279
308
 
309
+ AnomalyDetectorDataQualityMetric.add_member(:start_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "StartTimestamp"))
310
+ AnomalyDetectorDataQualityMetric.add_member(:metric_set_data_quality_metric_list, Shapes::ShapeRef.new(shape: MetricSetDataQualityMetricList, location_name: "MetricSetDataQualityMetricList"))
311
+ AnomalyDetectorDataQualityMetric.struct_class = Types::AnomalyDetectorDataQualityMetric
312
+
313
+ AnomalyDetectorDataQualityMetricList.member = Shapes::ShapeRef.new(shape: AnomalyDetectorDataQualityMetric)
314
+
280
315
  AnomalyDetectorSummary.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "AnomalyDetectorArn"))
281
316
  AnomalyDetectorSummary.add_member(:anomaly_detector_name, Shapes::ShapeRef.new(shape: AnomalyDetectorName, location_name: "AnomalyDetectorName"))
282
317
  AnomalyDetectorSummary.add_member(:anomaly_detector_description, Shapes::ShapeRef.new(shape: AnomalyDetectorDescription, location_name: "AnomalyDetectorDescription"))
@@ -370,11 +405,12 @@ module Aws::LookoutMetrics
370
405
  ContributionMatrix.struct_class = Types::ContributionMatrix
371
406
 
372
407
  CreateAlertRequest.add_member(:alert_name, Shapes::ShapeRef.new(shape: AlertName, required: true, location_name: "AlertName"))
373
- CreateAlertRequest.add_member(:alert_sensitivity_threshold, Shapes::ShapeRef.new(shape: SensitivityThreshold, required: true, location_name: "AlertSensitivityThreshold"))
408
+ CreateAlertRequest.add_member(:alert_sensitivity_threshold, Shapes::ShapeRef.new(shape: SensitivityThreshold, location_name: "AlertSensitivityThreshold"))
374
409
  CreateAlertRequest.add_member(:alert_description, Shapes::ShapeRef.new(shape: AlertDescription, location_name: "AlertDescription"))
375
410
  CreateAlertRequest.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "AnomalyDetectorArn"))
376
411
  CreateAlertRequest.add_member(:action, Shapes::ShapeRef.new(shape: Action, required: true, location_name: "Action"))
377
412
  CreateAlertRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
413
+ CreateAlertRequest.add_member(:alert_filters, Shapes::ShapeRef.new(shape: AlertFilters, location_name: "AlertFilters"))
378
414
  CreateAlertRequest.struct_class = Types::CreateAlertRequest
379
415
 
380
416
  CreateAlertResponse.add_member(:alert_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "AlertArn"))
@@ -401,6 +437,7 @@ module Aws::LookoutMetrics
401
437
  CreateMetricSetRequest.add_member(:metric_source, Shapes::ShapeRef.new(shape: MetricSource, required: true, location_name: "MetricSource"))
402
438
  CreateMetricSetRequest.add_member(:timezone, Shapes::ShapeRef.new(shape: Timezone, location_name: "Timezone"))
403
439
  CreateMetricSetRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
440
+ CreateMetricSetRequest.add_member(:dimension_filter_list, Shapes::ShapeRef.new(shape: MetricSetDimensionFilterList, location_name: "DimensionFilterList"))
404
441
  CreateMetricSetRequest.struct_class = Types::CreateMetricSetRequest
405
442
 
406
443
  CreateMetricSetResponse.add_member(:metric_set_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "MetricSetArn"))
@@ -414,6 +451,14 @@ module Aws::LookoutMetrics
414
451
  CsvFormatDescriptor.add_member(:quote_symbol, Shapes::ShapeRef.new(shape: QuoteSymbol, location_name: "QuoteSymbol"))
415
452
  CsvFormatDescriptor.struct_class = Types::CsvFormatDescriptor
416
453
 
454
+ DataQualityMetric.add_member(:metric_type, Shapes::ShapeRef.new(shape: DataQualityMetricType, location_name: "MetricType"))
455
+ DataQualityMetric.add_member(:metric_description, Shapes::ShapeRef.new(shape: DataQualityMetricDescription, location_name: "MetricDescription"))
456
+ DataQualityMetric.add_member(:related_column_name, Shapes::ShapeRef.new(shape: RelatedColumnName, location_name: "RelatedColumnName"))
457
+ DataQualityMetric.add_member(:metric_value, Shapes::ShapeRef.new(shape: Double, location_name: "MetricValue"))
458
+ DataQualityMetric.struct_class = Types::DataQualityMetric
459
+
460
+ DataQualityMetricList.member = Shapes::ShapeRef.new(shape: DataQualityMetric)
461
+
417
462
  DeactivateAnomalyDetectorRequest.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "AnomalyDetectorArn"))
418
463
  DeactivateAnomalyDetectorRequest.struct_class = Types::DeactivateAnomalyDetectorRequest
419
464
 
@@ -476,6 +521,7 @@ module Aws::LookoutMetrics
476
521
  DescribeMetricSetResponse.add_member(:metric_set_frequency, Shapes::ShapeRef.new(shape: Frequency, location_name: "MetricSetFrequency"))
477
522
  DescribeMetricSetResponse.add_member(:timezone, Shapes::ShapeRef.new(shape: Timezone, location_name: "Timezone"))
478
523
  DescribeMetricSetResponse.add_member(:metric_source, Shapes::ShapeRef.new(shape: MetricSource, location_name: "MetricSource"))
524
+ DescribeMetricSetResponse.add_member(:dimension_filter_list, Shapes::ShapeRef.new(shape: MetricSetDimensionFilterList, location_name: "DimensionFilterList"))
479
525
  DescribeMetricSetResponse.struct_class = Types::DescribeMetricSetResponse
480
526
 
481
527
  DetectMetricSetConfigRequest.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "AnomalyDetectorArn"))
@@ -523,6 +569,12 @@ module Aws::LookoutMetrics
523
569
 
524
570
  DimensionContributionList.member = Shapes::ShapeRef.new(shape: DimensionContribution)
525
571
 
572
+ DimensionFilter.add_member(:dimension_name, Shapes::ShapeRef.new(shape: ColumnName, location_name: "DimensionName"))
573
+ DimensionFilter.add_member(:dimension_value_list, Shapes::ShapeRef.new(shape: DimensionValueList, location_name: "DimensionValueList"))
574
+ DimensionFilter.struct_class = Types::DimensionFilter
575
+
576
+ DimensionFilterList.member = Shapes::ShapeRef.new(shape: DimensionFilter)
577
+
526
578
  DimensionList.member = Shapes::ShapeRef.new(shape: ColumnName)
527
579
 
528
580
  DimensionNameValue.add_member(:dimension_name, Shapes::ShapeRef.new(shape: ColumnName, required: true, location_name: "DimensionName"))
@@ -537,6 +589,8 @@ module Aws::LookoutMetrics
537
589
 
538
590
  DimensionValueContributionList.member = Shapes::ShapeRef.new(shape: DimensionValueContribution)
539
591
 
592
+ DimensionValueList.member = Shapes::ShapeRef.new(shape: DimensionValue)
593
+
540
594
  ExecutionList.member = Shapes::ShapeRef.new(shape: ExecutionStatus)
541
595
 
542
596
  ExecutionStatus.add_member(:timestamp, Shapes::ShapeRef.new(shape: TimestampString, location_name: "Timestamp"))
@@ -548,6 +602,12 @@ module Aws::LookoutMetrics
548
602
  FileFormatDescriptor.add_member(:json_format_descriptor, Shapes::ShapeRef.new(shape: JsonFormatDescriptor, location_name: "JsonFormatDescriptor"))
549
603
  FileFormatDescriptor.struct_class = Types::FileFormatDescriptor
550
604
 
605
+ Filter.add_member(:dimension_value, Shapes::ShapeRef.new(shape: DimensionValue, location_name: "DimensionValue"))
606
+ Filter.add_member(:filter_operation, Shapes::ShapeRef.new(shape: FilterOperation, location_name: "FilterOperation"))
607
+ Filter.struct_class = Types::Filter
608
+
609
+ FilterList.member = Shapes::ShapeRef.new(shape: Filter)
610
+
551
611
  GetAnomalyGroupRequest.add_member(:anomaly_group_id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "AnomalyGroupId"))
552
612
  GetAnomalyGroupRequest.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "AnomalyDetectorArn"))
553
613
  GetAnomalyGroupRequest.struct_class = Types::GetAnomalyGroupRequest
@@ -555,6 +615,13 @@ module Aws::LookoutMetrics
555
615
  GetAnomalyGroupResponse.add_member(:anomaly_group, Shapes::ShapeRef.new(shape: AnomalyGroup, location_name: "AnomalyGroup"))
556
616
  GetAnomalyGroupResponse.struct_class = Types::GetAnomalyGroupResponse
557
617
 
618
+ GetDataQualityMetricsRequest.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "AnomalyDetectorArn"))
619
+ GetDataQualityMetricsRequest.add_member(:metric_set_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "MetricSetArn"))
620
+ GetDataQualityMetricsRequest.struct_class = Types::GetDataQualityMetricsRequest
621
+
622
+ GetDataQualityMetricsResponse.add_member(:anomaly_detector_data_quality_metric_list, Shapes::ShapeRef.new(shape: AnomalyDetectorDataQualityMetricList, location_name: "AnomalyDetectorDataQualityMetricList"))
623
+ GetDataQualityMetricsResponse.struct_class = Types::GetDataQualityMetricsResponse
624
+
558
625
  GetFeedbackRequest.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "AnomalyDetectorArn"))
559
626
  GetFeedbackRequest.add_member(:anomaly_group_time_series_feedback, Shapes::ShapeRef.new(shape: AnomalyGroupTimeSeries, required: true, location_name: "AnomalyGroupTimeSeriesFeedback"))
560
627
  GetFeedbackRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults", metadata: {"box"=>true}))
@@ -685,6 +752,20 @@ module Aws::LookoutMetrics
685
752
 
686
753
  MetricList.member = Shapes::ShapeRef.new(shape: Metric)
687
754
 
755
+ MetricNameList.member = Shapes::ShapeRef.new(shape: MetricName)
756
+
757
+ MetricSetDataQualityMetric.add_member(:metric_set_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "MetricSetArn"))
758
+ MetricSetDataQualityMetric.add_member(:data_quality_metric_list, Shapes::ShapeRef.new(shape: DataQualityMetricList, location_name: "DataQualityMetricList"))
759
+ MetricSetDataQualityMetric.struct_class = Types::MetricSetDataQualityMetric
760
+
761
+ MetricSetDataQualityMetricList.member = Shapes::ShapeRef.new(shape: MetricSetDataQualityMetric)
762
+
763
+ MetricSetDimensionFilter.add_member(:name, Shapes::ShapeRef.new(shape: ColumnName, location_name: "Name"))
764
+ MetricSetDimensionFilter.add_member(:filter_list, Shapes::ShapeRef.new(shape: FilterList, location_name: "FilterList"))
765
+ MetricSetDimensionFilter.struct_class = Types::MetricSetDimensionFilter
766
+
767
+ MetricSetDimensionFilterList.member = Shapes::ShapeRef.new(shape: MetricSetDimensionFilter)
768
+
688
769
  MetricSetSummary.add_member(:metric_set_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "MetricSetArn"))
689
770
  MetricSetSummary.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "AnomalyDetectorArn"))
690
771
  MetricSetSummary.add_member(:metric_set_description, Shapes::ShapeRef.new(shape: MetricSetDescription, location_name: "MetricSetDescription"))
@@ -814,6 +895,16 @@ module Aws::LookoutMetrics
814
895
 
815
896
  UntagResourceResponse.struct_class = Types::UntagResourceResponse
816
897
 
898
+ UpdateAlertRequest.add_member(:alert_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "AlertArn"))
899
+ UpdateAlertRequest.add_member(:alert_description, Shapes::ShapeRef.new(shape: AlertDescription, location_name: "AlertDescription"))
900
+ UpdateAlertRequest.add_member(:alert_sensitivity_threshold, Shapes::ShapeRef.new(shape: SensitivityThreshold, location_name: "AlertSensitivityThreshold"))
901
+ UpdateAlertRequest.add_member(:action, Shapes::ShapeRef.new(shape: Action, location_name: "Action"))
902
+ UpdateAlertRequest.add_member(:alert_filters, Shapes::ShapeRef.new(shape: AlertFilters, location_name: "AlertFilters"))
903
+ UpdateAlertRequest.struct_class = Types::UpdateAlertRequest
904
+
905
+ UpdateAlertResponse.add_member(:alert_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "AlertArn"))
906
+ UpdateAlertResponse.struct_class = Types::UpdateAlertResponse
907
+
817
908
  UpdateAnomalyDetectorRequest.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "AnomalyDetectorArn"))
818
909
  UpdateAnomalyDetectorRequest.add_member(:kms_key_arn, Shapes::ShapeRef.new(shape: KmsKeyArn, location_name: "KmsKeyArn"))
819
910
  UpdateAnomalyDetectorRequest.add_member(:anomaly_detector_description, Shapes::ShapeRef.new(shape: AnomalyDetectorDescription, location_name: "AnomalyDetectorDescription"))
@@ -831,6 +922,7 @@ module Aws::LookoutMetrics
831
922
  UpdateMetricSetRequest.add_member(:dimension_list, Shapes::ShapeRef.new(shape: DimensionList, location_name: "DimensionList"))
832
923
  UpdateMetricSetRequest.add_member(:metric_set_frequency, Shapes::ShapeRef.new(shape: Frequency, location_name: "MetricSetFrequency"))
833
924
  UpdateMetricSetRequest.add_member(:metric_source, Shapes::ShapeRef.new(shape: MetricSource, location_name: "MetricSource"))
925
+ UpdateMetricSetRequest.add_member(:dimension_filter_list, Shapes::ShapeRef.new(shape: MetricSetDimensionFilterList, location_name: "DimensionFilterList"))
834
926
  UpdateMetricSetRequest.struct_class = Types::UpdateMetricSetRequest
835
927
 
836
928
  UpdateMetricSetResponse.add_member(:metric_set_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "MetricSetArn"))
@@ -1067,6 +1159,19 @@ module Aws::LookoutMetrics
1067
1159
  o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
1068
1160
  end)
1069
1161
 
1162
+ api.add_operation(:get_data_quality_metrics, Seahorse::Model::Operation.new.tap do |o|
1163
+ o.name = "GetDataQualityMetrics"
1164
+ o.http_method = "POST"
1165
+ o.http_request_uri = "/GetDataQualityMetrics"
1166
+ o.input = Shapes::ShapeRef.new(shape: GetDataQualityMetricsRequest)
1167
+ o.output = Shapes::ShapeRef.new(shape: GetDataQualityMetricsResponse)
1168
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1169
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
1170
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
1171
+ o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
1172
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
1173
+ end)
1174
+
1070
1175
  api.add_operation(:get_feedback, Seahorse::Model::Operation.new.tap do |o|
1071
1176
  o.name = "GetFeedback"
1072
1177
  o.http_method = "POST"
@@ -1259,6 +1364,19 @@ module Aws::LookoutMetrics
1259
1364
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1260
1365
  end)
1261
1366
 
1367
+ api.add_operation(:update_alert, Seahorse::Model::Operation.new.tap do |o|
1368
+ o.name = "UpdateAlert"
1369
+ o.http_method = "POST"
1370
+ o.http_request_uri = "/UpdateAlert"
1371
+ o.input = Shapes::ShapeRef.new(shape: UpdateAlertRequest)
1372
+ o.output = Shapes::ShapeRef.new(shape: UpdateAlertResponse)
1373
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
1374
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1375
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
1376
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
1377
+ o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
1378
+ end)
1379
+
1262
1380
  api.add_operation(:update_anomaly_detector, Seahorse::Model::Operation.new.tap do |o|
1263
1381
  o.name = "UpdateAnomalyDetector"
1264
1382
  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
@@ -732,7 +792,7 @@ module Aws::LookoutMetrics
732
792
  #
733
793
  # {
734
794
  # alert_name: "AlertName", # required
735
- # alert_sensitivity_threshold: 1, # required
795
+ # alert_sensitivity_threshold: 1,
736
796
  # alert_description: "AlertDescription",
737
797
  # anomaly_detector_arn: "Arn", # required
738
798
  # action: { # required
@@ -749,6 +809,15 @@ module Aws::LookoutMetrics
749
809
  # tags: {
750
810
  # "TagKey" => "TagValue",
751
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
+ # },
752
821
  # }
753
822
  #
754
823
  # @!attribute [rw] alert_name
@@ -779,6 +848,11 @@ module Aws::LookoutMetrics
779
848
  # [1]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html
780
849
  # @return [Hash<String,String>]
781
850
  #
851
+ # @!attribute [rw] alert_filters
852
+ # The configuration of the alert filters, containing MetricList and
853
+ # DimensionFilterList.
854
+ # @return [Types::AlertFilters]
855
+ #
782
856
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/CreateAlertRequest AWS API Documentation
783
857
  #
784
858
  class CreateAlertRequest < Struct.new(
@@ -787,7 +861,8 @@ module Aws::LookoutMetrics
787
861
  :alert_description,
788
862
  :anomaly_detector_arn,
789
863
  :action,
790
- :tags)
864
+ :tags,
865
+ :alert_filters)
791
866
  SENSITIVE = []
792
867
  include Aws::Structure
793
868
  end
@@ -961,6 +1036,17 @@ module Aws::LookoutMetrics
961
1036
  # tags: {
962
1037
  # "TagKey" => "TagValue",
963
1038
  # },
1039
+ # dimension_filter_list: [
1040
+ # {
1041
+ # name: "ColumnName",
1042
+ # filter_list: [
1043
+ # {
1044
+ # dimension_value: "DimensionValue",
1045
+ # filter_operation: "EQUALS", # accepts EQUALS
1046
+ # },
1047
+ # ],
1048
+ # },
1049
+ # ],
964
1050
  # }
965
1051
  #
966
1052
  # @!attribute [rw] anomaly_detector_arn
@@ -981,8 +1067,8 @@ module Aws::LookoutMetrics
981
1067
  #
982
1068
  # @!attribute [rw] offset
983
1069
  # After an interval ends, the amount of seconds that the detector
984
- # waits before importing data. Offset is only supported for S3 and
985
- # Redshift datasources.
1070
+ # waits before importing data. Offset is only supported for S3,
1071
+ # Redshift, Athena and datasources.
986
1072
  # @return [Integer]
987
1073
  #
988
1074
  # @!attribute [rw] timestamp_column
@@ -1016,6 +1102,11 @@ module Aws::LookoutMetrics
1016
1102
  # [1]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html
1017
1103
  # @return [Hash<String,String>]
1018
1104
  #
1105
+ # @!attribute [rw] dimension_filter_list
1106
+ # A list of filters that specify which data is kept for anomaly
1107
+ # detection.
1108
+ # @return [Array<Types::MetricSetDimensionFilter>]
1109
+ #
1019
1110
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/CreateMetricSetRequest AWS API Documentation
1020
1111
  #
1021
1112
  class CreateMetricSetRequest < Struct.new(
@@ -1029,7 +1120,8 @@ module Aws::LookoutMetrics
1029
1120
  :metric_set_frequency,
1030
1121
  :metric_source,
1031
1122
  :timezone,
1032
- :tags)
1123
+ :tags,
1124
+ :dimension_filter_list)
1033
1125
  SENSITIVE = []
1034
1126
  include Aws::Structure
1035
1127
  end
@@ -1098,6 +1190,37 @@ module Aws::LookoutMetrics
1098
1190
  include Aws::Structure
1099
1191
  end
1100
1192
 
1193
+ # An array that describes a data quality metric. Each
1194
+ # `DataQualityMetric` object contains the data quality metric name, its
1195
+ # value, a description of the metric, and the affected column.
1196
+ #
1197
+ # @!attribute [rw] metric_type
1198
+ # The name of the data quality metric.
1199
+ # @return [String]
1200
+ #
1201
+ # @!attribute [rw] metric_description
1202
+ # A description of the data quality metric.
1203
+ # @return [String]
1204
+ #
1205
+ # @!attribute [rw] related_column_name
1206
+ # The column that is being monitored.
1207
+ # @return [String]
1208
+ #
1209
+ # @!attribute [rw] metric_value
1210
+ # The value of the data quality metric.
1211
+ # @return [Float]
1212
+ #
1213
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DataQualityMetric AWS API Documentation
1214
+ #
1215
+ class DataQualityMetric < Struct.new(
1216
+ :metric_type,
1217
+ :metric_description,
1218
+ :related_column_name,
1219
+ :metric_value)
1220
+ SENSITIVE = []
1221
+ include Aws::Structure
1222
+ end
1223
+
1101
1224
  # @note When making an API call, you may pass DeactivateAnomalyDetectorRequest
1102
1225
  # data as a hash:
1103
1226
  #
@@ -1373,8 +1496,9 @@ module Aws::LookoutMetrics
1373
1496
  # @return [Time]
1374
1497
  #
1375
1498
  # @!attribute [rw] offset
1376
- # The offset in seconds. Only supported for S3 and Redshift
1377
- # datasources.
1499
+ # After an interval ends, the amount of seconds that the detector
1500
+ # waits before importing data. Offset is only supported for S3,
1501
+ # Redshift, Athena and datasources.
1378
1502
  # @return [Integer]
1379
1503
  #
1380
1504
  # @!attribute [rw] metric_list
@@ -1402,6 +1526,11 @@ module Aws::LookoutMetrics
1402
1526
  # Contains information about the dataset's source data.
1403
1527
  # @return [Types::MetricSource]
1404
1528
  #
1529
+ # @!attribute [rw] dimension_filter_list
1530
+ # The dimensions and their values that were used to filter the
1531
+ # dataset.
1532
+ # @return [Array<Types::MetricSetDimensionFilter>]
1533
+ #
1405
1534
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DescribeMetricSetResponse AWS API Documentation
1406
1535
  #
1407
1536
  class DescribeMetricSetResponse < Struct.new(
@@ -1417,7 +1546,8 @@ module Aws::LookoutMetrics
1417
1546
  :dimension_list,
1418
1547
  :metric_set_frequency,
1419
1548
  :timezone,
1420
- :metric_source)
1549
+ :metric_source,
1550
+ :dimension_filter_list)
1421
1551
  SENSITIVE = []
1422
1552
  include Aws::Structure
1423
1553
  end
@@ -1636,6 +1766,34 @@ module Aws::LookoutMetrics
1636
1766
  include Aws::Structure
1637
1767
  end
1638
1768
 
1769
+ # The dimension filter, containing DimensionName and DimensionValueList.
1770
+ #
1771
+ # @note When making an API call, you may pass DimensionFilter
1772
+ # data as a hash:
1773
+ #
1774
+ # {
1775
+ # dimension_name: "ColumnName",
1776
+ # dimension_value_list: ["DimensionValue"],
1777
+ # }
1778
+ #
1779
+ # @!attribute [rw] dimension_name
1780
+ # The name of the dimension to filter on.
1781
+ # @return [String]
1782
+ #
1783
+ # @!attribute [rw] dimension_value_list
1784
+ # The list of values for the dimension specified in DimensionName that
1785
+ # you want to filter on.
1786
+ # @return [Array<String>]
1787
+ #
1788
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DimensionFilter AWS API Documentation
1789
+ #
1790
+ class DimensionFilter < Struct.new(
1791
+ :dimension_name,
1792
+ :dimension_value_list)
1793
+ SENSITIVE = []
1794
+ include Aws::Structure
1795
+ end
1796
+
1639
1797
  # A dimension name and value.
1640
1798
  #
1641
1799
  # @!attribute [rw] dimension_name
@@ -1737,6 +1895,36 @@ module Aws::LookoutMetrics
1737
1895
  include Aws::Structure
1738
1896
  end
1739
1897
 
1898
+ # Describes a filter for choosing a subset of dimension values. Each
1899
+ # filter consists of the dimension that you want to include and the
1900
+ # condition statement. The condition statement is specified in the
1901
+ # `FilterOperation` object.
1902
+ #
1903
+ # @note When making an API call, you may pass Filter
1904
+ # data as a hash:
1905
+ #
1906
+ # {
1907
+ # dimension_value: "DimensionValue",
1908
+ # filter_operation: "EQUALS", # accepts EQUALS
1909
+ # }
1910
+ #
1911
+ # @!attribute [rw] dimension_value
1912
+ # The value that you want to include in the filter.
1913
+ # @return [String]
1914
+ #
1915
+ # @!attribute [rw] filter_operation
1916
+ # The condition to apply.
1917
+ # @return [String]
1918
+ #
1919
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/Filter AWS API Documentation
1920
+ #
1921
+ class Filter < Struct.new(
1922
+ :dimension_value,
1923
+ :filter_operation)
1924
+ SENSITIVE = []
1925
+ include Aws::Structure
1926
+ end
1927
+
1740
1928
  # @note When making an API call, you may pass GetAnomalyGroupRequest
1741
1929
  # data as a hash:
1742
1930
  #
@@ -1774,6 +1962,46 @@ module Aws::LookoutMetrics
1774
1962
  include Aws::Structure
1775
1963
  end
1776
1964
 
1965
+ # @note When making an API call, you may pass GetDataQualityMetricsRequest
1966
+ # data as a hash:
1967
+ #
1968
+ # {
1969
+ # anomaly_detector_arn: "Arn", # required
1970
+ # metric_set_arn: "Arn",
1971
+ # }
1972
+ #
1973
+ # @!attribute [rw] anomaly_detector_arn
1974
+ # The Amazon Resource Name (ARN) of the anomaly detector that you want
1975
+ # to investigate.
1976
+ # @return [String]
1977
+ #
1978
+ # @!attribute [rw] metric_set_arn
1979
+ # The Amazon Resource Name (ARN) of a specific data quality metric
1980
+ # set.
1981
+ # @return [String]
1982
+ #
1983
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/GetDataQualityMetricsRequest AWS API Documentation
1984
+ #
1985
+ class GetDataQualityMetricsRequest < Struct.new(
1986
+ :anomaly_detector_arn,
1987
+ :metric_set_arn)
1988
+ SENSITIVE = []
1989
+ include Aws::Structure
1990
+ end
1991
+
1992
+ # @!attribute [rw] anomaly_detector_data_quality_metric_list
1993
+ # A list of the data quality metrics for the `AnomalyDetectorArn` that
1994
+ # you requested.
1995
+ # @return [Array<Types::AnomalyDetectorDataQualityMetric>]
1996
+ #
1997
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/GetDataQualityMetricsResponse AWS API Documentation
1998
+ #
1999
+ class GetDataQualityMetricsResponse < Struct.new(
2000
+ :anomaly_detector_data_quality_metric_list)
2001
+ SENSITIVE = []
2002
+ include Aws::Structure
2003
+ end
2004
+
1777
2005
  # @note When making an API call, you may pass GetFeedbackRequest
1778
2006
  # data as a hash:
1779
2007
  #
@@ -2447,6 +2675,63 @@ module Aws::LookoutMetrics
2447
2675
  include Aws::Structure
2448
2676
  end
2449
2677
 
2678
+ # An array of `DataQualityMetric` objects that describes one or more
2679
+ # data quality metrics.
2680
+ #
2681
+ # @!attribute [rw] metric_set_arn
2682
+ # The Amazon Resource Name (ARN) of the data quality metric array.
2683
+ # @return [String]
2684
+ #
2685
+ # @!attribute [rw] data_quality_metric_list
2686
+ # The array of data quality metrics contained in the data quality
2687
+ # metric set.
2688
+ # @return [Array<Types::DataQualityMetric>]
2689
+ #
2690
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/MetricSetDataQualityMetric AWS API Documentation
2691
+ #
2692
+ class MetricSetDataQualityMetric < Struct.new(
2693
+ :metric_set_arn,
2694
+ :data_quality_metric_list)
2695
+ SENSITIVE = []
2696
+ include Aws::Structure
2697
+ end
2698
+
2699
+ # Describes a list of filters for choosing a subset of dimension values.
2700
+ # Each filter consists of the dimension and one of its values that you
2701
+ # want to include. When multiple dimensions or values are specified, the
2702
+ # dimensions are joined with an AND operation and the values are joined
2703
+ # with an OR operation.
2704
+ #
2705
+ # @note When making an API call, you may pass MetricSetDimensionFilter
2706
+ # data as a hash:
2707
+ #
2708
+ # {
2709
+ # name: "ColumnName",
2710
+ # filter_list: [
2711
+ # {
2712
+ # dimension_value: "DimensionValue",
2713
+ # filter_operation: "EQUALS", # accepts EQUALS
2714
+ # },
2715
+ # ],
2716
+ # }
2717
+ #
2718
+ # @!attribute [rw] name
2719
+ # The dimension that you want to filter on.
2720
+ # @return [String]
2721
+ #
2722
+ # @!attribute [rw] filter_list
2723
+ # The list of filters that you are applying.
2724
+ # @return [Array<Types::Filter>]
2725
+ #
2726
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/MetricSetDimensionFilter AWS API Documentation
2727
+ #
2728
+ class MetricSetDimensionFilter < Struct.new(
2729
+ :name,
2730
+ :filter_list)
2731
+ SENSITIVE = []
2732
+ include Aws::Structure
2733
+ end
2734
+
2450
2735
  # Contains information about a dataset.
2451
2736
  #
2452
2737
  # @!attribute [rw] metric_set_arn
@@ -2877,6 +3162,16 @@ module Aws::LookoutMetrics
2877
3162
  #
2878
3163
  # @!attribute [rw] sns_format
2879
3164
  # The format of the SNS topic.
3165
+ #
3166
+ # * `JSON` – Send JSON alerts with an anomaly ID and a link to the
3167
+ # anomaly detail page. This is the default.
3168
+ #
3169
+ # * `LONG_TEXT` – Send human-readable alerts with information about
3170
+ # the impacted timeseries and a link to the anomaly detail page. We
3171
+ # recommend this for email.
3172
+ #
3173
+ # * `SHORT_TEXT` – Send human-readable alerts with a link to the
3174
+ # anomaly detail page. We recommend this for SMS.
2880
3175
  # @return [String]
2881
3176
  #
2882
3177
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/SNSConfiguration AWS API Documentation
@@ -3123,6 +3418,80 @@ module Aws::LookoutMetrics
3123
3418
  #
3124
3419
  class UntagResourceResponse < Aws::EmptyStructure; end
3125
3420
 
3421
+ # @note When making an API call, you may pass UpdateAlertRequest
3422
+ # data as a hash:
3423
+ #
3424
+ # {
3425
+ # alert_arn: "Arn", # required
3426
+ # alert_description: "AlertDescription",
3427
+ # alert_sensitivity_threshold: 1,
3428
+ # action: {
3429
+ # sns_configuration: {
3430
+ # role_arn: "Arn", # required
3431
+ # sns_topic_arn: "Arn", # required
3432
+ # sns_format: "LONG_TEXT", # accepts LONG_TEXT, SHORT_TEXT, JSON
3433
+ # },
3434
+ # lambda_configuration: {
3435
+ # role_arn: "Arn", # required
3436
+ # lambda_arn: "Arn", # required
3437
+ # },
3438
+ # },
3439
+ # alert_filters: {
3440
+ # metric_list: ["MetricName"],
3441
+ # dimension_filter_list: [
3442
+ # {
3443
+ # dimension_name: "ColumnName",
3444
+ # dimension_value_list: ["DimensionValue"],
3445
+ # },
3446
+ # ],
3447
+ # },
3448
+ # }
3449
+ #
3450
+ # @!attribute [rw] alert_arn
3451
+ # The ARN of the alert to update.
3452
+ # @return [String]
3453
+ #
3454
+ # @!attribute [rw] alert_description
3455
+ # A description of the alert.
3456
+ # @return [String]
3457
+ #
3458
+ # @!attribute [rw] alert_sensitivity_threshold
3459
+ # An integer from 0 to 100 specifying the alert sensitivity threshold.
3460
+ # @return [Integer]
3461
+ #
3462
+ # @!attribute [rw] action
3463
+ # Action that will be triggered when there is an alert.
3464
+ # @return [Types::Action]
3465
+ #
3466
+ # @!attribute [rw] alert_filters
3467
+ # The configuration of the alert filters, containing MetricList and
3468
+ # DimensionFilterList.
3469
+ # @return [Types::AlertFilters]
3470
+ #
3471
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/UpdateAlertRequest AWS API Documentation
3472
+ #
3473
+ class UpdateAlertRequest < Struct.new(
3474
+ :alert_arn,
3475
+ :alert_description,
3476
+ :alert_sensitivity_threshold,
3477
+ :action,
3478
+ :alert_filters)
3479
+ SENSITIVE = []
3480
+ include Aws::Structure
3481
+ end
3482
+
3483
+ # @!attribute [rw] alert_arn
3484
+ # The ARN of the updated alert.
3485
+ # @return [String]
3486
+ #
3487
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/UpdateAlertResponse AWS API Documentation
3488
+ #
3489
+ class UpdateAlertResponse < Struct.new(
3490
+ :alert_arn)
3491
+ SENSITIVE = []
3492
+ include Aws::Structure
3493
+ end
3494
+
3126
3495
  # @note When making an API call, you may pass UpdateAnomalyDetectorRequest
3127
3496
  # data as a hash:
3128
3497
  #
@@ -3263,6 +3632,17 @@ module Aws::LookoutMetrics
3263
3632
  # },
3264
3633
  # },
3265
3634
  # },
3635
+ # dimension_filter_list: [
3636
+ # {
3637
+ # name: "ColumnName",
3638
+ # filter_list: [
3639
+ # {
3640
+ # dimension_value: "DimensionValue",
3641
+ # filter_operation: "EQUALS", # accepts EQUALS
3642
+ # },
3643
+ # ],
3644
+ # },
3645
+ # ],
3266
3646
  # }
3267
3647
  #
3268
3648
  # @!attribute [rw] metric_set_arn
@@ -3279,8 +3659,8 @@ module Aws::LookoutMetrics
3279
3659
  #
3280
3660
  # @!attribute [rw] offset
3281
3661
  # After an interval ends, the amount of seconds that the detector
3282
- # waits before importing data. Offset is only supported for S3 and
3283
- # Redshift datasources.
3662
+ # waits before importing data. Offset is only supported for S3,
3663
+ # Redshift, Athena and datasources.
3284
3664
  # @return [Integer]
3285
3665
  #
3286
3666
  # @!attribute [rw] timestamp_column
@@ -3299,6 +3679,14 @@ module Aws::LookoutMetrics
3299
3679
  # Contains information about source data used to generate metrics.
3300
3680
  # @return [Types::MetricSource]
3301
3681
  #
3682
+ # @!attribute [rw] dimension_filter_list
3683
+ # Describes a list of filters for choosing specific dimensions and
3684
+ # specific values. Each filter consists of the dimension and one of
3685
+ # its values that you want to include. When multiple dimensions or
3686
+ # values are specified, the dimensions are joined with an AND
3687
+ # operation and the values are joined with an OR operation.
3688
+ # @return [Array<Types::MetricSetDimensionFilter>]
3689
+ #
3302
3690
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/UpdateMetricSetRequest AWS API Documentation
3303
3691
  #
3304
3692
  class UpdateMetricSetRequest < Struct.new(
@@ -3309,7 +3697,8 @@ module Aws::LookoutMetrics
3309
3697
  :timestamp_column,
3310
3698
  :dimension_list,
3311
3699
  :metric_set_frequency,
3312
- :metric_source)
3700
+ :metric_source,
3701
+ :dimension_filter_list)
3313
3702
  SENSITIVE = []
3314
3703
  include Aws::Structure
3315
3704
  end
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-lookoutmetrics/customizations'
48
48
  # @!group service
49
49
  module Aws::LookoutMetrics
50
50
 
51
- GEM_VERSION = '1.19.0'
51
+ GEM_VERSION = '1.22.0'
52
52
 
53
53
  end
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.19.0
4
+ version: 1.22.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-05-31 00:00:00.000000000 Z
11
+ date: 2022-09-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core