@aws-sdk/client-securityhub 3.325.0 → 3.326.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.
Files changed (62) hide show
  1. package/dist-types/commands/AcceptAdministratorInvitationCommand.d.ts +4 -0
  2. package/dist-types/commands/AcceptInvitationCommand.d.ts +4 -0
  3. package/dist-types/commands/BatchDisableStandardsCommand.d.ts +18 -0
  4. package/dist-types/commands/BatchEnableStandardsCommand.d.ts +18 -0
  5. package/dist-types/commands/BatchGetSecurityControlsCommand.d.ts +23 -0
  6. package/dist-types/commands/BatchGetStandardsControlAssociationsCommand.d.ts +33 -0
  7. package/dist-types/commands/BatchImportFindingsCommand.d.ts +14 -0
  8. package/dist-types/commands/BatchUpdateFindingsCommand.d.ts +21 -0
  9. package/dist-types/commands/BatchUpdateStandardsControlAssociationsCommand.d.ts +17 -0
  10. package/dist-types/commands/CreateActionTargetCommand.d.ts +6 -0
  11. package/dist-types/commands/CreateFindingAggregatorCommand.d.ts +11 -0
  12. package/dist-types/commands/CreateInsightCommand.d.ts +6 -0
  13. package/dist-types/commands/CreateMembersCommand.d.ts +11 -0
  14. package/dist-types/commands/DeclineInvitationsCommand.d.ts +11 -0
  15. package/dist-types/commands/DeleteActionTargetCommand.d.ts +6 -0
  16. package/dist-types/commands/DeleteFindingAggregatorCommand.d.ts +4 -0
  17. package/dist-types/commands/DeleteInsightCommand.d.ts +6 -0
  18. package/dist-types/commands/DeleteInvitationsCommand.d.ts +11 -0
  19. package/dist-types/commands/DeleteMembersCommand.d.ts +11 -0
  20. package/dist-types/commands/DescribeActionTargetsCommand.d.ts +13 -0
  21. package/dist-types/commands/DescribeHubCommand.d.ts +9 -0
  22. package/dist-types/commands/DescribeOrganizationConfigurationCommand.d.ts +8 -0
  23. package/dist-types/commands/DescribeProductsCommand.d.ts +23 -0
  24. package/dist-types/commands/DescribeStandardsCommand.d.ts +18 -0
  25. package/dist-types/commands/DescribeStandardsControlsCommand.d.ts +22 -0
  26. package/dist-types/commands/DisableImportFindingsForProductCommand.d.ts +4 -0
  27. package/dist-types/commands/DisableOrganizationAdminAccountCommand.d.ts +4 -0
  28. package/dist-types/commands/DisableSecurityHubCommand.d.ts +4 -0
  29. package/dist-types/commands/DisassociateFromAdministratorAccountCommand.d.ts +4 -0
  30. package/dist-types/commands/DisassociateFromMasterAccountCommand.d.ts +4 -0
  31. package/dist-types/commands/DisassociateMembersCommand.d.ts +4 -0
  32. package/dist-types/commands/EnableImportFindingsForProductCommand.d.ts +6 -0
  33. package/dist-types/commands/EnableOrganizationAdminAccountCommand.d.ts +4 -0
  34. package/dist-types/commands/EnableSecurityHubCommand.d.ts +4 -0
  35. package/dist-types/commands/GetAdministratorAccountCommand.d.ts +11 -0
  36. package/dist-types/commands/GetEnabledStandardsCommand.d.ts +19 -0
  37. package/dist-types/commands/GetFindingAggregatorCommand.d.ts +11 -0
  38. package/dist-types/commands/GetFindingsCommand.d.ts +3760 -0
  39. package/dist-types/commands/GetInsightResultsCommand.d.ts +15 -0
  40. package/dist-types/commands/GetInsightsCommand.d.ts +264 -0
  41. package/dist-types/commands/GetInvitationsCountCommand.d.ts +6 -0
  42. package/dist-types/commands/GetMasterAccountCommand.d.ts +11 -0
  43. package/dist-types/commands/GetMembersCommand.d.ts +22 -0
  44. package/dist-types/commands/InviteMembersCommand.d.ts +11 -0
  45. package/dist-types/commands/ListEnabledProductsForImportCommand.d.ts +9 -0
  46. package/dist-types/commands/ListFindingAggregatorsCommand.d.ts +11 -0
  47. package/dist-types/commands/ListInvitationsCommand.d.ts +14 -0
  48. package/dist-types/commands/ListMembersCommand.d.ts +17 -0
  49. package/dist-types/commands/ListOrganizationAdminAccountsCommand.d.ts +12 -0
  50. package/dist-types/commands/ListSecurityControlDefinitionsCommand.d.ts +16 -0
  51. package/dist-types/commands/ListStandardsControlAssociationsCommand.d.ts +21 -0
  52. package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -0
  53. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  54. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  55. package/dist-types/commands/UpdateActionTargetCommand.d.ts +4 -0
  56. package/dist-types/commands/UpdateFindingAggregatorCommand.d.ts +11 -0
  57. package/dist-types/commands/UpdateFindingsCommand.d.ts +4 -0
  58. package/dist-types/commands/UpdateInsightCommand.d.ts +4 -0
  59. package/dist-types/commands/UpdateOrganizationConfigurationCommand.d.ts +4 -0
  60. package/dist-types/commands/UpdateSecurityHubConfigurationCommand.d.ts +4 -0
  61. package/dist-types/commands/UpdateStandardsControlCommand.d.ts +4 -0
  62. package/package.json +3 -3
@@ -37,6 +37,8 @@ export interface AcceptAdministratorInvitationCommandOutput extends AcceptAdmini
37
37
  * };
38
38
  * const command = new AcceptAdministratorInvitationCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // {};
41
+ *
40
42
  * ```
41
43
  *
42
44
  * @param AcceptAdministratorInvitationCommandInput - {@link AcceptAdministratorInvitationCommandInput}
@@ -62,6 +64,8 @@ export interface AcceptAdministratorInvitationCommandOutput extends AcceptAdmini
62
64
  * @throws {@link ResourceNotFoundException} (client fault)
63
65
  * <p>The request was rejected because we can't find the specified resource.</p>
64
66
  *
67
+ * @throws {@link SecurityHubServiceException}
68
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
65
69
  *
66
70
  * @example To accept an invitation be a member account
67
71
  * ```javascript
@@ -41,6 +41,8 @@ export interface AcceptInvitationCommandOutput extends AcceptInvitationResponse,
41
41
  * };
42
42
  * const command = new AcceptInvitationCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // {};
45
+ *
44
46
  * ```
45
47
  *
46
48
  * @param AcceptInvitationCommandInput - {@link AcceptInvitationCommandInput}
@@ -66,6 +68,8 @@ export interface AcceptInvitationCommandOutput extends AcceptInvitationResponse,
66
68
  * @throws {@link ResourceNotFoundException} (client fault)
67
69
  * <p>The request was rejected because we can't find the specified resource.</p>
68
70
  *
71
+ * @throws {@link SecurityHubServiceException}
72
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
69
73
  *
70
74
  */
71
75
  export declare class AcceptInvitationCommand extends $Command<AcceptInvitationCommandInput, AcceptInvitationCommandOutput, SecurityHubClientResolvedConfig> {
@@ -36,6 +36,22 @@ export interface BatchDisableStandardsCommandOutput extends BatchDisableStandard
36
36
  * };
37
37
  * const command = new BatchDisableStandardsCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // BatchDisableStandardsResponse
40
+ * // StandardsSubscriptions: [ // StandardsSubscriptions
41
+ * // { // StandardsSubscription
42
+ * // StandardsSubscriptionArn: "STRING_VALUE", // required
43
+ * // StandardsArn: "STRING_VALUE", // required
44
+ * // StandardsInput: { // StandardsInputParameterMap // required
45
+ * // "<keys>": "STRING_VALUE",
46
+ * // },
47
+ * // StandardsStatus: "PENDING" || "READY" || "FAILED" || "DELETING" || "INCOMPLETE", // required
48
+ * // StandardsStatusReason: { // StandardsStatusReason
49
+ * // StatusReasonCode: "NO_AVAILABLE_CONFIGURATION_RECORDER" || "INTERNAL_ERROR", // required
50
+ * // },
51
+ * // },
52
+ * // ],
53
+ * // };
54
+ *
39
55
  * ```
40
56
  *
41
57
  * @param BatchDisableStandardsCommandInput - {@link BatchDisableStandardsCommandInput}
@@ -58,6 +74,8 @@ export interface BatchDisableStandardsCommandOutput extends BatchDisableStandard
58
74
  * <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
59
75
  * account or throttling limits. The error code describes the limit exceeded.</p>
60
76
  *
77
+ * @throws {@link SecurityHubServiceException}
78
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
61
79
  *
62
80
  * @example To disable one or more security standards
63
81
  * ```javascript
@@ -42,6 +42,22 @@ export interface BatchEnableStandardsCommandOutput extends BatchEnableStandardsR
42
42
  * };
43
43
  * const command = new BatchEnableStandardsCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // BatchEnableStandardsResponse
46
+ * // StandardsSubscriptions: [ // StandardsSubscriptions
47
+ * // { // StandardsSubscription
48
+ * // StandardsSubscriptionArn: "STRING_VALUE", // required
49
+ * // StandardsArn: "STRING_VALUE", // required
50
+ * // StandardsInput: { // StandardsInputParameterMap // required
51
+ * // "<keys>": "STRING_VALUE",
52
+ * // },
53
+ * // StandardsStatus: "PENDING" || "READY" || "FAILED" || "DELETING" || "INCOMPLETE", // required
54
+ * // StandardsStatusReason: { // StandardsStatusReason
55
+ * // StatusReasonCode: "NO_AVAILABLE_CONFIGURATION_RECORDER" || "INTERNAL_ERROR", // required
56
+ * // },
57
+ * // },
58
+ * // ],
59
+ * // };
60
+ *
45
61
  * ```
46
62
  *
47
63
  * @param BatchEnableStandardsCommandInput - {@link BatchEnableStandardsCommandInput}
@@ -64,6 +80,8 @@ export interface BatchEnableStandardsCommandOutput extends BatchEnableStandardsR
64
80
  * <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
65
81
  * account or throttling limits. The error code describes the limit exceeded.</p>
66
82
  *
83
+ * @throws {@link SecurityHubServiceException}
84
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
67
85
  *
68
86
  * @example To import security findings from a third party provider to Security Hub
69
87
  * ```javascript
@@ -35,6 +35,27 @@ export interface BatchGetSecurityControlsCommandOutput extends BatchGetSecurityC
35
35
  * };
36
36
  * const command = new BatchGetSecurityControlsCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // BatchGetSecurityControlsResponse
39
+ * // SecurityControls: [ // SecurityControls // required
40
+ * // { // SecurityControl
41
+ * // SecurityControlId: "STRING_VALUE", // required
42
+ * // SecurityControlArn: "STRING_VALUE", // required
43
+ * // Title: "STRING_VALUE", // required
44
+ * // Description: "STRING_VALUE", // required
45
+ * // RemediationUrl: "STRING_VALUE", // required
46
+ * // SeverityRating: "LOW" || "MEDIUM" || "HIGH" || "CRITICAL", // required
47
+ * // SecurityControlStatus: "ENABLED" || "DISABLED", // required
48
+ * // },
49
+ * // ],
50
+ * // UnprocessedIds: [ // UnprocessedSecurityControls
51
+ * // { // UnprocessedSecurityControl
52
+ * // SecurityControlId: "STRING_VALUE", // required
53
+ * // ErrorCode: "INVALID_INPUT" || "ACCESS_DENIED" || "NOT_FOUND" || "LIMIT_EXCEEDED", // required
54
+ * // ErrorReason: "STRING_VALUE",
55
+ * // },
56
+ * // ],
57
+ * // };
58
+ *
38
59
  * ```
39
60
  *
40
61
  * @param BatchGetSecurityControlsCommandInput - {@link BatchGetSecurityControlsCommandInput}
@@ -57,6 +78,8 @@ export interface BatchGetSecurityControlsCommandOutput extends BatchGetSecurityC
57
78
  * <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
58
79
  * account or throttling limits. The error code describes the limit exceeded.</p>
59
80
  *
81
+ * @throws {@link SecurityHubServiceException}
82
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
60
83
  *
61
84
  */
62
85
  export declare class BatchGetSecurityControlsCommand extends $Command<BatchGetSecurityControlsCommandInput, BatchGetSecurityControlsCommandOutput, SecurityHubClientResolvedConfig> {
@@ -38,6 +38,37 @@ export interface BatchGetStandardsControlAssociationsCommandOutput extends Batch
38
38
  * };
39
39
  * const command = new BatchGetStandardsControlAssociationsCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // BatchGetStandardsControlAssociationsResponse
42
+ * // StandardsControlAssociationDetails: [ // StandardsControlAssociationDetails // required
43
+ * // { // StandardsControlAssociationDetail
44
+ * // StandardsArn: "STRING_VALUE", // required
45
+ * // SecurityControlId: "STRING_VALUE", // required
46
+ * // SecurityControlArn: "STRING_VALUE", // required
47
+ * // AssociationStatus: "ENABLED" || "DISABLED", // required
48
+ * // RelatedRequirements: [ // RelatedRequirementsList
49
+ * // "STRING_VALUE",
50
+ * // ],
51
+ * // UpdatedAt: new Date("TIMESTAMP"),
52
+ * // UpdatedReason: "STRING_VALUE",
53
+ * // StandardsControlTitle: "STRING_VALUE",
54
+ * // StandardsControlDescription: "STRING_VALUE",
55
+ * // StandardsControlArns: [ // StandardsControlArnList
56
+ * // "STRING_VALUE",
57
+ * // ],
58
+ * // },
59
+ * // ],
60
+ * // UnprocessedAssociations: [ // UnprocessedStandardsControlAssociations
61
+ * // { // UnprocessedStandardsControlAssociation
62
+ * // StandardsControlAssociationId: { // StandardsControlAssociationId
63
+ * // SecurityControlId: "STRING_VALUE", // required
64
+ * // StandardsArn: "STRING_VALUE", // required
65
+ * // },
66
+ * // ErrorCode: "INVALID_INPUT" || "ACCESS_DENIED" || "NOT_FOUND" || "LIMIT_EXCEEDED", // required
67
+ * // ErrorReason: "STRING_VALUE",
68
+ * // },
69
+ * // ],
70
+ * // };
71
+ *
41
72
  * ```
42
73
  *
43
74
  * @param BatchGetStandardsControlAssociationsCommandInput - {@link BatchGetStandardsControlAssociationsCommandInput}
@@ -60,6 +91,8 @@ export interface BatchGetStandardsControlAssociationsCommandOutput extends Batch
60
91
  * <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
61
92
  * account or throttling limits. The error code describes the limit exceeded.</p>
62
93
  *
94
+ * @throws {@link SecurityHubServiceException}
95
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
63
96
  *
64
97
  */
65
98
  export declare class BatchGetStandardsControlAssociationsCommand extends $Command<BatchGetStandardsControlAssociationsCommandInput, BatchGetStandardsControlAssociationsCommandOutput, SecurityHubClientResolvedConfig> {
@@ -3858,6 +3858,18 @@ export interface BatchImportFindingsCommandOutput extends BatchImportFindingsRes
3858
3858
  * };
3859
3859
  * const command = new BatchImportFindingsCommand(input);
3860
3860
  * const response = await client.send(command);
3861
+ * // { // BatchImportFindingsResponse
3862
+ * // FailedCount: Number("int"), // required
3863
+ * // SuccessCount: Number("int"), // required
3864
+ * // FailedFindings: [ // ImportFindingsErrorList
3865
+ * // { // ImportFindingsError
3866
+ * // Id: "STRING_VALUE", // required
3867
+ * // ErrorCode: "STRING_VALUE", // required
3868
+ * // ErrorMessage: "STRING_VALUE", // required
3869
+ * // },
3870
+ * // ],
3871
+ * // };
3872
+ *
3861
3873
  * ```
3862
3874
  *
3863
3875
  * @param BatchImportFindingsCommandInput - {@link BatchImportFindingsCommandInput}
@@ -3880,6 +3892,8 @@ export interface BatchImportFindingsCommandOutput extends BatchImportFindingsRes
3880
3892
  * <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
3881
3893
  * account or throttling limits. The error code describes the limit exceeded.</p>
3882
3894
  *
3895
+ * @throws {@link SecurityHubServiceException}
3896
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
3883
3897
  *
3884
3898
  * @example To import security findings from a third party provider to Security Hub
3885
3899
  * ```javascript
@@ -121,6 +121,25 @@ export interface BatchUpdateFindingsCommandOutput extends BatchUpdateFindingsRes
121
121
  * };
122
122
  * const command = new BatchUpdateFindingsCommand(input);
123
123
  * const response = await client.send(command);
124
+ * // { // BatchUpdateFindingsResponse
125
+ * // ProcessedFindings: [ // AwsSecurityFindingIdentifierList // required
126
+ * // { // AwsSecurityFindingIdentifier
127
+ * // Id: "STRING_VALUE", // required
128
+ * // ProductArn: "STRING_VALUE", // required
129
+ * // },
130
+ * // ],
131
+ * // UnprocessedFindings: [ // BatchUpdateFindingsUnprocessedFindingsList // required
132
+ * // { // BatchUpdateFindingsUnprocessedFinding
133
+ * // FindingIdentifier: {
134
+ * // Id: "STRING_VALUE", // required
135
+ * // ProductArn: "STRING_VALUE", // required
136
+ * // },
137
+ * // ErrorCode: "STRING_VALUE", // required
138
+ * // ErrorMessage: "STRING_VALUE", // required
139
+ * // },
140
+ * // ],
141
+ * // };
142
+ *
124
143
  * ```
125
144
  *
126
145
  * @param BatchUpdateFindingsCommandInput - {@link BatchUpdateFindingsCommandInput}
@@ -143,6 +162,8 @@ export interface BatchUpdateFindingsCommandOutput extends BatchUpdateFindingsRes
143
162
  * <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
144
163
  * account or throttling limits. The error code describes the limit exceeded.</p>
145
164
  *
165
+ * @throws {@link SecurityHubServiceException}
166
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
146
167
  *
147
168
  * @example To update Security Hub findings
148
169
  * ```javascript
@@ -40,6 +40,21 @@ export interface BatchUpdateStandardsControlAssociationsCommandOutput extends Ba
40
40
  * };
41
41
  * const command = new BatchUpdateStandardsControlAssociationsCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // BatchUpdateStandardsControlAssociationsResponse
44
+ * // UnprocessedAssociationUpdates: [ // UnprocessedStandardsControlAssociationUpdates
45
+ * // { // UnprocessedStandardsControlAssociationUpdate
46
+ * // StandardsControlAssociationUpdate: { // StandardsControlAssociationUpdate
47
+ * // StandardsArn: "STRING_VALUE", // required
48
+ * // SecurityControlId: "STRING_VALUE", // required
49
+ * // AssociationStatus: "ENABLED" || "DISABLED", // required
50
+ * // UpdatedReason: "STRING_VALUE",
51
+ * // },
52
+ * // ErrorCode: "INVALID_INPUT" || "ACCESS_DENIED" || "NOT_FOUND" || "LIMIT_EXCEEDED", // required
53
+ * // ErrorReason: "STRING_VALUE",
54
+ * // },
55
+ * // ],
56
+ * // };
57
+ *
43
58
  * ```
44
59
  *
45
60
  * @param BatchUpdateStandardsControlAssociationsCommandInput - {@link BatchUpdateStandardsControlAssociationsCommandInput}
@@ -62,6 +77,8 @@ export interface BatchUpdateStandardsControlAssociationsCommandOutput extends Ba
62
77
  * <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
63
78
  * account or throttling limits. The error code describes the limit exceeded.</p>
64
79
  *
80
+ * @throws {@link SecurityHubServiceException}
81
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
65
82
  *
66
83
  */
67
84
  export declare class BatchUpdateStandardsControlAssociationsCommand extends $Command<BatchUpdateStandardsControlAssociationsCommandInput, BatchUpdateStandardsControlAssociationsCommandOutput, SecurityHubClientResolvedConfig> {
@@ -35,6 +35,10 @@ export interface CreateActionTargetCommandOutput extends CreateActionTargetRespo
35
35
  * };
36
36
  * const command = new CreateActionTargetCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // CreateActionTargetResponse
39
+ * // ActionTargetArn: "STRING_VALUE", // required
40
+ * // };
41
+ *
38
42
  * ```
39
43
  *
40
44
  * @param CreateActionTargetCommandInput - {@link CreateActionTargetCommandInput}
@@ -60,6 +64,8 @@ export interface CreateActionTargetCommandOutput extends CreateActionTargetRespo
60
64
  * @throws {@link ResourceConflictException} (client fault)
61
65
  * <p>The resource specified in the request conflicts with an existing resource.</p>
62
66
  *
67
+ * @throws {@link SecurityHubServiceException}
68
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
63
69
  *
64
70
  * @example To create a custom action target
65
71
  * ```javascript
@@ -36,6 +36,15 @@ export interface CreateFindingAggregatorCommandOutput extends CreateFindingAggre
36
36
  * };
37
37
  * const command = new CreateFindingAggregatorCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // CreateFindingAggregatorResponse
40
+ * // FindingAggregatorArn: "STRING_VALUE",
41
+ * // FindingAggregationRegion: "STRING_VALUE",
42
+ * // RegionLinkingMode: "STRING_VALUE",
43
+ * // Regions: [ // StringList
44
+ * // "STRING_VALUE",
45
+ * // ],
46
+ * // };
47
+ *
39
48
  * ```
40
49
  *
41
50
  * @param CreateFindingAggregatorCommandInput - {@link CreateFindingAggregatorCommandInput}
@@ -61,6 +70,8 @@ export interface CreateFindingAggregatorCommandOutput extends CreateFindingAggre
61
70
  * <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
62
71
  * account or throttling limits. The error code describes the limit exceeded.</p>
63
72
  *
73
+ * @throws {@link SecurityHubServiceException}
74
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
64
75
  *
65
76
  * @example To enable cross-Region aggregation
66
77
  * ```javascript
@@ -286,6 +286,10 @@ export interface CreateInsightCommandOutput extends CreateInsightResponse, __Met
286
286
  * };
287
287
  * const command = new CreateInsightCommand(input);
288
288
  * const response = await client.send(command);
289
+ * // { // CreateInsightResponse
290
+ * // InsightArn: "STRING_VALUE", // required
291
+ * // };
292
+ *
289
293
  * ```
290
294
  *
291
295
  * @param CreateInsightCommandInput - {@link CreateInsightCommandInput}
@@ -311,6 +315,8 @@ export interface CreateInsightCommandOutput extends CreateInsightResponse, __Met
311
315
  * @throws {@link ResourceConflictException} (client fault)
312
316
  * <p>The resource specified in the request conflicts with an existing resource.</p>
313
317
  *
318
+ * @throws {@link SecurityHubServiceException}
319
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
314
320
  *
315
321
  * @example To create a custom insight
316
322
  * ```javascript
@@ -70,6 +70,15 @@ export interface CreateMembersCommandOutput extends CreateMembersResponse, __Met
70
70
  * };
71
71
  * const command = new CreateMembersCommand(input);
72
72
  * const response = await client.send(command);
73
+ * // { // CreateMembersResponse
74
+ * // UnprocessedAccounts: [ // ResultList
75
+ * // { // Result
76
+ * // AccountId: "STRING_VALUE",
77
+ * // ProcessingResult: "STRING_VALUE",
78
+ * // },
79
+ * // ],
80
+ * // };
81
+ *
73
82
  * ```
74
83
  *
75
84
  * @param CreateMembersCommandInput - {@link CreateMembersCommandInput}
@@ -95,6 +104,8 @@ export interface CreateMembersCommandOutput extends CreateMembersResponse, __Met
95
104
  * @throws {@link ResourceConflictException} (client fault)
96
105
  * <p>The resource specified in the request conflicts with an existing resource.</p>
97
106
  *
107
+ * @throws {@link SecurityHubServiceException}
108
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
98
109
  *
99
110
  * @example To add a member account
100
111
  * ```javascript
@@ -36,6 +36,15 @@ export interface DeclineInvitationsCommandOutput extends DeclineInvitationsRespo
36
36
  * };
37
37
  * const command = new DeclineInvitationsCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // DeclineInvitationsResponse
40
+ * // UnprocessedAccounts: [ // ResultList
41
+ * // { // Result
42
+ * // AccountId: "STRING_VALUE",
43
+ * // ProcessingResult: "STRING_VALUE",
44
+ * // },
45
+ * // ],
46
+ * // };
47
+ *
39
48
  * ```
40
49
  *
41
50
  * @param DeclineInvitationsCommandInput - {@link DeclineInvitationsCommandInput}
@@ -57,6 +66,8 @@ export interface DeclineInvitationsCommandOutput extends DeclineInvitationsRespo
57
66
  * @throws {@link ResourceNotFoundException} (client fault)
58
67
  * <p>The request was rejected because we can't find the specified resource.</p>
59
68
  *
69
+ * @throws {@link SecurityHubServiceException}
70
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
60
71
  *
61
72
  * @example To decline invitation to become a member account
62
73
  * ```javascript
@@ -33,6 +33,10 @@ export interface DeleteActionTargetCommandOutput extends DeleteActionTargetRespo
33
33
  * };
34
34
  * const command = new DeleteActionTargetCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DeleteActionTargetResponse
37
+ * // ActionTargetArn: "STRING_VALUE", // required
38
+ * // };
39
+ *
36
40
  * ```
37
41
  *
38
42
  * @param DeleteActionTargetCommandInput - {@link DeleteActionTargetCommandInput}
@@ -54,6 +58,8 @@ export interface DeleteActionTargetCommandOutput extends DeleteActionTargetRespo
54
58
  * @throws {@link ResourceNotFoundException} (client fault)
55
59
  * <p>The request was rejected because we can't find the specified resource.</p>
56
60
  *
61
+ * @throws {@link SecurityHubServiceException}
62
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
57
63
  *
58
64
  * @example To delete a custom action target
59
65
  * ```javascript
@@ -33,6 +33,8 @@ export interface DeleteFindingAggregatorCommandOutput extends DeleteFindingAggre
33
33
  * };
34
34
  * const command = new DeleteFindingAggregatorCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeleteFindingAggregatorCommandInput - {@link DeleteFindingAggregatorCommandInput}
@@ -61,6 +63,8 @@ export interface DeleteFindingAggregatorCommandOutput extends DeleteFindingAggre
61
63
  * @throws {@link ResourceNotFoundException} (client fault)
62
64
  * <p>The request was rejected because we can't find the specified resource.</p>
63
65
  *
66
+ * @throws {@link SecurityHubServiceException}
67
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
64
68
  *
65
69
  * @example To delete a finding aggregator
66
70
  * ```javascript
@@ -31,6 +31,10 @@ export interface DeleteInsightCommandOutput extends DeleteInsightResponse, __Met
31
31
  * };
32
32
  * const command = new DeleteInsightCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DeleteInsightResponse
35
+ * // InsightArn: "STRING_VALUE", // required
36
+ * // };
37
+ *
34
38
  * ```
35
39
  *
36
40
  * @param DeleteInsightCommandInput - {@link DeleteInsightCommandInput}
@@ -56,6 +60,8 @@ export interface DeleteInsightCommandOutput extends DeleteInsightResponse, __Met
56
60
  * @throws {@link ResourceNotFoundException} (client fault)
57
61
  * <p>The request was rejected because we can't find the specified resource.</p>
58
62
  *
63
+ * @throws {@link SecurityHubServiceException}
64
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
59
65
  *
60
66
  * @example To delete a custom insight
61
67
  * ```javascript
@@ -36,6 +36,15 @@ export interface DeleteInvitationsCommandOutput extends DeleteInvitationsRespons
36
36
  * };
37
37
  * const command = new DeleteInvitationsCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // DeleteInvitationsResponse
40
+ * // UnprocessedAccounts: [ // ResultList
41
+ * // { // Result
42
+ * // AccountId: "STRING_VALUE",
43
+ * // ProcessingResult: "STRING_VALUE",
44
+ * // },
45
+ * // ],
46
+ * // };
47
+ *
39
48
  * ```
40
49
  *
41
50
  * @param DeleteInvitationsCommandInput - {@link DeleteInvitationsCommandInput}
@@ -61,6 +70,8 @@ export interface DeleteInvitationsCommandOutput extends DeleteInvitationsRespons
61
70
  * @throws {@link ResourceNotFoundException} (client fault)
62
71
  * <p>The request was rejected because we can't find the specified resource.</p>
63
72
  *
73
+ * @throws {@link SecurityHubServiceException}
74
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
64
75
  *
65
76
  * @example To delete a custom insight
66
77
  * ```javascript
@@ -35,6 +35,15 @@ export interface DeleteMembersCommandOutput extends DeleteMembersResponse, __Met
35
35
  * };
36
36
  * const command = new DeleteMembersCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // DeleteMembersResponse
39
+ * // UnprocessedAccounts: [ // ResultList
40
+ * // { // Result
41
+ * // AccountId: "STRING_VALUE",
42
+ * // ProcessingResult: "STRING_VALUE",
43
+ * // },
44
+ * // ],
45
+ * // };
46
+ *
38
47
  * ```
39
48
  *
40
49
  * @param DeleteMembersCommandInput - {@link DeleteMembersCommandInput}
@@ -60,6 +69,8 @@ export interface DeleteMembersCommandOutput extends DeleteMembersResponse, __Met
60
69
  * @throws {@link ResourceNotFoundException} (client fault)
61
70
  * <p>The request was rejected because we can't find the specified resource.</p>
62
71
  *
72
+ * @throws {@link SecurityHubServiceException}
73
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
63
74
  *
64
75
  * @example To delete a member account
65
76
  * ```javascript
@@ -35,6 +35,17 @@ export interface DescribeActionTargetsCommandOutput extends DescribeActionTarget
35
35
  * };
36
36
  * const command = new DescribeActionTargetsCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // DescribeActionTargetsResponse
39
+ * // ActionTargets: [ // ActionTargetList // required
40
+ * // { // ActionTarget
41
+ * // ActionTargetArn: "STRING_VALUE", // required
42
+ * // Name: "STRING_VALUE", // required
43
+ * // Description: "STRING_VALUE", // required
44
+ * // },
45
+ * // ],
46
+ * // NextToken: "STRING_VALUE",
47
+ * // };
48
+ *
38
49
  * ```
39
50
  *
40
51
  * @param DescribeActionTargetsCommandInput - {@link DescribeActionTargetsCommandInput}
@@ -56,6 +67,8 @@ export interface DescribeActionTargetsCommandOutput extends DescribeActionTarget
56
67
  * @throws {@link ResourceNotFoundException} (client fault)
57
68
  * <p>The request was rejected because we can't find the specified resource.</p>
58
69
  *
70
+ * @throws {@link SecurityHubServiceException}
71
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
59
72
  *
60
73
  * @example To return custom action targets
61
74
  * ```javascript
@@ -32,6 +32,13 @@ export interface DescribeHubCommandOutput extends DescribeHubResponse, __Metadat
32
32
  * };
33
33
  * const command = new DescribeHubCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeHubResponse
36
+ * // HubArn: "STRING_VALUE",
37
+ * // SubscribedAt: "STRING_VALUE",
38
+ * // AutoEnableControls: true || false,
39
+ * // ControlFindingGenerator: "STANDARD_CONTROL" || "SECURITY_CONTROL",
40
+ * // };
41
+ *
35
42
  * ```
36
43
  *
37
44
  * @param DescribeHubCommandInput - {@link DescribeHubCommandInput}
@@ -57,6 +64,8 @@ export interface DescribeHubCommandOutput extends DescribeHubResponse, __Metadat
57
64
  * @throws {@link ResourceNotFoundException} (client fault)
58
65
  * <p>The request was rejected because we can't find the specified resource.</p>
59
66
  *
67
+ * @throws {@link SecurityHubServiceException}
68
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
60
69
  *
61
70
  * @example To return details about Hub resource
62
71
  * ```javascript
@@ -30,6 +30,12 @@ export interface DescribeOrganizationConfigurationCommandOutput extends Describe
30
30
  * const input = {};
31
31
  * const command = new DescribeOrganizationConfigurationCommand(input);
32
32
  * const response = await client.send(command);
33
+ * // { // DescribeOrganizationConfigurationResponse
34
+ * // AutoEnable: true || false,
35
+ * // MemberAccountLimitReached: true || false,
36
+ * // AutoEnableStandards: "NONE" || "DEFAULT",
37
+ * // };
38
+ *
33
39
  * ```
34
40
  *
35
41
  * @param DescribeOrganizationConfigurationCommandInput - {@link DescribeOrganizationConfigurationCommandInput}
@@ -52,6 +58,8 @@ export interface DescribeOrganizationConfigurationCommandOutput extends Describe
52
58
  * <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
53
59
  * account or throttling limits. The error code describes the limit exceeded.</p>
54
60
  *
61
+ * @throws {@link SecurityHubServiceException}
62
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
55
63
  *
56
64
  * @example To get information about Organizations configuration
57
65
  * ```javascript
@@ -37,6 +37,27 @@ export interface DescribeProductsCommandOutput extends DescribeProductsResponse,
37
37
  * };
38
38
  * const command = new DescribeProductsCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // DescribeProductsResponse
41
+ * // Products: [ // ProductsList // required
42
+ * // { // Product
43
+ * // ProductArn: "STRING_VALUE", // required
44
+ * // ProductName: "STRING_VALUE",
45
+ * // CompanyName: "STRING_VALUE",
46
+ * // Description: "STRING_VALUE",
47
+ * // Categories: [ // CategoryList
48
+ * // "STRING_VALUE",
49
+ * // ],
50
+ * // IntegrationTypes: [ // IntegrationTypeList
51
+ * // "SEND_FINDINGS_TO_SECURITY_HUB" || "RECEIVE_FINDINGS_FROM_SECURITY_HUB" || "UPDATE_FINDINGS_IN_SECURITY_HUB",
52
+ * // ],
53
+ * // MarketplaceUrl: "STRING_VALUE",
54
+ * // ActivationUrl: "STRING_VALUE",
55
+ * // ProductSubscriptionResourcePolicy: "STRING_VALUE",
56
+ * // },
57
+ * // ],
58
+ * // NextToken: "STRING_VALUE",
59
+ * // };
60
+ *
40
61
  * ```
41
62
  *
42
63
  * @param DescribeProductsCommandInput - {@link DescribeProductsCommandInput}
@@ -59,6 +80,8 @@ export interface DescribeProductsCommandOutput extends DescribeProductsResponse,
59
80
  * <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
60
81
  * account or throttling limits. The error code describes the limit exceeded.</p>
61
82
  *
83
+ * @throws {@link SecurityHubServiceException}
84
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
62
85
  *
63
86
  * @example To get information about Security Hub integrations
64
87
  * ```javascript
@@ -33,6 +33,22 @@ export interface DescribeStandardsCommandOutput extends DescribeStandardsRespons
33
33
  * };
34
34
  * const command = new DescribeStandardsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DescribeStandardsResponse
37
+ * // Standards: [ // Standards
38
+ * // { // Standard
39
+ * // StandardsArn: "STRING_VALUE",
40
+ * // Name: "STRING_VALUE",
41
+ * // Description: "STRING_VALUE",
42
+ * // EnabledByDefault: true || false,
43
+ * // StandardsManagedBy: { // StandardsManagedBy
44
+ * // Company: "STRING_VALUE",
45
+ * // Product: "STRING_VALUE",
46
+ * // },
47
+ * // },
48
+ * // ],
49
+ * // NextToken: "STRING_VALUE",
50
+ * // };
51
+ *
36
52
  * ```
37
53
  *
38
54
  * @param DescribeStandardsCommandInput - {@link DescribeStandardsCommandInput}
@@ -51,6 +67,8 @@ export interface DescribeStandardsCommandOutput extends DescribeStandardsRespons
51
67
  * <p>The request was rejected because you supplied an invalid or out-of-range value for an
52
68
  * input parameter.</p>
53
69
  *
70
+ * @throws {@link SecurityHubServiceException}
71
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
54
72
  *
55
73
  * @example To get available Security Hub standards
56
74
  * ```javascript