@aws-sdk/client-securityhub 3.352.0 → 3.354.0

package/dist-types/commands/BatchDeleteAutomationRulesCommand.d.ts

@@ -80,6 +80,34 @@ export interface BatchDeleteAutomationRulesCommandOutput extends BatchDeleteAuto
  * @throws {@link SecurityHubServiceException}
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
+ * @example To delete one or more automation rules
+ * ```javascript
+ * // The following example deletes the specified automation rules.
+ * const input = {
+ *   "AutomationRulesArns": [
+ *     "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *     "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
+ *   ]
+ * };
+ * const command = new BatchDeleteAutomationRulesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ProcessedAutomationRules": [
+ *     "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
+ *   ],
+ *   "UnprocessedAutomationRules": [
+ *     {
+ *       "ErrorCode": 500,
+ *       "ErrorMessage": "InternalException",
+ *       "RuleArn": "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-delete-one-or-more-automation-rules-1684769550318
+ * ```
+ *
  */
 export declare class BatchDeleteAutomationRulesCommand extends $Command<BatchDeleteAutomationRulesCommandInput, BatchDeleteAutomationRulesCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: BatchDeleteAutomationRulesCommandInput;

package/dist-types/commands/BatchGetAutomationRulesCommand.d.ts

@@ -265,6 +265,102 @@ export interface BatchGetAutomationRulesCommandOutput extends BatchGetAutomation
  * @throws {@link SecurityHubServiceException}
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
+ * @example To update one ore more automation rules
+ * ```javascript
+ * // The following example updates the specified automation rules.
+ * const input = {
+ *   "AutomationRulesArns": [
+ *     "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *     "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
+ *   ]
+ * };
+ * const command = new BatchGetAutomationRulesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Rules": [
+ *     {
+ *       "Actions": [
+ *         {
+ *           "FindingFieldsUpdate": {
+ *             "Workflow": {
+ *               "Status": "RESOLVED"
+ *             }
+ *           },
+ *           "Type": "FINDING_FIELDS_UPDATE"
+ *         }
+ *       ],
+ *       "CreatedAt": "2022-08-31T01:52:33.250Z",
+ *       "CreatedBy": "AROAJURBUYQQNL5OL2TIM:TEST-16MJ75L9VBK14",
+ *       "Criteria": {
+ *         "AwsAccountId": [
+ *           {
+ *             "Comparison": "EQUALS",
+ *             "Value": "111122223333"
+ *           }
+ *         ],
+ *         "FirstObservedAt": [
+ *           {
+ *             "DateRange": {
+ *               "Unit": "DAYS",
+ *               "Value": 5
+ *             }
+ *           }
+ *         ],
+ *         "Type": [
+ *           {
+ *             "Comparison": "EQUALS",
+ *             "Value": "Software and Configuration Checks/Industry and Regulatory Standards"
+ *           }
+ *         ]
+ *       },
+ *       "Description": "sample rule description 1",
+ *       "RuleArn": "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *       "RuleName": "sample-rule-name-1",
+ *       "RuleOrder": 1,
+ *       "RuleStatus": "ENABLED",
+ *       "UpdatedAt": "2022-08-31T01:52:33.250Z"
+ *     },
+ *     {
+ *       "Actions": [
+ *         {
+ *           "FindingFieldsUpdate": {
+ *             "Workflow": {
+ *               "Status": "RESOLVED"
+ *             }
+ *           },
+ *           "Type": "FINDING_FIELDS_UPDATE"
+ *         }
+ *       ],
+ *       "CreatedAt": "2022-08-31T01:52:33.250Z",
+ *       "CreatedBy": "AROAJURBUYQQNL5OL2TIM:TEST-16MJ75L9VBK14",
+ *       "Criteria": {
+ *         "ResourceType": [
+ *           {
+ *             "Comparison": "EQUALS",
+ *             "Value": "Ec2Instance"
+ *           }
+ *         ],
+ *         "SeverityLabel": [
+ *           {
+ *             "Comparison": "EQUALS",
+ *             "Value": "INFORMATIONAL"
+ *           }
+ *         ]
+ *       },
+ *       "Description": "Sample rule description 2",
+ *       "RuleArn": "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
+ *       "RuleName": "sample-rule-name-2",
+ *       "RuleOrder": 2,
+ *       "RuleStatus": "ENABLED",
+ *       "UpdatedAt": "2022-08-31T01:52:33.250Z"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-update-one-ore-more-automation-rules-1684771025347
+ * ```
+ *
  */
 export declare class BatchGetAutomationRulesCommand extends $Command<BatchGetAutomationRulesCommandInput, BatchGetAutomationRulesCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: BatchGetAutomationRulesCommandInput;

package/dist-types/commands/BatchUpdateAutomationRulesCommand.d.ts

@@ -259,6 +259,35 @@ export interface BatchUpdateAutomationRulesCommandOutput extends BatchUpdateAuto
  * @throws {@link SecurityHubServiceException}
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
+ * @example To update one ore more automation rules
+ * ```javascript
+ * // The following example updates the specified automation rules.
+ * const input = {
+ *   "UpdateAutomationRulesRequestItems": [
+ *     {
+ *       "RuleArn": "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *       "RuleOrder": 15,
+ *       "RuleStatus": "ENABLED"
+ *     },
+ *     {
+ *       "RuleArn": "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
+ *       "RuleStatus": "DISABLED"
+ *     }
+ *   ]
+ * };
+ * const command = new BatchUpdateAutomationRulesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ProcessedAutomationRules": [
+ *     "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *     "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
+ *   ]
+ * }
+ * *\/
+ * // example id: to-update-one-ore-more-automation-rules-1684771025347
+ * ```
+ *
  */
 export declare class BatchUpdateAutomationRulesCommand extends $Command<BatchUpdateAutomationRulesCommandInput, BatchUpdateAutomationRulesCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: BatchUpdateAutomationRulesCommandInput;

package/dist-types/commands/CreateAutomationRuleCommand.d.ts

@@ -247,6 +247,75 @@ export interface CreateAutomationRuleCommandOutput extends CreateAutomationRuleR
  * @throws {@link SecurityHubServiceException}
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
+ * @example To create an automation rule
+ * ```javascript
+ * // The following example creates an automation rule.
+ * const input = {
+ *   "Actions": [
+ *     {
+ *       "FindingFieldsUpdate": {
+ *         "Note": {
+ *           "Text": "This is a critical S3 bucket, please look into this ASAP",
+ *           "UpdatedBy": "test-user"
+ *         },
+ *         "Severity": {
+ *           "Label": "CRITICAL"
+ *         }
+ *       },
+ *       "Type": "FINDING_FIELDS_UPDATE"
+ *     }
+ *   ],
+ *   "Criteria": {
+ *     "ComplianceStatus": [
+ *       {
+ *         "Comparison": "EQUALS",
+ *         "Value": "FAILED"
+ *       }
+ *     ],
+ *     "ProductName": [
+ *       {
+ *         "Comparison": "EQUALS",
+ *         "Value": "Security Hub"
+ *       }
+ *     ],
+ *     "RecordState": [
+ *       {
+ *         "Comparison": "EQUALS",
+ *         "Value": "ACTIVE"
+ *       }
+ *     ],
+ *     "ResourceId": [
+ *       {
+ *         "Comparison": "EQUALS",
+ *         "Value": "arn:aws:s3:::examplebucket/developers/design_info.doc"
+ *       }
+ *     ],
+ *     "WorkflowStatus": [
+ *       {
+ *         "Comparison": "EQUALS",
+ *         "Value": "NEW"
+ *       }
+ *     ]
+ *   },
+ *   "Description": "Elevate finding severity to Critical for important resources",
+ *   "IsTerminal": false,
+ *   "RuleName": "Elevate severity for important resources",
+ *   "RuleOrder": 1,
+ *   "RuleStatus": "ENABLED",
+ *   "Tags": {
+ *     "important-resources-rule": "s3-bucket"
+ *   }
+ * };
+ * const command = new CreateAutomationRuleCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "RuleArn": "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
+ * }
+ * *\/
+ * // example id: to-create-an-automation-rule-1684768393507
+ * ```
+ *
  */
 export declare class CreateAutomationRuleCommand extends $Command<CreateAutomationRuleCommandInput, CreateAutomationRuleCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: CreateAutomationRuleCommandInput;

package/dist-types/commands/ListAutomationRulesCommand.d.ts

@@ -83,6 +83,45 @@ export interface ListAutomationRulesCommandOutput extends ListAutomationRulesRes
  * @throws {@link SecurityHubServiceException}
  * <p>Base exception class for all service exceptions from SecurityHub service.</p>
  *
+ * @example To list automation rules
+ * ```javascript
+ * // The following example lists automation rules and rule metadata in the calling account.
+ * const input = {
+ *   "MaxResults": 2,
+ *   "NextToken": "example-token"
+ * };
+ * const command = new ListAutomationRulesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "AutomationRulesMetadata": [
+ *     {
+ *       "CreatedAt": "2022-08-31T01:52:33.250Z",
+ *       "CreatedBy": "AROAJURBUYQQNL5OL2TIM:TEST-16MJ75L9VBK14",
+ *       "Description": "IAM.8 is a known issue and can be resolved",
+ *       "RuleArn": "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *       "RuleName": "sample-rule-name-1",
+ *       "RuleOrder": 1,
+ *       "RuleStatus": "ENABLED",
+ *       "UpdatedAt": "2022-08-31T01:52:33.250Z"
+ *     },
+ *     {
+ *       "CreatedAt": "2022-08-31T01:52:33.250Z",
+ *       "CreatedBy": "AROAJURBUYQQNL5OL2TIM:TEST-16MJ75L9VBK14",
+ *       "Description": "Lambda.2 is a known issue and can be resolved",
+ *       "RuleArn": "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
+ *       "RuleName": "sample-rule-name-2",
+ *       "RuleOrder": 2,
+ *       "RuleStatus": "ENABLED",
+ *       "UpdatedAt": "2022-08-31T01:52:33.250Z"
+ *     }
+ *   ],
+ *   "NextToken": "example-token"
+ * }
+ * *\/
+ * // example id: to-list-automation-rules-1684770582059
+ * ```
+ *
  */
 export declare class ListAutomationRulesCommand extends $Command<ListAutomationRulesCommandInput, ListAutomationRulesCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: ListAutomationRulesCommandInput;

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.352.0",
+  "version": "3.354.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,10 +21,10 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.352.0",
-    "@aws-sdk/config-resolver": "3.347.0",
-    "@aws-sdk/credential-provider-node": "3.352.0",
-    "@aws-sdk/fetch-http-handler": "3.347.0",
+    "@aws-sdk/client-sts": "3.354.0",
+    "@aws-sdk/config-resolver": "3.354.0",
+    "@aws-sdk/credential-provider-node": "3.354.0",
+    "@aws-sdk/fetch-http-handler": "3.353.0",
     "@aws-sdk/hash-node": "3.347.0",
     "@aws-sdk/invalid-dependency": "3.347.0",
     "@aws-sdk/middleware-content-length": "3.347.0",
@@ -32,12 +32,12 @@
     "@aws-sdk/middleware-host-header": "3.347.0",
     "@aws-sdk/middleware-logger": "3.347.0",
     "@aws-sdk/middleware-recursion-detection": "3.347.0",
-    "@aws-sdk/middleware-retry": "3.347.0",
+    "@aws-sdk/middleware-retry": "3.354.0",
     "@aws-sdk/middleware-serde": "3.347.0",
-    "@aws-sdk/middleware-signing": "3.347.0",
+    "@aws-sdk/middleware-signing": "3.354.0",
     "@aws-sdk/middleware-stack": "3.347.0",
     "@aws-sdk/middleware-user-agent": "3.352.0",
-    "@aws-sdk/node-config-provider": "3.347.0",
+    "@aws-sdk/node-config-provider": "3.354.0",
     "@aws-sdk/node-http-handler": "3.350.0",
     "@aws-sdk/smithy-client": "3.347.0",
     "@aws-sdk/types": "3.347.0",
@@ -45,12 +45,12 @@
     "@aws-sdk/util-base64": "3.310.0",
     "@aws-sdk/util-body-length-browser": "3.310.0",
     "@aws-sdk/util-body-length-node": "3.310.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.347.0",
-    "@aws-sdk/util-defaults-mode-node": "3.347.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.353.0",
+    "@aws-sdk/util-defaults-mode-node": "3.354.0",
     "@aws-sdk/util-endpoints": "3.352.0",
     "@aws-sdk/util-retry": "3.347.0",
     "@aws-sdk/util-user-agent-browser": "3.347.0",
-    "@aws-sdk/util-user-agent-node": "3.347.0",
+    "@aws-sdk/util-user-agent-node": "3.354.0",
     "@aws-sdk/util-utf8": "3.310.0",
     "@smithy/protocol-http": "^1.0.1",
     "@smithy/types": "^1.0.0",