aws-sdk-lookoutmetrics 1.21.0 → 1.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 611a3e0012b1c5023741f17f98742e04436de07023d2222dc17ba9be64a59ab7
-  data.tar.gz: c499352aafe83441dd1fdc09ba545c3289602d00ea635d3162bb23807b958e9b
+  metadata.gz: 184a3c6d40963d05d0d1e671784f841a895c2a42763c215f5bc7bc230676bf57
+  data.tar.gz: 1903e4ed0c6cdfc69c5389b47da85e5985f0424bc12442477413b8ba0b370572
 SHA512:
-  metadata.gz: a59f5e5e360406d787dc3b9eb96e672a37e2d84486817ff9962b8684e37003c17b4efdd28818c968028224483c76e60590fa8893d9cbcee5dc56e3e7f63d2c0c
-  data.tar.gz: ebc173c6018884e92b2098436cea40a8f3b891bfd9c7213cd2ff5b039bf0b7af7bc6a3777c8290cef6b35cc333e1fd0654ab59189d17c59bb6ff48f8ebff5fcd
+  metadata.gz: d32cf83d2bee7f42754e7f7a6b46cb23bc497d1376493b892a1ba0f5861939df37bc35e2b54698c39e08127000fc1147f8286b071255f86ff6c33d9907c9eb98
+  data.tar.gz: '0290662b53fe16bddb621f4354d836131ed08177e5fcd78962f5e62a99090494fe0ce11a317709881eaf0119711662a927508c1f9c0ec61680f0904a6136edbd'

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.22.0 (2022-09-08)
+------------------
+
+* 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.
+
 1.21.0 (2022-08-19)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.21.0
+1.22.0

data/lib/aws-sdk-lookoutmetrics/client.rb

@@ -567,6 +567,10 @@ module Aws::LookoutMetrics
     #
     #   [1]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html
     #
+    # @option params [Array<Types::MetricSetDimensionFilter>] :dimension_filter_list
+    #   A list of filters that specify which data is kept for anomaly
+    #   detection.
+    #
     # @return [Types::CreateMetricSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateMetricSetResponse#metric_set_arn #metric_set_arn} => String
@@ -663,6 +667,17 @@ module Aws::LookoutMetrics
     #     tags: {
     #       "TagKey" => "TagValue",
     #     },
+    #     dimension_filter_list: [
+    #       {
+    #         name: "ColumnName",
+    #         filter_list: [
+    #           {
+    #             dimension_value: "DimensionValue",
+    #             filter_operation: "EQUALS", # accepts EQUALS
+    #           },
+    #         ],
+    #       },
+    #     ],
     #   })
     #
     # @example Response structure
@@ -923,6 +938,7 @@ module Aws::LookoutMetrics
     #   * {Types::DescribeMetricSetResponse#metric_set_frequency #metric_set_frequency} => String
     #   * {Types::DescribeMetricSetResponse#timezone #timezone} => String
     #   * {Types::DescribeMetricSetResponse#metric_source #metric_source} => Types::MetricSource
+    #   * {Types::DescribeMetricSetResponse#dimension_filter_list #dimension_filter_list} => Array&lt;Types::MetricSetDimensionFilter&gt;
     #
     # @example Request syntax with placeholder values
     #
@@ -996,6 +1012,11 @@ module Aws::LookoutMetrics
     #   resp.metric_source.athena_source_config.work_group_name #=> String
     #   resp.metric_source.athena_source_config.s3_results_path #=> String
     #   resp.metric_source.athena_source_config.back_test_configuration.run_back_test_mode #=> Boolean
+    #   resp.dimension_filter_list #=> Array
+    #   resp.dimension_filter_list[0].name #=> String
+    #   resp.dimension_filter_list[0].filter_list #=> Array
+    #   resp.dimension_filter_list[0].filter_list[0].dimension_value #=> String
+    #   resp.dimension_filter_list[0].filter_list[0].filter_operation #=> String, one of "EQUALS"
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DescribeMetricSet AWS API Documentation
     #
@@ -1856,6 +1877,13 @@ module Aws::LookoutMetrics
     # @option params [Types::MetricSource] :metric_source
     #   Contains information about source data used to generate metrics.
     #
+    # @option params [Array<Types::MetricSetDimensionFilter>] :dimension_filter_list
+    #   Describes a list of filters for choosing specific dimensions and
+    #   specific values. Each filter consists of the dimension and one of its
+    #   values that you want to include. When multiple dimensions or values
+    #   are specified, the dimensions are joined with an AND operation and the
+    #   values are joined with an OR operation.
+    #
     # @return [Types::UpdateMetricSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::UpdateMetricSetResponse#metric_set_arn #metric_set_arn} => String
@@ -1947,6 +1975,17 @@ module Aws::LookoutMetrics
     #         },
     #       },
     #     },
+    #     dimension_filter_list: [
+    #       {
+    #         name: "ColumnName",
+    #         filter_list: [
+    #           {
+    #             dimension_value: "DimensionValue",
+    #             filter_operation: "EQUALS", # accepts EQUALS
+    #           },
+    #         ],
+    #       },
+    #     ],
     #   })
     #
     # @example Response structure
@@ -1975,7 +2014,7 @@ module Aws::LookoutMetrics
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-lookoutmetrics'
-      context[:gem_version] = '1.21.0'
+      context[:gem_version] = '1.22.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-lookoutmetrics/client_api.rb

@@ -124,6 +124,9 @@ module Aws::LookoutMetrics
     ExecutionStatus = Shapes::StructureShape.new(name: 'ExecutionStatus')
     FieldName = Shapes::StringShape.new(name: 'FieldName')
     FileFormatDescriptor = Shapes::StructureShape.new(name: 'FileFormatDescriptor')
+    Filter = Shapes::StructureShape.new(name: 'Filter')
+    FilterList = Shapes::ListShape.new(name: 'FilterList')
+    FilterOperation = Shapes::StringShape.new(name: 'FilterOperation')
     FlowName = Shapes::StringShape.new(name: 'FlowName')
     Frequency = Shapes::StringShape.new(name: 'Frequency')
     GetAnomalyGroupRequest = Shapes::StructureShape.new(name: 'GetAnomalyGroupRequest')
@@ -175,6 +178,8 @@ module Aws::LookoutMetrics
     MetricSetDataQualityMetric = Shapes::StructureShape.new(name: 'MetricSetDataQualityMetric')
     MetricSetDataQualityMetricList = Shapes::ListShape.new(name: 'MetricSetDataQualityMetricList')
     MetricSetDescription = Shapes::StringShape.new(name: 'MetricSetDescription')
+    MetricSetDimensionFilter = Shapes::StructureShape.new(name: 'MetricSetDimensionFilter')
+    MetricSetDimensionFilterList = Shapes::ListShape.new(name: 'MetricSetDimensionFilterList')
     MetricSetName = Shapes::StringShape.new(name: 'MetricSetName')
     MetricSetSummary = Shapes::StructureShape.new(name: 'MetricSetSummary')
     MetricSetSummaryList = Shapes::ListShape.new(name: 'MetricSetSummaryList')
@@ -432,6 +437,7 @@ module Aws::LookoutMetrics
     CreateMetricSetRequest.add_member(:metric_source, Shapes::ShapeRef.new(shape: MetricSource, required: true, location_name: "MetricSource"))
     CreateMetricSetRequest.add_member(:timezone, Shapes::ShapeRef.new(shape: Timezone, location_name: "Timezone"))
     CreateMetricSetRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
+    CreateMetricSetRequest.add_member(:dimension_filter_list, Shapes::ShapeRef.new(shape: MetricSetDimensionFilterList, location_name: "DimensionFilterList"))
     CreateMetricSetRequest.struct_class = Types::CreateMetricSetRequest
 
     CreateMetricSetResponse.add_member(:metric_set_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "MetricSetArn"))
@@ -515,6 +521,7 @@ module Aws::LookoutMetrics
     DescribeMetricSetResponse.add_member(:metric_set_frequency, Shapes::ShapeRef.new(shape: Frequency, location_name: "MetricSetFrequency"))
     DescribeMetricSetResponse.add_member(:timezone, Shapes::ShapeRef.new(shape: Timezone, location_name: "Timezone"))
     DescribeMetricSetResponse.add_member(:metric_source, Shapes::ShapeRef.new(shape: MetricSource, location_name: "MetricSource"))
+    DescribeMetricSetResponse.add_member(:dimension_filter_list, Shapes::ShapeRef.new(shape: MetricSetDimensionFilterList, location_name: "DimensionFilterList"))
     DescribeMetricSetResponse.struct_class = Types::DescribeMetricSetResponse
 
     DetectMetricSetConfigRequest.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "AnomalyDetectorArn"))
@@ -595,6 +602,12 @@ module Aws::LookoutMetrics
     FileFormatDescriptor.add_member(:json_format_descriptor, Shapes::ShapeRef.new(shape: JsonFormatDescriptor, location_name: "JsonFormatDescriptor"))
     FileFormatDescriptor.struct_class = Types::FileFormatDescriptor
 
+    Filter.add_member(:dimension_value, Shapes::ShapeRef.new(shape: DimensionValue, location_name: "DimensionValue"))
+    Filter.add_member(:filter_operation, Shapes::ShapeRef.new(shape: FilterOperation, location_name: "FilterOperation"))
+    Filter.struct_class = Types::Filter
+
+    FilterList.member = Shapes::ShapeRef.new(shape: Filter)
+
     GetAnomalyGroupRequest.add_member(:anomaly_group_id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "AnomalyGroupId"))
     GetAnomalyGroupRequest.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "AnomalyDetectorArn"))
     GetAnomalyGroupRequest.struct_class = Types::GetAnomalyGroupRequest
@@ -747,6 +760,12 @@ module Aws::LookoutMetrics
 
     MetricSetDataQualityMetricList.member = Shapes::ShapeRef.new(shape: MetricSetDataQualityMetric)
 
+    MetricSetDimensionFilter.add_member(:name, Shapes::ShapeRef.new(shape: ColumnName, location_name: "Name"))
+    MetricSetDimensionFilter.add_member(:filter_list, Shapes::ShapeRef.new(shape: FilterList, location_name: "FilterList"))
+    MetricSetDimensionFilter.struct_class = Types::MetricSetDimensionFilter
+
+    MetricSetDimensionFilterList.member = Shapes::ShapeRef.new(shape: MetricSetDimensionFilter)
+
     MetricSetSummary.add_member(:metric_set_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "MetricSetArn"))
     MetricSetSummary.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "AnomalyDetectorArn"))
     MetricSetSummary.add_member(:metric_set_description, Shapes::ShapeRef.new(shape: MetricSetDescription, location_name: "MetricSetDescription"))
@@ -903,6 +922,7 @@ module Aws::LookoutMetrics
     UpdateMetricSetRequest.add_member(:dimension_list, Shapes::ShapeRef.new(shape: DimensionList, location_name: "DimensionList"))
     UpdateMetricSetRequest.add_member(:metric_set_frequency, Shapes::ShapeRef.new(shape: Frequency, location_name: "MetricSetFrequency"))
     UpdateMetricSetRequest.add_member(:metric_source, Shapes::ShapeRef.new(shape: MetricSource, location_name: "MetricSource"))
+    UpdateMetricSetRequest.add_member(:dimension_filter_list, Shapes::ShapeRef.new(shape: MetricSetDimensionFilterList, location_name: "DimensionFilterList"))
     UpdateMetricSetRequest.struct_class = Types::UpdateMetricSetRequest
 
     UpdateMetricSetResponse.add_member(:metric_set_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "MetricSetArn"))

data/lib/aws-sdk-lookoutmetrics/types.rb

@@ -1036,6 +1036,17 @@ module Aws::LookoutMetrics
     #         tags: {
     #           "TagKey" => "TagValue",
     #         },
+    #         dimension_filter_list: [
+    #           {
+    #             name: "ColumnName",
+    #             filter_list: [
+    #               {
+    #                 dimension_value: "DimensionValue",
+    #                 filter_operation: "EQUALS", # accepts EQUALS
+    #               },
+    #             ],
+    #           },
+    #         ],
     #       }
     #
     # @!attribute [rw] anomaly_detector_arn
@@ -1091,6 +1102,11 @@ module Aws::LookoutMetrics
     #   [1]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html
     #   @return [Hash<String,String>]
     #
+    # @!attribute [rw] dimension_filter_list
+    #   A list of filters that specify which data is kept for anomaly
+    #   detection.
+    #   @return [Array<Types::MetricSetDimensionFilter>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/CreateMetricSetRequest AWS API Documentation
     #
     class CreateMetricSetRequest < Struct.new(
@@ -1104,7 +1120,8 @@ module Aws::LookoutMetrics
       :metric_set_frequency,
       :metric_source,
       :timezone,
-      :tags)
+      :tags,
+      :dimension_filter_list)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1509,6 +1526,11 @@ module Aws::LookoutMetrics
     #   Contains information about the dataset's source data.
     #   @return [Types::MetricSource]
     #
+    # @!attribute [rw] dimension_filter_list
+    #   The dimensions and their values that were used to filter the
+    #   dataset.
+    #   @return [Array<Types::MetricSetDimensionFilter>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DescribeMetricSetResponse AWS API Documentation
     #
     class DescribeMetricSetResponse < Struct.new(
@@ -1524,7 +1546,8 @@ module Aws::LookoutMetrics
       :dimension_list,
       :metric_set_frequency,
       :timezone,
-      :metric_source)
+      :metric_source,
+      :dimension_filter_list)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1872,6 +1895,36 @@ module Aws::LookoutMetrics
       include Aws::Structure
     end
 
+    # Describes a filter for choosing a subset of dimension values. Each
+    # filter consists of the dimension that you want to include and the
+    # condition statement. The condition statement is specified in the
+    # `FilterOperation` object.
+    #
+    # @note When making an API call, you may pass Filter
+    #   data as a hash:
+    #
+    #       {
+    #         dimension_value: "DimensionValue",
+    #         filter_operation: "EQUALS", # accepts EQUALS
+    #       }
+    #
+    # @!attribute [rw] dimension_value
+    #   The value that you want to include in the filter.
+    #   @return [String]
+    #
+    # @!attribute [rw] filter_operation
+    #   The condition to apply.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/Filter AWS API Documentation
+    #
+    class Filter < Struct.new(
+      :dimension_value,
+      :filter_operation)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass GetAnomalyGroupRequest
     #   data as a hash:
     #
@@ -2643,6 +2696,42 @@ module Aws::LookoutMetrics
       include Aws::Structure
     end
 
+    # Describes a list of filters for choosing a subset of dimension values.
+    # Each filter consists of the dimension and one of its values that you
+    # want to include. When multiple dimensions or values are specified, the
+    # dimensions are joined with an AND operation and the values are joined
+    # with an OR operation.
+    #
+    # @note When making an API call, you may pass MetricSetDimensionFilter
+    #   data as a hash:
+    #
+    #       {
+    #         name: "ColumnName",
+    #         filter_list: [
+    #           {
+    #             dimension_value: "DimensionValue",
+    #             filter_operation: "EQUALS", # accepts EQUALS
+    #           },
+    #         ],
+    #       }
+    #
+    # @!attribute [rw] name
+    #   The dimension that you want to filter on.
+    #   @return [String]
+    #
+    # @!attribute [rw] filter_list
+    #   The list of filters that you are applying.
+    #   @return [Array<Types::Filter>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/MetricSetDimensionFilter AWS API Documentation
+    #
+    class MetricSetDimensionFilter < Struct.new(
+      :name,
+      :filter_list)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains information about a dataset.
     #
     # @!attribute [rw] metric_set_arn
@@ -3543,6 +3632,17 @@ module Aws::LookoutMetrics
     #             },
     #           },
     #         },
+    #         dimension_filter_list: [
+    #           {
+    #             name: "ColumnName",
+    #             filter_list: [
+    #               {
+    #                 dimension_value: "DimensionValue",
+    #                 filter_operation: "EQUALS", # accepts EQUALS
+    #               },
+    #             ],
+    #           },
+    #         ],
     #       }
     #
     # @!attribute [rw] metric_set_arn
@@ -3579,6 +3679,14 @@ module Aws::LookoutMetrics
     #   Contains information about source data used to generate metrics.
     #   @return [Types::MetricSource]
     #
+    # @!attribute [rw] dimension_filter_list
+    #   Describes a list of filters for choosing specific dimensions and
+    #   specific values. Each filter consists of the dimension and one of
+    #   its values that you want to include. When multiple dimensions or
+    #   values are specified, the dimensions are joined with an AND
+    #   operation and the values are joined with an OR operation.
+    #   @return [Array<Types::MetricSetDimensionFilter>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/UpdateMetricSetRequest AWS API Documentation
     #
     class UpdateMetricSetRequest < Struct.new(
@@ -3589,7 +3697,8 @@ module Aws::LookoutMetrics
       :timestamp_column,
       :dimension_list,
       :metric_set_frequency,
-      :metric_source)
+      :metric_source,
+      :dimension_filter_list)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-lookoutmetrics.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-lookoutmetrics/customizations'
 # @!group service
 module Aws::LookoutMetrics
 
-  GEM_VERSION = '1.21.0'
+  GEM_VERSION = '1.22.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-lookoutmetrics
 version: !ruby/object:Gem::Version
-  version: 1.21.0
+  version: 1.22.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-19 00:00:00.000000000 Z
+date: 2022-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core