aws-sdk-iot 1.45.0 → 1.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 3e8d2e53276b04ad2282b5d2e43438facd487869142548e8b7a24b900a5f85f9
-  data.tar.gz: 39e28e44523037fefc8ba4d41dd538b7398faacb2400b8a73158c23ef8a37d7a
+SHA1:
+  metadata.gz: 4382449a82754996007bdb4bdb34fa8b79647056
+  data.tar.gz: a38bacdd6e95a49d457a70e26a04e64fa12eebe0
 SHA512:
-  metadata.gz: 2ac0b8aad04714e57f4ce43257cf6bf86320482ef7a0246cd7cddd82ad36416e5258cb7f1c54d6978a8d17cf306c70ea0bed6f8c94a1b47c00b94fa308ab22d8
-  data.tar.gz: ced9f72cbd1ff1aec07ecd1ab0f7df12e7c78e82cf75b39222ef65fed0ad09e3b504abed221b39b5bb52280eabd6c1f9b861e26cf198e422b401c663281a3600
+  metadata.gz: a2965d34e99c66adfe4404c1fda6b279b7f1c65f724e0e0c07bdca5f6e7f10c3d23b7c6eaa177cbb108a0a7f610446c63a0dd4b4b2eebc888390d1b3e81dcbb0
+  data.tar.gz: 259ae8fa73c2c2e32da544a4643c2dadf829414a11529e662e8c12a29ccc958bd7acb9afe75632b46b176d99ccabe4c01b5c76106dc847a4fd1df7c17ed297f0

data/lib/aws-sdk-iot.rb

@@ -45,6 +45,6 @@ require_relative 'aws-sdk-iot/customizations'
 # @service
 module Aws::IoT
 
-  GEM_VERSION = '1.45.0'
+  GEM_VERSION = '1.46.0'
 
 end

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

@@ -269,8 +269,7 @@ module Aws::IoT
     #
     #   @option options [Integer] :http_read_timeout (60) The default
     #     number of seconds to wait for response data.  This value can
-    #     safely be set
-    #     per-request on the session yielded by {#session_for}.
+    #     safely be set per-request on the session.
     #
     #   @option options [Float] :http_idle_timeout (5) The number of
     #     seconds a connection is allowed to sit idle before it is
@@ -282,7 +281,7 @@ module Aws::IoT
     #     request body.  This option has no effect unless the request has
     #     "Expect" header set to "100-continue".  Defaults to `nil` which
     #     disables this behaviour.  This value can safely be set per
-    #     request on the session yielded by {#session_for}.
+    #     request on the session.
     #
     #   @option options [Boolean] :http_wire_trace (false) When `true`,
     #     HTTP debug output will be sent to the `:logger`.
@@ -961,6 +960,68 @@ module Aws::IoT
       req.send_request(options)
     end
 
+    # Create a dimension that you can use to limit the scope of a metric
+    # used in a security profile for AWS IoT Device Defender. For example,
+    # using a `TOPIC_FILTER` dimension, you can narrow down the scope of the
+    # metric only to MQTT topics whose name match the pattern specified in
+    # the dimension.
+    #
+    # @option params [required, String] :name
+    #   A unique identifier for the dimension. Choose something that describes
+    #   the type and value to make it easy to remember what it does.
+    #
+    # @option params [required, String] :type
+    #   Specifies the type of dimension. Supported types: `TOPIC_FILTER.`
+    #
+    # @option params [required, Array<String>] :string_values
+    #   Specifies the value or list of values for the dimension. For
+    #   `TOPIC_FILTER` dimensions, this is a pattern used to match the MQTT
+    #   topic (for example, "admin/#").
+    #
+    # @option params [Array<Types::Tag>] :tags
+    #   Metadata that can be used to manage the dimension.
+    #
+    # @option params [required, String] :client_request_token
+    #   Each dimension must have a unique client request token. If you try to
+    #   create a new dimension with the same token as a dimension that already
+    #   exists, an exception occurs. If you omit this value, AWS SDKs will
+    #   automatically generate a unique client request.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
+    # @return [Types::CreateDimensionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateDimensionResponse#name #name} => String
+    #   * {Types::CreateDimensionResponse#arn #arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_dimension({
+    #     name: "DimensionName", # required
+    #     type: "TOPIC_FILTER", # required, accepts TOPIC_FILTER
+    #     string_values: ["DimensionStringValue"], # required
+    #     tags: [
+    #       {
+    #         key: "TagKey",
+    #         value: "TagValue",
+    #       },
+    #     ],
+    #     client_request_token: "ClientRequestToken", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.name #=> String
+    #   resp.arn #=> String
+    #
+    # @overload create_dimension(params = {})
+    # @param [Hash] params ({})
+    def create_dimension(params = {}, options = {})
+      req = build_request(:create_dimension, params)
+      req.send_request(options)
+    end
+
     # Creates a domain configuration.
     #
     # <note markdown="1"> The domain configuration feature is in public preview and is subject
@@ -1838,6 +1899,14 @@ module Aws::IoT
     #   retained for any metric used in the profile's `behaviors`, but it is
     #   also retained for any metric specified here.
     #
+    #   **Note:** This API field is deprecated. Please use
+    #   CreateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
+    #
+    # @option params [Array<Types::MetricToRetain>] :additional_metrics_to_retain_v2
+    #   A list of metrics whose data is retained (stored). By default, data is
+    #   retained for any metric used in the profile's `behaviors`, but it is
+    #   also retained for any metric specified here.
+    #
     # @option params [Array<Types::Tag>] :tags
     #   Metadata that can be used to manage the security profile.
     #
@@ -1855,6 +1924,10 @@ module Aws::IoT
     #       {
     #         name: "BehaviorName", # required
     #         metric: "BehaviorMetric",
+    #         metric_dimension: {
+    #           dimension_name: "DimensionName", # required
+    #           operator: "IN", # accepts IN, NOT_IN
+    #         },
     #         criteria: {
     #           comparison_operator: "less-than", # accepts less-than, less-than-equals, greater-than, greater-than-equals, in-cidr-set, not-in-cidr-set, in-port-set, not-in-port-set
     #           value: {
@@ -1878,6 +1951,15 @@ module Aws::IoT
     #       },
     #     },
     #     additional_metrics_to_retain: ["BehaviorMetric"],
+    #     additional_metrics_to_retain_v2: [
+    #       {
+    #         metric: "BehaviorMetric", # required
+    #         metric_dimension: {
+    #           dimension_name: "DimensionName", # required
+    #           operator: "IN", # accepts IN, NOT_IN
+    #         },
+    #       },
+    #     ],
     #     tags: [
     #       {
     #         key: "TagKey",
@@ -2624,6 +2706,26 @@ module Aws::IoT
       req.send_request(options)
     end
 
+    # Removes the specified dimension from your AWS account.
+    #
+    # @option params [required, String] :name
+    #   The unique identifier for the dimension that you want to delete.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_dimension({
+    #     name: "DimensionName", # required
+    #   })
+    #
+    # @overload delete_dimension(params = {})
+    # @param [Hash] params ({})
+    def delete_dimension(params = {}, options = {})
+      req = build_request(:delete_dimension, params)
+      req.send_request(options)
+    end
+
     # Deletes the specified domain configuration.
     #
     # <note markdown="1"> The domain configuration feature is in public preview and is subject
@@ -3571,6 +3673,44 @@ module Aws::IoT
       req.send_request(options)
     end
 
+    # Provides details about a dimension that is defined in your AWS
+    # account.
+    #
+    # @option params [required, String] :name
+    #   The unique identifier for the dimension.
+    #
+    # @return [Types::DescribeDimensionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DescribeDimensionResponse#name #name} => String
+    #   * {Types::DescribeDimensionResponse#arn #arn} => String
+    #   * {Types::DescribeDimensionResponse#type #type} => String
+    #   * {Types::DescribeDimensionResponse#string_values #string_values} => Array&lt;String&gt;
+    #   * {Types::DescribeDimensionResponse#creation_date #creation_date} => Time
+    #   * {Types::DescribeDimensionResponse#last_modified_date #last_modified_date} => Time
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.describe_dimension({
+    #     name: "DimensionName", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.name #=> String
+    #   resp.arn #=> String
+    #   resp.type #=> String, one of "TOPIC_FILTER"
+    #   resp.string_values #=> Array
+    #   resp.string_values[0] #=> String
+    #   resp.creation_date #=> Time
+    #   resp.last_modified_date #=> Time
+    #
+    # @overload describe_dimension(params = {})
+    # @param [Hash] params ({})
+    def describe_dimension(params = {}, options = {})
+      req = build_request(:describe_dimension, params)
+      req.send_request(options)
+    end
+
     # Gets summary information about a domain configuration.
     #
     # <note markdown="1"> The domain configuration feature is in public preview and is subject
@@ -4039,6 +4179,7 @@ module Aws::IoT
     #   * {Types::DescribeSecurityProfileResponse#behaviors #behaviors} => Array&lt;Types::Behavior&gt;
     #   * {Types::DescribeSecurityProfileResponse#alert_targets #alert_targets} => Hash&lt;String,Types::AlertTarget&gt;
     #   * {Types::DescribeSecurityProfileResponse#additional_metrics_to_retain #additional_metrics_to_retain} => Array&lt;String&gt;
+    #   * {Types::DescribeSecurityProfileResponse#additional_metrics_to_retain_v2 #additional_metrics_to_retain_v2} => Array&lt;Types::MetricToRetain&gt;
     #   * {Types::DescribeSecurityProfileResponse#version #version} => Integer
     #   * {Types::DescribeSecurityProfileResponse#creation_date #creation_date} => Time
     #   * {Types::DescribeSecurityProfileResponse#last_modified_date #last_modified_date} => Time
@@ -4057,6 +4198,8 @@ module Aws::IoT
     #   resp.behaviors #=> Array
     #   resp.behaviors[0].name #=> String
     #   resp.behaviors[0].metric #=> String
+    #   resp.behaviors[0].metric_dimension.dimension_name #=> String
+    #   resp.behaviors[0].metric_dimension.operator #=> String, one of "IN", "NOT_IN"
     #   resp.behaviors[0].criteria.comparison_operator #=> String, one of "less-than", "less-than-equals", "greater-than", "greater-than-equals", "in-cidr-set", "not-in-cidr-set", "in-port-set", "not-in-port-set"
     #   resp.behaviors[0].criteria.value.count #=> Integer
     #   resp.behaviors[0].criteria.value.cidrs #=> Array
@@ -4072,6 +4215,10 @@ module Aws::IoT
     #   resp.alert_targets["AlertTargetType"].role_arn #=> String
     #   resp.additional_metrics_to_retain #=> Array
     #   resp.additional_metrics_to_retain[0] #=> String
+    #   resp.additional_metrics_to_retain_v2 #=> Array
+    #   resp.additional_metrics_to_retain_v2[0].metric #=> String
+    #   resp.additional_metrics_to_retain_v2[0].metric_dimension.dimension_name #=> String
+    #   resp.additional_metrics_to_retain_v2[0].metric_dimension.operator #=> String, one of "IN", "NOT_IN"
     #   resp.version #=> Integer
     #   resp.creation_date #=> Time
     #   resp.last_modified_date #=> Time
@@ -5163,6 +5310,8 @@ module Aws::IoT
     #   resp.active_violations[0].security_profile_name #=> String
     #   resp.active_violations[0].behavior.name #=> String
     #   resp.active_violations[0].behavior.metric #=> String
+    #   resp.active_violations[0].behavior.metric_dimension.dimension_name #=> String
+    #   resp.active_violations[0].behavior.metric_dimension.operator #=> String, one of "IN", "NOT_IN"
     #   resp.active_violations[0].behavior.criteria.comparison_operator #=> String, one of "less-than", "less-than-equals", "greater-than", "greater-than-equals", "in-cidr-set", "not-in-cidr-set", "in-port-set", "not-in-port-set"
     #   resp.active_violations[0].behavior.criteria.value.count #=> Integer
     #   resp.active_violations[0].behavior.criteria.value.cidrs #=> Array
@@ -5726,6 +5875,39 @@ module Aws::IoT
       req.send_request(options)
     end
 
+    # List the set of dimensions that are defined for your AWS account.
+    #
+    # @option params [String] :next_token
+    #   The token for the next set of results.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to retrieve at one time.
+    #
+    # @return [Types::ListDimensionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListDimensionsResponse#dimension_names #dimension_names} => Array&lt;String&gt;
+    #   * {Types::ListDimensionsResponse#next_token #next_token} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_dimensions({
+    #     next_token: "NextToken",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.dimension_names #=> Array
+    #   resp.dimension_names[0] #=> String
+    #   resp.next_token #=> String
+    #
+    # @overload list_dimensions(params = {})
+    # @param [Hash] params ({})
+    def list_dimensions(params = {}, options = {})
+      req = build_request(:list_dimensions, params)
+      req.send_request(options)
+    end
+
     # Gets a list of domain configurations for the user. This list is sorted
     # alphabetically by domain configuration name.
     #
@@ -6453,6 +6635,10 @@ module Aws::IoT
     # @option params [Integer] :max_results
     #   The maximum number of results to return at one time.
     #
+    # @option params [String] :dimension_name
+    #   A filter to limit results to the security profiles that use the
+    #   defined dimension.
+    #
     # @return [Types::ListSecurityProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ListSecurityProfilesResponse#security_profile_identifiers #security_profile_identifiers} => Array&lt;Types::SecurityProfileIdentifier&gt;
@@ -6463,6 +6649,7 @@ module Aws::IoT
     #   resp = client.list_security_profiles({
     #     next_token: "NextToken",
     #     max_results: 1,
+    #     dimension_name: "DimensionName",
     #   })
     #
     # @example Response structure
@@ -7216,6 +7403,8 @@ module Aws::IoT
     #   resp.violation_events[0].security_profile_name #=> String
     #   resp.violation_events[0].behavior.name #=> String
     #   resp.violation_events[0].behavior.metric #=> String
+    #   resp.violation_events[0].behavior.metric_dimension.dimension_name #=> String
+    #   resp.violation_events[0].behavior.metric_dimension.operator #=> String, one of "IN", "NOT_IN"
     #   resp.violation_events[0].behavior.criteria.comparison_operator #=> String, one of "less-than", "less-than-equals", "greater-than", "greater-than-equals", "in-cidr-set", "not-in-cidr-set", "in-port-set", "not-in-port-set"
     #   resp.violation_events[0].behavior.criteria.value.count #=> Integer
     #   resp.violation_events[0].behavior.criteria.value.cidrs #=> Array
@@ -8622,6 +8811,51 @@ module Aws::IoT
       req.send_request(options)
     end
 
+    # Updates the definition for a dimension. You cannot change the type of
+    # a dimension after it is created (you can delete it and re-create it).
+    #
+    # @option params [required, String] :name
+    #   A unique identifier for the dimension. Choose something that describes
+    #   the type and value to make it easy to remember what it does.
+    #
+    # @option params [required, Array<String>] :string_values
+    #   Specifies the value or list of values for the dimension. For
+    #   `TOPIC_FILTER` dimensions, this is a pattern used to match the MQTT
+    #   topic (for example, "admin/#").
+    #
+    # @return [Types::UpdateDimensionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::UpdateDimensionResponse#name #name} => String
+    #   * {Types::UpdateDimensionResponse#arn #arn} => String
+    #   * {Types::UpdateDimensionResponse#type #type} => String
+    #   * {Types::UpdateDimensionResponse#string_values #string_values} => Array&lt;String&gt;
+    #   * {Types::UpdateDimensionResponse#creation_date #creation_date} => Time
+    #   * {Types::UpdateDimensionResponse#last_modified_date #last_modified_date} => Time
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.update_dimension({
+    #     name: "DimensionName", # required
+    #     string_values: ["DimensionStringValue"], # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.name #=> String
+    #   resp.arn #=> String
+    #   resp.type #=> String, one of "TOPIC_FILTER"
+    #   resp.string_values #=> Array
+    #   resp.string_values[0] #=> String
+    #   resp.creation_date #=> Time
+    #   resp.last_modified_date #=> Time
+    #
+    # @overload update_dimension(params = {})
+    # @param [Hash] params ({})
+    def update_dimension(params = {}, options = {})
+      req = build_request(:update_dimension, params)
+      req.send_request(options)
+    end
+
     # Updates values stored in the domain configuration. Domain
     # configurations for default endpoints can't be updated.
     #
@@ -9086,6 +9320,14 @@ module Aws::IoT
     #   retained for any metric used in the profile's `behaviors`, but it is
     #   also retained for any metric specified here.
     #
+    #   **Note:** This API field is deprecated. Please use
+    #   UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
+    #
+    # @option params [Array<Types::MetricToRetain>] :additional_metrics_to_retain_v2
+    #   A list of metrics whose data is retained (stored). By default, data is
+    #   retained for any metric used in the profile's behaviors, but it is
+    #   also retained for any metric specified here.
+    #
     # @option params [Boolean] :delete_behaviors
     #   If true, delete all `behaviors` defined for this security profile. If
     #   any `behaviors` are defined in the current invocation, an exception
@@ -9115,6 +9357,7 @@ module Aws::IoT
     #   * {Types::UpdateSecurityProfileResponse#behaviors #behaviors} => Array&lt;Types::Behavior&gt;
     #   * {Types::UpdateSecurityProfileResponse#alert_targets #alert_targets} => Hash&lt;String,Types::AlertTarget&gt;
     #   * {Types::UpdateSecurityProfileResponse#additional_metrics_to_retain #additional_metrics_to_retain} => Array&lt;String&gt;
+    #   * {Types::UpdateSecurityProfileResponse#additional_metrics_to_retain_v2 #additional_metrics_to_retain_v2} => Array&lt;Types::MetricToRetain&gt;
     #   * {Types::UpdateSecurityProfileResponse#version #version} => Integer
     #   * {Types::UpdateSecurityProfileResponse#creation_date #creation_date} => Time
     #   * {Types::UpdateSecurityProfileResponse#last_modified_date #last_modified_date} => Time
@@ -9128,6 +9371,10 @@ module Aws::IoT
     #       {
     #         name: "BehaviorName", # required
     #         metric: "BehaviorMetric",
+    #         metric_dimension: {
+    #           dimension_name: "DimensionName", # required
+    #           operator: "IN", # accepts IN, NOT_IN
+    #         },
     #         criteria: {
     #           comparison_operator: "less-than", # accepts less-than, less-than-equals, greater-than, greater-than-equals, in-cidr-set, not-in-cidr-set, in-port-set, not-in-port-set
     #           value: {
@@ -9151,6 +9398,15 @@ module Aws::IoT
     #       },
     #     },
     #     additional_metrics_to_retain: ["BehaviorMetric"],
+    #     additional_metrics_to_retain_v2: [
+    #       {
+    #         metric: "BehaviorMetric", # required
+    #         metric_dimension: {
+    #           dimension_name: "DimensionName", # required
+    #           operator: "IN", # accepts IN, NOT_IN
+    #         },
+    #       },
+    #     ],
     #     delete_behaviors: false,
     #     delete_alert_targets: false,
     #     delete_additional_metrics_to_retain: false,
@@ -9165,6 +9421,8 @@ module Aws::IoT
     #   resp.behaviors #=> Array
     #   resp.behaviors[0].name #=> String
     #   resp.behaviors[0].metric #=> String
+    #   resp.behaviors[0].metric_dimension.dimension_name #=> String
+    #   resp.behaviors[0].metric_dimension.operator #=> String, one of "IN", "NOT_IN"
     #   resp.behaviors[0].criteria.comparison_operator #=> String, one of "less-than", "less-than-equals", "greater-than", "greater-than-equals", "in-cidr-set", "not-in-cidr-set", "in-port-set", "not-in-port-set"
     #   resp.behaviors[0].criteria.value.count #=> Integer
     #   resp.behaviors[0].criteria.value.cidrs #=> Array
@@ -9180,6 +9438,10 @@ module Aws::IoT
     #   resp.alert_targets["AlertTargetType"].role_arn #=> String
     #   resp.additional_metrics_to_retain #=> Array
     #   resp.additional_metrics_to_retain[0] #=> String
+    #   resp.additional_metrics_to_retain_v2 #=> Array
+    #   resp.additional_metrics_to_retain_v2[0].metric #=> String
+    #   resp.additional_metrics_to_retain_v2[0].metric_dimension.dimension_name #=> String
+    #   resp.additional_metrics_to_retain_v2[0].metric_dimension.operator #=> String, one of "IN", "NOT_IN"
     #   resp.version #=> Integer
     #   resp.creation_date #=> Time
     #   resp.last_modified_date #=> Time
@@ -9446,6 +9708,10 @@ module Aws::IoT
     #       {
     #         name: "BehaviorName", # required
     #         metric: "BehaviorMetric",
+    #         metric_dimension: {
+    #           dimension_name: "DimensionName", # required
+    #           operator: "IN", # accepts IN, NOT_IN
+    #         },
     #         criteria: {
     #           comparison_operator: "less-than", # accepts less-than, less-than-equals, greater-than, greater-than-equals, in-cidr-set, not-in-cidr-set, in-port-set, not-in-port-set
     #           value: {
@@ -9490,7 +9756,7 @@ module Aws::IoT
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-iot'
-      context[:gem_version] = '1.45.0'
+      context[:gem_version] = '1.46.0'
       Seahorse::Client::Request.new(handlers, context)
     end