@aws-sdk/client-securityhub 3.325.0 → 3.327.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 (94) hide show
  1. package/README.md +8 -0
  2. package/dist-cjs/SecurityHub.js +2 -0
  3. package/dist-cjs/commands/GetFindingHistoryCommand.js +45 -0
  4. package/dist-cjs/commands/index.js +1 -0
  5. package/dist-cjs/models/models_2.js +5 -1
  6. package/dist-cjs/pagination/GetFindingHistoryPaginator.js +29 -0
  7. package/dist-cjs/pagination/index.js +1 -0
  8. package/dist-cjs/protocols/Aws_restJson1.js +90 -3
  9. package/dist-es/SecurityHub.js +2 -0
  10. package/dist-es/commands/GetFindingHistoryCommand.js +41 -0
  11. package/dist-es/commands/index.js +1 -0
  12. package/dist-es/models/models_2.js +4 -0
  13. package/dist-es/pagination/GetFindingHistoryPaginator.js +25 -0
  14. package/dist-es/pagination/index.js +1 -0
  15. package/dist-es/protocols/Aws_restJson1.js +85 -0
  16. package/dist-types/SecurityHub.d.ts +7 -0
  17. package/dist-types/SecurityHubClient.d.ts +3 -2
  18. package/dist-types/commands/AcceptAdministratorInvitationCommand.d.ts +4 -0
  19. package/dist-types/commands/AcceptInvitationCommand.d.ts +4 -0
  20. package/dist-types/commands/BatchDisableStandardsCommand.d.ts +18 -0
  21. package/dist-types/commands/BatchEnableStandardsCommand.d.ts +18 -0
  22. package/dist-types/commands/BatchGetSecurityControlsCommand.d.ts +23 -0
  23. package/dist-types/commands/BatchGetStandardsControlAssociationsCommand.d.ts +33 -0
  24. package/dist-types/commands/BatchImportFindingsCommand.d.ts +14 -0
  25. package/dist-types/commands/BatchUpdateFindingsCommand.d.ts +21 -0
  26. package/dist-types/commands/BatchUpdateStandardsControlAssociationsCommand.d.ts +17 -0
  27. package/dist-types/commands/CreateActionTargetCommand.d.ts +6 -0
  28. package/dist-types/commands/CreateFindingAggregatorCommand.d.ts +11 -0
  29. package/dist-types/commands/CreateInsightCommand.d.ts +6 -0
  30. package/dist-types/commands/CreateMembersCommand.d.ts +11 -0
  31. package/dist-types/commands/DeclineInvitationsCommand.d.ts +11 -0
  32. package/dist-types/commands/DeleteActionTargetCommand.d.ts +6 -0
  33. package/dist-types/commands/DeleteFindingAggregatorCommand.d.ts +4 -0
  34. package/dist-types/commands/DeleteInsightCommand.d.ts +6 -0
  35. package/dist-types/commands/DeleteInvitationsCommand.d.ts +11 -0
  36. package/dist-types/commands/DeleteMembersCommand.d.ts +11 -0
  37. package/dist-types/commands/DescribeActionTargetsCommand.d.ts +13 -0
  38. package/dist-types/commands/DescribeHubCommand.d.ts +9 -0
  39. package/dist-types/commands/DescribeOrganizationConfigurationCommand.d.ts +8 -0
  40. package/dist-types/commands/DescribeProductsCommand.d.ts +23 -0
  41. package/dist-types/commands/DescribeStandardsCommand.d.ts +18 -0
  42. package/dist-types/commands/DescribeStandardsControlsCommand.d.ts +22 -0
  43. package/dist-types/commands/DisableImportFindingsForProductCommand.d.ts +4 -0
  44. package/dist-types/commands/DisableOrganizationAdminAccountCommand.d.ts +4 -0
  45. package/dist-types/commands/DisableSecurityHubCommand.d.ts +4 -0
  46. package/dist-types/commands/DisassociateFromAdministratorAccountCommand.d.ts +4 -0
  47. package/dist-types/commands/DisassociateFromMasterAccountCommand.d.ts +4 -0
  48. package/dist-types/commands/DisassociateMembersCommand.d.ts +4 -0
  49. package/dist-types/commands/EnableImportFindingsForProductCommand.d.ts +6 -0
  50. package/dist-types/commands/EnableOrganizationAdminAccountCommand.d.ts +4 -0
  51. package/dist-types/commands/EnableSecurityHubCommand.d.ts +4 -0
  52. package/dist-types/commands/GetAdministratorAccountCommand.d.ts +11 -0
  53. package/dist-types/commands/GetEnabledStandardsCommand.d.ts +19 -0
  54. package/dist-types/commands/GetFindingAggregatorCommand.d.ts +11 -0
  55. package/dist-types/commands/GetFindingHistoryCommand.d.ts +157 -0
  56. package/dist-types/commands/GetFindingsCommand.d.ts +3760 -0
  57. package/dist-types/commands/GetInsightResultsCommand.d.ts +15 -0
  58. package/dist-types/commands/GetInsightsCommand.d.ts +264 -0
  59. package/dist-types/commands/GetInvitationsCountCommand.d.ts +6 -0
  60. package/dist-types/commands/GetMasterAccountCommand.d.ts +11 -0
  61. package/dist-types/commands/GetMembersCommand.d.ts +22 -0
  62. package/dist-types/commands/InviteMembersCommand.d.ts +11 -0
  63. package/dist-types/commands/ListEnabledProductsForImportCommand.d.ts +9 -0
  64. package/dist-types/commands/ListFindingAggregatorsCommand.d.ts +11 -0
  65. package/dist-types/commands/ListInvitationsCommand.d.ts +14 -0
  66. package/dist-types/commands/ListMembersCommand.d.ts +17 -0
  67. package/dist-types/commands/ListOrganizationAdminAccountsCommand.d.ts +12 -0
  68. package/dist-types/commands/ListSecurityControlDefinitionsCommand.d.ts +16 -0
  69. package/dist-types/commands/ListStandardsControlAssociationsCommand.d.ts +21 -0
  70. package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -0
  71. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  72. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  73. package/dist-types/commands/UpdateActionTargetCommand.d.ts +4 -0
  74. package/dist-types/commands/UpdateFindingAggregatorCommand.d.ts +11 -0
  75. package/dist-types/commands/UpdateFindingsCommand.d.ts +4 -0
  76. package/dist-types/commands/UpdateInsightCommand.d.ts +4 -0
  77. package/dist-types/commands/UpdateOrganizationConfigurationCommand.d.ts +4 -0
  78. package/dist-types/commands/UpdateSecurityHubConfigurationCommand.d.ts +4 -0
  79. package/dist-types/commands/UpdateStandardsControlCommand.d.ts +4 -0
  80. package/dist-types/commands/index.d.ts +1 -0
  81. package/dist-types/models/models_1.d.ts +16 -16
  82. package/dist-types/models/models_2.d.ts +196 -1
  83. package/dist-types/pagination/GetFindingHistoryPaginator.d.ts +7 -0
  84. package/dist-types/pagination/index.d.ts +1 -0
  85. package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
  86. package/dist-types/ts3.4/SecurityHub.d.ts +17 -0
  87. package/dist-types/ts3.4/SecurityHubClient.d.ts +6 -0
  88. package/dist-types/ts3.4/commands/GetFindingHistoryCommand.d.ts +38 -0
  89. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  90. package/dist-types/ts3.4/models/models_2.d.ts +35 -0
  91. package/dist-types/ts3.4/pagination/GetFindingHistoryPaginator.d.ts +11 -0
  92. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  93. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
  94. package/package.json +7 -7
@@ -31,6 +31,19 @@ export interface GetInsightResultsCommandOutput extends GetInsightResultsRespons
31
31
  * };
32
32
  * const command = new GetInsightResultsCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetInsightResultsResponse
35
+ * // InsightResults: { // InsightResults
36
+ * // InsightArn: "STRING_VALUE", // required
37
+ * // GroupByAttribute: "STRING_VALUE", // required
38
+ * // ResultValues: [ // InsightResultValueList // required
39
+ * // { // InsightResultValue
40
+ * // GroupByAttributeValue: "STRING_VALUE", // required
41
+ * // Count: Number("int"), // required
42
+ * // },
43
+ * // ],
44
+ * // },
45
+ * // };
46
+ *
34
47
  * ```
35
48
  *
36
49
  * @param GetInsightResultsCommandInput - {@link GetInsightResultsCommandInput}
@@ -56,6 +69,8 @@ export interface GetInsightResultsCommandOutput extends GetInsightResultsRespons
56
69
  * @throws {@link ResourceNotFoundException} (client fault)
57
70
  * <p>The request was rejected because we can't find the specified resource.</p>
58
71
  *
72
+ * @throws {@link SecurityHubServiceException}
73
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
59
74
  *
60
75
  * @example To get the results of a Security Hub insight
61
76
  * ```javascript
@@ -35,6 +35,268 @@ export interface GetInsightsCommandOutput extends GetInsightsResponse, __Metadat
35
35
  * };
36
36
  * const command = new GetInsightsCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // GetInsightsResponse
39
+ * // Insights: [ // InsightList // required
40
+ * // { // Insight
41
+ * // InsightArn: "STRING_VALUE", // required
42
+ * // Name: "STRING_VALUE", // required
43
+ * // Filters: { // AwsSecurityFindingFilters
44
+ * // ProductArn: [ // StringFilterList
45
+ * // { // StringFilter
46
+ * // Value: "STRING_VALUE",
47
+ * // Comparison: "EQUALS" || "PREFIX" || "NOT_EQUALS" || "PREFIX_NOT_EQUALS",
48
+ * // },
49
+ * // ],
50
+ * // AwsAccountId: [
51
+ * // {
52
+ * // Value: "STRING_VALUE",
53
+ * // Comparison: "EQUALS" || "PREFIX" || "NOT_EQUALS" || "PREFIX_NOT_EQUALS",
54
+ * // },
55
+ * // ],
56
+ * // Id: [
57
+ * // {
58
+ * // Value: "STRING_VALUE",
59
+ * // Comparison: "EQUALS" || "PREFIX" || "NOT_EQUALS" || "PREFIX_NOT_EQUALS",
60
+ * // },
61
+ * // ],
62
+ * // GeneratorId: [
63
+ * // {
64
+ * // Value: "STRING_VALUE",
65
+ * // Comparison: "EQUALS" || "PREFIX" || "NOT_EQUALS" || "PREFIX_NOT_EQUALS",
66
+ * // },
67
+ * // ],
68
+ * // Region: [
69
+ * // {
70
+ * // Value: "STRING_VALUE",
71
+ * // Comparison: "EQUALS" || "PREFIX" || "NOT_EQUALS" || "PREFIX_NOT_EQUALS",
72
+ * // },
73
+ * // ],
74
+ * // Type: "<StringFilterList>",
75
+ * // FirstObservedAt: [ // DateFilterList
76
+ * // { // DateFilter
77
+ * // Start: "STRING_VALUE",
78
+ * // End: "STRING_VALUE",
79
+ * // DateRange: { // DateRange
80
+ * // Value: Number("int"),
81
+ * // Unit: "DAYS",
82
+ * // },
83
+ * // },
84
+ * // ],
85
+ * // LastObservedAt: [
86
+ * // {
87
+ * // Start: "STRING_VALUE",
88
+ * // End: "STRING_VALUE",
89
+ * // DateRange: {
90
+ * // Value: Number("int"),
91
+ * // Unit: "DAYS",
92
+ * // },
93
+ * // },
94
+ * // ],
95
+ * // CreatedAt: [
96
+ * // {
97
+ * // Start: "STRING_VALUE",
98
+ * // End: "STRING_VALUE",
99
+ * // DateRange: {
100
+ * // Value: Number("int"),
101
+ * // Unit: "DAYS",
102
+ * // },
103
+ * // },
104
+ * // ],
105
+ * // UpdatedAt: [
106
+ * // {
107
+ * // Start: "STRING_VALUE",
108
+ * // End: "STRING_VALUE",
109
+ * // DateRange: {
110
+ * // Value: Number("int"),
111
+ * // Unit: "DAYS",
112
+ * // },
113
+ * // },
114
+ * // ],
115
+ * // SeverityProduct: [ // NumberFilterList
116
+ * // { // NumberFilter
117
+ * // Gte: Number("double"),
118
+ * // Lte: Number("double"),
119
+ * // Eq: Number("double"),
120
+ * // },
121
+ * // ],
122
+ * // SeverityNormalized: [
123
+ * // {
124
+ * // Gte: Number("double"),
125
+ * // Lte: Number("double"),
126
+ * // Eq: Number("double"),
127
+ * // },
128
+ * // ],
129
+ * // SeverityLabel: "<StringFilterList>",
130
+ * // Confidence: [
131
+ * // {
132
+ * // Gte: Number("double"),
133
+ * // Lte: Number("double"),
134
+ * // Eq: Number("double"),
135
+ * // },
136
+ * // ],
137
+ * // Criticality: [
138
+ * // {
139
+ * // Gte: Number("double"),
140
+ * // Lte: Number("double"),
141
+ * // Eq: Number("double"),
142
+ * // },
143
+ * // ],
144
+ * // Title: "<StringFilterList>",
145
+ * // Description: "<StringFilterList>",
146
+ * // RecommendationText: "<StringFilterList>",
147
+ * // SourceUrl: "<StringFilterList>",
148
+ * // ProductFields: [ // MapFilterList
149
+ * // { // MapFilter
150
+ * // Key: "STRING_VALUE",
151
+ * // Value: "STRING_VALUE",
152
+ * // Comparison: "EQUALS" || "NOT_EQUALS",
153
+ * // },
154
+ * // ],
155
+ * // ProductName: "<StringFilterList>",
156
+ * // CompanyName: "<StringFilterList>",
157
+ * // UserDefinedFields: [
158
+ * // {
159
+ * // Key: "STRING_VALUE",
160
+ * // Value: "STRING_VALUE",
161
+ * // Comparison: "EQUALS" || "NOT_EQUALS",
162
+ * // },
163
+ * // ],
164
+ * // MalwareName: "<StringFilterList>",
165
+ * // MalwareType: "<StringFilterList>",
166
+ * // MalwarePath: "<StringFilterList>",
167
+ * // MalwareState: "<StringFilterList>",
168
+ * // NetworkDirection: "<StringFilterList>",
169
+ * // NetworkProtocol: "<StringFilterList>",
170
+ * // NetworkSourceIpV4: [ // IpFilterList
171
+ * // { // IpFilter
172
+ * // Cidr: "STRING_VALUE",
173
+ * // },
174
+ * // ],
175
+ * // NetworkSourceIpV6: [
176
+ * // {
177
+ * // Cidr: "STRING_VALUE",
178
+ * // },
179
+ * // ],
180
+ * // NetworkSourcePort: [
181
+ * // {
182
+ * // Gte: Number("double"),
183
+ * // Lte: Number("double"),
184
+ * // Eq: Number("double"),
185
+ * // },
186
+ * // ],
187
+ * // NetworkSourceDomain: "<StringFilterList>",
188
+ * // NetworkSourceMac: "<StringFilterList>",
189
+ * // NetworkDestinationIpV4: [
190
+ * // {
191
+ * // Cidr: "STRING_VALUE",
192
+ * // },
193
+ * // ],
194
+ * // NetworkDestinationIpV6: [
195
+ * // {
196
+ * // Cidr: "STRING_VALUE",
197
+ * // },
198
+ * // ],
199
+ * // NetworkDestinationPort: "<NumberFilterList>",
200
+ * // NetworkDestinationDomain: "<StringFilterList>",
201
+ * // ProcessName: "<StringFilterList>",
202
+ * // ProcessPath: "<StringFilterList>",
203
+ * // ProcessPid: "<NumberFilterList>",
204
+ * // ProcessParentPid: "<NumberFilterList>",
205
+ * // ProcessLaunchedAt: [
206
+ * // {
207
+ * // Start: "STRING_VALUE",
208
+ * // End: "STRING_VALUE",
209
+ * // DateRange: {
210
+ * // Value: Number("int"),
211
+ * // Unit: "DAYS",
212
+ * // },
213
+ * // },
214
+ * // ],
215
+ * // ProcessTerminatedAt: "<DateFilterList>",
216
+ * // ThreatIntelIndicatorType: "<StringFilterList>",
217
+ * // ThreatIntelIndicatorValue: "<StringFilterList>",
218
+ * // ThreatIntelIndicatorCategory: "<StringFilterList>",
219
+ * // ThreatIntelIndicatorLastObservedAt: "<DateFilterList>",
220
+ * // ThreatIntelIndicatorSource: "<StringFilterList>",
221
+ * // ThreatIntelIndicatorSourceUrl: "<StringFilterList>",
222
+ * // ResourceType: "<StringFilterList>",
223
+ * // ResourceId: "<StringFilterList>",
224
+ * // ResourcePartition: "<StringFilterList>",
225
+ * // ResourceRegion: "<StringFilterList>",
226
+ * // ResourceTags: [
227
+ * // {
228
+ * // Key: "STRING_VALUE",
229
+ * // Value: "STRING_VALUE",
230
+ * // Comparison: "EQUALS" || "NOT_EQUALS",
231
+ * // },
232
+ * // ],
233
+ * // ResourceAwsEc2InstanceType: "<StringFilterList>",
234
+ * // ResourceAwsEc2InstanceImageId: "<StringFilterList>",
235
+ * // ResourceAwsEc2InstanceIpV4Addresses: [
236
+ * // {
237
+ * // Cidr: "STRING_VALUE",
238
+ * // },
239
+ * // ],
240
+ * // ResourceAwsEc2InstanceIpV6Addresses: "<IpFilterList>",
241
+ * // ResourceAwsEc2InstanceKeyName: "<StringFilterList>",
242
+ * // ResourceAwsEc2InstanceIamInstanceProfileArn: "<StringFilterList>",
243
+ * // ResourceAwsEc2InstanceVpcId: "<StringFilterList>",
244
+ * // ResourceAwsEc2InstanceSubnetId: "<StringFilterList>",
245
+ * // ResourceAwsEc2InstanceLaunchedAt: "<DateFilterList>",
246
+ * // ResourceAwsS3BucketOwnerId: "<StringFilterList>",
247
+ * // ResourceAwsS3BucketOwnerName: "<StringFilterList>",
248
+ * // ResourceAwsIamAccessKeyUserName: "<StringFilterList>",
249
+ * // ResourceAwsIamAccessKeyPrincipalName: "<StringFilterList>",
250
+ * // ResourceAwsIamAccessKeyStatus: "<StringFilterList>",
251
+ * // ResourceAwsIamAccessKeyCreatedAt: "<DateFilterList>",
252
+ * // ResourceAwsIamUserUserName: "<StringFilterList>",
253
+ * // ResourceContainerName: "<StringFilterList>",
254
+ * // ResourceContainerImageId: "<StringFilterList>",
255
+ * // ResourceContainerImageName: "<StringFilterList>",
256
+ * // ResourceContainerLaunchedAt: "<DateFilterList>",
257
+ * // ResourceDetailsOther: [
258
+ * // {
259
+ * // Key: "STRING_VALUE",
260
+ * // Value: "STRING_VALUE",
261
+ * // Comparison: "EQUALS" || "NOT_EQUALS",
262
+ * // },
263
+ * // ],
264
+ * // ComplianceStatus: "<StringFilterList>",
265
+ * // VerificationState: "<StringFilterList>",
266
+ * // WorkflowState: "<StringFilterList>",
267
+ * // WorkflowStatus: "<StringFilterList>",
268
+ * // RecordState: "<StringFilterList>",
269
+ * // RelatedFindingsProductArn: "<StringFilterList>",
270
+ * // RelatedFindingsId: "<StringFilterList>",
271
+ * // NoteText: "<StringFilterList>",
272
+ * // NoteUpdatedAt: "<DateFilterList>",
273
+ * // NoteUpdatedBy: "<StringFilterList>",
274
+ * // Keyword: [ // KeywordFilterList
275
+ * // { // KeywordFilter
276
+ * // Value: "STRING_VALUE",
277
+ * // },
278
+ * // ],
279
+ * // FindingProviderFieldsConfidence: "<NumberFilterList>",
280
+ * // FindingProviderFieldsCriticality: "<NumberFilterList>",
281
+ * // FindingProviderFieldsRelatedFindingsId: "<StringFilterList>",
282
+ * // FindingProviderFieldsRelatedFindingsProductArn: "<StringFilterList>",
283
+ * // FindingProviderFieldsSeverityLabel: "<StringFilterList>",
284
+ * // FindingProviderFieldsSeverityOriginal: "<StringFilterList>",
285
+ * // FindingProviderFieldsTypes: "<StringFilterList>",
286
+ * // Sample: [ // BooleanFilterList
287
+ * // { // BooleanFilter
288
+ * // Value: true || false,
289
+ * // },
290
+ * // ],
291
+ * // ComplianceSecurityControlId: "<StringFilterList>",
292
+ * // ComplianceAssociatedStandardsId: "<StringFilterList>",
293
+ * // },
294
+ * // GroupByAttribute: "STRING_VALUE", // required
295
+ * // },
296
+ * // ],
297
+ * // NextToken: "STRING_VALUE",
298
+ * // };
299
+ *
38
300
  * ```
39
301
  *
40
302
  * @param GetInsightsCommandInput - {@link GetInsightsCommandInput}
@@ -60,6 +322,8 @@ export interface GetInsightsCommandOutput extends GetInsightsResponse, __Metadat
60
322
  * @throws {@link ResourceNotFoundException} (client fault)
61
323
  * <p>The request was rejected because we can't find the specified resource.</p>
62
324
  *
325
+ * @throws {@link SecurityHubServiceException}
326
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
63
327
  *
64
328
  * @example To get details of a Security Hub insight
65
329
  * ```javascript
@@ -30,6 +30,10 @@ export interface GetInvitationsCountCommandOutput extends GetInvitationsCountRes
30
30
  * const input = {};
31
31
  * const command = new GetInvitationsCountCommand(input);
32
32
  * const response = await client.send(command);
33
+ * // { // GetInvitationsCountResponse
34
+ * // InvitationsCount: Number("int"),
35
+ * // };
36
+ *
33
37
  * ```
34
38
  *
35
39
  * @param GetInvitationsCountCommandInput - {@link GetInvitationsCountCommandInput}
@@ -52,6 +56,8 @@ export interface GetInvitationsCountCommandOutput extends GetInvitationsCountRes
52
56
  * <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
53
57
  * account or throttling limits. The error code describes the limit exceeded.</p>
54
58
  *
59
+ * @throws {@link SecurityHubServiceException}
60
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
55
61
  *
56
62
  * @example To get a count of membership invitations
57
63
  * ```javascript
@@ -35,6 +35,15 @@ export interface GetMasterAccountCommandOutput extends GetMasterAccountResponse,
35
35
  * const input = {};
36
36
  * const command = new GetMasterAccountCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // GetMasterAccountResponse
39
+ * // Master: { // Invitation
40
+ * // AccountId: "STRING_VALUE",
41
+ * // InvitationId: "STRING_VALUE",
42
+ * // InvitedAt: new Date("TIMESTAMP"),
43
+ * // MemberStatus: "STRING_VALUE",
44
+ * // },
45
+ * // };
46
+ *
38
47
  * ```
39
48
  *
40
49
  * @param GetMasterAccountCommandInput - {@link GetMasterAccountCommandInput}
@@ -60,6 +69,8 @@ export interface GetMasterAccountCommandOutput extends GetMasterAccountResponse,
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
  */
65
76
  export declare class GetMasterAccountCommand extends $Command<GetMasterAccountCommandInput, GetMasterAccountCommandOutput, SecurityHubClientResolvedConfig> {
@@ -37,6 +37,26 @@ export interface GetMembersCommandOutput extends GetMembersResponse, __MetadataB
37
37
  * };
38
38
  * const command = new GetMembersCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // GetMembersResponse
41
+ * // Members: [ // MemberList
42
+ * // { // Member
43
+ * // AccountId: "STRING_VALUE",
44
+ * // Email: "STRING_VALUE",
45
+ * // MasterId: "STRING_VALUE",
46
+ * // AdministratorId: "STRING_VALUE",
47
+ * // MemberStatus: "STRING_VALUE",
48
+ * // InvitedAt: new Date("TIMESTAMP"),
49
+ * // UpdatedAt: new Date("TIMESTAMP"),
50
+ * // },
51
+ * // ],
52
+ * // UnprocessedAccounts: [ // ResultList
53
+ * // { // Result
54
+ * // AccountId: "STRING_VALUE",
55
+ * // ProcessingResult: "STRING_VALUE",
56
+ * // },
57
+ * // ],
58
+ * // };
59
+ *
40
60
  * ```
41
61
  *
42
62
  * @param GetMembersCommandInput - {@link GetMembersCommandInput}
@@ -62,6 +82,8 @@ export interface GetMembersCommandOutput extends GetMembersResponse, __MetadataB
62
82
  * @throws {@link ResourceNotFoundException} (client fault)
63
83
  * <p>The request was rejected because we can't find the specified resource.</p>
64
84
  *
85
+ * @throws {@link SecurityHubServiceException}
86
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
65
87
  *
66
88
  * @example To get member account details
67
89
  * ```javascript
@@ -39,6 +39,15 @@ export interface InviteMembersCommandOutput extends InviteMembersResponse, __Met
39
39
  * };
40
40
  * const command = new InviteMembersCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // InviteMembersResponse
43
+ * // UnprocessedAccounts: [ // ResultList
44
+ * // { // Result
45
+ * // AccountId: "STRING_VALUE",
46
+ * // ProcessingResult: "STRING_VALUE",
47
+ * // },
48
+ * // ],
49
+ * // };
50
+ *
42
51
  * ```
43
52
  *
44
53
  * @param InviteMembersCommandInput - {@link InviteMembersCommandInput}
@@ -64,6 +73,8 @@ export interface InviteMembersCommandOutput extends InviteMembersResponse, __Met
64
73
  * @throws {@link ResourceNotFoundException} (client fault)
65
74
  * <p>The request was rejected because we can't find the specified resource.</p>
66
75
  *
76
+ * @throws {@link SecurityHubServiceException}
77
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
67
78
  *
68
79
  * @example To invite accounts to become members
69
80
  * ```javascript
@@ -33,6 +33,13 @@ export interface ListEnabledProductsForImportCommandOutput extends ListEnabledPr
33
33
  * };
34
34
  * const command = new ListEnabledProductsForImportCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListEnabledProductsForImportResponse
37
+ * // ProductSubscriptions: [ // ProductSubscriptionArnList
38
+ * // "STRING_VALUE",
39
+ * // ],
40
+ * // NextToken: "STRING_VALUE",
41
+ * // };
42
+ *
36
43
  * ```
37
44
  *
38
45
  * @param ListEnabledProductsForImportCommandInput - {@link ListEnabledProductsForImportCommandInput}
@@ -51,6 +58,8 @@ export interface ListEnabledProductsForImportCommandOutput extends ListEnabledPr
51
58
  * <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
52
59
  * account or throttling limits. The error code describes the limit exceeded.</p>
53
60
  *
61
+ * @throws {@link SecurityHubServiceException}
62
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
54
63
  *
55
64
  * @example To list ARNs for enabled integrations
56
65
  * ```javascript
@@ -32,6 +32,15 @@ export interface ListFindingAggregatorsCommandOutput extends ListFindingAggregat
32
32
  * };
33
33
  * const command = new ListFindingAggregatorsCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // ListFindingAggregatorsResponse
36
+ * // FindingAggregators: [ // FindingAggregatorList
37
+ * // { // FindingAggregator
38
+ * // FindingAggregatorArn: "STRING_VALUE",
39
+ * // },
40
+ * // ],
41
+ * // NextToken: "STRING_VALUE",
42
+ * // };
43
+ *
35
44
  * ```
36
45
  *
37
46
  * @param ListFindingAggregatorsCommandInput - {@link ListFindingAggregatorsCommandInput}
@@ -57,6 +66,8 @@ export interface ListFindingAggregatorsCommandOutput extends ListFindingAggregat
57
66
  * <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
58
67
  * account or throttling limits. The error code describes the limit exceeded.</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 update the enablement status of a standard control
62
73
  * ```javascript
@@ -34,6 +34,18 @@ export interface ListInvitationsCommandOutput extends ListInvitationsResponse, _
34
34
  * };
35
35
  * const command = new ListInvitationsCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListInvitationsResponse
38
+ * // Invitations: [ // InvitationList
39
+ * // { // Invitation
40
+ * // AccountId: "STRING_VALUE",
41
+ * // InvitationId: "STRING_VALUE",
42
+ * // InvitedAt: new Date("TIMESTAMP"),
43
+ * // MemberStatus: "STRING_VALUE",
44
+ * // },
45
+ * // ],
46
+ * // NextToken: "STRING_VALUE",
47
+ * // };
48
+ *
37
49
  * ```
38
50
  *
39
51
  * @param ListInvitationsCommandInput - {@link ListInvitationsCommandInput}
@@ -56,6 +68,8 @@ export interface ListInvitationsCommandOutput extends ListInvitationsResponse, _
56
68
  * <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
57
69
  * account or throttling limits. The error code describes the limit exceeded.</p>
58
70
  *
71
+ * @throws {@link SecurityHubServiceException}
72
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
59
73
  *
60
74
  * @example To list membership invitations to calling account
61
75
  * ```javascript
@@ -36,6 +36,21 @@ export interface ListMembersCommandOutput extends ListMembersResponse, __Metadat
36
36
  * };
37
37
  * const command = new ListMembersCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // ListMembersResponse
40
+ * // Members: [ // MemberList
41
+ * // { // Member
42
+ * // AccountId: "STRING_VALUE",
43
+ * // Email: "STRING_VALUE",
44
+ * // MasterId: "STRING_VALUE",
45
+ * // AdministratorId: "STRING_VALUE",
46
+ * // MemberStatus: "STRING_VALUE",
47
+ * // InvitedAt: new Date("TIMESTAMP"),
48
+ * // UpdatedAt: new Date("TIMESTAMP"),
49
+ * // },
50
+ * // ],
51
+ * // NextToken: "STRING_VALUE",
52
+ * // };
53
+ *
39
54
  * ```
40
55
  *
41
56
  * @param ListMembersCommandInput - {@link ListMembersCommandInput}
@@ -58,6 +73,8 @@ export interface ListMembersCommandOutput extends ListMembersResponse, __Metadat
58
73
  * <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
59
74
  * account or throttling limits. The error code describes the limit exceeded.</p>
60
75
  *
76
+ * @throws {@link SecurityHubServiceException}
77
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
61
78
  *
62
79
  * @example To list member account details
63
80
  * ```javascript
@@ -33,6 +33,16 @@ export interface ListOrganizationAdminAccountsCommandOutput extends ListOrganiza
33
33
  * };
34
34
  * const command = new ListOrganizationAdminAccountsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListOrganizationAdminAccountsResponse
37
+ * // AdminAccounts: [ // AdminAccounts
38
+ * // { // AdminAccount
39
+ * // AccountId: "STRING_VALUE",
40
+ * // Status: "ENABLED" || "DISABLE_IN_PROGRESS",
41
+ * // },
42
+ * // ],
43
+ * // NextToken: "STRING_VALUE",
44
+ * // };
45
+ *
36
46
  * ```
37
47
  *
38
48
  * @param ListOrganizationAdminAccountsCommandInput - {@link ListOrganizationAdminAccountsCommandInput}
@@ -55,6 +65,8 @@ export interface ListOrganizationAdminAccountsCommandOutput extends ListOrganiza
55
65
  * <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
56
66
  * account or throttling limits. The error code describes the limit exceeded.</p>
57
67
  *
68
+ * @throws {@link SecurityHubServiceException}
69
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
58
70
  *
59
71
  * @example To list administrator acccounts for an organization
60
72
  * ```javascript
@@ -35,6 +35,20 @@ export interface ListSecurityControlDefinitionsCommandOutput extends ListSecurit
35
35
  * };
36
36
  * const command = new ListSecurityControlDefinitionsCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // ListSecurityControlDefinitionsResponse
39
+ * // SecurityControlDefinitions: [ // SecurityControlDefinitions // required
40
+ * // { // SecurityControlDefinition
41
+ * // SecurityControlId: "STRING_VALUE", // required
42
+ * // Title: "STRING_VALUE", // required
43
+ * // Description: "STRING_VALUE", // required
44
+ * // RemediationUrl: "STRING_VALUE", // required
45
+ * // SeverityRating: "LOW" || "MEDIUM" || "HIGH" || "CRITICAL", // required
46
+ * // CurrentRegionAvailability: "AVAILABLE" || "UNAVAILABLE", // required
47
+ * // },
48
+ * // ],
49
+ * // NextToken: "STRING_VALUE",
50
+ * // };
51
+ *
38
52
  * ```
39
53
  *
40
54
  * @param ListSecurityControlDefinitionsCommandInput - {@link ListSecurityControlDefinitionsCommandInput}
@@ -57,6 +71,8 @@ export interface ListSecurityControlDefinitionsCommandOutput extends ListSecurit
57
71
  * <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
58
72
  * account or throttling limits. The error code describes the limit exceeded.</p>
59
73
  *
74
+ * @throws {@link SecurityHubServiceException}
75
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
60
76
  *
61
77
  * @example To list security controls that apply to a standard
62
78
  * ```javascript
@@ -35,6 +35,25 @@ export interface ListStandardsControlAssociationsCommandOutput extends ListStand
35
35
  * };
36
36
  * const command = new ListStandardsControlAssociationsCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // ListStandardsControlAssociationsResponse
39
+ * // StandardsControlAssociationSummaries: [ // StandardsControlAssociationSummaries // required
40
+ * // { // StandardsControlAssociationSummary
41
+ * // StandardsArn: "STRING_VALUE", // required
42
+ * // SecurityControlId: "STRING_VALUE", // required
43
+ * // SecurityControlArn: "STRING_VALUE", // required
44
+ * // AssociationStatus: "ENABLED" || "DISABLED", // required
45
+ * // RelatedRequirements: [ // RelatedRequirementsList
46
+ * // "STRING_VALUE",
47
+ * // ],
48
+ * // UpdatedAt: new Date("TIMESTAMP"),
49
+ * // UpdatedReason: "STRING_VALUE",
50
+ * // StandardsControlTitle: "STRING_VALUE",
51
+ * // StandardsControlDescription: "STRING_VALUE",
52
+ * // },
53
+ * // ],
54
+ * // NextToken: "STRING_VALUE",
55
+ * // };
56
+ *
38
57
  * ```
39
58
  *
40
59
  * @param ListStandardsControlAssociationsCommandInput - {@link ListStandardsControlAssociationsCommandInput}
@@ -57,6 +76,8 @@ export interface ListStandardsControlAssociationsCommandOutput extends ListStand
57
76
  * <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
58
77
  * account or throttling limits. The error code describes the limit exceeded.</p>
59
78
  *
79
+ * @throws {@link SecurityHubServiceException}
80
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
60
81
  *
61
82
  * @example To say whether standard
62
83
  * ```javascript
@@ -31,6 +31,12 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
31
31
  * };
32
32
  * const command = new ListTagsForResourceCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // ListTagsForResourceResponse
35
+ * // Tags: { // TagMap
36
+ * // "<keys>": "STRING_VALUE",
37
+ * // },
38
+ * // };
39
+ *
34
40
  * ```
35
41
  *
36
42
  * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
@@ -49,6 +55,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
49
55
  * @throws {@link ResourceNotFoundException} (client fault)
50
56
  * <p>The request was rejected because we can't find the specified resource.</p>
51
57
  *
58
+ * @throws {@link SecurityHubServiceException}
59
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
52
60
  *
53
61
  * @example To get a list of tags for a resource
54
62
  * ```javascript
@@ -34,6 +34,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
34
34
  * };
35
35
  * const command = new TagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -52,6 +54,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
52
54
  * @throws {@link ResourceNotFoundException} (client fault)
53
55
  * <p>The request was rejected because we can't find the specified resource.</p>
54
56
  *
57
+ * @throws {@link SecurityHubServiceException}
58
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
55
59
  *
56
60
  * @example To tag a resource
57
61
  * ```javascript