aws-sdk-lookoutmetrics 1.21.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: 611a3e0012b1c5023741f17f98742e04436de07023d2222dc17ba9be64a59ab7
4
- data.tar.gz: c499352aafe83441dd1fdc09ba545c3289602d00ea635d3162bb23807b958e9b
3
+ metadata.gz: 184a3c6d40963d05d0d1e671784f841a895c2a42763c215f5bc7bc230676bf57
4
+ data.tar.gz: 1903e4ed0c6cdfc69c5389b47da85e5985f0424bc12442477413b8ba0b370572
5
5
  SHA512:
6
- metadata.gz: a59f5e5e360406d787dc3b9eb96e672a37e2d84486817ff9962b8684e37003c17b4efdd28818c968028224483c76e60590fa8893d9cbcee5dc56e3e7f63d2c0c
7
- data.tar.gz: ebc173c6018884e92b2098436cea40a8f3b891bfd9c7213cd2ff5b039bf0b7af7bc6a3777c8290cef6b35cc333e1fd0654ab59189d17c59bb6ff48f8ebff5fcd
6
+ metadata.gz: d32cf83d2bee7f42754e7f7a6b46cb23bc497d1376493b892a1ba0f5861939df37bc35e2b54698c39e08127000fc1147f8286b071255f86ff6c33d9907c9eb98
7
+ data.tar.gz: '0290662b53fe16bddb621f4354d836131ed08177e5fcd78962f5e62a99090494fe0ce11a317709881eaf0119711662a927508c1f9c0ec61680f0904a6136edbd'
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
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
+
4
9
  1.21.0 (2022-08-19)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.21.0
1
+ 1.22.0
@@ -567,6 +567,10 @@ module Aws::LookoutMetrics
567
567
  #
568
568
  # [1]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html
569
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
+ #
570
574
  # @return [Types::CreateMetricSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
571
575
  #
572
576
  # * {Types::CreateMetricSetResponse#metric_set_arn #metric_set_arn} => String
@@ -663,6 +667,17 @@ module Aws::LookoutMetrics
663
667
  # tags: {
664
668
  # "TagKey" => "TagValue",
665
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
+ # ],
666
681
  # })
667
682
  #
668
683
  # @example Response structure
@@ -923,6 +938,7 @@ module Aws::LookoutMetrics
923
938
  # * {Types::DescribeMetricSetResponse#metric_set_frequency #metric_set_frequency} => String
924
939
  # * {Types::DescribeMetricSetResponse#timezone #timezone} => String
925
940
  # * {Types::DescribeMetricSetResponse#metric_source #metric_source} => Types::MetricSource
941
+ # * {Types::DescribeMetricSetResponse#dimension_filter_list #dimension_filter_list} => Array&lt;Types::MetricSetDimensionFilter&gt;
926
942
  #
927
943
  # @example Request syntax with placeholder values
928
944
  #
@@ -996,6 +1012,11 @@ module Aws::LookoutMetrics
996
1012
  # resp.metric_source.athena_source_config.work_group_name #=> String
997
1013
  # resp.metric_source.athena_source_config.s3_results_path #=> String
998
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"
999
1020
  #
1000
1021
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DescribeMetricSet AWS API Documentation
1001
1022
  #
@@ -1856,6 +1877,13 @@ module Aws::LookoutMetrics
1856
1877
  # @option params [Types::MetricSource] :metric_source
1857
1878
  # Contains information about source data used to generate metrics.
1858
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
+ #
1859
1887
  # @return [Types::UpdateMetricSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1860
1888
  #
1861
1889
  # * {Types::UpdateMetricSetResponse#metric_set_arn #metric_set_arn} => String
@@ -1947,6 +1975,17 @@ module Aws::LookoutMetrics
1947
1975
  # },
1948
1976
  # },
1949
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
+ # ],
1950
1989
  # })
1951
1990
  #
1952
1991
  # @example Response structure
@@ -1975,7 +2014,7 @@ module Aws::LookoutMetrics
1975
2014
  params: params,
1976
2015
  config: config)
1977
2016
  context[:gem_name] = 'aws-sdk-lookoutmetrics'
1978
- context[:gem_version] = '1.21.0'
2017
+ context[:gem_version] = '1.22.0'
1979
2018
  Seahorse::Client::Request.new(handlers, context)
1980
2019
  end
1981
2020
 
@@ -124,6 +124,9 @@ module Aws::LookoutMetrics
124
124
  ExecutionStatus = Shapes::StructureShape.new(name: 'ExecutionStatus')
125
125
  FieldName = Shapes::StringShape.new(name: 'FieldName')
126
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')
127
130
  FlowName = Shapes::StringShape.new(name: 'FlowName')
128
131
  Frequency = Shapes::StringShape.new(name: 'Frequency')
129
132
  GetAnomalyGroupRequest = Shapes::StructureShape.new(name: 'GetAnomalyGroupRequest')
@@ -175,6 +178,8 @@ module Aws::LookoutMetrics
175
178
  MetricSetDataQualityMetric = Shapes::StructureShape.new(name: 'MetricSetDataQualityMetric')
176
179
  MetricSetDataQualityMetricList = Shapes::ListShape.new(name: 'MetricSetDataQualityMetricList')
177
180
  MetricSetDescription = Shapes::StringShape.new(name: 'MetricSetDescription')
181
+ MetricSetDimensionFilter = Shapes::StructureShape.new(name: 'MetricSetDimensionFilter')
182
+ MetricSetDimensionFilterList = Shapes::ListShape.new(name: 'MetricSetDimensionFilterList')
178
183
  MetricSetName = Shapes::StringShape.new(name: 'MetricSetName')
179
184
  MetricSetSummary = Shapes::StructureShape.new(name: 'MetricSetSummary')
180
185
  MetricSetSummaryList = Shapes::ListShape.new(name: 'MetricSetSummaryList')
@@ -432,6 +437,7 @@ module Aws::LookoutMetrics
432
437
  CreateMetricSetRequest.add_member(:metric_source, Shapes::ShapeRef.new(shape: MetricSource, required: true, location_name: "MetricSource"))
433
438
  CreateMetricSetRequest.add_member(:timezone, Shapes::ShapeRef.new(shape: Timezone, location_name: "Timezone"))
434
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"))
435
441
  CreateMetricSetRequest.struct_class = Types::CreateMetricSetRequest
436
442
 
437
443
  CreateMetricSetResponse.add_member(:metric_set_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "MetricSetArn"))
@@ -515,6 +521,7 @@ module Aws::LookoutMetrics
515
521
  DescribeMetricSetResponse.add_member(:metric_set_frequency, Shapes::ShapeRef.new(shape: Frequency, location_name: "MetricSetFrequency"))
516
522
  DescribeMetricSetResponse.add_member(:timezone, Shapes::ShapeRef.new(shape: Timezone, location_name: "Timezone"))
517
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"))
518
525
  DescribeMetricSetResponse.struct_class = Types::DescribeMetricSetResponse
519
526
 
520
527
  DetectMetricSetConfigRequest.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "AnomalyDetectorArn"))
@@ -595,6 +602,12 @@ module Aws::LookoutMetrics
595
602
  FileFormatDescriptor.add_member(:json_format_descriptor, Shapes::ShapeRef.new(shape: JsonFormatDescriptor, location_name: "JsonFormatDescriptor"))
596
603
  FileFormatDescriptor.struct_class = Types::FileFormatDescriptor
597
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
+
598
611
  GetAnomalyGroupRequest.add_member(:anomaly_group_id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "AnomalyGroupId"))
599
612
  GetAnomalyGroupRequest.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "AnomalyDetectorArn"))
600
613
  GetAnomalyGroupRequest.struct_class = Types::GetAnomalyGroupRequest
@@ -747,6 +760,12 @@ module Aws::LookoutMetrics
747
760
 
748
761
  MetricSetDataQualityMetricList.member = Shapes::ShapeRef.new(shape: MetricSetDataQualityMetric)
749
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
+
750
769
  MetricSetSummary.add_member(:metric_set_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "MetricSetArn"))
751
770
  MetricSetSummary.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "AnomalyDetectorArn"))
752
771
  MetricSetSummary.add_member(:metric_set_description, Shapes::ShapeRef.new(shape: MetricSetDescription, location_name: "MetricSetDescription"))
@@ -903,6 +922,7 @@ module Aws::LookoutMetrics
903
922
  UpdateMetricSetRequest.add_member(:dimension_list, Shapes::ShapeRef.new(shape: DimensionList, location_name: "DimensionList"))
904
923
  UpdateMetricSetRequest.add_member(:metric_set_frequency, Shapes::ShapeRef.new(shape: Frequency, location_name: "MetricSetFrequency"))
905
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"))
906
926
  UpdateMetricSetRequest.struct_class = Types::UpdateMetricSetRequest
907
927
 
908
928
  UpdateMetricSetResponse.add_member(:metric_set_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "MetricSetArn"))
@@ -1036,6 +1036,17 @@ module Aws::LookoutMetrics
1036
1036
  # tags: {
1037
1037
  # "TagKey" => "TagValue",
1038
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
+ # ],
1039
1050
  # }
1040
1051
  #
1041
1052
  # @!attribute [rw] anomaly_detector_arn
@@ -1091,6 +1102,11 @@ module Aws::LookoutMetrics
1091
1102
  # [1]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html
1092
1103
  # @return [Hash<String,String>]
1093
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
+ #
1094
1110
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/CreateMetricSetRequest AWS API Documentation
1095
1111
  #
1096
1112
  class CreateMetricSetRequest < Struct.new(
@@ -1104,7 +1120,8 @@ module Aws::LookoutMetrics
1104
1120
  :metric_set_frequency,
1105
1121
  :metric_source,
1106
1122
  :timezone,
1107
- :tags)
1123
+ :tags,
1124
+ :dimension_filter_list)
1108
1125
  SENSITIVE = []
1109
1126
  include Aws::Structure
1110
1127
  end
@@ -1509,6 +1526,11 @@ module Aws::LookoutMetrics
1509
1526
  # Contains information about the dataset's source data.
1510
1527
  # @return [Types::MetricSource]
1511
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
+ #
1512
1534
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DescribeMetricSetResponse AWS API Documentation
1513
1535
  #
1514
1536
  class DescribeMetricSetResponse < Struct.new(
@@ -1524,7 +1546,8 @@ module Aws::LookoutMetrics
1524
1546
  :dimension_list,
1525
1547
  :metric_set_frequency,
1526
1548
  :timezone,
1527
- :metric_source)
1549
+ :metric_source,
1550
+ :dimension_filter_list)
1528
1551
  SENSITIVE = []
1529
1552
  include Aws::Structure
1530
1553
  end
@@ -1872,6 +1895,36 @@ module Aws::LookoutMetrics
1872
1895
  include Aws::Structure
1873
1896
  end
1874
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
+
1875
1928
  # @note When making an API call, you may pass GetAnomalyGroupRequest
1876
1929
  # data as a hash:
1877
1930
  #
@@ -2643,6 +2696,42 @@ module Aws::LookoutMetrics
2643
2696
  include Aws::Structure
2644
2697
  end
2645
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
+
2646
2735
  # Contains information about a dataset.
2647
2736
  #
2648
2737
  # @!attribute [rw] metric_set_arn
@@ -3543,6 +3632,17 @@ module Aws::LookoutMetrics
3543
3632
  # },
3544
3633
  # },
3545
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
+ # ],
3546
3646
  # }
3547
3647
  #
3548
3648
  # @!attribute [rw] metric_set_arn
@@ -3579,6 +3679,14 @@ module Aws::LookoutMetrics
3579
3679
  # Contains information about source data used to generate metrics.
3580
3680
  # @return [Types::MetricSource]
3581
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
+ #
3582
3690
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/UpdateMetricSetRequest AWS API Documentation
3583
3691
  #
3584
3692
  class UpdateMetricSetRequest < Struct.new(
@@ -3589,7 +3697,8 @@ module Aws::LookoutMetrics
3589
3697
  :timestamp_column,
3590
3698
  :dimension_list,
3591
3699
  :metric_set_frequency,
3592
- :metric_source)
3700
+ :metric_source,
3701
+ :dimension_filter_list)
3593
3702
  SENSITIVE = []
3594
3703
  include Aws::Structure
3595
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.21.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.21.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-08-19 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