@aws-sdk/client-securityhub 3.363.0 → 3.366.0

package/dist-types/models/models_0.d.ts

@@ -662,8 +662,7 @@ export interface WorkflowUpdate {
 /**
  * @public
  * <p>
- *          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.
  *       </p>
  */
 export interface AutomationRulesFindingFieldsUpdate {
@@ -677,31 +676,31 @@ export interface AutomationRulesFindingFieldsUpdate {
     Severity?: SeverityUpdate;
     /**
      * <p>
-     *          The rule action will update the <code>VerificationState</code> field of a finding.
+     *          The rule action updates the <code>VerificationState</code> field of a finding.
      *       </p>
      */
     VerificationState?: VerificationState | string;
     /**
      * <p>
-     *          The rule action will update the <code>Confidence</code> field of a finding.
+     *          The rule action updates the <code>Confidence</code> field of a finding.
      *       </p>
      */
     Confidence?: number;
     /**
      * <p>
-     *          The rule action will update the <code>Criticality</code> field of a finding.
+     *          The rule action updates the <code>Criticality</code> field of a finding.
      *       </p>
      */
     Criticality?: number;
     /**
      * <p>
-     *          The rule action will update the <code>Types</code> field of a finding.
+     *          The rule action updates the <code>Types</code> field of a finding.
      *       </p>
      */
     Types?: string[];
     /**
      * <p>
-     *          The rule action will update the <code>UserDefinedFields</code> field of a finding.
+     *          The rule action updates the <code>UserDefinedFields</code> field of a finding.
      *       </p>
      */
     UserDefinedFields?: Record<string, string>;
@@ -711,7 +710,7 @@ export interface AutomationRulesFindingFieldsUpdate {
     Workflow?: WorkflowUpdate;
     /**
      * <p>
-     *             A list of findings that are related to a finding.
+     *             The rule action updates the <code>RelatedFindings</code> field of a finding.
      *         </p>
      */
     RelatedFindings?: RelatedFinding[];
@@ -738,8 +737,7 @@ export interface AutomationRulesAction {
     /**
      * <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
+     *          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>
@@ -1415,7 +1413,7 @@ export interface AutomationRulesConfig {
     /**
      * <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
+     *          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>
      */
@@ -1442,15 +1440,16 @@ export interface AutomationRulesConfig {
      * <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 rule criteria and doesn't evaluate other rules for the finding.
    The default value of this field is <code>false</code>.
      *         </p>
      */
     IsTerminal?: boolean;
     /**
      * <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
+     *          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>
      */
@@ -1504,9 +1503,11 @@ export interface AutomationRulesMetadata {
     /**
      * <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
+     *          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 <code>BatchUpdateAutomationRules</code>.
+     *          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>
      */
     RuleStatus?: RuleStatus | string;
@@ -1533,7 +1534,7 @@ export interface AutomationRulesMetadata {
      *             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 rule criteria and doesn't evaluate other rules for the finding.
    The default value of this field is <code>false</code>.
      *         </p>
      */

package/dist-types/models/models_2.d.ts

@@ -324,9 +324,7 @@ export interface SecurityControl {
     SeverityRating: SeverityRating | string | undefined;
     /**
      * <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>.
+     *          The enablement status of a security control in a specific standard.
      *       </p>
      */
     SecurityControlStatus: ControlStatus | string | undefined;
@@ -595,9 +593,11 @@ export interface UpdateAutomationRulesRequestItem {
     /**
      * <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
+     *          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 <code>BatchUpdateAutomationRules</code>.
+     *          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>
      */
     RuleStatus?: RuleStatus | string;
@@ -623,7 +623,7 @@ export interface UpdateAutomationRulesRequestItem {
      * <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 rule criteria and doesn't evaluate other rules for the finding.
    The default value of this field is <code>false</code>.
      *         </p>
      */
@@ -631,7 +631,7 @@ export interface UpdateAutomationRulesRequestItem {
     /**
      * <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
+     *          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>
      */
@@ -1002,9 +1002,11 @@ export interface CreateAutomationRuleRequest {
     /**
      * <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
+     *          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 <code>BatchUpdateAutomationRules</code>.
+     *          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>
      */
     RuleStatus?: RuleStatus | string;
@@ -1030,14 +1032,14 @@ export interface CreateAutomationRuleRequest {
      * <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>.
+     *             the rule criteria and doesn't evaluate other rules for the finding. The default value of this field is <code>false</code>.
      *         </p>
      */
     IsTerminal?: boolean;
     /**
      * <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
+     *          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>
      */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-securityhub",
   "description": "AWS SDK for JavaScript Securityhub Client for Node.js, Browser and React Native",
-  "version": "3.363.0",
+  "version": "3.366.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",