Skip to content

Commit 2cd992b

Browse files
author
AWS
committed
AWS SecurityHub Update: Documentation updates for AWS Security Hub
1 parent 22d97ef commit 2cd992b

File tree

2 files changed

+26
-20
lines changed

2 files changed

+26
-20
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS SecurityHub",
4+
"contributor": "",
5+
"description": "Documentation updates for AWS Security Hub"
6+
}

services/securityhub/src/main/resources/codegen-resources/service-2.json

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1460,7 +1460,7 @@
14601460
"members":{
14611461
"Type":{
14621462
"shape":"AutomationRulesActionType",
1463-
"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>"
1463+
"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>"
14641464
},
14651465
"FindingFieldsUpdate":{
14661466
"shape":"AutomationRulesFindingFieldsUpdate",
@@ -1488,7 +1488,7 @@
14881488
},
14891489
"RuleStatus":{
14901490
"shape":"RuleStatus",
1491-
"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>"
1491+
"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>"
14921492
},
14931493
"RuleOrder":{
14941494
"shape":"RuleOrderValue",
@@ -1504,11 +1504,11 @@
15041504
},
15051505
"IsTerminal":{
15061506
"shape":"Boolean",
1507-
"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>"
1507+
"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>"
15081508
},
15091509
"Criteria":{
15101510
"shape":"AutomationRulesFindingFilters",
1511-
"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>"
1511+
"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>"
15121512
},
15131513
"Actions":{
15141514
"shape":"ActionList",
@@ -1540,31 +1540,31 @@
15401540
"Severity":{"shape":"SeverityUpdate"},
15411541
"VerificationState":{
15421542
"shape":"VerificationState",
1543-
"documentation":"<p> The rule action will update the <code>VerificationState</code> field of a finding. </p>"
1543+
"documentation":"<p> The rule action updates the <code>VerificationState</code> field of a finding. </p>"
15441544
},
15451545
"Confidence":{
15461546
"shape":"RatioScale",
1547-
"documentation":"<p> The rule action will update the <code>Confidence</code> field of a finding. </p>"
1547+
"documentation":"<p> The rule action updates the <code>Confidence</code> field of a finding. </p>"
15481548
},
15491549
"Criticality":{
15501550
"shape":"RatioScale",
1551-
"documentation":"<p> The rule action will update the <code>Criticality</code> field of a finding. </p>"
1551+
"documentation":"<p> The rule action updates the <code>Criticality</code> field of a finding. </p>"
15521552
},
15531553
"Types":{
15541554
"shape":"TypeList",
1555-
"documentation":"<p> The rule action will update the <code>Types</code> field of a finding. </p>"
1555+
"documentation":"<p> The rule action updates the <code>Types</code> field of a finding. </p>"
15561556
},
15571557
"UserDefinedFields":{
15581558
"shape":"FieldMap",
1559-
"documentation":"<p> The rule action will update the <code>UserDefinedFields</code> field of a finding. </p>"
1559+
"documentation":"<p> The rule action updates the <code>UserDefinedFields</code> field of a finding. </p>"
15601560
},
15611561
"Workflow":{"shape":"WorkflowUpdate"},
15621562
"RelatedFindings":{
15631563
"shape":"RelatedFindingList",
1564-
"documentation":"<p> A list of findings that are related to a finding. </p>"
1564+
"documentation":"<p> The rule action updates the <code>RelatedFindings</code> field of a finding. </p>"
15651565
}
15661566
},
1567-
"documentation":"<p> Identifies the finding fields that the automation rule action will update when a finding matches the defined criteria. </p>"
1567+
"documentation":"<p> Identifies the finding fields that the automation rule action updates when a finding matches the defined criteria. </p>"
15681568
},
15691569
"AutomationRulesFindingFilters":{
15701570
"type":"structure",
@@ -1721,7 +1721,7 @@
17211721
},
17221722
"RuleStatus":{
17231723
"shape":"RuleStatus",
1724-
"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>"
1724+
"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>"
17251725
},
17261726
"RuleOrder":{
17271727
"shape":"RuleOrderValue",
@@ -1737,7 +1737,7 @@
17371737
},
17381738
"IsTerminal":{
17391739
"shape":"Boolean",
1740-
"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>"
1740+
"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>"
17411741
},
17421742
"CreatedAt":{
17431743
"shape":"Timestamp",
@@ -14696,7 +14696,7 @@
1469614696
},
1469714697
"RuleStatus":{
1469814698
"shape":"RuleStatus",
14699-
"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>"
14699+
"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>"
1470014700
},
1470114701
"RuleOrder":{
1470214702
"shape":"RuleOrderValue",
@@ -14712,11 +14712,11 @@
1471214712
},
1471314713
"IsTerminal":{
1471414714
"shape":"Boolean",
14715-
"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>"
14715+
"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>"
1471614716
},
1471714717
"Criteria":{
1471814718
"shape":"AutomationRulesFindingFilters",
14719-
"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>"
14719+
"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>"
1472014720
},
1472114721
"Actions":{
1472214722
"shape":"ActionList",
@@ -18127,7 +18127,7 @@
1812718127
},
1812818128
"SecurityControlStatus":{
1812918129
"shape":"ControlStatus",
18130-
"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>"
18130+
"documentation":"<p> The enablement status of a security control in a specific standard. </p>"
1813118131
}
1813218132
},
1813318133
"documentation":"<p> A security control in Security Hub describes a security best practice related to a specific resource. </p>"
@@ -19116,7 +19116,7 @@
1911619116
},
1911719117
"RuleStatus":{
1911819118
"shape":"RuleStatus",
19119-
"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>"
19119+
"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>"
1912019120
},
1912119121
"RuleOrder":{
1912219122
"shape":"RuleOrderValue",
@@ -19132,11 +19132,11 @@
1913219132
},
1913319133
"IsTerminal":{
1913419134
"shape":"Boolean",
19135-
"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>"
19135+
"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>"
1913619136
},
1913719137
"Criteria":{
1913819138
"shape":"AutomationRulesFindingFilters",
19139-
"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>"
19139+
"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>"
1914019140
},
1914119141
"Actions":{
1914219142
"shape":"ActionList",

0 commit comments

Comments
 (0)