aws-sdk-ioteventsdata 1.26.0 → 1.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a838ba5bfb496b0446c2ea14f93f5de97041cdc7a22d00412ad88ced06ee1cc5
-  data.tar.gz: '0693b46220439034a0ace8441a2e552403736ea49a78d77f4c93db9834d1ddb2'
+  metadata.gz: 898dc31a30e4a618a2e7920ac235ab574e4672c216cb3e247feb144c1e0d7f91
+  data.tar.gz: f2fb81e173ca9704b61fcf29a444431ef838b6fa577d6b9184dc86e14c405bff
 SHA512:
-  metadata.gz: e0dd5de22afdbb74678cbb1ff6d2b8d395ec7791fae3fbbaad0745f50b8fdbc3e51943e2bfbdfde289caff012629bfcc10aa231eced04084d11f6f85fa98db77
-  data.tar.gz: f2eb2ecdaa614bd6ff435d8675a334c4fc19ab906a9d0bf387a26c63289ce11399e7a8416370e1368fd9c6fc5119180f6b5a0763732c58d818c23feea38588b3
+  metadata.gz: b44079fe0b9a5b85704541b9cd821d964ec9bd4d722e11b90c716702fedc9a25c96e4c29062d0c6ca3b89f7cb0fa5d422dee65be3771b486321b61c27f641f87
+  data.tar.gz: db8e71efc2e30ddd5f01fd2eafbc6c5399c4a009952a5ee4c7bddafe6be93109d9152ab7f3980bc358cc6b984fe0cfd9698667ca1df244f9fa499d0c20b536ea

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.27.0 (2022-05-18)
+------------------
+
+* Feature - Introducing new API for deleting detectors: BatchDeleteDetector.
+
 1.26.0 (2022-02-24)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.26.0
+1.27.0

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

@@ -389,6 +389,48 @@ module Aws::IoTEventsData
       req.send_request(options)
     end
 
+    # Deletes one or more detectors that were created. When a detector is
+    # deleted, its state will be cleared and the detector will be removed
+    # from the list of detectors. The deleted detector will no longer appear
+    # if referenced in the [ListDetectors][1] API call.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_ListDetectors.html
+    #
+    # @option params [required, Array<Types::DeleteDetectorRequest>] :detectors
+    #   The list of one or more detectors to be deleted.
+    #
+    # @return [Types::BatchDeleteDetectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::BatchDeleteDetectorResponse#batch_delete_detector_error_entries #batch_delete_detector_error_entries} => Array&lt;Types::BatchDeleteDetectorErrorEntry&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.batch_delete_detector({
+    #     detectors: [ # required
+    #       {
+    #         message_id: "MessageId", # required
+    #         detector_model_name: "DetectorModelName", # required
+    #         key_value: "KeyValue",
+    #       },
+    #     ],
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.batch_delete_detector_error_entries #=> Array
+    #   resp.batch_delete_detector_error_entries[0].message_id #=> String
+    #   resp.batch_delete_detector_error_entries[0].error_code #=> String, one of "ResourceNotFoundException", "InvalidRequestException", "InternalFailureException", "ServiceUnavailableException", "ThrottlingException"
+    #   resp.batch_delete_detector_error_entries[0].error_message #=> String
+    #
+    # @overload batch_delete_detector(params = {})
+    # @param [Hash] params ({})
+    def batch_delete_detector(params = {}, options = {})
+      req = build_request(:batch_delete_detector, params)
+      req.send_request(options)
+    end
+
     # Disables one or more alarms. The alarms change to the `DISABLED` state
     # after you disable them.
     #
@@ -838,7 +880,7 @@ module Aws::IoTEventsData
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-ioteventsdata'
-      context[:gem_version] = '1.26.0'
+      context[:gem_version] = '1.27.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -27,6 +27,10 @@ module Aws::IoTEventsData
     BatchAcknowledgeAlarmResponse = Shapes::StructureShape.new(name: 'BatchAcknowledgeAlarmResponse')
     BatchAlarmActionErrorEntries = Shapes::ListShape.new(name: 'BatchAlarmActionErrorEntries')
     BatchAlarmActionErrorEntry = Shapes::StructureShape.new(name: 'BatchAlarmActionErrorEntry')
+    BatchDeleteDetectorErrorEntries = Shapes::ListShape.new(name: 'BatchDeleteDetectorErrorEntries')
+    BatchDeleteDetectorErrorEntry = Shapes::StructureShape.new(name: 'BatchDeleteDetectorErrorEntry')
+    BatchDeleteDetectorRequest = Shapes::StructureShape.new(name: 'BatchDeleteDetectorRequest')
+    BatchDeleteDetectorResponse = Shapes::StructureShape.new(name: 'BatchDeleteDetectorResponse')
     BatchDisableAlarmRequest = Shapes::StructureShape.new(name: 'BatchDisableAlarmRequest')
     BatchDisableAlarmResponse = Shapes::StructureShape.new(name: 'BatchDisableAlarmResponse')
     BatchEnableAlarmRequest = Shapes::StructureShape.new(name: 'BatchEnableAlarmRequest')
@@ -46,6 +50,8 @@ module Aws::IoTEventsData
     ComparisonOperator = Shapes::StringShape.new(name: 'ComparisonOperator')
     CustomerAction = Shapes::StructureShape.new(name: 'CustomerAction')
     CustomerActionName = Shapes::StringShape.new(name: 'CustomerActionName')
+    DeleteDetectorRequest = Shapes::StructureShape.new(name: 'DeleteDetectorRequest')
+    DeleteDetectorRequests = Shapes::ListShape.new(name: 'DeleteDetectorRequests')
     DescribeAlarmRequest = Shapes::StructureShape.new(name: 'DescribeAlarmRequest')
     DescribeAlarmResponse = Shapes::StructureShape.new(name: 'DescribeAlarmResponse')
     DescribeDetectorRequest = Shapes::StructureShape.new(name: 'DescribeDetectorRequest')
@@ -170,6 +176,19 @@ module Aws::IoTEventsData
     BatchAlarmActionErrorEntry.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "errorMessage"))
     BatchAlarmActionErrorEntry.struct_class = Types::BatchAlarmActionErrorEntry
 
+    BatchDeleteDetectorErrorEntries.member = Shapes::ShapeRef.new(shape: BatchDeleteDetectorErrorEntry)
+
+    BatchDeleteDetectorErrorEntry.add_member(:message_id, Shapes::ShapeRef.new(shape: MessageId, location_name: "messageId"))
+    BatchDeleteDetectorErrorEntry.add_member(:error_code, Shapes::ShapeRef.new(shape: ErrorCode, location_name: "errorCode"))
+    BatchDeleteDetectorErrorEntry.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "errorMessage"))
+    BatchDeleteDetectorErrorEntry.struct_class = Types::BatchDeleteDetectorErrorEntry
+
+    BatchDeleteDetectorRequest.add_member(:detectors, Shapes::ShapeRef.new(shape: DeleteDetectorRequests, required: true, location_name: "detectors"))
+    BatchDeleteDetectorRequest.struct_class = Types::BatchDeleteDetectorRequest
+
+    BatchDeleteDetectorResponse.add_member(:batch_delete_detector_error_entries, Shapes::ShapeRef.new(shape: BatchDeleteDetectorErrorEntries, location_name: "batchDeleteDetectorErrorEntries"))
+    BatchDeleteDetectorResponse.struct_class = Types::BatchDeleteDetectorResponse
+
     BatchDisableAlarmRequest.add_member(:disable_action_requests, Shapes::ShapeRef.new(shape: DisableAlarmActionRequests, required: true, location_name: "disableActionRequests"))
     BatchDisableAlarmRequest.struct_class = Types::BatchDisableAlarmRequest
 
@@ -228,6 +247,13 @@ module Aws::IoTEventsData
     CustomerAction.add_member(:reset_action_configuration, Shapes::ShapeRef.new(shape: ResetActionConfiguration, location_name: "resetActionConfiguration"))
     CustomerAction.struct_class = Types::CustomerAction
 
+    DeleteDetectorRequest.add_member(:message_id, Shapes::ShapeRef.new(shape: MessageId, required: true, location_name: "messageId"))
+    DeleteDetectorRequest.add_member(:detector_model_name, Shapes::ShapeRef.new(shape: DetectorModelName, required: true, location_name: "detectorModelName"))
+    DeleteDetectorRequest.add_member(:key_value, Shapes::ShapeRef.new(shape: KeyValue, location_name: "keyValue"))
+    DeleteDetectorRequest.struct_class = Types::DeleteDetectorRequest
+
+    DeleteDetectorRequests.member = Shapes::ShapeRef.new(shape: DeleteDetectorRequest)
+
     DescribeAlarmRequest.add_member(:alarm_model_name, Shapes::ShapeRef.new(shape: AlarmModelName, required: true, location: "uri", location_name: "alarmModelName"))
     DescribeAlarmRequest.add_member(:key_value, Shapes::ShapeRef.new(shape: KeyValue, location: "querystring", location_name: "keyValue"))
     DescribeAlarmRequest.struct_class = Types::DescribeAlarmRequest
@@ -440,6 +466,18 @@ module Aws::IoTEventsData
         o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
       end)
 
+      api.add_operation(:batch_delete_detector, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "BatchDeleteDetector"
+        o.http_method = "POST"
+        o.http_request_uri = "/detectors/delete"
+        o.input = Shapes::ShapeRef.new(shape: BatchDeleteDetectorRequest)
+        o.output = Shapes::ShapeRef.new(shape: BatchDeleteDetectorResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
+        o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+      end)
+
       api.add_operation(:batch_disable_alarm, Seahorse::Model::Operation.new.tap do |o|
         o.name = "BatchDisableAlarm"
         o.http_method = "POST"

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

@@ -307,6 +307,69 @@ module Aws::IoTEventsData
       include Aws::Structure
     end
 
+    # Contains error messages associated with the deletion request.
+    #
+    # @!attribute [rw] message_id
+    #   The ID of the message that caused the error. (See the value of the
+    #   `"messageId"` in the [detectors][1] object of the
+    #   `DeleteDetectorRequest`.)
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchDeleteDetector.html#iotevents-iotevents-data_BatchDeleteDetector-request-detectors
+    #   @return [String]
+    #
+    # @!attribute [rw] error_code
+    #   The error code.
+    #   @return [String]
+    #
+    # @!attribute [rw] error_message
+    #   A message that describes the error.
+    #   @return [String]
+    #
+    class BatchDeleteDetectorErrorEntry < Struct.new(
+      :message_id,
+      :error_code,
+      :error_message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass BatchDeleteDetectorRequest
+    #   data as a hash:
+    #
+    #       {
+    #         detectors: [ # required
+    #           {
+    #             message_id: "MessageId", # required
+    #             detector_model_name: "DetectorModelName", # required
+    #             key_value: "KeyValue",
+    #           },
+    #         ],
+    #       }
+    #
+    # @!attribute [rw] detectors
+    #   The list of one or more detectors to be deleted.
+    #   @return [Array<Types::DeleteDetectorRequest>]
+    #
+    class BatchDeleteDetectorRequest < Struct.new(
+      :detectors)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] batch_delete_detector_error_entries
+    #   A list of errors associated with the request, or an empty array
+    #   (`[]`) if there are no errors. Each error entry contains a
+    #   `messageId` that helps you identify the entry that failed.
+    #   @return [Array<Types::BatchDeleteDetectorErrorEntry>]
+    #
+    class BatchDeleteDetectorResponse < Struct.new(
+      :batch_delete_detector_error_entries)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass BatchDisableAlarmRequest
     #   data as a hash:
     #
@@ -652,6 +715,43 @@ module Aws::IoTEventsData
       include Aws::Structure
     end
 
+    # Information used to delete the detector model.
+    #
+    # @note When making an API call, you may pass DeleteDetectorRequest
+    #   data as a hash:
+    #
+    #       {
+    #         message_id: "MessageId", # required
+    #         detector_model_name: "DetectorModelName", # required
+    #         key_value: "KeyValue",
+    #       }
+    #
+    # @!attribute [rw] message_id
+    #   The ID to assign to the `DeleteDetectorRequest`. Each `"messageId"`
+    #   must be unique within each batch sent.
+    #   @return [String]
+    #
+    # @!attribute [rw] detector_model_name
+    #   The name of the detector model that was used to create the detector
+    #   instance.
+    #   @return [String]
+    #
+    # @!attribute [rw] key_value
+    #   The value of the [key][1] used to identify the detector.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateDetectorModel.html#iotevents-CreateDetectorModel-request-key
+    #   @return [String]
+    #
+    class DeleteDetectorRequest < Struct.new(
+      :message_id,
+      :detector_model_name,
+      :key_value)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass DescribeAlarmRequest
     #   data as a hash:
     #

data/lib/aws-sdk-ioteventsdata.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-ioteventsdata/customizations'
 # @!group service
 module Aws::IoTEventsData
 
-  GEM_VERSION = '1.26.0'
+  GEM_VERSION = '1.27.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-ioteventsdata
 version: !ruby/object:Gem::Version
-  version: 1.26.0
+  version: 1.27.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2022-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core