@aws-sdk/client-securityhub 3.600.0 → 3.602.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8966,7 +8966,45 @@ export interface Compliance {
8966
8966
  SecurityControlParameters?: SecurityControlParameter[];
8967
8967
  }
8968
8968
  /**
8969
- * <p>The severity assigned to the finding by the finding provider.</p>
8969
+ * <p>The severity assigned to a finding by the finding provider. This object may include one or more of the following
8970
+ * attributes:</p>
8971
+ * <ul>
8972
+ * <li>
8973
+ * <p>
8974
+ * <code>Label</code>
8975
+ * </p>
8976
+ * </li>
8977
+ * <li>
8978
+ * <p>
8979
+ * <code>Normalized</code>
8980
+ * </p>
8981
+ * </li>
8982
+ * <li>
8983
+ * <p>
8984
+ * <code>Original</code>
8985
+ * </p>
8986
+ * </li>
8987
+ * <li>
8988
+ * <p>
8989
+ * <code>Product</code>
8990
+ * </p>
8991
+ * </li>
8992
+ * </ul>
8993
+ * <p>If a <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings.html">
8994
+ * <code>BatchImportFindings</code>
8995
+ * </a> request for a
8996
+ * new finding only provides <code>Label</code> or only provides <code>Normalized</code>, Security Hub
8997
+ * automatically populates the value of the other field.</p>
8998
+ * <p>The <code>Normalized</code> and <code>Product</code> attributes are included in the <code>FindingProviderSeverity</code>
8999
+ * structure to preserve the historical information associated with the finding, even if the top-level
9000
+ * <code>Severity</code> object is later modified using the <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings.html">
9001
+ * <code>BatchUpdateFindings</code>
9002
+ * </a> operation.</p>
9003
+ * <p>If the top-level <code>Finding.Severity</code> object is present, but <code>Finding.FindingProviderFields</code> isn't present,
9004
+ * Security Hub creates the <code>FindingProviderFields.Severity</code> object and copies the entire <code>Finding.Severity</code> object into it.
9005
+ * This ensures that the original, provider-supplied details are retained within the <code>FindingProviderFields.Severity</code>
9006
+ * object, even if the top-level <code>Severity</code> object is overwritten.
9007
+ * </p>
8970
9008
  * @public
8971
9009
  */
8972
9010
  export interface FindingProviderSeverity {
@@ -8983,7 +9021,51 @@ export interface FindingProviderSeverity {
8983
9021
  Original?: string;
8984
9022
  }
8985
9023
  /**
8986
- * <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>
9024
+ * <p>In a <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings.html">
9025
+ * <code>BatchImportFindings</code>
9026
+ * </a> request, finding providers use <code>FindingProviderFields</code> to provide
9027
+ * and update values for the following fields:</p>
9028
+ * <ul>
9029
+ * <li>
9030
+ * <p>
9031
+ * <code>Confidence</code>
9032
+ * </p>
9033
+ * </li>
9034
+ * <li>
9035
+ * <p>
9036
+ * <code>Criticality</code>
9037
+ * </p>
9038
+ * </li>
9039
+ * <li>
9040
+ * <p>
9041
+ * <code>RelatedFindings</code>
9042
+ * </p>
9043
+ * </li>
9044
+ * <li>
9045
+ * <p>
9046
+ * <code>Severity</code>
9047
+ * </p>
9048
+ * </li>
9049
+ * <li>
9050
+ * <p>
9051
+ * <code>Types</code>
9052
+ * </p>
9053
+ * </li>
9054
+ * </ul>
9055
+ * <p>The preceding fields are nested under the <code>FindingProviderFields</code> object, but also have analogues of the same name
9056
+ * as top-level ASFF fields. When a new finding is sent to Security Hub by a finding provider, Security Hub populates the
9057
+ * <code>FindingProviderFields</code> object automatically, if it is empty, based on the corresponding top-level fields.</p>
9058
+ * <p>Finding providers can update <code>FindingProviderFields</code> only by using the <code>BatchImportFindings</code>
9059
+ * operation. Finding providers can't update
9060
+ * this object with the <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings.html">
9061
+ * <code>BatchUpdateFindings</code>
9062
+ * </a> operation. Customers can update the top-level fields by using the <code>BatchUpdateFindings</code> operation. Customers can't
9063
+ * update <code>FindingProviderFields</code>.</p>
9064
+ * <p>For information about how Security Hub handles updates from <code>BatchImportFindings</code> to
9065
+ * <code>FindingProviderFields</code> and to the corresponding top-level
9066
+ * attributes, see <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/finding-update-batchimportfindings.html#batchimportfindings-findingproviderfields">Using <code>FindingProviderFields</code>
9067
+ * </a> in the <i>Security Hub User Guide</i>.</p>
9068
+ * <p></p>
8987
9069
  * @public
8988
9070
  */
8989
9071
  export interface FindingProviderFields {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-securityhub",
3
3
  "description": "AWS SDK for JavaScript Securityhub Client for Node.js, Browser and React Native",
4
- "version": "3.600.0",
4
+ "version": "3.602.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-securityhub",