@aws-sdk/client-securityhub 3.933.0 → 3.935.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 (83) hide show
  1. package/dist-cjs/index.js +474 -476
  2. package/dist-es/index.js +2 -1
  3. package/dist-es/models/enums.js +458 -0
  4. package/dist-es/models/errors.js +193 -0
  5. package/dist-es/models/models_0.js +1 -178
  6. package/dist-es/models/models_1.js +1 -48
  7. package/dist-es/models/models_2.js +1 -359
  8. package/dist-es/models/models_3.js +1 -68
  9. package/dist-es/schemas/schemas_0.js +1 -1
  10. package/dist-types/commands/GetFindingStatisticsV2Command.d.ts +2 -1
  11. package/dist-types/commands/GetFindingsV2Command.d.ts +2 -1
  12. package/dist-types/commands/GetInsightResultsCommand.d.ts +1 -1
  13. package/dist-types/commands/GetInsightsCommand.d.ts +1 -1
  14. package/dist-types/commands/GetInvitationsCountCommand.d.ts +1 -1
  15. package/dist-types/commands/GetMasterAccountCommand.d.ts +1 -1
  16. package/dist-types/commands/GetMembersCommand.d.ts +1 -1
  17. package/dist-types/commands/GetResourcesStatisticsV2Command.d.ts +2 -1
  18. package/dist-types/commands/GetResourcesV2Command.d.ts +2 -1
  19. package/dist-types/commands/GetSecurityControlDefinitionCommand.d.ts +1 -1
  20. package/dist-types/commands/InviteMembersCommand.d.ts +1 -1
  21. package/dist-types/commands/ListAggregatorsV2Command.d.ts +1 -1
  22. package/dist-types/commands/ListAutomationRulesCommand.d.ts +1 -1
  23. package/dist-types/commands/ListAutomationRulesV2Command.d.ts +1 -1
  24. package/dist-types/commands/ListConfigurationPoliciesCommand.d.ts +1 -1
  25. package/dist-types/commands/ListConfigurationPolicyAssociationsCommand.d.ts +1 -1
  26. package/dist-types/commands/ListConnectorsV2Command.d.ts +1 -1
  27. package/dist-types/commands/ListEnabledProductsForImportCommand.d.ts +1 -1
  28. package/dist-types/commands/ListFindingAggregatorsCommand.d.ts +1 -1
  29. package/dist-types/commands/ListInvitationsCommand.d.ts +1 -1
  30. package/dist-types/commands/ListMembersCommand.d.ts +1 -1
  31. package/dist-types/commands/ListOrganizationAdminAccountsCommand.d.ts +1 -1
  32. package/dist-types/commands/ListSecurityControlDefinitionsCommand.d.ts +1 -1
  33. package/dist-types/commands/ListStandardsControlAssociationsCommand.d.ts +1 -1
  34. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  35. package/dist-types/commands/StartConfigurationPolicyAssociationCommand.d.ts +1 -1
  36. package/dist-types/commands/StartConfigurationPolicyDisassociationCommand.d.ts +1 -1
  37. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  38. package/dist-types/index.d.ts +6 -1
  39. package/dist-types/models/enums.d.ts +994 -0
  40. package/dist-types/models/errors.d.ts +179 -0
  41. package/dist-types/models/models_0.d.ts +903 -305
  42. package/dist-types/models/models_1.d.ts +5669 -5639
  43. package/dist-types/models/models_2.d.ts +5423 -5594
  44. package/dist-types/models/models_3.d.ts +3 -1634
  45. package/dist-types/ts3.4/commands/GetFindingStatisticsV2Command.d.ts +2 -4
  46. package/dist-types/ts3.4/commands/GetFindingsV2Command.d.ts +2 -4
  47. package/dist-types/ts3.4/commands/GetInsightResultsCommand.d.ts +1 -1
  48. package/dist-types/ts3.4/commands/GetInsightsCommand.d.ts +1 -1
  49. package/dist-types/ts3.4/commands/GetInvitationsCountCommand.d.ts +1 -1
  50. package/dist-types/ts3.4/commands/GetMasterAccountCommand.d.ts +1 -1
  51. package/dist-types/ts3.4/commands/GetMembersCommand.d.ts +1 -1
  52. package/dist-types/ts3.4/commands/GetResourcesStatisticsV2Command.d.ts +2 -4
  53. package/dist-types/ts3.4/commands/GetResourcesV2Command.d.ts +2 -4
  54. package/dist-types/ts3.4/commands/GetSecurityControlDefinitionCommand.d.ts +1 -1
  55. package/dist-types/ts3.4/commands/InviteMembersCommand.d.ts +1 -1
  56. package/dist-types/ts3.4/commands/ListAggregatorsV2Command.d.ts +1 -1
  57. package/dist-types/ts3.4/commands/ListAutomationRulesCommand.d.ts +1 -1
  58. package/dist-types/ts3.4/commands/ListAutomationRulesV2Command.d.ts +1 -1
  59. package/dist-types/ts3.4/commands/ListConfigurationPoliciesCommand.d.ts +1 -1
  60. package/dist-types/ts3.4/commands/ListConfigurationPolicyAssociationsCommand.d.ts +1 -1
  61. package/dist-types/ts3.4/commands/ListConnectorsV2Command.d.ts +1 -1
  62. package/dist-types/ts3.4/commands/ListEnabledProductsForImportCommand.d.ts +1 -1
  63. package/dist-types/ts3.4/commands/ListFindingAggregatorsCommand.d.ts +1 -1
  64. package/dist-types/ts3.4/commands/ListInvitationsCommand.d.ts +1 -1
  65. package/dist-types/ts3.4/commands/ListMembersCommand.d.ts +1 -1
  66. package/dist-types/ts3.4/commands/ListOrganizationAdminAccountsCommand.d.ts +1 -1
  67. package/dist-types/ts3.4/commands/ListSecurityControlDefinitionsCommand.d.ts +1 -1
  68. package/dist-types/ts3.4/commands/ListStandardsControlAssociationsCommand.d.ts +1 -1
  69. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
  70. package/dist-types/ts3.4/commands/StartConfigurationPolicyAssociationCommand.d.ts +1 -1
  71. package/dist-types/ts3.4/commands/StartConfigurationPolicyDisassociationCommand.d.ts +1 -1
  72. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
  73. package/dist-types/ts3.4/index.d.ts +6 -1
  74. package/dist-types/ts3.4/models/enums.d.ts +574 -0
  75. package/dist-types/ts3.4/models/errors.d.ts +106 -0
  76. package/dist-types/ts3.4/models/models_0.d.ts +209 -164
  77. package/dist-types/ts3.4/models/models_1.d.ts +205 -260
  78. package/dist-types/ts3.4/models/models_2.d.ts +398 -582
  79. package/dist-types/ts3.4/models/models_3.d.ts +13 -439
  80. package/package.json +12 -12
  81. package/dist-es/models/index.js +0 -4
  82. package/dist-types/models/index.d.ts +0 -4
  83. package/dist-types/ts3.4/models/index.d.ts +0 -4
@@ -1,1637 +1,6 @@
1
- import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
- import { DocumentType as __DocumentType } from "@smithy/types";
3
- import { AdminAccount, AggregatorV2, AllowedOperators, AssociationFilters, AssociationStatus, AssociationType, AutoEnableStandards, AutomationRulesActionV2, AutomationRulesMetadata, AutomationRulesMetadataV2, ConfigurationPolicyAssociationStatus, DateFilter, MapFilter, NoteUpdate, NumberFilter, RuleStatusV2, StringFilter } from "./models_0";
4
- import { RecordState } from "./models_1";
5
- import { AwsSecurityFindingFilters, ConfigurationOptions, ConfigurationPolicyAssociationSummary, ConfigurationPolicySummary, ConnectorProviderName, ConnectorStatus, ConnectorSummary, ControlFindingGenerator, ControlStatus, FindingAggregator, GroupByField, Invitation, OcsfBooleanFilter, OcsfDateFilter, OcsfIpFilter, OcsfMapFilter, OcsfNumberFilter, OcsfStringFilter, OrganizationConfiguration, ParameterConfiguration, Policy, Result, SecurityControlProperty, SecurityHubFeature, SeverityRating, SortCriterion, SortOrder, Target, TargetType } from "./models_2";
6
- import { SecurityHubServiceException as __BaseException } from "./SecurityHubServiceException";
7
- /**
8
- * <p>Represents individual aggregated results when grouping security findings for each <code>GroupByField</code>.</p>
9
- * @public
10
- */
11
- export interface GroupByValue {
12
- /**
13
- * <p>The value of the field by which findings are grouped.</p>
14
- * @public
15
- */
16
- FieldValue?: string | undefined;
17
- /**
18
- * <p>The number of findings for a specific <code>FieldValue</code> and <code>GroupByField</code>.</p>
19
- * @public
20
- */
21
- Count?: number | undefined;
22
- }
23
- /**
24
- * <p>Represents finding statistics grouped by <code>GroupedByField</code>.</p>
25
- * @public
26
- */
27
- export interface GroupByResult {
28
- /**
29
- * <p>The attribute by which filtered security findings should be grouped.</p>
30
- * @public
31
- */
32
- GroupByField?: string | undefined;
33
- /**
34
- * <p>An array of grouped values and their respective counts for each <code>GroupByField</code>.</p>
35
- * @public
36
- */
37
- GroupByValues?: GroupByValue[] | undefined;
38
- }
39
- /**
40
- * @public
41
- */
42
- export interface GetFindingStatisticsV2Response {
43
- /**
44
- * <p>Aggregated statistics about security findings based on specified grouping criteria.</p>
45
- * @public
46
- */
47
- GroupByResults?: GroupByResult[] | undefined;
48
- }
49
- /**
50
- * @public
51
- */
52
- export interface GetFindingsV2Response {
53
- /**
54
- * <p>An array of security findings returned by the operation.</p>
55
- * @public
56
- */
57
- Findings?: __DocumentType[] | undefined;
58
- /**
59
- * <p>The pagination token to use to request the next page of results.
60
- * Otherwise, this parameter is null.</p>
61
- * @public
62
- */
63
- NextToken?: string | undefined;
64
- }
65
- /**
66
- * @public
67
- */
68
- export interface GetInsightResultsRequest {
69
- /**
70
- * <p>The ARN of the insight for which to return results.</p>
71
- * @public
72
- */
73
- InsightArn: string | undefined;
74
- }
75
- /**
76
- * <p>The insight result values returned by the <code>GetInsightResults</code>
77
- * operation.</p>
78
- * @public
79
- */
80
- export interface InsightResultValue {
81
- /**
82
- * <p>The value of the attribute that the findings are grouped by for the insight whose
83
- * results are returned by the <code>GetInsightResults</code> operation.</p>
84
- * @public
85
- */
86
- GroupByAttributeValue: string | undefined;
87
- /**
88
- * <p>The number of findings returned for each <code>GroupByAttributeValue</code>.</p>
89
- * @public
90
- */
91
- Count: number | undefined;
92
- }
93
- /**
94
- * <p>The insight results returned by the <code>GetInsightResults</code> operation.</p>
95
- * @public
96
- */
97
- export interface InsightResults {
98
- /**
99
- * <p>The ARN of the insight whose results are returned by the <code>GetInsightResults</code>
100
- * operation.</p>
101
- * @public
102
- */
103
- InsightArn: string | undefined;
104
- /**
105
- * <p>The attribute that the findings are grouped by for the insight whose results are
106
- * returned by the <code>GetInsightResults</code> operation.</p>
107
- * @public
108
- */
109
- GroupByAttribute: string | undefined;
110
- /**
111
- * <p>The list of insight result values returned by the <code>GetInsightResults</code>
112
- * operation.</p>
113
- * @public
114
- */
115
- ResultValues: InsightResultValue[] | undefined;
116
- }
117
- /**
118
- * @public
119
- */
120
- export interface GetInsightResultsResponse {
121
- /**
122
- * <p>The insight results returned by the operation.</p>
123
- * @public
124
- */
125
- InsightResults: InsightResults | undefined;
126
- }
127
- /**
128
- * @public
129
- */
130
- export interface GetInsightsRequest {
131
- /**
132
- * <p>The ARNs of the insights to describe. If you don't provide any insight ARNs, then
133
- * <code>GetInsights</code> returns all of your custom insights. It does not return any
134
- * managed insights.</p>
135
- * @public
136
- */
137
- InsightArns?: string[] | undefined;
138
- /**
139
- * <p>The token that is required for pagination. On your first call to the
140
- * <code>GetInsights</code> operation, set the value of this parameter to
141
- * <code>NULL</code>.</p>
142
- * <p>For subsequent calls to the operation, to continue listing data, set the value of this
143
- * parameter to the value returned from the previous response.</p>
144
- * @public
145
- */
146
- NextToken?: string | undefined;
147
- /**
148
- * <p>The maximum number of items to return in the response.</p>
149
- * @public
150
- */
151
- MaxResults?: number | undefined;
152
- }
153
- /**
154
- * <p>Contains information about a Security Hub insight.</p>
155
- * @public
156
- */
157
- export interface Insight {
158
- /**
159
- * <p>The ARN of a Security Hub insight.</p>
160
- * @public
161
- */
162
- InsightArn: string | undefined;
163
- /**
164
- * <p>The name of a Security Hub insight.</p>
165
- * @public
166
- */
167
- Name: string | undefined;
168
- /**
169
- * <p>One or more attributes used to filter the findings included in the insight. You can filter by up to ten finding attributes. For each attribute, you can provide up to 20 filter values.
170
- * The insight only includes findings that match the criteria defined in the filters.</p>
171
- * @public
172
- */
173
- Filters: AwsSecurityFindingFilters | undefined;
174
- /**
175
- * <p>The grouping attribute for the insight's findings. Indicates how to group the matching
176
- * findings, and identifies the type of item that the insight applies to. For example, if an
177
- * insight is grouped by resource identifier, then the insight produces a list of resource
178
- * identifiers.</p>
179
- * @public
180
- */
181
- GroupByAttribute: string | undefined;
182
- }
183
- /**
184
- * @public
185
- */
186
- export interface GetInsightsResponse {
187
- /**
188
- * <p>The insights returned by the operation.</p>
189
- * @public
190
- */
191
- Insights: Insight[] | undefined;
192
- /**
193
- * <p>The pagination token to use to request the next page of results.</p>
194
- * @public
195
- */
196
- NextToken?: string | undefined;
197
- }
198
- /**
199
- * @public
200
- */
201
- export interface GetInvitationsCountRequest {
202
- }
203
- /**
204
- * @public
205
- */
206
- export interface GetInvitationsCountResponse {
207
- /**
208
- * <p>The number of all membership invitations sent to this Security Hub member account, not
209
- * including the currently accepted invitation.</p>
210
- * @public
211
- */
212
- InvitationsCount?: number | undefined;
213
- }
214
- /**
215
- * @public
216
- */
217
- export interface GetMasterAccountRequest {
218
- }
219
- /**
220
- * @public
221
- */
222
- export interface GetMasterAccountResponse {
223
- /**
224
- * <p>A list of details about the Security Hub administrator account for the current member account.
225
- * </p>
226
- * @public
227
- */
228
- Master?: Invitation | undefined;
229
- }
230
- /**
231
- * @public
232
- */
233
- export interface GetMembersRequest {
234
- /**
235
- * <p>The list of account IDs for the Security Hub member accounts to return the details for. </p>
236
- * @public
237
- */
238
- AccountIds: string[] | undefined;
239
- }
240
- /**
241
- * <p>The details about a member account.</p>
242
- * @public
243
- */
244
- export interface Member {
245
- /**
246
- * <p>The Amazon Web Services account ID of the member account.</p>
247
- * @public
248
- */
249
- AccountId?: string | undefined;
250
- /**
251
- * <p>The email address of the member account.</p>
252
- * @public
253
- */
254
- Email?: string | undefined;
255
- /**
256
- * <p>This is replaced by <code>AdministratorID</code>.</p>
257
- * <p>The Amazon Web Services account ID of the Security Hub administrator account associated with this member account.</p>
258
- *
259
- * @deprecated This field is deprecated, use AdministratorId instead.
260
- * @public
261
- */
262
- MasterId?: string | undefined;
263
- /**
264
- * <p>The Amazon Web Services account ID of the Security Hub administrator account associated with this member account.</p>
265
- * @public
266
- */
267
- AdministratorId?: string | undefined;
268
- /**
269
- * <p>The status of the relationship between the member account and its administrator account.
270
- * </p>
271
- * <p>The status can have one of the following values:</p>
272
- * <ul>
273
- * <li>
274
- * <p>
275
- * <code>Created</code> - Indicates that the administrator account added the member account,
276
- * but has not yet invited the member account.</p>
277
- * </li>
278
- * <li>
279
- * <p>
280
- * <code>Invited</code> - Indicates that the administrator account invited the member
281
- * account. The member account has not yet responded to the invitation.</p>
282
- * </li>
283
- * <li>
284
- * <p>
285
- * <code>Enabled</code> - Indicates that the member account is currently active. For
286
- * manually invited member accounts, indicates that the member account accepted the
287
- * invitation.</p>
288
- * </li>
289
- * <li>
290
- * <p>
291
- * <code>Removed</code> - Indicates that the administrator account disassociated the member
292
- * account.</p>
293
- * </li>
294
- * <li>
295
- * <p>
296
- * <code>Resigned</code> - Indicates that the member account disassociated themselves
297
- * from the administrator account.</p>
298
- * </li>
299
- * <li>
300
- * <p>
301
- * <code>Deleted</code> - Indicates that the administrator account deleted the member
302
- * account.</p>
303
- * </li>
304
- * <li>
305
- * <p>
306
- * <code>AccountSuspended</code> - Indicates that an organization account was suspended from Amazon Web Services at the same time that the administrator account tried to enable the organization account as a member account.</p>
307
- * </li>
308
- * </ul>
309
- * @public
310
- */
311
- MemberStatus?: string | undefined;
312
- /**
313
- * <p>A timestamp for the date and time when the invitation was sent to the member
314
- * account.</p>
315
- * @public
316
- */
317
- InvitedAt?: Date | undefined;
318
- /**
319
- * <p>The timestamp for the date and time when the member account was updated.</p>
320
- * @public
321
- */
322
- UpdatedAt?: Date | undefined;
323
- }
324
- /**
325
- * @public
326
- */
327
- export interface GetMembersResponse {
328
- /**
329
- * <p>The list of details about the Security Hub member accounts.</p>
330
- * @public
331
- */
332
- Members?: Member[] | undefined;
333
- /**
334
- * <p>The list of Amazon Web Services accounts that could not be processed. For each account, the list
335
- * includes the account ID and the email address.</p>
336
- * @public
337
- */
338
- UnprocessedAccounts?: Result[] | undefined;
339
- }
340
- /**
341
- * @public
342
- * @enum
343
- */
344
- export declare const ResourcesDateField: {
345
- readonly RESOURCE_CREATION_TIME_DT: "ResourceCreationTime";
346
- readonly RESOURCE_DETAIL_CAPTURE_TIME_DT: "ResourceDetailCaptureTime";
347
- };
348
- /**
349
- * @public
350
- */
351
- export type ResourcesDateField = (typeof ResourcesDateField)[keyof typeof ResourcesDateField];
352
- /**
353
- * <p>Enables the filtering of Amazon Web Services resources based on date and timestamp attributes.</p>
354
- * @public
355
- */
356
- export interface ResourcesDateFilter {
357
- /**
358
- * <p>The name of the field.</p>
359
- * @public
360
- */
361
- FieldName?: ResourcesDateField | undefined;
362
- /**
363
- * <p>A date filter for querying findings.</p>
364
- * @public
365
- */
366
- Filter?: DateFilter | undefined;
367
- }
368
- /**
369
- * @public
370
- * @enum
371
- */
372
- export declare const ResourcesMapField: {
373
- readonly TAG: "ResourceTags";
374
- };
375
- /**
376
- * @public
377
- */
378
- export type ResourcesMapField = (typeof ResourcesMapField)[keyof typeof ResourcesMapField];
379
- /**
380
- * <p>Enables filtering of Amazon Web Services resources based on key-value map attributes.</p>
381
- * @public
382
- */
383
- export interface ResourcesMapFilter {
384
- /**
385
- * <p>The name of the field.</p>
386
- * @public
387
- */
388
- FieldName?: ResourcesMapField | undefined;
389
- /**
390
- * <p>A map filter for filtering Security Hub findings. Each map filter provides the field to check for, the
391
- * value to check for, and the comparison operator.</p>
392
- * @public
393
- */
394
- Filter?: MapFilter | undefined;
395
- }
396
- /**
397
- * @public
398
- * @enum
399
- */
400
- export declare const ResourcesNumberField: {
401
- readonly SEVERITY_CRITICAL: "FindingsSummary.Severities.Critical";
402
- readonly SEVERITY_FATAL: "FindingsSummary.Severities.Fatal";
403
- readonly SEVERITY_HIGH: "FindingsSummary.Severities.High";
404
- readonly SEVERITY_INFORMATIONAL: "FindingsSummary.Severities.Informational";
405
- readonly SEVERITY_LOW: "FindingsSummary.Severities.Low";
406
- readonly SEVERITY_MEDIUM: "FindingsSummary.Severities.Medium";
407
- readonly SEVERITY_OTHER: "FindingsSummary.Severities.Other";
408
- readonly SEVERITY_UNKNOWN: "FindingsSummary.Severities.Unknown";
409
- readonly TOTAL_FINDINGS: "FindingsSummary.TotalFindings";
410
- };
411
- /**
412
- * @public
413
- */
414
- export type ResourcesNumberField = (typeof ResourcesNumberField)[keyof typeof ResourcesNumberField];
415
- /**
416
- * <p>Enables filtering of Amazon Web Services resources based on numerical values.</p>
417
- * @public
418
- */
419
- export interface ResourcesNumberFilter {
420
- /**
421
- * <p>The name of the field.</p>
422
- * @public
423
- */
424
- FieldName?: ResourcesNumberField | undefined;
425
- /**
426
- * <p>A number filter for querying findings.</p>
427
- * @public
428
- */
429
- Filter?: NumberFilter | undefined;
430
- }
431
- /**
432
- * @public
433
- * @enum
434
- */
435
- export declare const ResourcesStringField: {
436
- readonly ACCOUNT_ID: "AccountId";
437
- readonly FINDING_TYPE: "FindingsSummary.FindingType";
438
- readonly PRODUCT_NAME: "FindingsSummary.ProductName";
439
- readonly REGION: "Region";
440
- readonly RESOURCE_CATEGORY: "ResourceCategory";
441
- readonly RESOURCE_GUID: "ResourceGuid";
442
- readonly RESOURCE_ID: "ResourceId";
443
- readonly RESOURCE_NAME: "ResourceName";
444
- readonly RESOURCE_TYPE: "ResourceType";
445
- };
446
- /**
447
- * @public
448
- */
449
- export type ResourcesStringField = (typeof ResourcesStringField)[keyof typeof ResourcesStringField];
450
- /**
451
- * <p>Enables filtering of Amazon Web Services resources based on string field values.</p>
452
- * @public
453
- */
454
- export interface ResourcesStringFilter {
455
- /**
456
- * <p>The name of the field.</p>
457
- * @public
458
- */
459
- FieldName?: ResourcesStringField | undefined;
460
- /**
461
- * <p>A string filter for filtering Security Hub findings.</p>
462
- * @public
463
- */
464
- Filter?: StringFilter | undefined;
465
- }
466
- /**
467
- * @public
468
- * @enum
469
- */
470
- export declare const ResourceGroupByField: {
471
- readonly ACCOUNT_ID: "AccountId";
472
- readonly FINDING_TYPE: "FindingsSummary.FindingType";
473
- readonly REGION: "Region";
474
- readonly RESOURCE_CATEGORY: "ResourceCategory";
475
- readonly RESOURCE_NAME: "ResourceName";
476
- readonly RESOURCE_TYPE: "ResourceType";
477
- };
478
- /**
479
- * @public
480
- */
481
- export type ResourceGroupByField = (typeof ResourceGroupByField)[keyof typeof ResourceGroupByField];
482
- /**
483
- * @public
484
- */
485
- export interface GetResourcesStatisticsV2Response {
486
- /**
487
- * <p>The aggregated statistics about resources based on the specified grouping rule.</p>
488
- * @public
489
- */
490
- GroupByResults: GroupByResult[] | undefined;
491
- }
492
- /**
493
- * <p>A comprehensive distribution of security findings by severity level for Amazon Web Services resources.</p>
494
- * @public
495
- */
496
- export interface ResourceSeverityBreakdown {
497
- /**
498
- * <p>The number of findings not in any of the severity categories.</p>
499
- * @public
500
- */
501
- Other?: number | undefined;
502
- /**
503
- * <p>The number of findings with a severity level of fatal.</p>
504
- * @public
505
- */
506
- Fatal?: number | undefined;
507
- /**
508
- * <p>The number of findings with a severity level of critical.</p>
509
- * @public
510
- */
511
- Critical?: number | undefined;
512
- /**
513
- * <p>The number of findings with a severity level of high.</p>
514
- * @public
515
- */
516
- High?: number | undefined;
517
- /**
518
- * <p>The number of findings with a severity level of medium.</p>
519
- * @public
520
- */
521
- Medium?: number | undefined;
522
- /**
523
- * <p>The number of findings with a severity level of low.</p>
524
- * @public
525
- */
526
- Low?: number | undefined;
527
- /**
528
- * <p>The number of findings that provide security-related information.</p>
529
- * @public
530
- */
531
- Informational?: number | undefined;
532
- /**
533
- * <p>The number of findings with a severity level cannot be determined.</p>
534
- * @public
535
- */
536
- Unknown?: number | undefined;
537
- }
538
- /**
539
- * <p>A list of summaries for all finding types on a resource.</p>
540
- * @public
541
- */
542
- export interface ResourceFindingsSummary {
543
- /**
544
- * <p>The category or classification of the security finding.</p>
545
- * @public
546
- */
547
- FindingType: string | undefined;
548
- /**
549
- * <p>The name of the product associated with the security finding.</p>
550
- * @public
551
- */
552
- ProductName: string | undefined;
553
- /**
554
- * <p>The total count of security findings.</p>
555
- * @public
556
- */
557
- TotalFindings: number | undefined;
558
- /**
559
- * <p>A breakdown of security findings by their severity levels.</p>
560
- * @public
561
- */
562
- Severities?: ResourceSeverityBreakdown | undefined;
563
- }
564
- /**
565
- * @public
566
- * @enum
567
- */
568
- export declare const ResourceCategory: {
569
- readonly AI_ML: "AI/ML";
570
- readonly CODE: "Code";
571
- readonly COMPUTE: "Compute";
572
- readonly DATABASE: "Database";
573
- readonly IDENTITY: "Identity";
574
- readonly NETWORK: "Network";
575
- readonly OTHER: "Other";
576
- readonly STORAGE: "Storage";
577
- };
578
- /**
579
- * @public
580
- */
581
- export type ResourceCategory = (typeof ResourceCategory)[keyof typeof ResourceCategory];
582
- /**
583
- * <p>Represents tag information associated with Amazon Web Services resources.</p>
584
- * @public
585
- */
586
- export interface ResourceTag {
587
- /**
588
- * <p>The identifier or name of the tag.</p>
589
- * @public
590
- */
591
- Key: string | undefined;
592
- /**
593
- * <p>The data associated with the tag key.</p>
594
- * @public
595
- */
596
- Value: string | undefined;
597
- }
598
- /**
599
- * <p>Provides comprehensive details about an Amazon Web Services resource and its associated security findings.</p>
600
- * @public
601
- */
602
- export interface ResourceResult {
603
- /**
604
- * <p>The global identifier used to identify a resource.</p>
605
- * @public
606
- */
607
- ResourceGuid?: string | undefined;
608
- /**
609
- * <p>The unique identifier for a resource.</p>
610
- * @public
611
- */
612
- ResourceId: string | undefined;
613
- /**
614
- * <p>The Amazon Web Services account that owns the resource.</p>
615
- * @public
616
- */
617
- AccountId: string | undefined;
618
- /**
619
- * <p>The Amazon Web Services Region where the resource is located.</p>
620
- * @public
621
- */
622
- Region: string | undefined;
623
- /**
624
- * <p>The grouping where the resource belongs.</p>
625
- * @public
626
- */
627
- ResourceCategory?: ResourceCategory | undefined;
628
- /**
629
- * <p>The type of resource.</p>
630
- * @public
631
- */
632
- ResourceType?: string | undefined;
633
- /**
634
- * <p>The name of the resource.</p>
635
- * @public
636
- */
637
- ResourceName?: string | undefined;
638
- /**
639
- * <p>The time when the resource was created.</p>
640
- * @public
641
- */
642
- ResourceCreationTimeDt?: string | undefined;
643
- /**
644
- * <p>The timestamp when information about the resource was captured.</p>
645
- * @public
646
- */
647
- ResourceDetailCaptureTimeDt: string | undefined;
648
- /**
649
- * <p>An aggregated view of security findings associated with a resource.</p>
650
- * @public
651
- */
652
- FindingsSummary?: ResourceFindingsSummary[] | undefined;
653
- /**
654
- * <p>The key-value pairs associated with a resource.</p>
655
- * @public
656
- */
657
- ResourceTags?: ResourceTag[] | undefined;
658
- /**
659
- * <p>The configuration details of a resource.</p>
660
- * @public
661
- */
662
- ResourceConfig: __DocumentType | undefined;
663
- }
664
- /**
665
- * @public
666
- */
667
- export interface GetResourcesV2Response {
668
- /**
669
- * <p>Filters resources based on a set of criteria.</p>
670
- * @public
671
- */
672
- Resources: ResourceResult[] | undefined;
673
- /**
674
- * <p>The pagination token to use to request the next page of results.
675
- * Otherwise, this parameter is null.</p>
676
- * @public
677
- */
678
- NextToken?: string | undefined;
679
- }
680
- /**
681
- * @public
682
- */
683
- export interface GetSecurityControlDefinitionRequest {
684
- /**
685
- * <p>
686
- * The ID of the security control to retrieve the definition for. This field doesn’t accept an Amazon Resource Name (ARN).
687
- * </p>
688
- * @public
689
- */
690
- SecurityControlId: string | undefined;
691
- }
692
- /**
693
- * @public
694
- * @enum
695
- */
696
- export declare const RegionAvailabilityStatus: {
697
- readonly AVAILABLE: "AVAILABLE";
698
- readonly UNAVAILABLE: "UNAVAILABLE";
699
- };
700
- /**
701
- * @public
702
- */
703
- export type RegionAvailabilityStatus = (typeof RegionAvailabilityStatus)[keyof typeof RegionAvailabilityStatus];
704
- /**
705
- * <p>
706
- * An object that describes a security control parameter and the options for customizing it.
707
- * </p>
708
- * @public
709
- */
710
- export interface ParameterDefinition {
711
- /**
712
- * <p>
713
- * Description of a control parameter.
714
- * </p>
715
- * @public
716
- */
717
- Description: string | undefined;
718
- /**
719
- * <p>
720
- * The options for customizing a control parameter. Customization options vary based on the data type of the parameter.
721
- * </p>
722
- * @public
723
- */
724
- ConfigurationOptions: ConfigurationOptions | undefined;
725
- }
726
- /**
727
- * <p>
728
- * Provides metadata for a security control, including its unique standard-agnostic identifier, title, description,
729
- * severity, availability in Amazon Web Services Regions, and a link to remediation steps.
730
- * </p>
731
- * @public
732
- */
733
- export interface SecurityControlDefinition {
734
- /**
735
- * <p>
736
- * The unique identifier of a security control across standards. Values for this field typically consist of an
737
- * Amazon Web Services service name and a number (for example, APIGateway.3). This parameter differs from
738
- * <code>SecurityControlArn</code>, which is a unique Amazon Resource Name (ARN) assigned to a control. The
739
- * ARN references the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).
740
- * </p>
741
- * @public
742
- */
743
- SecurityControlId: string | undefined;
744
- /**
745
- * <p>
746
- * The title of a security control.
747
- * </p>
748
- * @public
749
- */
750
- Title: string | undefined;
751
- /**
752
- * <p> The description of a security control across standards. This typically summarizes how
753
- * Security Hub evaluates the control and the conditions under which it produces a
754
- * failed finding. This parameter doesn't reference a specific standard. </p>
755
- * @public
756
- */
757
- Description: string | undefined;
758
- /**
759
- * <p>
760
- * A link to Security Hub documentation that explains how to remediate a failed finding for a security control.
761
- * </p>
762
- * @public
763
- */
764
- RemediationUrl: string | undefined;
765
- /**
766
- * <p>
767
- * The severity of a security control. For more information about how Security Hub determines control severity,
768
- * see <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/controls-findings-create-update.html#control-findings-severity">Assigning severity to control findings</a> in the
769
- * <i>Security Hub User Guide</i>.
770
- * </p>
771
- * @public
772
- */
773
- SeverityRating: SeverityRating | undefined;
774
- /**
775
- * <p>
776
- * Specifies whether a security control is available in the current Amazon Web Services Region.
777
- * </p>
778
- * @public
779
- */
780
- CurrentRegionAvailability: RegionAvailabilityStatus | undefined;
781
- /**
782
- * <p>
783
- * Security control properties that you can customize. Currently, only parameter customization is supported for select
784
- * controls. An empty array is returned for controls that don’t support custom properties.
785
- * </p>
786
- * @public
787
- */
788
- CustomizableProperties?: SecurityControlProperty[] | undefined;
789
- /**
790
- * <p>
791
- * An object that provides a security control parameter name, description, and the options for customizing it. This
792
- * object is excluded for a control that doesn't support custom parameters.
793
- * </p>
794
- * @public
795
- */
796
- ParameterDefinitions?: Record<string, ParameterDefinition> | undefined;
797
- }
798
- /**
799
- * @public
800
- */
801
- export interface GetSecurityControlDefinitionResponse {
802
- /**
803
- * <p>
804
- * Provides metadata for a security control, including its unique standard-agnostic identifier, title, description,
805
- * severity, availability in Amazon Web Services Regions, and a link to remediation steps.
806
- * </p>
807
- * @public
808
- */
809
- SecurityControlDefinition: SecurityControlDefinition | undefined;
810
- }
811
- /**
812
- * @public
813
- */
814
- export interface InviteMembersRequest {
815
- /**
816
- * <p>The list of account IDs of the Amazon Web Services accounts to invite to Security Hub as members. </p>
817
- * @public
818
- */
819
- AccountIds: string[] | undefined;
820
- }
821
- /**
822
- * @public
823
- */
824
- export interface InviteMembersResponse {
825
- /**
826
- * <p>The list of Amazon Web Services accounts that could not be processed. For each account, the list
827
- * includes the account ID and the email address.</p>
828
- * @public
829
- */
830
- UnprocessedAccounts?: Result[] | undefined;
831
- }
832
- /**
833
- * <p>The parameters used to modify an existing Jira Cloud integration.</p>
834
- * @public
835
- */
836
- export interface JiraCloudUpdateConfiguration {
837
- /**
838
- * <p>The project key for a JiraCloud instance.</p>
839
- * @public
840
- */
841
- ProjectKey: string | undefined;
842
- }
843
- /**
844
- * @public
845
- */
846
- export interface ListAggregatorsV2Request {
847
- /**
848
- * <p>The token required for pagination.
849
- * On your first call, set the value of this parameter to <code>NULL</code>.
850
- * For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.</p>
851
- * @public
852
- */
853
- NextToken?: string | undefined;
854
- /**
855
- * <p>The maximum number of results to return.</p>
856
- * @public
857
- */
858
- MaxResults?: number | undefined;
859
- }
860
- /**
861
- * @public
862
- */
863
- export interface ListAggregatorsV2Response {
864
- /**
865
- * <p>An array of aggregators.</p>
866
- * @public
867
- */
868
- AggregatorsV2?: AggregatorV2[] | undefined;
869
- /**
870
- * <p>The pagination token to use to request the next page of results.
871
- * Otherwise, this parameter is null.</p>
872
- * @public
873
- */
874
- NextToken?: string | undefined;
875
- }
876
- /**
877
- * @public
878
- */
879
- export interface ListAutomationRulesRequest {
880
- /**
881
- * <p>
882
- * A token to specify where to start paginating the response. This is the <code>NextToken</code>
883
- * from a previously truncated response. On your first call to the <code>ListAutomationRules</code>
884
- * API, set the value of this parameter to <code>NULL</code>.
885
- * </p>
886
- * @public
887
- */
888
- NextToken?: string | undefined;
889
- /**
890
- * <p> The maximum number of rules to return in the response. This currently ranges from 1 to
891
- * 100. </p>
892
- * @public
893
- */
894
- MaxResults?: number | undefined;
895
- }
896
- /**
897
- * @public
898
- */
899
- export interface ListAutomationRulesResponse {
900
- /**
901
- * <p>
902
- * Metadata for rules in the calling account. The response includes rules with a
903
- * <code>RuleStatus</code> of <code>ENABLED</code> and <code>DISABLED</code>.
904
- * </p>
905
- * @public
906
- */
907
- AutomationRulesMetadata?: AutomationRulesMetadata[] | undefined;
908
- /**
909
- * <p>
910
- * A pagination token for the response.
911
- * </p>
912
- * @public
913
- */
914
- NextToken?: string | undefined;
915
- }
916
- /**
917
- * @public
918
- */
919
- export interface ListAutomationRulesV2Request {
920
- /**
921
- * <p>The token required for pagination.
922
- * On your first call, set the value of this parameter to <code>NULL</code>.
923
- * For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.</p>
924
- * @public
925
- */
926
- NextToken?: string | undefined;
927
- /**
928
- * <p>The maximum number of results to return.</p>
929
- * @public
930
- */
931
- MaxResults?: number | undefined;
932
- }
933
- /**
934
- * @public
935
- */
936
- export interface ListAutomationRulesV2Response {
937
- /**
938
- * <p>An array of automation rules.</p>
939
- * @public
940
- */
941
- Rules?: AutomationRulesMetadataV2[] | undefined;
942
- /**
943
- * <p>The pagination token to use to request the next page of results.
944
- * Otherwise, this parameter is null.</p>
945
- * @public
946
- */
947
- NextToken?: string | undefined;
948
- }
949
- /**
950
- * @public
951
- */
952
- export interface ListConfigurationPoliciesRequest {
953
- /**
954
- * <p>
955
- * The NextToken value that's returned from a previous paginated <code>ListConfigurationPolicies</code> request where
956
- * <code>MaxResults</code> was used but the results exceeded the value of that parameter. Pagination continues from the
957
- * <code>MaxResults</code> was used but the results exceeded the value of that parameter. Pagination continues from the
958
- * end of the previous response that returned the <code>NextToken</code> value. This value is <code>null</code> when
959
- * there are no more results to return.
960
- * </p>
961
- * @public
962
- */
963
- NextToken?: string | undefined;
964
- /**
965
- * <p>
966
- * The maximum number of results that's returned by <code>ListConfigurationPolicies</code> in each page of the response.
967
- * When this parameter is used, <code>ListConfigurationPolicies</code> returns the specified number of results in a
968
- * single page and a <code>NextToken</code> response element. You can see the remaining results of the initial request
969
- * by sending another <code>ListConfigurationPolicies</code> request with the returned <code>NextToken</code> value. A
970
- * valid range for <code>MaxResults</code> is between 1 and 100.
971
- * </p>
972
- * @public
973
- */
974
- MaxResults?: number | undefined;
975
- }
976
- /**
977
- * @public
978
- */
979
- export interface ListConfigurationPoliciesResponse {
980
- /**
981
- * <p>
982
- * Provides metadata for each of your configuration policies.
983
- * </p>
984
- * @public
985
- */
986
- ConfigurationPolicySummaries?: ConfigurationPolicySummary[] | undefined;
987
- /**
988
- * <p>
989
- * The <code>NextToken</code> value to include in the next <code>ListConfigurationPolicies</code> request. When the
990
- * results of a <code>ListConfigurationPolicies</code> request exceed <code>MaxResults</code>, this value can be used to
991
- * retrieve the next page of results. This value is <code>null</code> when there are no more results to return.
992
- * </p>
993
- * @public
994
- */
995
- NextToken?: string | undefined;
996
- }
997
- /**
998
- * @public
999
- */
1000
- export interface ListConfigurationPolicyAssociationsRequest {
1001
- /**
1002
- * <p>
1003
- * The <code>NextToken</code> value that's returned from a previous paginated <code>ListConfigurationPolicyAssociations</code>
1004
- * request where <code>MaxResults</code> was used but the results exceeded the value of that parameter. Pagination
1005
- * continues from the end of the previous response that returned the <code>NextToken</code> value. This value is <code>null</code>
1006
- * when there are no more results to return.
1007
- * </p>
1008
- * @public
1009
- */
1010
- NextToken?: string | undefined;
1011
- /**
1012
- * <p>
1013
- * The maximum number of results that's returned by <code>ListConfigurationPolicies</code> in each page of the response.
1014
- * When this parameter is used, <code>ListConfigurationPolicyAssociations</code> returns the specified number of results
1015
- * in a single page and a <code>NextToken</code> response element. You can see the remaining results of the initial
1016
- * request by sending another <code>ListConfigurationPolicyAssociations</code> request with the returned <code>NextToken</code>
1017
- * value. A valid range for <code>MaxResults</code> is between 1 and 100.
1018
- * </p>
1019
- * @public
1020
- */
1021
- MaxResults?: number | undefined;
1022
- /**
1023
- * <p>
1024
- * Options for filtering the <code>ListConfigurationPolicyAssociations</code> response. You can filter by the Amazon Resource Name (ARN) or
1025
- * universally unique identifier (UUID) of a configuration, <code>AssociationType</code>, or <code>AssociationStatus</code>.
1026
- * </p>
1027
- * @public
1028
- */
1029
- Filters?: AssociationFilters | undefined;
1030
- }
1031
- /**
1032
- * @public
1033
- */
1034
- export interface ListConfigurationPolicyAssociationsResponse {
1035
- /**
1036
- * <p>
1037
- * An object that contains the details of each configuration policy association that’s returned in a
1038
- * <code>ListConfigurationPolicyAssociations</code> request.
1039
- * </p>
1040
- * @public
1041
- */
1042
- ConfigurationPolicyAssociationSummaries?: ConfigurationPolicyAssociationSummary[] | undefined;
1043
- /**
1044
- * <p>
1045
- * The <code>NextToken</code> value to include in the next <code>ListConfigurationPolicyAssociations</code> request. When
1046
- * the results of a <code>ListConfigurationPolicyAssociations</code> request exceed <code>MaxResults</code>, this value
1047
- * can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.
1048
- * </p>
1049
- * @public
1050
- */
1051
- NextToken?: string | undefined;
1052
- }
1053
- /**
1054
- * @public
1055
- */
1056
- export interface ListConnectorsV2Request {
1057
- /**
1058
- * <p>The pagination token per the Amazon Web Services Pagination standard</p>
1059
- * @public
1060
- */
1061
- NextToken?: string | undefined;
1062
- /**
1063
- * <p>The maximum number of results to be returned.</p>
1064
- * @public
1065
- */
1066
- MaxResults?: number | undefined;
1067
- /**
1068
- * <p>The name of the third-party provider.</p>
1069
- * @public
1070
- */
1071
- ProviderName?: ConnectorProviderName | undefined;
1072
- /**
1073
- * <p>The status for the connectorV2.</p>
1074
- * @public
1075
- */
1076
- ConnectorStatus?: ConnectorStatus | undefined;
1077
- }
1078
- /**
1079
- * @public
1080
- */
1081
- export interface ListConnectorsV2Response {
1082
- /**
1083
- * <p>The pagination token to use to request the next page of results.
1084
- * Otherwise, this parameter is null.</p>
1085
- * @public
1086
- */
1087
- NextToken?: string | undefined;
1088
- /**
1089
- * <p>An array of connectorV2 summaries.</p>
1090
- * @public
1091
- */
1092
- Connectors: ConnectorSummary[] | undefined;
1093
- }
1094
- /**
1095
- * @public
1096
- */
1097
- export interface ListEnabledProductsForImportRequest {
1098
- /**
1099
- * <p>The token that is required for pagination. On your first call to the
1100
- * <code>ListEnabledProductsForImport</code> operation, set the value of this parameter to
1101
- * <code>NULL</code>.</p>
1102
- * <p>For subsequent calls to the operation, to continue listing data, set the value of this
1103
- * parameter to the value returned from the previous response.</p>
1104
- * @public
1105
- */
1106
- NextToken?: string | undefined;
1107
- /**
1108
- * <p>The maximum number of items to return in the response.</p>
1109
- * @public
1110
- */
1111
- MaxResults?: number | undefined;
1112
- }
1113
- /**
1114
- * @public
1115
- */
1116
- export interface ListEnabledProductsForImportResponse {
1117
- /**
1118
- * <p>The list of ARNs for the resources that represent your subscriptions to products. </p>
1119
- * @public
1120
- */
1121
- ProductSubscriptions?: string[] | undefined;
1122
- /**
1123
- * <p>The pagination token to use to request the next page of results.</p>
1124
- * @public
1125
- */
1126
- NextToken?: string | undefined;
1127
- }
1128
- /**
1129
- * @public
1130
- */
1131
- export interface ListFindingAggregatorsRequest {
1132
- /**
1133
- * <p>The token returned with the previous set of results. Identifies the next set of results to return.</p>
1134
- * @public
1135
- */
1136
- NextToken?: string | undefined;
1137
- /**
1138
- * <p>The maximum number of results to return. This operation currently only returns a single result.</p>
1139
- * @public
1140
- */
1141
- MaxResults?: number | undefined;
1142
- }
1143
- /**
1144
- * @public
1145
- */
1146
- export interface ListFindingAggregatorsResponse {
1147
- /**
1148
- * <p>The list of finding aggregators. This operation currently only returns a single result.</p>
1149
- * @public
1150
- */
1151
- FindingAggregators?: FindingAggregator[] | undefined;
1152
- /**
1153
- * <p>If there are more results, this is the token to provide in the next call to <code>ListFindingAggregators</code>.</p>
1154
- * <p>This operation currently only returns a single result.
1155
- * </p>
1156
- * @public
1157
- */
1158
- NextToken?: string | undefined;
1159
- }
1160
- /**
1161
- * @public
1162
- */
1163
- export interface ListInvitationsRequest {
1164
- /**
1165
- * <p>The maximum number of items to return in the response. </p>
1166
- * @public
1167
- */
1168
- MaxResults?: number | undefined;
1169
- /**
1170
- * <p>The token that is required for pagination. On your first call to the
1171
- * <code>ListInvitations</code> operation, set the value of this parameter to
1172
- * <code>NULL</code>.</p>
1173
- * <p>For subsequent calls to the operation, to continue listing data, set the value of this
1174
- * parameter to the value returned from the previous response.</p>
1175
- * @public
1176
- */
1177
- NextToken?: string | undefined;
1178
- }
1179
- /**
1180
- * @public
1181
- */
1182
- export interface ListInvitationsResponse {
1183
- /**
1184
- * <p>The details of the invitations returned by the operation.</p>
1185
- * @public
1186
- */
1187
- Invitations?: Invitation[] | undefined;
1188
- /**
1189
- * <p>The pagination token to use to request the next page of results.</p>
1190
- * @public
1191
- */
1192
- NextToken?: string | undefined;
1193
- }
1194
- /**
1195
- * @public
1196
- */
1197
- export interface ListMembersRequest {
1198
- /**
1199
- * <p>Specifies which member accounts to include in the response based on their relationship
1200
- * status with the administrator account. The default value is <code>TRUE</code>.</p>
1201
- * <p>If <code>OnlyAssociated</code> is set to <code>TRUE</code>, the response includes member
1202
- * accounts whose relationship status with the administrator account is set to <code>ENABLED</code>.</p>
1203
- * <p>If <code>OnlyAssociated</code> is set to <code>FALSE</code>, the response includes all
1204
- * existing member accounts. </p>
1205
- * @public
1206
- */
1207
- OnlyAssociated?: boolean | undefined;
1208
- /**
1209
- * <p>The maximum number of items to return in the response. </p>
1210
- * @public
1211
- */
1212
- MaxResults?: number | undefined;
1213
- /**
1214
- * <p>The token that is required for pagination. On your first call to the
1215
- * <code>ListMembers</code> operation, set the value of this parameter to
1216
- * <code>NULL</code>.</p>
1217
- * <p>For subsequent calls to the operation, to continue listing data, set the value of this
1218
- * parameter to the value returned from the previous response.</p>
1219
- * @public
1220
- */
1221
- NextToken?: string | undefined;
1222
- }
1223
- /**
1224
- * @public
1225
- */
1226
- export interface ListMembersResponse {
1227
- /**
1228
- * <p>Member details returned by the operation.</p>
1229
- * @public
1230
- */
1231
- Members?: Member[] | undefined;
1232
- /**
1233
- * <p>The pagination token to use to request the next page of results.</p>
1234
- * @public
1235
- */
1236
- NextToken?: string | undefined;
1237
- }
1238
- /**
1239
- * @public
1240
- */
1241
- export interface ListOrganizationAdminAccountsRequest {
1242
- /**
1243
- * <p>The maximum number of items to return in the response.</p>
1244
- * @public
1245
- */
1246
- MaxResults?: number | undefined;
1247
- /**
1248
- * <p>The token that is required for pagination. On your first call to the
1249
- * <code>ListOrganizationAdminAccounts</code> operation, set the value of this parameter to
1250
- * <code>NULL</code>. For subsequent calls to the operation, to continue listing data, set
1251
- * the value of this parameter to the value returned from the previous response. </p>
1252
- * @public
1253
- */
1254
- NextToken?: string | undefined;
1255
- /**
1256
- * <p>The feature where the delegated administrator account is listed.
1257
- * Defaults to Security Hub if not specified.</p>
1258
- * @public
1259
- */
1260
- Feature?: SecurityHubFeature | undefined;
1261
- }
1262
- /**
1263
- * @public
1264
- */
1265
- export interface ListOrganizationAdminAccountsResponse {
1266
- /**
1267
- * <p>The list of Security Hub administrator accounts.</p>
1268
- * @public
1269
- */
1270
- AdminAccounts?: AdminAccount[] | undefined;
1271
- /**
1272
- * <p>The pagination token to use to request the next page of results.</p>
1273
- * @public
1274
- */
1275
- NextToken?: string | undefined;
1276
- /**
1277
- * <p>The feature where the delegated administrator account is listed.
1278
- * Defaults to Security Hub CSPM if not specified.</p>
1279
- * @public
1280
- */
1281
- Feature?: SecurityHubFeature | undefined;
1282
- }
1283
- /**
1284
- * @public
1285
- */
1286
- export interface ListSecurityControlDefinitionsRequest {
1287
- /**
1288
- * <p>
1289
- * The Amazon Resource Name (ARN) of the standard that you want to view controls for.
1290
- * </p>
1291
- * @public
1292
- */
1293
- StandardsArn?: string | undefined;
1294
- /**
1295
- * <p>
1296
- * Optional pagination parameter.
1297
- * </p>
1298
- * @public
1299
- */
1300
- NextToken?: string | undefined;
1301
- /**
1302
- * <p> An optional parameter that limits the total results of the API response to the
1303
- * specified number. If this parameter isn't provided in the request, the results include the
1304
- * first 25 security controls that apply to the specified standard. The results also include a
1305
- * <code>NextToken</code> parameter that you can use in a subsequent API call to get the
1306
- * next 25 controls. This repeats until all controls for the standard are returned. </p>
1307
- * @public
1308
- */
1309
- MaxResults?: number | undefined;
1310
- }
1311
- /**
1312
- * @public
1313
- */
1314
- export interface ListSecurityControlDefinitionsResponse {
1315
- /**
1316
- * <p>
1317
- * An array of controls that apply to the specified standard.
1318
- * </p>
1319
- * @public
1320
- */
1321
- SecurityControlDefinitions: SecurityControlDefinition[] | undefined;
1322
- /**
1323
- * <p> A pagination parameter that's included in the response only if it was included in the
1324
- * request. </p>
1325
- * @public
1326
- */
1327
- NextToken?: string | undefined;
1328
- }
1329
- /**
1330
- * @public
1331
- */
1332
- export interface ListStandardsControlAssociationsRequest {
1333
- /**
1334
- * <p>
1335
- * The identifier of the control (identified with <code>SecurityControlId</code>, <code>SecurityControlArn</code>, or a mix of both parameters) that you
1336
- * want to determine the enablement status of in each enabled standard.
1337
- * </p>
1338
- * @public
1339
- */
1340
- SecurityControlId: string | undefined;
1341
- /**
1342
- * <p>
1343
- * Optional pagination parameter.
1344
- * </p>
1345
- * @public
1346
- */
1347
- NextToken?: string | undefined;
1348
- /**
1349
- * <p> An optional parameter that limits the total results of the API response to the
1350
- * specified number. If this parameter isn't provided in the request, the results include the
1351
- * first 25 standard and control associations. The results also include a
1352
- * <code>NextToken</code> parameter that you can use in a subsequent API call to get the
1353
- * next 25 associations. This repeats until all associations for the specified control are
1354
- * returned. The number of results is limited by the number of supported Security Hub
1355
- * standards that you've enabled in the calling account. </p>
1356
- * @public
1357
- */
1358
- MaxResults?: number | undefined;
1359
- }
1360
- /**
1361
- * <p> An array that provides the enablement status and other details for each control that
1362
- * applies to each enabled standard. </p>
1363
- * @public
1364
- */
1365
- export interface StandardsControlAssociationSummary {
1366
- /**
1367
- * <p>
1368
- * The Amazon Resource Name (ARN) of a standard.
1369
- * </p>
1370
- * @public
1371
- */
1372
- StandardsArn: string | undefined;
1373
- /**
1374
- * <p>
1375
- * A unique standard-agnostic identifier for a control. Values for this field typically consist of an
1376
- * Amazon Web Services service and a number, such as APIGateway.5. This field doesn't reference a specific standard.
1377
- * </p>
1378
- * @public
1379
- */
1380
- SecurityControlId: string | undefined;
1381
- /**
1382
- * <p> The ARN of a control, such as
1383
- * <code>arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1</code>. This
1384
- * parameter doesn't mention a specific standard. </p>
1385
- * @public
1386
- */
1387
- SecurityControlArn: string | undefined;
1388
- /**
1389
- * <p>
1390
- * The enablement status of a control in a specific standard.
1391
- * </p>
1392
- * @public
1393
- */
1394
- AssociationStatus: AssociationStatus | undefined;
1395
- /**
1396
- * <p>
1397
- * The requirement that underlies this control in the compliance framework related to the standard.
1398
- * </p>
1399
- * @public
1400
- */
1401
- RelatedRequirements?: string[] | undefined;
1402
- /**
1403
- * <p>The last time that a control's enablement status in a specified standard was updated.</p>
1404
- * @public
1405
- */
1406
- UpdatedAt?: Date | undefined;
1407
- /**
1408
- * <p>The reason for updating a control's enablement status in a specified standard.</p>
1409
- * @public
1410
- */
1411
- UpdatedReason?: string | undefined;
1412
- /**
1413
- * <p>
1414
- * The title of a control.
1415
- * </p>
1416
- * @public
1417
- */
1418
- StandardsControlTitle?: string | undefined;
1419
- /**
1420
- * <p>
1421
- * The description of a control. This typically summarizes how Security Hub evaluates the control and the
1422
- * conditions under which it produces a failed finding. The parameter may reference a specific standard.
1423
- * </p>
1424
- * @public
1425
- */
1426
- StandardsControlDescription?: string | undefined;
1427
- }
1428
- /**
1429
- * @public
1430
- */
1431
- export interface ListStandardsControlAssociationsResponse {
1432
- /**
1433
- * <p> An array that provides the enablement status and other details for each security
1434
- * control that applies to each enabled standard. </p>
1435
- * @public
1436
- */
1437
- StandardsControlAssociationSummaries: StandardsControlAssociationSummary[] | undefined;
1438
- /**
1439
- * <p> A pagination parameter that's included in the response only if it was included in the
1440
- * request. </p>
1441
- * @public
1442
- */
1443
- NextToken?: string | undefined;
1444
- }
1445
- /**
1446
- * @public
1447
- */
1448
- export interface ListTagsForResourceRequest {
1449
- /**
1450
- * <p>The ARN of the resource to retrieve tags for.</p>
1451
- * @public
1452
- */
1453
- ResourceArn: string | undefined;
1454
- }
1455
- /**
1456
- * @public
1457
- */
1458
- export interface ListTagsForResourceResponse {
1459
- /**
1460
- * <p>The tags associated with a resource.</p>
1461
- * @public
1462
- */
1463
- Tags?: Record<string, string> | undefined;
1464
- }
1465
- /**
1466
- * <p>The parameters required to update the configuration of an integration provider.</p>
1467
- * @public
1468
- */
1469
- export type ProviderUpdateConfiguration = ProviderUpdateConfiguration.JiraCloudMember | ProviderUpdateConfiguration.$UnknownMember;
1470
- /**
1471
- * @public
1472
- */
1473
- export declare namespace ProviderUpdateConfiguration {
1474
- /**
1475
- * <p>The parameters required to update the configuration for a Jira Cloud integration.</p>
1476
- * @public
1477
- */
1478
- interface JiraCloudMember {
1479
- JiraCloud: JiraCloudUpdateConfiguration;
1480
- $unknown?: never;
1481
- }
1482
- /**
1483
- * @public
1484
- */
1485
- interface $UnknownMember {
1486
- JiraCloud?: never;
1487
- $unknown: [string, any];
1488
- }
1489
- /**
1490
- * @deprecated unused in schema-serde mode.
1491
- *
1492
- */
1493
- interface Visitor<T> {
1494
- JiraCloud: (value: JiraCloudUpdateConfiguration) => T;
1495
- _: (name: string, value: any) => T;
1496
- }
1497
- }
1498
- /**
1499
- * <p>
1500
- * The request was rejected because it conflicts with the resource's availability. For example, you tried
1501
- * to update a security control that's currently in the <code>UPDATING</code> state.
1502
- * </p>
1503
- * @public
1504
- */
1505
- export declare class ResourceInUseException extends __BaseException {
1506
- readonly name: "ResourceInUseException";
1507
- readonly $fault: "client";
1508
- Message?: string | undefined;
1509
- Code?: string | undefined;
1510
- /**
1511
- * @internal
1512
- */
1513
- constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
1514
- }
1515
- /**
1516
- * @public
1517
- */
1518
- export interface StartConfigurationPolicyAssociationRequest {
1519
- /**
1520
- * <p>
1521
- * The Amazon Resource Name (ARN) of a configuration policy, the universally unique identifier (UUID) of a
1522
- * configuration policy, or a value of <code>SELF_MANAGED_SECURITY_HUB</code> for a self-managed configuration.
1523
- * </p>
1524
- * @public
1525
- */
1526
- ConfigurationPolicyIdentifier: string | undefined;
1527
- /**
1528
- * <p>
1529
- * The identifier of the target account, organizational unit, or the root to associate with the specified configuration.
1530
- * </p>
1531
- * @public
1532
- */
1533
- Target: Target | undefined;
1534
- }
1535
- /**
1536
- * @public
1537
- */
1538
- export interface StartConfigurationPolicyAssociationResponse {
1539
- /**
1540
- * <p>
1541
- * The UUID of the configuration policy.
1542
- * </p>
1543
- * @public
1544
- */
1545
- ConfigurationPolicyId?: string | undefined;
1546
- /**
1547
- * <p>
1548
- * The identifier of the target account, organizational unit, or the organization root with which the configuration is associated.
1549
- * </p>
1550
- * @public
1551
- */
1552
- TargetId?: string | undefined;
1553
- /**
1554
- * <p>
1555
- * Indicates whether the target is an Amazon Web Services account, organizational unit, or the organization root.
1556
- * </p>
1557
- * @public
1558
- */
1559
- TargetType?: TargetType | undefined;
1560
- /**
1561
- * <p>
1562
- * Indicates whether the association between the specified target and the configuration was directly applied by the
1563
- * Security Hub delegated administrator or inherited from a parent.
1564
- * </p>
1565
- * @public
1566
- */
1567
- AssociationType?: AssociationType | undefined;
1568
- /**
1569
- * <p>
1570
- * The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated.
1571
- * </p>
1572
- * @public
1573
- */
1574
- UpdatedAt?: Date | undefined;
1575
- /**
1576
- * <p>
1577
- * The current status of the association between the specified target and the configuration.
1578
- * </p>
1579
- * @public
1580
- */
1581
- AssociationStatus?: ConfigurationPolicyAssociationStatus | undefined;
1582
- /**
1583
- * <p>
1584
- * An explanation for a <code>FAILED</code> value for <code>AssociationStatus</code>.
1585
- * </p>
1586
- * @public
1587
- */
1588
- AssociationStatusMessage?: string | undefined;
1589
- }
1590
- /**
1591
- * @public
1592
- */
1593
- export interface StartConfigurationPolicyDisassociationRequest {
1594
- /**
1595
- * <p>
1596
- * The identifier of the target account, organizational unit, or the root to disassociate from the specified configuration.
1597
- * </p>
1598
- * @public
1599
- */
1600
- Target?: Target | undefined;
1601
- /**
1602
- * <p>
1603
- * The Amazon Resource Name (ARN) of a configuration policy, the universally unique identifier (UUID) of a
1604
- * configuration policy, or a value of <code>SELF_MANAGED_SECURITY_HUB</code> for a self-managed configuration.
1605
- * </p>
1606
- * @public
1607
- */
1608
- ConfigurationPolicyIdentifier: string | undefined;
1609
- }
1610
- /**
1611
- * @public
1612
- */
1613
- export interface StartConfigurationPolicyDisassociationResponse {
1614
- }
1615
- /**
1616
- * @public
1617
- */
1618
- export interface TagResourceRequest {
1619
- /**
1620
- * <p>The ARN of the resource to apply the tags to.</p>
1621
- * @public
1622
- */
1623
- ResourceArn: string | undefined;
1624
- /**
1625
- * <p>The tags to add to the resource. You can add up to 50 tags at a time. The tag keys can be no longer than 128 characters. The tag values can be no longer than 256 characters.</p>
1626
- * @public
1627
- */
1628
- Tags: Record<string, string> | undefined;
1629
- }
1630
- /**
1631
- * @public
1632
- */
1633
- export interface TagResourceResponse {
1634
- }
1
+ import { AllowedOperators, AutoEnableStandards, ControlFindingGenerator, ControlStatus, GroupByField, RecordState, ResourceGroupByField, RuleStatusV2, SortOrder } from "./enums";
2
+ import { AutomationRulesActionV2, NoteUpdate } from "./models_0";
3
+ import { AwsSecurityFindingFilters, OcsfBooleanFilter, OcsfDateFilter, OcsfIpFilter, OcsfMapFilter, OcsfNumberFilter, OcsfStringFilter, OrganizationConfiguration, ParameterConfiguration, Policy, ProviderUpdateConfiguration, ResourcesDateFilter, ResourcesMapFilter, ResourcesNumberFilter, ResourcesStringFilter, SortCriterion } from "./models_2";
1635
4
  /**
1636
5
  * @public
1637
6
  */