aws-sdk-securityhub 1.86.0 → 1.87.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a55a6736c853206b757a21b4c87bbef24147988d9a00f9046f6dca2a75c6ad95
-  data.tar.gz: 8864533bcee20ddffd63f9e87e02238272ec312ba107076c32c3fc15d6258c39
+  metadata.gz: de0f251175b025aa6ad0d48c577a0d14a611ebc1ae6a513b6d20fa33f54c74cf
+  data.tar.gz: 5b1c6a2578dda9c8e86ab63f7d522921fa8f8bbafd53c84b726b15eee90e241a
 SHA512:
-  metadata.gz: 4e758953f57b5f34f730a6e0381fa0448a26e8f38c8a172dca3974c117451948d9c62c9c55f555baec114351ccc7cac044e0b41f154e6a737fb600fa3d31bff6
-  data.tar.gz: '0794dbeb5fb0b7a803ff350de8b1de548165bc3b4a8971778eefcac37581c1ef7602c3789fa864cbb01ad1e16d1c45b59edecaef6ecc67673d23228fbc17fcb2'
+  metadata.gz: 49abf9f33fd5d917b65f1c8a3dd47929d76ae300c056b76e6a2f2eaef812e75eaf5909fbd9787bbcfbd5f83e28f8a1d3ecb47d61492b0413d2ebf9aae603b808
+  data.tar.gz: '082aeb1029ace44b25e20d7719bb8953ac627a1accf623b9d50fa102812e9dc2629fad5fbdf2446410c7869c07e61da81595e373fb67c4aa156274c0ff1abc72'

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.87.0 (2023-07-05)
+------------------
+
+* Feature - Documentation updates for AWS Security Hub
+
 1.86.0 (2023-06-28)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.86.0
+1.87.0

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

@@ -1981,9 +1981,14 @@ module Aws::SecurityHub
     #
     # @option params [String] :rule_status
     #   Whether the rule is active after it is created. If this parameter is
-    #   equal to `Enabled`, Security Hub will apply the rule to findings and
-    #   finding updates after the rule is created. To change the value of this
-    #   parameter after creating a rule, use `BatchUpdateAutomationRules`.
+    #   equal to `ENABLED`, Security Hub starts applying the rule to findings
+    #   and finding updates after the rule is created. To change the value of
+    #   this parameter after creating a rule, use [
+    #   `BatchUpdateAutomationRules` ][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html
     #
     # @option params [required, Integer] :rule_order
     #   An integer ranging from 1 to 1000 that represents the order in which
@@ -2002,14 +2007,14 @@ module Aws::SecurityHub
     #   matches the criteria for multiple rules, and each rule has different
     #   actions. If the value of this field is set to `true` for a rule,
     #   Security Hub applies the rule action to a finding that matches the
-    #   rule criteria and won't evaluate other rules for the finding. The
+    #   rule criteria and doesn't evaluate other rules for the finding. The
     #   default value of this field is `false`.
     #
     # @option params [required, Types::AutomationRulesFindingFilters] :criteria
     #   A set of ASFF finding field attributes and corresponding expected
-    #   values that Security Hub uses to filter findings. If a finding matches
-    #   the conditions specified in this parameter, Security Hub applies the
-    #   rule action to the finding.
+    #   values that Security Hub uses to filter findings. If a rule is enabled
+    #   and a finding matches the conditions specified in this parameter,
+    #   Security Hub applies the rule action to the finding.
     #
     # @option params [required, Array<Types::AutomationRulesAction>] :actions
     #   One or more actions to update finding fields if a finding matches the
@@ -8683,7 +8688,7 @@ module Aws::SecurityHub
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-securityhub'
-      context[:gem_version] = '1.86.0'
+      context[:gem_version] = '1.87.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -396,10 +396,9 @@ module Aws::SecurityHub
     #
     # @!attribute [rw] type
     #   Specifies that the rule action should update the `Types` finding
-    #   field. The `Types` finding field provides one or more finding types
-    #   in the format of namespace/category/classifier that classify a
-    #   finding. For more information, see [Types taxonomy for ASFF][1] in
-    #   the *Security Hub User Guide*.
+    #   field. The `Types` finding field classifies findings in the format
+    #   of namespace/category/classifier. For more information, see [Types
+    #   taxonomy for ASFF][1] in the *Security Hub User Guide*.
     #
     #
     #
@@ -428,8 +427,8 @@ module Aws::SecurityHub
     #
     # @!attribute [rw] rule_status
     #   Whether the rule is active after it is created. If this parameter is
-    #   equal to `>ENABLED`, Security Hub will apply the rule to findings
-    #   and finding updates after the rule is created.
+    #   equal to `ENABLED`, Security Hub starts applying the rule to
+    #   findings and finding updates after the rule is created.
     #   @return [String]
     #
     # @!attribute [rw] rule_order
@@ -452,16 +451,16 @@ module Aws::SecurityHub
     #   finding matches the criteria for multiple rules, and each rule has
     #   different actions. If the value of this field is set to `true` for a
     #   rule, Security Hub applies the rule action to a finding that matches
-    #   the rule criteria and won't evaluate other rules for the finding.

-    #   finding.
 The default value of this field is `false`.
+    #   the rule criteria and doesn't evaluate other rules for the finding.

+    #   finding.
 The default value of this field is `false`.
     #   @return [Boolean]
     #
     # @!attribute [rw] criteria
     #   A set of [Amazon Web Services Security Finding Format][1] finding
     #   field attributes and corresponding expected values that Security Hub
-    #   uses to filter findings. If a finding matches the conditions
-    #   specified in this parameter, Security Hub applies the rule action to
-    #   the finding.
+    #   uses to filter findings. If a rule is enabled and a finding matches
+    #   the conditions specified in this parameter, Security Hub applies the
+    #   rule action to the finding.
     #
     #
     #
@@ -519,8 +518,8 @@ module Aws::SecurityHub
       include Aws::Structure
     end
 
-    # Identifies the finding fields that the automation rule action will
-    # update when a finding matches the defined criteria.
+    # Identifies the finding fields that the automation rule action updates
+    # when a finding matches the defined criteria.
     #
     # @!attribute [rw] note
     #   The updated note.
@@ -531,25 +530,23 @@ module Aws::SecurityHub
     #   @return [Types::SeverityUpdate]
     #
     # @!attribute [rw] verification_state
-    #   The rule action will update the `VerificationState` field of a
-    #   finding.
+    #   The rule action updates the `VerificationState` field of a finding.
     #   @return [String]
     #
     # @!attribute [rw] confidence
-    #   The rule action will update the `Confidence` field of a finding.
+    #   The rule action updates the `Confidence` field of a finding.
     #   @return [Integer]
     #
     # @!attribute [rw] criticality
-    #   The rule action will update the `Criticality` field of a finding.
+    #   The rule action updates the `Criticality` field of a finding.
     #   @return [Integer]
     #
     # @!attribute [rw] types
-    #   The rule action will update the `Types` field of a finding.
+    #   The rule action updates the `Types` field of a finding.
     #   @return [Array<String>]
     #
     # @!attribute [rw] user_defined_fields
-    #   The rule action will update the `UserDefinedFields` field of a
-    #   finding.
+    #   The rule action updates the `UserDefinedFields` field of a finding.
     #   @return [Hash<String,String>]
     #
     # @!attribute [rw] workflow
@@ -557,7 +554,7 @@ module Aws::SecurityHub
     #   @return [Types::WorkflowUpdate]
     #
     # @!attribute [rw] related_findings
-    #   A list of findings that are related to a finding.
+    #   The rule action updates the `RelatedFindings` field of a finding.
     #   @return [Array<Types::RelatedFinding>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/AutomationRulesFindingFieldsUpdate AWS API Documentation
@@ -866,10 +863,14 @@ module Aws::SecurityHub
     #
     # @!attribute [rw] rule_status
     #   Whether the rule is active after it is created. If this parameter is
-    #   equal to `ENABLED`, Security Hub will apply the rule to findings and
-    #   finding updates after the rule is created. To change the value of
-    #   this parameter after creating a rule, use
-    #   `BatchUpdateAutomationRules`.
+    #   equal to `ENABLED`, Security Hub starts applying the rule to
+    #   findings and finding updates after the rule is created. To change
+    #   the value of this parameter after creating a rule, use [
+    #   `BatchUpdateAutomationRules` ][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html
     #   @return [String]
     #
     # @!attribute [rw] rule_order
@@ -892,8 +893,8 @@ module Aws::SecurityHub
     #   finding matches the criteria for multiple rules, and each rule has
     #   different actions. If the value of this field is set to `true` for a
     #   rule, Security Hub applies the rule action to a finding that matches
-    #   the rule criteria and won't evaluate other rules for the finding.

-    #   finding.
 The default value of this field is `false`.
+    #   the rule criteria and doesn't evaluate other rules for the finding.

+    #   finding.
 The default value of this field is `false`.
     #   @return [Boolean]
     #
     # @!attribute [rw] created_at
@@ -20705,10 +20706,14 @@ module Aws::SecurityHub
     #
     # @!attribute [rw] rule_status
     #   Whether the rule is active after it is created. If this parameter is
-    #   equal to `Enabled`, Security Hub will apply the rule to findings and
-    #   finding updates after the rule is created. To change the value of
-    #   this parameter after creating a rule, use
-    #   `BatchUpdateAutomationRules`.
+    #   equal to `ENABLED`, Security Hub starts applying the rule to
+    #   findings and finding updates after the rule is created. To change
+    #   the value of this parameter after creating a rule, use [
+    #   `BatchUpdateAutomationRules` ][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html
     #   @return [String]
     #
     # @!attribute [rw] rule_order
@@ -20731,15 +20736,15 @@ module Aws::SecurityHub
     #   finding matches the criteria for multiple rules, and each rule has
     #   different actions. If the value of this field is set to `true` for a
     #   rule, Security Hub applies the rule action to a finding that matches
-    #   the rule criteria and won't evaluate other rules for the finding.
+    #   the rule criteria and doesn't evaluate other rules for the finding.
     #   The default value of this field is `false`.
     #   @return [Boolean]
     #
     # @!attribute [rw] criteria
     #   A set of ASFF finding field attributes and corresponding expected
-    #   values that Security Hub uses to filter findings. If a finding
-    #   matches the conditions specified in this parameter, Security Hub
-    #   applies the rule action to the finding.
+    #   values that Security Hub uses to filter findings. If a rule is
+    #   enabled and a finding matches the conditions specified in this
+    #   parameter, Security Hub applies the rule action to the finding.
     #   @return [Types::AutomationRulesFindingFilters]
     #
     # @!attribute [rw] actions
@@ -25349,14 +25354,7 @@ module Aws::SecurityHub
     #   @return [String]
     #
     # @!attribute [rw] security_control_status
-    #   The status of a security control based on the compliance status of
-    #   its findings. For more information about how control status is
-    #   determined, see [Determining the overall status of a control from
-    #   its findings][1] in the *Security Hub User Guide*.
-    #
-    #
-    #
-    #   [1]: https://docs.aws.amazon.com/securityhub/latest/userguide/controls-overall-status.html
+    #   The enablement status of a security control in a specific standard.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/SecurityControl AWS API Documentation
@@ -26572,10 +26570,14 @@ module Aws::SecurityHub
     #
     # @!attribute [rw] rule_status
     #   Whether the rule is active after it is created. If this parameter is
-    #   equal to `ENABLED`, Security Hub will apply the rule to findings and
-    #   finding updates after the rule is created. To change the value of
-    #   this parameter after creating a rule, use
-    #   `BatchUpdateAutomationRules`.
+    #   equal to `ENABLED`, Security Hub starts applying the rule to
+    #   findings and finding updates after the rule is created. To change
+    #   the value of this parameter after creating a rule, use [
+    #   `BatchUpdateAutomationRules` ][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html
     #   @return [String]
     #
     # @!attribute [rw] rule_order
@@ -26598,15 +26600,15 @@ module Aws::SecurityHub
     #   finding matches the criteria for multiple rules, and each rule has
     #   different actions. If the value of this field is set to `true` for a
     #   rule, Security Hub applies the rule action to a finding that matches
-    #   the rule criteria and won't evaluate other rules for the finding.

-    #   finding.
 The default value of this field is `false`.
+    #   the rule criteria and doesn't evaluate other rules for the finding.

+    #   finding.
 The default value of this field is `false`.
     #   @return [Boolean]
     #
     # @!attribute [rw] criteria
     #   A set of ASFF finding field attributes and corresponding expected
-    #   values that Security Hub uses to filter findings. If a finding
-    #   matches the conditions specified in this parameter, Security Hub
-    #   applies the rule action to the finding.
+    #   values that Security Hub uses to filter findings. If a rule is
+    #   enabled and a finding matches the conditions specified in this
+    #   parameter, Security Hub applies the rule action to the finding.
     #   @return [Types::AutomationRulesFindingFilters]
     #
     # @!attribute [rw] actions

data/lib/aws-sdk-securityhub.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-securityhub/customizations'
 # @!group service
 module Aws::SecurityHub
 
-  GEM_VERSION = '1.86.0'
+  GEM_VERSION = '1.87.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-securityhub
 version: !ruby/object:Gem::Version
-  version: 1.86.0
+  version: 1.87.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-28 00:00:00.000000000 Z
+date: 2023-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core