aws-sdk-iot 1.75.0 → 1.76.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 777563bcee47aa617cefbd8f7453e813f6ca0b35f2a77e7854e27456a7a377dc
-  data.tar.gz: 363748251c5a7b07da78a6e78a2efee5a2a194b94e60fa16475c903320a8b412
+  metadata.gz: a5775a8d8d9df11921ef1514c92e01ab967f296a45e9d7432bb6c44f6ac11045
+  data.tar.gz: 20cee15e7d5575401c5ace2df264c53ff0015220953403c3e7dcda0b9e95bcc2
 SHA512:
-  metadata.gz: 63d8281c51e6f14b7a62615c038140ecf219a50937b5b4cc9739861f714d99584b38be7a40563b52a29492a9cbd3f295f7615b6ef0660d9559acd0a14f34a00b
-  data.tar.gz: 7126c9ad606ac911cc0ad2f0ba8edb43800f1c39aa3860ad434978c632786fe2940c9b4fa3ea0d3c312ee59ff7eff9789a0a73bb1abc1c10f50fe07bba211061
+  metadata.gz: '03795a0eb460723bcb13aed53846f09bfb6b35f7db434905a1800bb29cf1e9963298248ebdf8c19ff70f2ef7e5329b19fa219b72ce1824f79b3523a3c0617c81'
+  data.tar.gz: d67db06013a512f5ef65e01e5b18c59a06793d2702922e85e3ff21282b3f3b018f833047405a17e4afdeb24df850c27ae025f153e3d28f773c9e16c0f8930802

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.76.0 (2021-09-21)
+------------------
+
+* Feature - This release adds support for verifying, viewing and filtering AWS IoT Device Defender detect violations with four verification states.
+
 1.75.0 (2021-09-13)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.75.0
+1.76.0

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

@@ -964,7 +964,10 @@ module Aws::IoT
     #   The description of the audit suppression.
     #
     # @option params [required, String] :client_request_token
-    #   The epoch timestamp in seconds at which this suppression expires.
+    #   Each audit supression must have a unique client request token. If you
+    #   try to create a new audit suppression with the same token as one that
+    #   already exists, an exception occurs. If you omit this value, Amazon
+    #   Web Services SDKs will automatically generate a unique client request.
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.**
@@ -7259,6 +7262,9 @@ module Aws::IoT
     # @option params [Boolean] :list_suppressed_alerts
     #   A list of all suppressed alerts.
     #
+    # @option params [String] :verification_state
+    #   The verification state of the violation (detect alarm).
+    #
     # @option params [String] :next_token
     #   The token for the next set of results.
     #
@@ -7279,6 +7285,7 @@ module Aws::IoT
     #     security_profile_name: "SecurityProfileName",
     #     behavior_criteria_type: "STATIC", # accepts STATIC, STATISTICAL, MACHINE_LEARNING
     #     list_suppressed_alerts: false,
+    #     verification_state: "FALSE_POSITIVE", # accepts FALSE_POSITIVE, BENIGN_POSITIVE, TRUE_POSITIVE, UNKNOWN
     #     next_token: "NextToken",
     #     max_results: 1,
     #   })
@@ -7321,6 +7328,8 @@ module Aws::IoT
     #   resp.active_violations[0].last_violation_value.strings #=> Array
     #   resp.active_violations[0].last_violation_value.strings[0] #=> String
     #   resp.active_violations[0].violation_event_additional_info.confidence_level #=> String, one of "LOW", "MEDIUM", "HIGH"
+    #   resp.active_violations[0].verification_state #=> String, one of "FALSE_POSITIVE", "BENIGN_POSITIVE", "TRUE_POSITIVE", "UNKNOWN"
+    #   resp.active_violations[0].verification_state_description #=> String
     #   resp.active_violations[0].last_violation_time #=> Time
     #   resp.active_violations[0].violation_start_time #=> Time
     #   resp.next_token #=> String
@@ -10233,6 +10242,9 @@ module Aws::IoT
     # @option params [Boolean] :list_suppressed_alerts
     #   A list of all suppressed alerts.
     #
+    # @option params [String] :verification_state
+    #   The verification state of the violation (detect alarm).
+    #
     # @option params [String] :next_token
     #   The token for the next set of results.
     #
@@ -10255,6 +10267,7 @@ module Aws::IoT
     #     security_profile_name: "SecurityProfileName",
     #     behavior_criteria_type: "STATIC", # accepts STATIC, STATISTICAL, MACHINE_LEARNING
     #     list_suppressed_alerts: false,
+    #     verification_state: "FALSE_POSITIVE", # accepts FALSE_POSITIVE, BENIGN_POSITIVE, TRUE_POSITIVE, UNKNOWN
     #     next_token: "NextToken",
     #     max_results: 1,
     #   })
@@ -10298,6 +10311,8 @@ module Aws::IoT
     #   resp.violation_events[0].metric_value.strings[0] #=> String
     #   resp.violation_events[0].violation_event_additional_info.confidence_level #=> String, one of "LOW", "MEDIUM", "HIGH"
     #   resp.violation_events[0].violation_event_type #=> String, one of "in-alarm", "alarm-cleared", "alarm-invalidated"
+    #   resp.violation_events[0].verification_state #=> String, one of "FALSE_POSITIVE", "BENIGN_POSITIVE", "TRUE_POSITIVE", "UNKNOWN"
+    #   resp.violation_events[0].verification_state_description #=> String
     #   resp.violation_events[0].violation_event_time #=> Time
     #   resp.next_token #=> String
     #
@@ -10308,6 +10323,36 @@ module Aws::IoT
       req.send_request(options)
     end
 
+    # Set a verification state and provide a description of that
+    # verification state on a violation (detect alarm).
+    #
+    # @option params [required, String] :violation_id
+    #   The violation ID.
+    #
+    # @option params [required, String] :verification_state
+    #   The verification state of the violation.
+    #
+    # @option params [String] :verification_state_description
+    #   The description of the verification state of the violation (detect
+    #   alarm).
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.put_verification_state_on_violation({
+    #     violation_id: "ViolationId", # required
+    #     verification_state: "FALSE_POSITIVE", # required, accepts FALSE_POSITIVE, BENIGN_POSITIVE, TRUE_POSITIVE, UNKNOWN
+    #     verification_state_description: "VerificationStateDescription",
+    #   })
+    #
+    # @overload put_verification_state_on_violation(params = {})
+    # @param [Hash] params ({})
+    def put_verification_state_on_violation(params = {}, options = {})
+      req = build_request(:put_verification_state_on_violation, params)
+      req.send_request(options)
+    end
+
     # Registers a CA certificate with IoT. This CA certificate can then be
     # used to sign device certificates, which can be then registered with
     # IoT. You can register up to 10 CA certificates per Amazon Web Services
@@ -13328,7 +13373,7 @@ module Aws::IoT
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-iot'
-      context[:gem_version] = '1.75.0'
+      context[:gem_version] = '1.76.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -873,6 +873,8 @@ module Aws::IoT
     PutAssetPropertyValueEntry = Shapes::StructureShape.new(name: 'PutAssetPropertyValueEntry')
     PutAssetPropertyValueEntryList = Shapes::ListShape.new(name: 'PutAssetPropertyValueEntryList')
     PutItemInput = Shapes::StructureShape.new(name: 'PutItemInput')
+    PutVerificationStateOnViolationRequest = Shapes::StructureShape.new(name: 'PutVerificationStateOnViolationRequest')
+    PutVerificationStateOnViolationResponse = Shapes::StructureShape.new(name: 'PutVerificationStateOnViolationResponse')
     Qos = Shapes::IntegerShape.new(name: 'Qos')
     QueryMaxResults = Shapes::IntegerShape.new(name: 'QueryMaxResults')
     QueryString = Shapes::StringShape.new(name: 'QueryString')
@@ -1206,6 +1208,8 @@ module Aws::IoT
     ValidationErrors = Shapes::ListShape.new(name: 'ValidationErrors')
     Value = Shapes::StringShape.new(name: 'Value')
     Variance = Shapes::FloatShape.new(name: 'Variance')
+    VerificationState = Shapes::StringShape.new(name: 'VerificationState')
+    VerificationStateDescription = Shapes::StringShape.new(name: 'VerificationStateDescription')
     Version = Shapes::IntegerShape.new(name: 'Version')
     VersionConflictException = Shapes::StructureShape.new(name: 'VersionConflictException')
     VersionNumber = Shapes::IntegerShape.new(name: 'VersionNumber')
@@ -1274,6 +1278,8 @@ module Aws::IoT
     ActiveViolation.add_member(:behavior, Shapes::ShapeRef.new(shape: Behavior, location_name: "behavior"))
     ActiveViolation.add_member(:last_violation_value, Shapes::ShapeRef.new(shape: MetricValue, location_name: "lastViolationValue"))
     ActiveViolation.add_member(:violation_event_additional_info, Shapes::ShapeRef.new(shape: ViolationEventAdditionalInfo, location_name: "violationEventAdditionalInfo"))
+    ActiveViolation.add_member(:verification_state, Shapes::ShapeRef.new(shape: VerificationState, location_name: "verificationState"))
+    ActiveViolation.add_member(:verification_state_description, Shapes::ShapeRef.new(shape: VerificationStateDescription, location_name: "verificationStateDescription"))
     ActiveViolation.add_member(:last_violation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastViolationTime"))
     ActiveViolation.add_member(:violation_start_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "violationStartTime"))
     ActiveViolation.struct_class = Types::ActiveViolation
@@ -3049,6 +3055,7 @@ module Aws::IoT
     ListActiveViolationsRequest.add_member(:security_profile_name, Shapes::ShapeRef.new(shape: SecurityProfileName, location: "querystring", location_name: "securityProfileName"))
     ListActiveViolationsRequest.add_member(:behavior_criteria_type, Shapes::ShapeRef.new(shape: BehaviorCriteriaType, location: "querystring", location_name: "behaviorCriteriaType"))
     ListActiveViolationsRequest.add_member(:list_suppressed_alerts, Shapes::ShapeRef.new(shape: ListSuppressedAlerts, location: "querystring", location_name: "listSuppressedAlerts"))
+    ListActiveViolationsRequest.add_member(:verification_state, Shapes::ShapeRef.new(shape: VerificationState, location: "querystring", location_name: "verificationState"))
     ListActiveViolationsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
     ListActiveViolationsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
     ListActiveViolationsRequest.struct_class = Types::ListActiveViolationsRequest
@@ -3563,6 +3570,7 @@ module Aws::IoT
     ListViolationEventsRequest.add_member(:security_profile_name, Shapes::ShapeRef.new(shape: SecurityProfileName, location: "querystring", location_name: "securityProfileName"))
     ListViolationEventsRequest.add_member(:behavior_criteria_type, Shapes::ShapeRef.new(shape: BehaviorCriteriaType, location: "querystring", location_name: "behaviorCriteriaType"))
     ListViolationEventsRequest.add_member(:list_suppressed_alerts, Shapes::ShapeRef.new(shape: ListSuppressedAlerts, location: "querystring", location_name: "listSuppressedAlerts"))
+    ListViolationEventsRequest.add_member(:verification_state, Shapes::ShapeRef.new(shape: VerificationState, location: "querystring", location_name: "verificationState"))
     ListViolationEventsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
     ListViolationEventsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
     ListViolationEventsRequest.struct_class = Types::ListViolationEventsRequest
@@ -3788,6 +3796,13 @@ module Aws::IoT
     PutItemInput.add_member(:table_name, Shapes::ShapeRef.new(shape: TableName, required: true, location_name: "tableName"))
     PutItemInput.struct_class = Types::PutItemInput
 
+    PutVerificationStateOnViolationRequest.add_member(:violation_id, Shapes::ShapeRef.new(shape: ViolationId, required: true, location: "uri", location_name: "violationId"))
+    PutVerificationStateOnViolationRequest.add_member(:verification_state, Shapes::ShapeRef.new(shape: VerificationState, required: true, location_name: "verificationState"))
+    PutVerificationStateOnViolationRequest.add_member(:verification_state_description, Shapes::ShapeRef.new(shape: VerificationStateDescription, location_name: "verificationStateDescription"))
+    PutVerificationStateOnViolationRequest.struct_class = Types::PutVerificationStateOnViolationRequest
+
+    PutVerificationStateOnViolationResponse.struct_class = Types::PutVerificationStateOnViolationResponse
+
     RateIncreaseCriteria.add_member(:number_of_notified_things, Shapes::ShapeRef.new(shape: NumberOfThings, location_name: "numberOfNotifiedThings"))
     RateIncreaseCriteria.add_member(:number_of_succeeded_things, Shapes::ShapeRef.new(shape: NumberOfThings, location_name: "numberOfSucceededThings"))
     RateIncreaseCriteria.struct_class = Types::RateIncreaseCriteria
@@ -4657,6 +4672,8 @@ module Aws::IoT
     ViolationEvent.add_member(:metric_value, Shapes::ShapeRef.new(shape: MetricValue, location_name: "metricValue"))
     ViolationEvent.add_member(:violation_event_additional_info, Shapes::ShapeRef.new(shape: ViolationEventAdditionalInfo, location_name: "violationEventAdditionalInfo"))
     ViolationEvent.add_member(:violation_event_type, Shapes::ShapeRef.new(shape: ViolationEventType, location_name: "violationEventType"))
+    ViolationEvent.add_member(:verification_state, Shapes::ShapeRef.new(shape: VerificationState, location_name: "verificationState"))
+    ViolationEvent.add_member(:verification_state_description, Shapes::ShapeRef.new(shape: VerificationStateDescription, location_name: "verificationStateDescription"))
     ViolationEvent.add_member(:violation_event_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "violationEventTime"))
     ViolationEvent.struct_class = Types::ViolationEvent
 
@@ -7440,6 +7457,17 @@ module Aws::IoT
         )
       end)
 
+      api.add_operation(:put_verification_state_on_violation, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "PutVerificationStateOnViolation"
+        o.http_method = "POST"
+        o.http_request_uri = "/violations/verification-state/{violationId}"
+        o.input = Shapes::ShapeRef.new(shape: PutVerificationStateOnViolationRequest)
+        o.output = Shapes::ShapeRef.new(shape: PutVerificationStateOnViolationResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
+      end)
+
       api.add_operation(:register_ca_certificate, Seahorse::Model::Operation.new.tap do |o|
         o.name = "RegisterCACertificate"
         o.http_method = "POST"

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

@@ -336,9 +336,12 @@ module Aws::IoT
     #   @return [Types::CloudwatchLogsAction]
     #
     # @!attribute [rw] elasticsearch
-    #   Write data to an Amazon Elasticsearch Service domain.
+    #   Write data to an Amazon OpenSearch Service domain.
     #
-    #   <note markdown="1"> This action is deprecated. Use the [OpenSearch action][1] instead.
+    #   <note markdown="1"> The `Elasticsearch` action can only be used by existing rule
+    #   actions. To create a new rule action or to update an existing rule
+    #   action, use the `OpenSearch` rule action instead. For more
+    #   information, see [OpenSearchAction][1].
     #
     #    </note>
     #
@@ -446,6 +449,14 @@ module Aws::IoT
     #   The details of a violation event.
     #   @return [Types::ViolationEventAdditionalInfo]
     #
+    # @!attribute [rw] verification_state
+    #   The verification state of the violation (detect alarm).
+    #   @return [String]
+    #
+    # @!attribute [rw] verification_state_description
+    #   The description of the verification state of the violation.
+    #   @return [String]
+    #
     # @!attribute [rw] last_violation_time
     #   The time the most recent violation occurred.
     #   @return [Time]
@@ -461,6 +472,8 @@ module Aws::IoT
       :behavior,
       :last_violation_value,
       :violation_event_additional_info,
+      :verification_state,
+      :verification_state_description,
       :last_violation_time,
       :violation_start_time)
       SENSITIVE = []
@@ -2769,7 +2782,11 @@ module Aws::IoT
     #   @return [String]
     #
     # @!attribute [rw] client_request_token
-    #   The epoch timestamp in seconds at which this suppression expires.
+    #   Each audit supression must have a unique client request token. If
+    #   you try to create a new audit suppression with the same token as one
+    #   that already exists, an exception occurs. If you omit this value,
+    #   Amazon Web Services SDKs will automatically generate a unique client
+    #   request.
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   not need to pass this option.
@@ -8461,10 +8478,13 @@ module Aws::IoT
       include Aws::Structure
     end
 
-    # Describes an action that writes data to an Amazon Elasticsearch
-    # Service domain.
+    # Describes an action that writes data to an Amazon OpenSearch Service
+    # domain.
     #
-    # <note markdown="1"> This action is deprecated. Use the [OpenSearch action][1] instead.
+    # <note markdown="1"> The `Elasticsearch` action can only be used by existing rule actions.
+    # To create a new rule action or to update an existing rule action, use
+    # the `OpenSearch` rule action instead. For more information, see
+    # [OpenSearchAction][1].
     #
     #  </note>
     #
@@ -8484,15 +8504,15 @@ module Aws::IoT
     #       }
     #
     # @!attribute [rw] role_arn
-    #   The IAM role ARN that has access to Elasticsearch.
+    #   The IAM role ARN that has access to OpenSearch.
     #   @return [String]
     #
     # @!attribute [rw] endpoint
-    #   The endpoint of your Elasticsearch domain.
+    #   The endpoint of your OpenSearch domain.
     #   @return [String]
     #
     # @!attribute [rw] index
-    #   The Elasticsearch index where you want to store your data.
+    #   The index where you want to store your data.
     #   @return [String]
     #
     # @!attribute [rw] type
@@ -10451,6 +10471,7 @@ module Aws::IoT
     #         security_profile_name: "SecurityProfileName",
     #         behavior_criteria_type: "STATIC", # accepts STATIC, STATISTICAL, MACHINE_LEARNING
     #         list_suppressed_alerts: false,
+    #         verification_state: "FALSE_POSITIVE", # accepts FALSE_POSITIVE, BENIGN_POSITIVE, TRUE_POSITIVE, UNKNOWN
     #         next_token: "NextToken",
     #         max_results: 1,
     #       }
@@ -10472,6 +10493,10 @@ module Aws::IoT
     #   A list of all suppressed alerts.
     #   @return [Boolean]
     #
+    # @!attribute [rw] verification_state
+    #   The verification state of the violation (detect alarm).
+    #   @return [String]
+    #
     # @!attribute [rw] next_token
     #   The token for the next set of results.
     #   @return [String]
@@ -10485,6 +10510,7 @@ module Aws::IoT
       :security_profile_name,
       :behavior_criteria_type,
       :list_suppressed_alerts,
+      :verification_state,
       :next_token,
       :max_results)
       SENSITIVE = []
@@ -13254,6 +13280,7 @@ module Aws::IoT
     #         security_profile_name: "SecurityProfileName",
     #         behavior_criteria_type: "STATIC", # accepts STATIC, STATISTICAL, MACHINE_LEARNING
     #         list_suppressed_alerts: false,
+    #         verification_state: "FALSE_POSITIVE", # accepts FALSE_POSITIVE, BENIGN_POSITIVE, TRUE_POSITIVE, UNKNOWN
     #         next_token: "NextToken",
     #         max_results: 1,
     #       }
@@ -13284,6 +13311,10 @@ module Aws::IoT
     #   A list of all suppressed alerts.
     #   @return [Boolean]
     #
+    # @!attribute [rw] verification_state
+    #   The verification state of the violation (detect alarm).
+    #   @return [String]
+    #
     # @!attribute [rw] next_token
     #   The token for the next set of results.
     #   @return [String]
@@ -13299,6 +13330,7 @@ module Aws::IoT
       :security_profile_name,
       :behavior_criteria_type,
       :list_suppressed_alerts,
+      :verification_state,
       :next_token,
       :max_results)
       SENSITIVE = []
@@ -14320,6 +14352,38 @@ module Aws::IoT
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass PutVerificationStateOnViolationRequest
+    #   data as a hash:
+    #
+    #       {
+    #         violation_id: "ViolationId", # required
+    #         verification_state: "FALSE_POSITIVE", # required, accepts FALSE_POSITIVE, BENIGN_POSITIVE, TRUE_POSITIVE, UNKNOWN
+    #         verification_state_description: "VerificationStateDescription",
+    #       }
+    #
+    # @!attribute [rw] violation_id
+    #   The violation ID.
+    #   @return [String]
+    #
+    # @!attribute [rw] verification_state
+    #   The verification state of the violation.
+    #   @return [String]
+    #
+    # @!attribute [rw] verification_state_description
+    #   The description of the verification state of the violation (detect
+    #   alarm).
+    #   @return [String]
+    #
+    class PutVerificationStateOnViolationRequest < Struct.new(
+      :violation_id,
+      :verification_state,
+      :verification_state_description)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    class PutVerificationStateOnViolationResponse < Aws::EmptyStructure; end
+
     # Allows you to define a criteria to initiate the increase in rate of
     # rollout for a job.
     #
@@ -19837,6 +19901,14 @@ module Aws::IoT
     #   The type of violation event.
     #   @return [String]
     #
+    # @!attribute [rw] verification_state
+    #   The verification state of the violation (detect alarm).
+    #   @return [String]
+    #
+    # @!attribute [rw] verification_state_description
+    #   The description of the verification state of the violation.
+    #   @return [String]
+    #
     # @!attribute [rw] violation_event_time
     #   The time the violation event occurred.
     #   @return [Time]
@@ -19849,6 +19921,8 @@ module Aws::IoT
       :metric_value,
       :violation_event_additional_info,
       :violation_event_type,
+      :verification_state,
+      :verification_state_description,
       :violation_event_time)
       SENSITIVE = []
       include Aws::Structure

data/lib/aws-sdk-iot.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-iot
 version: !ruby/object:Gem::Version
-  version: 1.75.0
+  version: 1.76.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-13 00:00:00.000000000 Z
+date: 2021-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core