aws-sdk-iot 1.87.0 → 1.88.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bb9edb1f47f005ceda3bddf53a3909c47e5e324b3a35d5eaf6753bd1f4ce1f7
-  data.tar.gz: a30b963a97726a8a74e152d8348bc65766f848639c85a9c6a8bd16b9e3e62742
+  metadata.gz: 1f5eecdaf0afc42535b10c47d68bb1a50aafe0cb39eb284e1bb1ffbf5e003510
+  data.tar.gz: 21f4ebbc5bd2dcc5718395ba2749aaa30ef7e353ac7816a5e6d1a35b436b4d1a
 SHA512:
-  metadata.gz: 3800815d737bf85ba1c8d036c1ecc1b1b3fd6315ce8e6c2264e775298ae2317c8eda494e892239195405e485281eb9cc90afce62105943c1b841bd5a2e1bb9d5
-  data.tar.gz: 91c871c5d9eebf09fb7b80cf55d8cb4d2bb37264595c49594d1da449adb8d6177dabdfa18fbc84ec23a99f9fd67c5b7cc1e144800aed57e7299f34cd4cf4f316
+  metadata.gz: 8a999c2c56725a835b0d61a04edb63fa5d08615924f9c99653d0425a5843e17c1b6c7ceb40aeccd998c446346a547d4c292bb0311abee1e0f170b5e257af9d4f
+  data.tar.gz: 6ecdcd2cd1ff058c55f99a86d8e27668b92b09c607d4b423fdf30dab4a8ac8292fb4ab8786f32593e6cb23fe2ec5c5b5b511619a8c2ecba43305f7570ff108a2

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.88.0 (2022-04-04)
+------------------
+
+* Feature - AWS IoT - AWS IoT Device Defender adds support to list metric datapoints collected for IoT devices through the ListMetricValues API
+
 1.87.0 (2022-03-30)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.87.0
+1.88.0

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

@@ -8879,6 +8879,78 @@ module Aws::IoT
       req.send_request(options)
     end
 
+    # Lists the values reported for an IoT Device Defender metric
+    # (device-side metric, cloud-side metric, or custom metric) by the given
+    # thing during the specified time period.
+    #
+    # @option params [required, String] :thing_name
+    #   The name of the thing for which security profile metric values are
+    #   returned.
+    #
+    # @option params [required, String] :metric_name
+    #   The name of the security profile metric for which values are returned.
+    #
+    # @option params [String] :dimension_name
+    #   The dimension name.
+    #
+    # @option params [String] :dimension_value_operator
+    #   The dimension value operator.
+    #
+    # @option params [required, Time,DateTime,Date,Integer,String] :start_time
+    #   The start of the time period for which metric values are returned.
+    #
+    # @option params [required, Time,DateTime,Date,Integer,String] :end_time
+    #   The end of the time period for which metric values are returned.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to return at one time.
+    #
+    # @option params [String] :next_token
+    #   The token for the next set of results.
+    #
+    # @return [Types::ListMetricValuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListMetricValuesResponse#metric_datum_list #metric_datum_list} => Array<Types::MetricDatum>
+    #   * {Types::ListMetricValuesResponse#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_metric_values({
+    #     thing_name: "DeviceDefenderThingName", # required
+    #     metric_name: "BehaviorMetric", # required
+    #     dimension_name: "DimensionName",
+    #     dimension_value_operator: "IN", # accepts IN, NOT_IN
+    #     start_time: Time.now, # required
+    #     end_time: Time.now, # required
+    #     max_results: 1,
+    #     next_token: "NextToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.metric_datum_list #=> Array
+    #   resp.metric_datum_list[0].timestamp #=> Time
+    #   resp.metric_datum_list[0].value.count #=> Integer
+    #   resp.metric_datum_list[0].value.cidrs #=> Array
+    #   resp.metric_datum_list[0].value.cidrs[0] #=> String
+    #   resp.metric_datum_list[0].value.ports #=> Array
+    #   resp.metric_datum_list[0].value.ports[0] #=> Integer
+    #   resp.metric_datum_list[0].value.number #=> Float
+    #   resp.metric_datum_list[0].value.numbers #=> Array
+    #   resp.metric_datum_list[0].value.numbers[0] #=> Float
+    #   resp.metric_datum_list[0].value.strings #=> Array
+    #   resp.metric_datum_list[0].value.strings[0] #=> String
+    #   resp.next_token #=> String
+    #
+    # @overload list_metric_values(params = {})
+    # @param [Hash] params ({})
+    def list_metric_values(params = {}, options = {})
+      req = build_request(:list_metric_values, params)
+      req.send_request(options)
+    end
+
     # Gets a list of all mitigation actions that match the specified filter
     # criteria.
     #
@@ -13600,7 +13672,7 @@ module Aws::IoT
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-iot'
-      context[:gem_version] = '1.87.0'
+      context[:gem_version] = '1.88.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -700,6 +700,8 @@ module Aws::IoT
     ListJobsResponse = Shapes::StructureShape.new(name: 'ListJobsResponse')
     ListManagedJobTemplatesRequest = Shapes::StructureShape.new(name: 'ListManagedJobTemplatesRequest')
     ListManagedJobTemplatesResponse = Shapes::StructureShape.new(name: 'ListManagedJobTemplatesResponse')
+    ListMetricValuesRequest = Shapes::StructureShape.new(name: 'ListMetricValuesRequest')
+    ListMetricValuesResponse = Shapes::StructureShape.new(name: 'ListMetricValuesResponse')
     ListMitigationActionsRequest = Shapes::StructureShape.new(name: 'ListMitigationActionsRequest')
     ListMitigationActionsResponse = Shapes::StructureShape.new(name: 'ListMitigationActionsResponse')
     ListOTAUpdatesRequest = Shapes::StructureShape.new(name: 'ListOTAUpdatesRequest')
@@ -787,6 +789,8 @@ module Aws::IoT
     Message = Shapes::StringShape.new(name: 'Message')
     MessageFormat = Shapes::StringShape.new(name: 'MessageFormat')
     MessageId = Shapes::StringShape.new(name: 'MessageId')
+    MetricDatum = Shapes::StructureShape.new(name: 'MetricDatum')
+    MetricDatumList = Shapes::ListShape.new(name: 'MetricDatumList')
     MetricDimension = Shapes::StructureShape.new(name: 'MetricDimension')
     MetricName = Shapes::StringShape.new(name: 'MetricName')
     MetricNames = Shapes::ListShape.new(name: 'MetricNames')
@@ -1332,7 +1336,7 @@ module Aws::IoT
     AddThingToThingGroupResponse.struct_class = Types::AddThingToThingGroupResponse
 
     AddThingsToThingGroupParams.add_member(:thing_group_names, Shapes::ShapeRef.new(shape: ThingGroupNames, required: true, location_name: "thingGroupNames"))
-    AddThingsToThingGroupParams.add_member(:override_dynamic_groups, Shapes::ShapeRef.new(shape: OverrideDynamicGroups, location_name: "overrideDynamicGroups"))
+    AddThingsToThingGroupParams.add_member(:override_dynamic_groups, Shapes::ShapeRef.new(shape: NullableBoolean, location_name: "overrideDynamicGroups"))
     AddThingsToThingGroupParams.struct_class = Types::AddThingsToThingGroupParams
 
     AdditionalMetricsToRetainList.member = Shapes::ShapeRef.new(shape: BehaviorMetric)
@@ -3365,6 +3369,20 @@ module Aws::IoT
     ListManagedJobTemplatesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
     ListManagedJobTemplatesResponse.struct_class = Types::ListManagedJobTemplatesResponse
 
+    ListMetricValuesRequest.add_member(:thing_name, Shapes::ShapeRef.new(shape: DeviceDefenderThingName, required: true, location: "querystring", location_name: "thingName"))
+    ListMetricValuesRequest.add_member(:metric_name, Shapes::ShapeRef.new(shape: BehaviorMetric, required: true, location: "querystring", location_name: "metricName"))
+    ListMetricValuesRequest.add_member(:dimension_name, Shapes::ShapeRef.new(shape: DimensionName, location: "querystring", location_name: "dimensionName"))
+    ListMetricValuesRequest.add_member(:dimension_value_operator, Shapes::ShapeRef.new(shape: DimensionValueOperator, location: "querystring", location_name: "dimensionValueOperator"))
+    ListMetricValuesRequest.add_member(:start_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location: "querystring", location_name: "startTime"))
+    ListMetricValuesRequest.add_member(:end_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location: "querystring", location_name: "endTime"))
+    ListMetricValuesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
+    ListMetricValuesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
+    ListMetricValuesRequest.struct_class = Types::ListMetricValuesRequest
+
+    ListMetricValuesResponse.add_member(:metric_datum_list, Shapes::ShapeRef.new(shape: MetricDatumList, location_name: "metricDatumList"))
+    ListMetricValuesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
+    ListMetricValuesResponse.struct_class = Types::ListMetricValuesResponse
+
     ListMitigationActionsRequest.add_member(:action_type, Shapes::ShapeRef.new(shape: MitigationActionType, location: "querystring", location_name: "actionType"))
     ListMitigationActionsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
     ListMitigationActionsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
@@ -3685,6 +3703,12 @@ module Aws::IoT
 
     ManagedJobTemplatesSummaryList.member = Shapes::ShapeRef.new(shape: ManagedJobTemplateSummary)
 
+    MetricDatum.add_member(:timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "timestamp"))
+    MetricDatum.add_member(:value, Shapes::ShapeRef.new(shape: MetricValue, location_name: "value"))
+    MetricDatum.struct_class = Types::MetricDatum
+
+    MetricDatumList.member = Shapes::ShapeRef.new(shape: MetricDatum)
+
     MetricDimension.add_member(:dimension_name, Shapes::ShapeRef.new(shape: DimensionName, required: true, location_name: "dimensionName"))
     MetricDimension.add_member(:operator, Shapes::ShapeRef.new(shape: DimensionValueOperator, location_name: "operator"))
     MetricDimension.struct_class = Types::MetricDimension
@@ -7011,6 +7035,24 @@ module Aws::IoT
         o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
       end)
 
+      api.add_operation(:list_metric_values, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "ListMetricValues"
+        o.http_method = "GET"
+        o.http_request_uri = "/metric-values"
+        o.input = Shapes::ShapeRef.new(shape: ListMetricValuesRequest)
+        o.output = Shapes::ShapeRef.new(shape: ListMetricValuesResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
+      end)
+
       api.add_operation(:list_mitigation_actions, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ListMitigationActions"
         o.http_method = "GET"

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

@@ -5517,21 +5517,11 @@ module Aws::IoT
     #   @return [Types::CodeSigningCertificateChain]
     #
     # @!attribute [rw] hash_algorithm
-    #   The hash algorithm used to code sign the file. You can use a string
-    #   as the algorithm name if the target over-the-air (OTA) update
-    #   devices are able to verify the signature that was generated using
-    #   the same signature algorithm. For example, FreeRTOS uses `SHA256` or
-    #   `SHA1`, so you can pass either of them based on which was used for
-    #   generating the signature.
+    #   The hash algorithm used to code sign the file.
     #   @return [String]
     #
     # @!attribute [rw] signature_algorithm
-    #   The signature algorithm used to code sign the file. You can use a
-    #   string as the algorithm name if the target over-the-air (OTA) update
-    #   devices are able to verify the signature that was generated using
-    #   the same signature algorithm. For example, FreeRTOS uses `ECDSA` or
-    #   `RSA`, so you can pass either of them based on which was used for
-    #   generating the signature.
+    #   The signature algorithm used to code sign the file.
     #   @return [String]
     #
     class CustomCodeSigning < Struct.new(
@@ -12108,6 +12098,84 @@ module Aws::IoT
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass ListMetricValuesRequest
+    #   data as a hash:
+    #
+    #       {
+    #         thing_name: "DeviceDefenderThingName", # required
+    #         metric_name: "BehaviorMetric", # required
+    #         dimension_name: "DimensionName",
+    #         dimension_value_operator: "IN", # accepts IN, NOT_IN
+    #         start_time: Time.now, # required
+    #         end_time: Time.now, # required
+    #         max_results: 1,
+    #         next_token: "NextToken",
+    #       }
+    #
+    # @!attribute [rw] thing_name
+    #   The name of the thing for which security profile metric values are
+    #   returned.
+    #   @return [String]
+    #
+    # @!attribute [rw] metric_name
+    #   The name of the security profile metric for which values are
+    #   returned.
+    #   @return [String]
+    #
+    # @!attribute [rw] dimension_name
+    #   The dimension name.
+    #   @return [String]
+    #
+    # @!attribute [rw] dimension_value_operator
+    #   The dimension value operator.
+    #   @return [String]
+    #
+    # @!attribute [rw] start_time
+    #   The start of the time period for which metric values are returned.
+    #   @return [Time]
+    #
+    # @!attribute [rw] end_time
+    #   The end of the time period for which metric values are returned.
+    #   @return [Time]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of results to return at one time.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] next_token
+    #   The token for the next set of results.
+    #   @return [String]
+    #
+    class ListMetricValuesRequest < Struct.new(
+      :thing_name,
+      :metric_name,
+      :dimension_name,
+      :dimension_value_operator,
+      :start_time,
+      :end_time,
+      :max_results,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] metric_datum_list
+    #   The data the thing reports for the metric during the specified time
+    #   period.
+    #   @return [Array<Types::MetricDatum>]
+    #
+    # @!attribute [rw] next_token
+    #   A token that can be used to retrieve the next set of results, or
+    #   `null` if there are no additional results.
+    #   @return [String]
+    #
+    class ListMetricValuesResponse < Struct.new(
+      :metric_datum_list,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass ListMitigationActionsRequest
     #   data as a hash:
     #
@@ -13792,6 +13860,23 @@ module Aws::IoT
       include Aws::Structure
     end
 
+    # A metric.
+    #
+    # @!attribute [rw] timestamp
+    #   The time the metric value was reported.
+    #   @return [Time]
+    #
+    # @!attribute [rw] value
+    #   The value reported for the metric.
+    #   @return [Types::MetricValue]
+    #
+    class MetricDatum < Struct.new(
+      :timestamp,
+      :value)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The dimension of a metric.
     #
     # @note When making an API call, you may pass MetricDimension

data/lib/aws-sdk-iot.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-iot/customizations'
 # @!group service
 module Aws::IoT
 
-  GEM_VERSION = '1.87.0'
+  GEM_VERSION = '1.88.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-iot
 version: !ruby/object:Gem::Version
-  version: 1.87.0
+  version: 1.88.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-30 00:00:00.000000000 Z
+date: 2022-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core