@aws-sdk/client-securityhub 3.775.0 → 3.782.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.
- package/dist-types/commands/AcceptAdministratorInvitationCommand.d.ts +8 -5
- package/dist-types/commands/AcceptInvitationCommand.d.ts +1 -0
- package/dist-types/commands/BatchDeleteAutomationRulesCommand.d.ts +9 -9
- package/dist-types/commands/BatchDisableStandardsCommand.d.ts +9 -9
- package/dist-types/commands/BatchEnableStandardsCommand.d.ts +10 -10
- package/dist-types/commands/BatchGetAutomationRulesCommand.d.ts +49 -49
- package/dist-types/commands/BatchGetConfigurationPolicyAssociationsCommand.d.ts +22 -22
- package/dist-types/commands/BatchGetSecurityControlsCommand.d.ts +33 -33
- package/dist-types/commands/BatchGetStandardsControlAssociationsCommand.d.ts +1 -50
- package/dist-types/commands/BatchImportFindingsCommand.d.ts +26 -26
- package/dist-types/commands/BatchUpdateAutomationRulesCommand.d.ts +10 -10
- package/dist-types/commands/BatchUpdateFindingsCommand.d.ts +30 -30
- package/dist-types/commands/BatchUpdateStandardsControlAssociationsCommand.d.ts +20 -20
- package/dist-types/commands/CreateActionTargetCommand.d.ts +7 -7
- package/dist-types/commands/CreateAutomationRuleCommand.d.ts +35 -35
- package/dist-types/commands/CreateConfigurationPolicyCommand.d.ts +37 -37
- package/dist-types/commands/CreateFindingAggregatorCommand.d.ts +9 -9
- package/dist-types/commands/CreateInsightCommand.d.ts +13 -13
- package/dist-types/commands/CreateMembersCommand.d.ts +7 -7
- package/dist-types/commands/DeclineInvitationsCommand.d.ts +5 -5
- package/dist-types/commands/DeleteActionTargetCommand.d.ts +5 -5
- package/dist-types/commands/DeleteConfigurationPolicyCommand.d.ts +7 -4
- package/dist-types/commands/DeleteFindingAggregatorCommand.d.ts +7 -4
- package/dist-types/commands/DeleteInsightCommand.d.ts +5 -5
- package/dist-types/commands/DeleteInvitationsCommand.d.ts +5 -5
- package/dist-types/commands/DeleteMembersCommand.d.ts +5 -5
- package/dist-types/commands/DescribeActionTargetsCommand.d.ts +8 -8
- package/dist-types/commands/DescribeHubCommand.d.ts +8 -8
- package/dist-types/commands/DescribeOrganizationConfigurationCommand.d.ts +10 -10
- package/dist-types/commands/DescribeProductsCommand.d.ts +17 -17
- package/dist-types/commands/DescribeStandardsCommand.d.ts +21 -21
- package/dist-types/commands/DescribeStandardsControlsCommand.d.ts +1 -46
- package/dist-types/commands/DisableImportFindingsForProductCommand.d.ts +7 -4
- package/dist-types/commands/DisableOrganizationAdminAccountCommand.d.ts +7 -4
- package/dist-types/commands/DisableSecurityHubCommand.d.ts +7 -4
- package/dist-types/commands/DisassociateFromAdministratorAccountCommand.d.ts +7 -4
- package/dist-types/commands/DisassociateFromMasterAccountCommand.d.ts +1 -0
- package/dist-types/commands/DisassociateMembersCommand.d.ts +7 -4
- package/dist-types/commands/EnableImportFindingsForProductCommand.d.ts +5 -5
- package/dist-types/commands/EnableOrganizationAdminAccountCommand.d.ts +7 -4
- package/dist-types/commands/EnableSecurityHubCommand.d.ts +9 -6
- package/dist-types/commands/GetAdministratorAccountCommand.d.ts +1 -19
- package/dist-types/commands/GetConfigurationPolicyAssociationCommand.d.ts +12 -12
- package/dist-types/commands/GetConfigurationPolicyCommand.d.ts +23 -23
- package/dist-types/commands/GetEnabledStandardsCommand.d.ts +9 -9
- package/dist-types/commands/GetFindingAggregatorCommand.d.ts +8 -8
- package/dist-types/commands/GetFindingHistoryCommand.d.ts +1 -42
- package/dist-types/commands/GetFindingsCommand.d.ts +63 -63
- package/dist-types/commands/GetInsightResultsCommand.d.ts +12 -12
- package/dist-types/commands/GetInsightsCommand.d.ts +15 -15
- package/dist-types/commands/GetInvitationsCountCommand.d.ts +7 -7
- package/dist-types/commands/GetMasterAccountCommand.d.ts +1 -0
- package/dist-types/commands/GetMembersCommand.d.ts +1 -37
- package/dist-types/commands/GetSecurityControlDefinitionCommand.d.ts +19 -19
- package/dist-types/commands/InviteMembersCommand.d.ts +5 -5
- package/dist-types/commands/ListAutomationRulesCommand.d.ts +23 -23
- package/dist-types/commands/ListConfigurationPoliciesCommand.d.ts +13 -13
- package/dist-types/commands/ListConfigurationPolicyAssociationsCommand.d.ts +15 -15
- package/dist-types/commands/ListEnabledProductsForImportCommand.d.ts +5 -5
- package/dist-types/commands/ListFindingAggregatorsCommand.d.ts +6 -6
- package/dist-types/commands/ListInvitationsCommand.d.ts +1 -21
- package/dist-types/commands/ListMembersCommand.d.ts +1 -31
- package/dist-types/commands/ListOrganizationAdminAccountsCommand.d.ts +7 -7
- package/dist-types/commands/ListSecurityControlDefinitionsCommand.d.ts +28 -28
- package/dist-types/commands/ListStandardsControlAssociationsCommand.d.ts +1 -44
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +7 -7
- package/dist-types/commands/StartConfigurationPolicyAssociationCommand.d.ts +13 -13
- package/dist-types/commands/StartConfigurationPolicyDisassociationCommand.d.ts +9 -6
- package/dist-types/commands/TagResourceCommand.d.ts +10 -7
- package/dist-types/commands/UntagResourceCommand.d.ts +8 -5
- package/dist-types/commands/UpdateActionTargetCommand.d.ts +9 -6
- package/dist-types/commands/UpdateConfigurationPolicyCommand.d.ts +39 -39
- package/dist-types/commands/UpdateFindingAggregatorCommand.d.ts +10 -10
- package/dist-types/commands/UpdateFindingsCommand.d.ts +1 -0
- package/dist-types/commands/UpdateInsightCommand.d.ts +15 -12
- package/dist-types/commands/UpdateOrganizationConfigurationCommand.d.ts +10 -7
- package/dist-types/commands/UpdateSecurityControlCommand.d.ts +13 -10
- package/dist-types/commands/UpdateSecurityHubConfigurationCommand.d.ts +8 -5
- package/dist-types/commands/UpdateStandardsControlCommand.d.ts +9 -6
- package/package.json +5 -5
|
@@ -270,36 +270,36 @@ declare const BatchUpdateAutomationRulesCommand_base: {
|
|
|
270
270
|
* @throws {@link SecurityHubServiceException}
|
|
271
271
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
272
272
|
*
|
|
273
|
-
*
|
|
273
|
+
*
|
|
274
274
|
* @example To update one ore more automation rules
|
|
275
275
|
* ```javascript
|
|
276
276
|
* // The following example updates the specified automation rules.
|
|
277
277
|
* const input = {
|
|
278
|
-
*
|
|
278
|
+
* UpdateAutomationRulesRequestItems: [
|
|
279
279
|
* {
|
|
280
|
-
*
|
|
281
|
-
*
|
|
282
|
-
*
|
|
280
|
+
* RuleArn: "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
281
|
+
* RuleOrder: 15,
|
|
282
|
+
* RuleStatus: "ENABLED"
|
|
283
283
|
* },
|
|
284
284
|
* {
|
|
285
|
-
*
|
|
286
|
-
*
|
|
285
|
+
* RuleArn: "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
|
|
286
|
+
* RuleStatus: "DISABLED"
|
|
287
287
|
* }
|
|
288
288
|
* ]
|
|
289
289
|
* };
|
|
290
290
|
* const command = new BatchUpdateAutomationRulesCommand(input);
|
|
291
291
|
* const response = await client.send(command);
|
|
292
|
-
* /* response
|
|
292
|
+
* /* response is
|
|
293
293
|
* {
|
|
294
|
-
*
|
|
294
|
+
* ProcessedAutomationRules: [
|
|
295
295
|
* "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
296
296
|
* "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
|
|
297
297
|
* ]
|
|
298
298
|
* }
|
|
299
299
|
* *\/
|
|
300
|
-
* // example id: to-update-one-ore-more-automation-rules-1684771025347
|
|
301
300
|
* ```
|
|
302
301
|
*
|
|
302
|
+
* @public
|
|
303
303
|
*/
|
|
304
304
|
export declare class BatchUpdateAutomationRulesCommand extends BatchUpdateAutomationRulesCommand_base {
|
|
305
305
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -173,67 +173,67 @@ declare const BatchUpdateFindingsCommand_base: {
|
|
|
173
173
|
* @throws {@link SecurityHubServiceException}
|
|
174
174
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
175
175
|
*
|
|
176
|
-
*
|
|
176
|
+
*
|
|
177
177
|
* @example To update Security Hub findings
|
|
178
178
|
* ```javascript
|
|
179
179
|
* // The following example updates Security Hub findings. The finding identifier parameter specifies which findings to update. Only specific finding fields can be updated with this operation.
|
|
180
180
|
* const input = {
|
|
181
|
-
*
|
|
182
|
-
*
|
|
183
|
-
*
|
|
181
|
+
* Confidence: 80,
|
|
182
|
+
* Criticality: 80,
|
|
183
|
+
* FindingIdentifiers: [
|
|
184
184
|
* {
|
|
185
|
-
*
|
|
186
|
-
*
|
|
185
|
+
* Id: "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1/PCI.Lambda.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
186
|
+
* ProductArn: "arn:aws:securityhub:us-west-1::product/aws/securityhub"
|
|
187
187
|
* },
|
|
188
188
|
* {
|
|
189
|
-
*
|
|
190
|
-
*
|
|
189
|
+
* Id: "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1/PCI.Lambda.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
|
|
190
|
+
* ProductArn: "arn:aws:securityhub:us-west-1::product/aws/securityhub"
|
|
191
191
|
* }
|
|
192
192
|
* ],
|
|
193
|
-
*
|
|
194
|
-
*
|
|
195
|
-
*
|
|
193
|
+
* Note: {
|
|
194
|
+
* Text: "Known issue that is not a risk.",
|
|
195
|
+
* UpdatedBy: "user1"
|
|
196
196
|
* },
|
|
197
|
-
*
|
|
197
|
+
* RelatedFindings: [
|
|
198
198
|
* {
|
|
199
|
-
*
|
|
200
|
-
*
|
|
199
|
+
* Id: "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1/PCI.Lambda.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
|
|
200
|
+
* ProductArn: "arn:aws:securityhub:us-west-1::product/aws/securityhub"
|
|
201
201
|
* }
|
|
202
202
|
* ],
|
|
203
|
-
*
|
|
204
|
-
*
|
|
203
|
+
* Severity: {
|
|
204
|
+
* Label: "LOW"
|
|
205
205
|
* },
|
|
206
|
-
*
|
|
206
|
+
* Types: [
|
|
207
207
|
* "Software and Configuration Checks/Vulnerabilities/CVE"
|
|
208
208
|
* ],
|
|
209
|
-
*
|
|
210
|
-
*
|
|
209
|
+
* UserDefinedFields: {
|
|
210
|
+
* reviewedByCio: "true"
|
|
211
211
|
* },
|
|
212
|
-
*
|
|
213
|
-
*
|
|
214
|
-
*
|
|
212
|
+
* VerificationState: "TRUE_POSITIVE",
|
|
213
|
+
* Workflow: {
|
|
214
|
+
* Status: "RESOLVED"
|
|
215
215
|
* }
|
|
216
216
|
* };
|
|
217
217
|
* const command = new BatchUpdateFindingsCommand(input);
|
|
218
218
|
* const response = await client.send(command);
|
|
219
|
-
* /* response
|
|
219
|
+
* /* response is
|
|
220
220
|
* {
|
|
221
|
-
*
|
|
221
|
+
* ProcessedFindings: [
|
|
222
222
|
* {
|
|
223
|
-
*
|
|
224
|
-
*
|
|
223
|
+
* Id: "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1/PCI.Lambda.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
224
|
+
* ProductArn: "arn:aws:securityhub:us-west-1::product/aws/securityhub"
|
|
225
225
|
* },
|
|
226
226
|
* {
|
|
227
|
-
*
|
|
228
|
-
*
|
|
227
|
+
* Id: "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1/PCI.Lambda.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
|
|
228
|
+
* ProductArn: "arn:aws:securityhub:us-west-1::product/aws/securityhub"
|
|
229
229
|
* }
|
|
230
230
|
* ],
|
|
231
|
-
*
|
|
231
|
+
* UnprocessedFindings: []
|
|
232
232
|
* }
|
|
233
233
|
* *\/
|
|
234
|
-
* // example id: to-update-security-hub-findings-1675183938248
|
|
235
234
|
* ```
|
|
236
235
|
*
|
|
236
|
+
* @public
|
|
237
237
|
*/
|
|
238
238
|
export declare class BatchUpdateFindingsCommand extends BatchUpdateFindingsCommand_base {
|
|
239
239
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -91,47 +91,47 @@ declare const BatchUpdateStandardsControlAssociationsCommand_base: {
|
|
|
91
91
|
* @throws {@link SecurityHubServiceException}
|
|
92
92
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
93
93
|
*
|
|
94
|
-
*
|
|
94
|
+
*
|
|
95
95
|
* @example To update enablement status of a batch of controls
|
|
96
96
|
* ```javascript
|
|
97
97
|
* // The following example disables CloudWatch.12 in CIS AWS Foundations Benchmark v1.2.0. The example returns an error for CloudTrail.1 because an invalid standard ARN is provided.
|
|
98
98
|
* const input = {
|
|
99
|
-
*
|
|
99
|
+
* StandardsControlAssociationUpdates: [
|
|
100
100
|
* {
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
*
|
|
101
|
+
* AssociationStatus: "DISABLED",
|
|
102
|
+
* SecurityControlId: "CloudTrail.1",
|
|
103
|
+
* StandardsArn: "arn:aws:securityhub:::ruleset/sample-standard/v/1.1.0",
|
|
104
|
+
* UpdatedReason: "Not relevant to environment"
|
|
105
105
|
* },
|
|
106
106
|
* {
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
*
|
|
107
|
+
* AssociationStatus: "DISABLED",
|
|
108
|
+
* SecurityControlId: "CloudWatch.12",
|
|
109
|
+
* StandardsArn: "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0",
|
|
110
|
+
* UpdatedReason: "Not relevant to environment"
|
|
111
111
|
* }
|
|
112
112
|
* ]
|
|
113
113
|
* };
|
|
114
114
|
* const command = new BatchUpdateStandardsControlAssociationsCommand(input);
|
|
115
115
|
* const response = await client.send(command);
|
|
116
|
-
* /* response
|
|
116
|
+
* /* response is
|
|
117
117
|
* {
|
|
118
|
-
*
|
|
118
|
+
* UnprocessedAssociationUpdates: [
|
|
119
119
|
* {
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
*
|
|
120
|
+
* ErrorCode: "INVALID_INPUT",
|
|
121
|
+
* ErrorReason: "Invalid Standards Arn: 'arn:aws:securityhub:::ruleset/sample-standard/v/1.1.0'",
|
|
122
|
+
* StandardsControlAssociationUpdate: {
|
|
123
|
+
* AssociationStatus: "DISABLED",
|
|
124
|
+
* SecurityControlId: "CloudTrail.1",
|
|
125
|
+
* StandardsArn: "arn:aws:securityhub:::ruleset/sample-standard/v/1.1.0",
|
|
126
|
+
* UpdatedReason: "Test Reason"
|
|
127
127
|
* }
|
|
128
128
|
* }
|
|
129
129
|
* ]
|
|
130
130
|
* }
|
|
131
131
|
* *\/
|
|
132
|
-
* // example id: to-update-enablement-status-of-a-batch-of-controls-1683300378416
|
|
133
132
|
* ```
|
|
134
133
|
*
|
|
134
|
+
* @public
|
|
135
135
|
*/
|
|
136
136
|
export declare class BatchUpdateStandardsControlAssociationsCommand extends BatchUpdateStandardsControlAssociationsCommand_base {
|
|
137
137
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -75,25 +75,25 @@ declare const CreateActionTargetCommand_base: {
|
|
|
75
75
|
* @throws {@link SecurityHubServiceException}
|
|
76
76
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
77
77
|
*
|
|
78
|
-
*
|
|
78
|
+
*
|
|
79
79
|
* @example To create a custom action target
|
|
80
80
|
* ```javascript
|
|
81
81
|
* // The following example creates a custom action target in Security Hub. Custom actions on findings and insights automatically trigger actions in Amazon CloudWatch Events.
|
|
82
82
|
* const input = {
|
|
83
|
-
*
|
|
84
|
-
*
|
|
85
|
-
*
|
|
83
|
+
* Description: "Action to send the finding for remediation tracking",
|
|
84
|
+
* Id: "Remediation",
|
|
85
|
+
* Name: "Send to remediation"
|
|
86
86
|
* };
|
|
87
87
|
* const command = new CreateActionTargetCommand(input);
|
|
88
88
|
* const response = await client.send(command);
|
|
89
|
-
* /* response
|
|
89
|
+
* /* response is
|
|
90
90
|
* {
|
|
91
|
-
*
|
|
91
|
+
* ActionTargetArn: "arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation"
|
|
92
92
|
* }
|
|
93
93
|
* *\/
|
|
94
|
-
* // example id: to-create-a-custom-action-target-1675184966299
|
|
95
94
|
* ```
|
|
96
95
|
*
|
|
96
|
+
* @public
|
|
97
97
|
*/
|
|
98
98
|
export declare class CreateActionTargetCommand extends CreateActionTargetCommand_base {
|
|
99
99
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -258,76 +258,76 @@ declare const CreateAutomationRuleCommand_base: {
|
|
|
258
258
|
* @throws {@link SecurityHubServiceException}
|
|
259
259
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
260
260
|
*
|
|
261
|
-
*
|
|
261
|
+
*
|
|
262
262
|
* @example To create an automation rule
|
|
263
263
|
* ```javascript
|
|
264
264
|
* // The following example creates an automation rule.
|
|
265
265
|
* const input = {
|
|
266
|
-
*
|
|
266
|
+
* Actions: [
|
|
267
267
|
* {
|
|
268
|
-
*
|
|
269
|
-
*
|
|
270
|
-
*
|
|
271
|
-
*
|
|
268
|
+
* FindingFieldsUpdate: {
|
|
269
|
+
* Note: {
|
|
270
|
+
* Text: "This is a critical S3 bucket, please look into this ASAP",
|
|
271
|
+
* UpdatedBy: "test-user"
|
|
272
272
|
* },
|
|
273
|
-
*
|
|
274
|
-
*
|
|
273
|
+
* Severity: {
|
|
274
|
+
* Label: "CRITICAL"
|
|
275
275
|
* }
|
|
276
276
|
* },
|
|
277
|
-
*
|
|
277
|
+
* Type: "FINDING_FIELDS_UPDATE"
|
|
278
278
|
* }
|
|
279
279
|
* ],
|
|
280
|
-
*
|
|
281
|
-
*
|
|
280
|
+
* Criteria: {
|
|
281
|
+
* ComplianceStatus: [
|
|
282
282
|
* {
|
|
283
|
-
*
|
|
284
|
-
*
|
|
283
|
+
* Comparison: "EQUALS",
|
|
284
|
+
* Value: "FAILED"
|
|
285
285
|
* }
|
|
286
286
|
* ],
|
|
287
|
-
*
|
|
287
|
+
* ProductName: [
|
|
288
288
|
* {
|
|
289
|
-
*
|
|
290
|
-
*
|
|
289
|
+
* Comparison: "EQUALS",
|
|
290
|
+
* Value: "Security Hub"
|
|
291
291
|
* }
|
|
292
292
|
* ],
|
|
293
|
-
*
|
|
293
|
+
* RecordState: [
|
|
294
294
|
* {
|
|
295
|
-
*
|
|
296
|
-
*
|
|
295
|
+
* Comparison: "EQUALS",
|
|
296
|
+
* Value: "ACTIVE"
|
|
297
297
|
* }
|
|
298
298
|
* ],
|
|
299
|
-
*
|
|
299
|
+
* ResourceId: [
|
|
300
300
|
* {
|
|
301
|
-
*
|
|
302
|
-
*
|
|
301
|
+
* Comparison: "EQUALS",
|
|
302
|
+
* Value: "arn:aws:s3:::examplebucket/developers/design_info.doc"
|
|
303
303
|
* }
|
|
304
304
|
* ],
|
|
305
|
-
*
|
|
305
|
+
* WorkflowStatus: [
|
|
306
306
|
* {
|
|
307
|
-
*
|
|
308
|
-
*
|
|
307
|
+
* Comparison: "EQUALS",
|
|
308
|
+
* Value: "NEW"
|
|
309
309
|
* }
|
|
310
310
|
* ]
|
|
311
311
|
* },
|
|
312
|
-
*
|
|
313
|
-
*
|
|
314
|
-
*
|
|
315
|
-
*
|
|
316
|
-
*
|
|
317
|
-
*
|
|
318
|
-
*
|
|
312
|
+
* Description: "Elevate finding severity to Critical for important resources",
|
|
313
|
+
* IsTerminal: false,
|
|
314
|
+
* RuleName: "Elevate severity for important resources",
|
|
315
|
+
* RuleOrder: 1,
|
|
316
|
+
* RuleStatus: "ENABLED",
|
|
317
|
+
* Tags: {
|
|
318
|
+
* important-resources-rule: "s3-bucket"
|
|
319
319
|
* }
|
|
320
320
|
* };
|
|
321
321
|
* const command = new CreateAutomationRuleCommand(input);
|
|
322
322
|
* const response = await client.send(command);
|
|
323
|
-
* /* response
|
|
323
|
+
* /* response is
|
|
324
324
|
* {
|
|
325
|
-
*
|
|
325
|
+
* RuleArn: "arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
|
|
326
326
|
* }
|
|
327
327
|
* *\/
|
|
328
|
-
* // example id: to-create-an-automation-rule-1684768393507
|
|
329
328
|
* ```
|
|
330
329
|
*
|
|
330
|
+
* @public
|
|
331
331
|
*/
|
|
332
332
|
export declare class CreateAutomationRuleCommand extends CreateAutomationRuleCommand_base {
|
|
333
333
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -170,83 +170,83 @@ declare const CreateConfigurationPolicyCommand_base: {
|
|
|
170
170
|
* @throws {@link SecurityHubServiceException}
|
|
171
171
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
172
172
|
*
|
|
173
|
-
*
|
|
173
|
+
*
|
|
174
174
|
* @example To create a configuration policy
|
|
175
175
|
* ```javascript
|
|
176
176
|
* // This operation creates a configuration policy in Security Hub.
|
|
177
177
|
* const input = {
|
|
178
|
-
*
|
|
179
|
-
*
|
|
180
|
-
*
|
|
178
|
+
* ConfigurationPolicy: {
|
|
179
|
+
* SecurityHub: {
|
|
180
|
+
* EnabledStandardIdentifiers: [
|
|
181
181
|
* "arn:aws:securityhub:us-east-1::standards/aws-foundational-security-best-practices/v/1.0.0",
|
|
182
182
|
* "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0"
|
|
183
183
|
* ],
|
|
184
|
-
*
|
|
185
|
-
*
|
|
184
|
+
* SecurityControlsConfiguration: {
|
|
185
|
+
* DisabledSecurityControlIdentifiers: [
|
|
186
186
|
* "CloudWatch.1"
|
|
187
187
|
* ],
|
|
188
|
-
*
|
|
188
|
+
* SecurityControlCustomParameters: [
|
|
189
189
|
* {
|
|
190
|
-
*
|
|
191
|
-
*
|
|
192
|
-
*
|
|
193
|
-
*
|
|
190
|
+
* Parameters: {
|
|
191
|
+
* daysToExpiration: {
|
|
192
|
+
* Value: {
|
|
193
|
+
* Integer: 14
|
|
194
194
|
* },
|
|
195
|
-
*
|
|
195
|
+
* ValueType: "CUSTOM"
|
|
196
196
|
* }
|
|
197
197
|
* },
|
|
198
|
-
*
|
|
198
|
+
* SecurityControlId: "ACM.1"
|
|
199
199
|
* }
|
|
200
200
|
* ]
|
|
201
201
|
* },
|
|
202
|
-
*
|
|
202
|
+
* ServiceEnabled: true
|
|
203
203
|
* }
|
|
204
204
|
* },
|
|
205
|
-
*
|
|
206
|
-
*
|
|
205
|
+
* Description: "Configuration policy for testing FSBP and CIS",
|
|
206
|
+
* Name: "TestConfigurationPolicy"
|
|
207
207
|
* };
|
|
208
208
|
* const command = new CreateConfigurationPolicyCommand(input);
|
|
209
209
|
* const response = await client.send(command);
|
|
210
|
-
* /* response
|
|
210
|
+
* /* response is
|
|
211
211
|
* {
|
|
212
|
-
*
|
|
213
|
-
*
|
|
214
|
-
*
|
|
215
|
-
*
|
|
212
|
+
* Arn: "arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
213
|
+
* ConfigurationPolicy: {
|
|
214
|
+
* SecurityHub: {
|
|
215
|
+
* EnabledStandardIdentifiers: [
|
|
216
216
|
* "arn:aws:securityhub:us-east-1::standards/aws-foundational-security-best-practices/v/1.0.0",
|
|
217
217
|
* "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0"
|
|
218
218
|
* ],
|
|
219
|
-
*
|
|
220
|
-
*
|
|
219
|
+
* SecurityControlsConfiguration: {
|
|
220
|
+
* DisabledSecurityControlIdentifiers: [
|
|
221
221
|
* "CloudWatch.1"
|
|
222
222
|
* ],
|
|
223
|
-
*
|
|
223
|
+
* SecurityControlCustomParameters: [
|
|
224
224
|
* {
|
|
225
|
-
*
|
|
226
|
-
*
|
|
227
|
-
*
|
|
228
|
-
*
|
|
225
|
+
* Parameters: {
|
|
226
|
+
* daysToExpiration: {
|
|
227
|
+
* Value: {
|
|
228
|
+
* Integer: 14
|
|
229
229
|
* },
|
|
230
|
-
*
|
|
230
|
+
* ValueType: "CUSTOM"
|
|
231
231
|
* }
|
|
232
232
|
* },
|
|
233
|
-
*
|
|
233
|
+
* SecurityControlId: "ACM.1"
|
|
234
234
|
* }
|
|
235
235
|
* ]
|
|
236
236
|
* },
|
|
237
|
-
*
|
|
237
|
+
* ServiceEnabled: true
|
|
238
238
|
* }
|
|
239
239
|
* },
|
|
240
|
-
*
|
|
241
|
-
*
|
|
242
|
-
*
|
|
243
|
-
*
|
|
244
|
-
*
|
|
240
|
+
* CreatedAt: "2023-01-11T06:17:17.154Z",
|
|
241
|
+
* Description: "Configuration policy for testing FSBP and CIS",
|
|
242
|
+
* Id: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
243
|
+
* Name: "TestConfigurationPolicy",
|
|
244
|
+
* UpdatedAt: "2023-01-11T06:17:17.154Z"
|
|
245
245
|
* }
|
|
246
246
|
* *\/
|
|
247
|
-
* // example id: to-create-a-configuration-policy-1695172470099
|
|
248
247
|
* ```
|
|
249
248
|
*
|
|
249
|
+
* @public
|
|
250
250
|
*/
|
|
251
251
|
export declare class CreateConfigurationPolicyCommand extends CreateConfigurationPolicyCommand_base {
|
|
252
252
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -84,33 +84,33 @@ declare const CreateFindingAggregatorCommand_base: {
|
|
|
84
84
|
* @throws {@link SecurityHubServiceException}
|
|
85
85
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
86
86
|
*
|
|
87
|
-
*
|
|
87
|
+
*
|
|
88
88
|
* @example To enable cross-Region aggregation
|
|
89
89
|
* ```javascript
|
|
90
90
|
* // The following example creates a finding aggregator. This is required to enable cross-Region aggregation.
|
|
91
91
|
* const input = {
|
|
92
|
-
*
|
|
93
|
-
*
|
|
92
|
+
* RegionLinkingMode: "SPECIFIED_REGIONS",
|
|
93
|
+
* Regions: [
|
|
94
94
|
* "us-west-1",
|
|
95
95
|
* "us-west-2"
|
|
96
96
|
* ]
|
|
97
97
|
* };
|
|
98
98
|
* const command = new CreateFindingAggregatorCommand(input);
|
|
99
99
|
* const response = await client.send(command);
|
|
100
|
-
* /* response
|
|
100
|
+
* /* response is
|
|
101
101
|
* {
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
*
|
|
105
|
-
*
|
|
102
|
+
* FindingAggregationRegion: "us-east-1",
|
|
103
|
+
* FindingAggregatorArn: "arn:aws:securityhub:us-east-1:222222222222:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
104
|
+
* RegionLinkingMode: "SPECIFIED_REGIONS",
|
|
105
|
+
* Regions: [
|
|
106
106
|
* "us-west-1",
|
|
107
107
|
* "us-west-2"
|
|
108
108
|
* ]
|
|
109
109
|
* }
|
|
110
110
|
* *\/
|
|
111
|
-
* // example id: to-enable-cross-region-aggregation-1674766716226
|
|
112
111
|
* ```
|
|
113
112
|
*
|
|
113
|
+
* @public
|
|
114
114
|
*/
|
|
115
115
|
export declare class CreateFindingAggregatorCommand extends CreateFindingAggregatorCommand_base {
|
|
116
116
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -343,38 +343,38 @@ declare const CreateInsightCommand_base: {
|
|
|
343
343
|
* @throws {@link SecurityHubServiceException}
|
|
344
344
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
345
345
|
*
|
|
346
|
-
*
|
|
346
|
+
*
|
|
347
347
|
* @example To create a custom insight
|
|
348
348
|
* ```javascript
|
|
349
349
|
* // The following example creates a custom insight in Security Hub. An insight is a collection of findings that relate to a security issue.
|
|
350
350
|
* const input = {
|
|
351
|
-
*
|
|
352
|
-
*
|
|
351
|
+
* Filters: {
|
|
352
|
+
* ResourceType: [
|
|
353
353
|
* {
|
|
354
|
-
*
|
|
355
|
-
*
|
|
354
|
+
* Comparison: "EQUALS",
|
|
355
|
+
* Value: "AwsIamRole"
|
|
356
356
|
* }
|
|
357
357
|
* ],
|
|
358
|
-
*
|
|
358
|
+
* SeverityLabel: [
|
|
359
359
|
* {
|
|
360
|
-
*
|
|
361
|
-
*
|
|
360
|
+
* Comparison: "EQUALS",
|
|
361
|
+
* Value: "CRITICAL"
|
|
362
362
|
* }
|
|
363
363
|
* ]
|
|
364
364
|
* },
|
|
365
|
-
*
|
|
366
|
-
*
|
|
365
|
+
* GroupByAttribute: "ResourceId",
|
|
366
|
+
* Name: "Critical role findings"
|
|
367
367
|
* };
|
|
368
368
|
* const command = new CreateInsightCommand(input);
|
|
369
369
|
* const response = await client.send(command);
|
|
370
|
-
* /* response
|
|
370
|
+
* /* response is
|
|
371
371
|
* {
|
|
372
|
-
*
|
|
372
|
+
* InsightArn: "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
|
|
373
373
|
* }
|
|
374
374
|
* *\/
|
|
375
|
-
* // example id: to-create-a-custom-insight-1675354046628
|
|
376
375
|
* ```
|
|
377
376
|
*
|
|
377
|
+
* @public
|
|
378
378
|
*/
|
|
379
379
|
export declare class CreateInsightCommand extends CreateInsightCommand_base {
|
|
380
380
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -118,30 +118,30 @@ declare const CreateMembersCommand_base: {
|
|
|
118
118
|
* @throws {@link SecurityHubServiceException}
|
|
119
119
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
120
120
|
*
|
|
121
|
-
*
|
|
121
|
+
*
|
|
122
122
|
* @example To add a member account
|
|
123
123
|
* ```javascript
|
|
124
124
|
* // The following example creates a member association between the specified accounts and the administrator account (the account that makes the request). This operation is used to add accounts that aren't part of an organization.
|
|
125
125
|
* const input = {
|
|
126
|
-
*
|
|
126
|
+
* AccountDetails: [
|
|
127
127
|
* {
|
|
128
|
-
*
|
|
128
|
+
* AccountId: "123456789012"
|
|
129
129
|
* },
|
|
130
130
|
* {
|
|
131
|
-
*
|
|
131
|
+
* AccountId: "111122223333"
|
|
132
132
|
* }
|
|
133
133
|
* ]
|
|
134
134
|
* };
|
|
135
135
|
* const command = new CreateMembersCommand(input);
|
|
136
136
|
* const response = await client.send(command);
|
|
137
|
-
* /* response
|
|
137
|
+
* /* response is
|
|
138
138
|
* {
|
|
139
|
-
*
|
|
139
|
+
* UnprocessedAccounts: []
|
|
140
140
|
* }
|
|
141
141
|
* *\/
|
|
142
|
-
* // example id: to-add-a-member-account-1675354709996
|
|
143
142
|
* ```
|
|
144
143
|
*
|
|
144
|
+
* @public
|
|
145
145
|
*/
|
|
146
146
|
export declare class CreateMembersCommand extends CreateMembersCommand_base {
|
|
147
147
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -82,26 +82,26 @@ declare const DeclineInvitationsCommand_base: {
|
|
|
82
82
|
* @throws {@link SecurityHubServiceException}
|
|
83
83
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
84
84
|
*
|
|
85
|
-
*
|
|
85
|
+
*
|
|
86
86
|
* @example To decline invitation to become a member account
|
|
87
87
|
* ```javascript
|
|
88
88
|
* // The following example declines an invitation from the Security Hub administrator account to become a member account. The invited account makes the request.
|
|
89
89
|
* const input = {
|
|
90
|
-
*
|
|
90
|
+
* AccountIds: [
|
|
91
91
|
* "123456789012",
|
|
92
92
|
* "111122223333"
|
|
93
93
|
* ]
|
|
94
94
|
* };
|
|
95
95
|
* const command = new DeclineInvitationsCommand(input);
|
|
96
96
|
* const response = await client.send(command);
|
|
97
|
-
* /* response
|
|
97
|
+
* /* response is
|
|
98
98
|
* {
|
|
99
|
-
*
|
|
99
|
+
* UnprocessedAccounts: []
|
|
100
100
|
* }
|
|
101
101
|
* *\/
|
|
102
|
-
* // example id: to-decline-invitation-to-become-a-member-account-1675448487605
|
|
103
102
|
* ```
|
|
104
103
|
*
|
|
104
|
+
* @public
|
|
105
105
|
*/
|
|
106
106
|
export declare class DeclineInvitationsCommand extends DeclineInvitationsCommand_base {
|
|
107
107
|
/** @internal type navigation helper, not in runtime. */
|