Skip to content

Commit e0f0232

Browse files
author
awstools
committed
docs(client-securityhub): Documentation updates for Security Hub
1 parent 8741cd4 commit e0f0232

File tree

2 files changed

+86
-4
lines changed

2 files changed

+86
-4
lines changed

‎clients/client-securityhub/src/models/models_1.ts

+84-2
Original file line numberDiff line numberDiff line change
@@ -10068,7 +10068,45 @@ export interface Compliance {
1006810068
}
1006910069

1007010070
/**
10071-
* <p>The severity assigned to the finding by the finding provider.</p>
10071+
* <p>The severity assigned to a finding by the finding provider. This object may include one or more of the following
10072+
* attributes:</p>
10073+
* <ul>
10074+
* <li>
10075+
* <p>
10076+
* <code>Label</code>
10077+
* </p>
10078+
* </li>
10079+
* <li>
10080+
* <p>
10081+
* <code>Normalized</code>
10082+
* </p>
10083+
* </li>
10084+
* <li>
10085+
* <p>
10086+
* <code>Original</code>
10087+
* </p>
10088+
* </li>
10089+
* <li>
10090+
* <p>
10091+
* <code>Product</code>
10092+
* </p>
10093+
* </li>
10094+
* </ul>
10095+
* <p>If a <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings.html">
10096+
* <code>BatchImportFindings</code>
10097+
* </a> request for a
10098+
* new finding only provides <code>Label</code> or only provides <code>Normalized</code>, Security Hub
10099+
* automatically populates the value of the other field.</p>
10100+
* <p>The <code>Normalized</code> and <code>Product</code> attributes are included in the <code>FindingProviderSeverity</code>
10101+
* structure to preserve the historical information associated with the finding, even if the top-level
10102+
* <code>Severity</code> object is later modified using the <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings.html">
10103+
* <code>BatchUpdateFindings</code>
10104+
* </a> operation.</p>
10105+
* <p>If the top-level <code>Finding.Severity</code> object is present, but <code>Finding.FindingProviderFields</code> isn't present,
10106+
* Security Hub creates the <code>FindingProviderFields.Severity</code> object and copies the entire <code>Finding.Severity</code> object into it.
10107+
* This ensures that the original, provider-supplied details are retained within the <code>FindingProviderFields.Severity</code>
10108+
* object, even if the top-level <code>Severity</code> object is overwritten.
10109+
* </p>
1007210110
* @public
1007310111
*/
1007410112
export interface FindingProviderSeverity {
@@ -10087,7 +10125,51 @@ export interface FindingProviderSeverity {
1008710125
}
1008810126

1008910127
/**
10090-
* <p>In a <code>BatchImportFindings</code> request, finding providers use <code>FindingProviderFields</code> to provide and update values for confidence, criticality, related findings, severity, and types.</p>
10128+
* <p>In a <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings.html">
10129+
* <code>BatchImportFindings</code>
10130+
* </a> request, finding providers use <code>FindingProviderFields</code> to provide
10131+
* and update values for the following fields:</p>
10132+
* <ul>
10133+
* <li>
10134+
* <p>
10135+
* <code>Confidence</code>
10136+
* </p>
10137+
* </li>
10138+
* <li>
10139+
* <p>
10140+
* <code>Criticality</code>
10141+
* </p>
10142+
* </li>
10143+
* <li>
10144+
* <p>
10145+
* <code>RelatedFindings</code>
10146+
* </p>
10147+
* </li>
10148+
* <li>
10149+
* <p>
10150+
* <code>Severity</code>
10151+
* </p>
10152+
* </li>
10153+
* <li>
10154+
* <p>
10155+
* <code>Types</code>
10156+
* </p>
10157+
* </li>
10158+
* </ul>
10159+
* <p>The preceding fields are nested under the <code>FindingProviderFields</code> object, but also have analogues of the same name
10160+
* as top-level ASFF fields. When a new finding is sent to Security Hub by a finding provider, Security Hub populates the
10161+
* <code>FindingProviderFields</code> object automatically, if it is empty, based on the corresponding top-level fields.</p>
10162+
* <p>Finding providers can update <code>FindingProviderFields</code> only by using the <code>BatchImportFindings</code>
10163+
* operation. Finding providers can't update
10164+
* this object with the <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings.html">
10165+
* <code>BatchUpdateFindings</code>
10166+
* </a> operation. Customers can update the top-level fields by using the <code>BatchUpdateFindings</code> operation. Customers can't
10167+
* update <code>FindingProviderFields</code>.</p>
10168+
* <p>For information about how Security Hub handles updates from <code>BatchImportFindings</code> to
10169+
* <code>FindingProviderFields</code> and to the corresponding top-level
10170+
* attributes, see <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/finding-update-batchimportfindings.html#batchimportfindings-findingproviderfields">Using <code>FindingProviderFields</code>
10171+
* </a> in the <i>Security Hub User Guide</i>.</p>
10172+
* <p></p>
1009110173
* @public
1009210174
*/
1009310175
export interface FindingProviderFields {

‎codegen/sdk-codegen/aws-models/securityhub.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -25554,7 +25554,7 @@
2555425554
}
2555525555
},
2555625556
"traits": {
25557-
"smithy.api#documentation": "<p>In a <code>BatchImportFindings</code> request, finding providers use <code>FindingProviderFields</code> to provide and update values for confidence, criticality, related findings, severity, and types.</p>"
25557+
"smithy.api#documentation": "<p>In a <a href=\"https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings.html\">\n <code>BatchImportFindings</code>\n </a> request, finding providers use <code>FindingProviderFields</code> to provide \n and update values for the following fields:</p>\n <ul>\n <li>\n <p>\n <code>Confidence</code>\n </p>\n </li>\n <li>\n <p>\n <code>Criticality</code>\n </p>\n </li>\n <li>\n <p>\n <code>RelatedFindings</code>\n </p>\n </li>\n <li>\n <p>\n <code>Severity</code>\n </p>\n </li>\n <li>\n <p>\n <code>Types</code>\n </p>\n </li>\n </ul>\n <p>The preceding fields are nested under the <code>FindingProviderFields</code> object, but also have analogues of the same name \n as top-level ASFF fields. When a new finding is sent to Security Hub by a finding provider, Security Hub populates the \n <code>FindingProviderFields</code> object automatically, if it is empty, based on the corresponding top-level fields.</p>\n <p>Finding providers can update <code>FindingProviderFields</code> only by using the <code>BatchImportFindings</code> \n operation. Finding providers can't update\n this object with the <a href=\"https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings.html\">\n <code>BatchUpdateFindings</code>\n </a> operation. Customers can update the top-level fields by using the <code>BatchUpdateFindings</code> operation. Customers can't \n update <code>FindingProviderFields</code>.</p>\n <p>For information about how Security Hub handles updates from <code>BatchImportFindings</code> to\n <code>FindingProviderFields</code> and to the corresponding top-level\n attributes, see <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/finding-update-batchimportfindings.html#batchimportfindings-findingproviderfields\">Using <code>FindingProviderFields</code>\n </a> in the <i>Security Hub User Guide</i>.</p>\n <p></p>"
2555825558
}
2555925559
},
2556025560
"com.amazonaws.securityhub#FindingProviderSeverity": {
@@ -25574,7 +25574,7 @@
2557425574
}
2557525575
},
2557625576
"traits": {
25577-
"smithy.api#documentation": "<p>The severity assigned to the finding by the finding provider.</p>"
25577+
"smithy.api#documentation": "<p>The severity assigned to a finding by the finding provider. This object may include one or more of the following \nattributes:</p>\n <ul>\n <li>\n <p>\n <code>Label</code>\n </p>\n </li>\n <li>\n <p>\n <code>Normalized</code>\n </p>\n </li>\n <li>\n <p>\n <code>Original</code>\n </p>\n </li>\n <li>\n <p>\n <code>Product</code>\n </p>\n </li>\n </ul>\n <p>If a <a href=\"https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings.html\">\n <code>BatchImportFindings</code>\n </a> request for a \n new finding only provides <code>Label</code> or only provides <code>Normalized</code>, Security Hub \n automatically populates the value of the other field.</p>\n <p>The <code>Normalized</code> and <code>Product</code> attributes are included in the <code>FindingProviderSeverity</code> \n structure to preserve the historical information associated with the finding, even if the top-level \n <code>Severity</code> object is later modified using the <a href=\"https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings.html\">\n <code>BatchUpdateFindings</code>\n </a> operation.</p>\n <p>If the top-level <code>Finding.Severity</code> object is present, but <code>Finding.FindingProviderFields</code> isn't present, \n Security Hub creates the <code>FindingProviderFields.Severity</code> object and copies the entire <code>Finding.Severity</code> object into it. \n This ensures that the original, provider-supplied details are retained within the <code>FindingProviderFields.Severity</code> \n object, even if the top-level <code>Severity</code> object is overwritten.\n </p>"
2557825578
}
2557925579
},
2558025580
"com.amazonaws.securityhub#FirewallPolicyDetails": {

0 commit comments

Comments
 (0)