AWS SecurityHub Update: Documentation updates for AWS Security Hub

AWS · AWS · commit 2cd992b6144d · 2023-07-05T18:07:09.000Z
diff --git a/.changes/next-release/feature-AWSSecurityHub-9f8257d.json b/.changes/next-release/feature-AWSSecurityHub-9f8257d.json
@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "AWS SecurityHub",
+    "contributor": "",
+    "description": "Documentation updates for AWS Security Hub"
+}
diff --git a/services/securityhub/src/main/resources/codegen-resources/service-2.json b/services/securityhub/src/main/resources/codegen-resources/service-2.json
@@ -1460,7 +1460,7 @@
       "members":{
         "Type":{
           "shape":"AutomationRulesActionType",
-          "documentation":"<p> Specifies that the rule action should update the <code>Types</code> finding field. The <code>Types</code> finding field provides one or more finding types in the format of namespace/category/classifier that classify a finding. For more information, see <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format-type-taxonomy.html\">Types taxonomy for ASFF</a> in the <i>Security Hub User Guide</i>. </p>"
+          "documentation":"<p> Specifies that the rule action should update the <code>Types</code> finding field. The <code>Types</code> finding field classifies findings in the format of namespace/category/classifier. For more information, see <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format-type-taxonomy.html\">Types taxonomy for ASFF</a> in the <i>Security Hub User Guide</i>. </p>"
         },
         "FindingFieldsUpdate":{
           "shape":"AutomationRulesFindingFieldsUpdate",
@@ -1488,7 +1488,7 @@
         },
         "RuleStatus":{
           "shape":"RuleStatus",
-          "documentation":"<p> Whether the rule is active after it is created. If this parameter is equal to <code>&gt;ENABLED</code>, Security Hub will apply the rule to findings and finding updates after the rule is created. </p>"
+          "documentation":"<p> Whether the rule is active after it is created. If this parameter is equal to <code>ENABLED</code>, Security Hub starts applying the rule to findings and finding updates after the rule is created. </p>"
         },
         "RuleOrder":{
           "shape":"RuleOrderValue",
@@ -1504,11 +1504,11 @@
         },
         "IsTerminal":{
           "shape":"Boolean",
-          "documentation":"<p>Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If the value of this field is set to <code>true</code> 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.&#x2028; The default value of this field is <code>false</code>. </p>"
+          "documentation":"<p>Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If the value of this field is set to <code>true</code> for a rule, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding.&#x2028; The default value of this field is <code>false</code>. </p>"
         },
         "Criteria":{
           "shape":"AutomationRulesFindingFilters",
-          "documentation":"<p> A set of <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html\">Amazon Web Services Security Finding Format</a> 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. </p>"
+          "documentation":"<p> A set of <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html\">Amazon Web Services Security Finding Format</a> finding field attributes and corresponding expected 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. </p>"
         },
         "Actions":{
           "shape":"ActionList",
@@ -1540,31 +1540,31 @@
         "Severity":{"shape":"SeverityUpdate"},
         "VerificationState":{
           "shape":"VerificationState",
-          "documentation":"<p> The rule action will update the <code>VerificationState</code> field of a finding. </p>"
+          "documentation":"<p> The rule action updates the <code>VerificationState</code> field of a finding. </p>"
         },
         "Confidence":{
           "shape":"RatioScale",
-          "documentation":"<p> The rule action will update the <code>Confidence</code> field of a finding. </p>"
+          "documentation":"<p> The rule action updates the <code>Confidence</code> field of a finding. </p>"
         },
         "Criticality":{
           "shape":"RatioScale",
-          "documentation":"<p> The rule action will update the <code>Criticality</code> field of a finding. </p>"
+          "documentation":"<p> The rule action updates the <code>Criticality</code> field of a finding. </p>"
         },
         "Types":{
           "shape":"TypeList",
-          "documentation":"<p> The rule action will update the <code>Types</code> field of a finding. </p>"
+          "documentation":"<p> The rule action updates the <code>Types</code> field of a finding. </p>"
         },
         "UserDefinedFields":{
           "shape":"FieldMap",
-          "documentation":"<p> The rule action will update the <code>UserDefinedFields</code> field of a finding. </p>"
+          "documentation":"<p> The rule action updates the <code>UserDefinedFields</code> field of a finding. </p>"
         },
         "Workflow":{"shape":"WorkflowUpdate"},
         "RelatedFindings":{
           "shape":"RelatedFindingList",
-          "documentation":"<p> A list of findings that are related to a finding. </p>"
+          "documentation":"<p> The rule action updates the <code>RelatedFindings</code> field of a finding. </p>"
         }
       },
-      "documentation":"<p> Identifies the finding fields that the automation rule action will update when a finding matches the defined criteria. </p>"
+      "documentation":"<p> Identifies the finding fields that the automation rule action updates when a finding matches the defined criteria. </p>"
     },
     "AutomationRulesFindingFilters":{
       "type":"structure",
@@ -1721,7 +1721,7 @@
         },
         "RuleStatus":{
           "shape":"RuleStatus",
-          "documentation":"<p> Whether the rule is active after it is created. If this parameter is equal to <code>ENABLED</code>, 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 <code>BatchUpdateAutomationRules</code>. </p>"
+          "documentation":"<p> Whether the rule is active after it is created. If this parameter is equal to <code>ENABLED</code>, 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 <a href=\"https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html\"> <code>BatchUpdateAutomationRules</code> </a>. </p>"
         },
         "RuleOrder":{
           "shape":"RuleOrderValue",
@@ -1737,7 +1737,7 @@
         },
         "IsTerminal":{
           "shape":"Boolean",
-          "documentation":"<p> Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If the value of this field is set to <code>true</code> 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.&#x2028; The default value of this field is <code>false</code>. </p>"
+          "documentation":"<p> Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If the value of this field is set to <code>true</code> for a rule, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding.&#x2028; The default value of this field is <code>false</code>. </p>"
         },
         "CreatedAt":{
           "shape":"Timestamp",
@@ -14696,7 +14696,7 @@
         },
         "RuleStatus":{
           "shape":"RuleStatus",
-          "documentation":"<p> Whether the rule is active after it is created. If this parameter is equal to <code>Enabled</code>, 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 <code>BatchUpdateAutomationRules</code>. </p>"
+          "documentation":"<p> Whether the rule is active after it is created. If this parameter is equal to <code>ENABLED</code>, 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 <a href=\"https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html\"> <code>BatchUpdateAutomationRules</code> </a>. </p>"
         },
         "RuleOrder":{
           "shape":"RuleOrderValue",
@@ -14712,11 +14712,11 @@
         },
         "IsTerminal":{
           "shape":"Boolean",
-          "documentation":"<p>Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If the value of this field is set to <code>true</code> 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 default value of this field is <code>false</code>. </p>"
+          "documentation":"<p>Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If the value of this field is set to <code>true</code> for a rule, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding. The default value of this field is <code>false</code>. </p>"
         },
         "Criteria":{
           "shape":"AutomationRulesFindingFilters",
-          "documentation":"<p> 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. </p>"
+          "documentation":"<p> A set of ASFF finding field attributes and corresponding expected 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. </p>"
         },
         "Actions":{
           "shape":"ActionList",
@@ -18127,7 +18127,7 @@
         },
         "SecurityControlStatus":{
           "shape":"ControlStatus",
-          "documentation":"<p> The status of a security control based on the compliance status of its findings. For more information about how control status is determined, see <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/controls-overall-status.html\">Determining the overall status of a control from its findings</a> in the <i>Security Hub User Guide</i>. </p>"
+          "documentation":"<p> The enablement status of a security control in a specific standard. </p>"
         }
       },
       "documentation":"<p> A security control in Security Hub describes a security best practice related to a specific resource. </p>"
@@ -19116,7 +19116,7 @@
         },
         "RuleStatus":{
           "shape":"RuleStatus",
-          "documentation":"<p> Whether the rule is active after it is created. If this parameter is equal to <code>ENABLED</code>, 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 <code>BatchUpdateAutomationRules</code>. </p>"
+          "documentation":"<p> Whether the rule is active after it is created. If this parameter is equal to <code>ENABLED</code>, 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 <a href=\"https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html\"> <code>BatchUpdateAutomationRules</code> </a>. </p>"
         },
         "RuleOrder":{
           "shape":"RuleOrderValue",
@@ -19132,11 +19132,11 @@
         },
         "IsTerminal":{
           "shape":"Boolean",
-          "documentation":"<p>Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If the value of this field is set to <code>true</code> 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.&#x2028; The default value of this field is <code>false</code>. </p>"
+          "documentation":"<p>Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If the value of this field is set to <code>true</code> for a rule, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding.&#x2028; The default value of this field is <code>false</code>. </p>"
         },
         "Criteria":{
           "shape":"AutomationRulesFindingFilters",
-          "documentation":"<p> 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. </p>"
+          "documentation":"<p> A set of ASFF finding field attributes and corresponding expected 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. </p>"
         },
         "Actions":{
           "shape":"ActionList",
