@aws-sdk/client-guardduty 3.379.1 → 3.382.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.
@@ -5,15 +5,18 @@ import { GuardDutyServiceException as __BaseException } from "./GuardDutyService
5
5
  */
6
6
  export interface AcceptAdministratorInvitationRequest {
7
7
  /**
8
+ * @public
8
9
  * <p>The unique ID of the detector of the GuardDuty member account.</p>
9
10
  */
10
11
  DetectorId: string | undefined;
11
12
  /**
13
+ * @public
12
14
  * <p>The account ID of the GuardDuty administrator account whose invitation you're
13
15
  * accepting.</p>
14
16
  */
15
17
  AdministratorId: string | undefined;
16
18
  /**
19
+ * @public
17
20
  * <p>The value that is used to validate the administrator account to the member
18
21
  * account.</p>
19
22
  */
@@ -32,10 +35,12 @@ export declare class BadRequestException extends __BaseException {
32
35
  readonly name: "BadRequestException";
33
36
  readonly $fault: "client";
34
37
  /**
38
+ * @public
35
39
  * <p>The error message.</p>
36
40
  */
37
41
  Message?: string;
38
42
  /**
43
+ * @public
39
44
  * <p>The error type.</p>
40
45
  */
41
46
  Type?: string;
@@ -52,10 +57,12 @@ export declare class InternalServerErrorException extends __BaseException {
52
57
  readonly name: "InternalServerErrorException";
53
58
  readonly $fault: "server";
54
59
  /**
60
+ * @public
55
61
  * <p>The error message.</p>
56
62
  */
57
63
  Message?: string;
58
64
  /**
65
+ * @public
59
66
  * <p>The error type.</p>
60
67
  */
61
68
  Type?: string;
@@ -69,15 +76,18 @@ export declare class InternalServerErrorException extends __BaseException {
69
76
  */
70
77
  export interface AcceptInvitationRequest {
71
78
  /**
79
+ * @public
72
80
  * <p>The unique ID of the detector of the GuardDuty member account.</p>
73
81
  */
74
82
  DetectorId: string | undefined;
75
83
  /**
84
+ * @public
76
85
  * <p>The account ID of the GuardDuty administrator account whose invitation you're
77
86
  * accepting.</p>
78
87
  */
79
88
  MasterId: string | undefined;
80
89
  /**
90
+ * @public
81
91
  * <p>The value that is used to validate the administrator account to the member
82
92
  * account.</p>
83
93
  */
@@ -94,11 +104,13 @@ export interface AcceptInvitationResponse {
94
104
  */
95
105
  export interface AccessControlList {
96
106
  /**
107
+ * @public
97
108
  * <p>A value that indicates whether public read access for the bucket is enabled through an
98
109
  * Access Control List (ACL).</p>
99
110
  */
100
111
  AllowsPublicReadAccess?: boolean;
101
112
  /**
113
+ * @public
102
114
  * <p>A value that indicates whether public write access for the bucket is enabled through an
103
115
  * Access Control List (ACL).</p>
104
116
  */
@@ -112,10 +124,12 @@ export declare class AccessDeniedException extends __BaseException {
112
124
  readonly name: "AccessDeniedException";
113
125
  readonly $fault: "client";
114
126
  /**
127
+ * @public
115
128
  * <p>The error message.</p>
116
129
  */
117
130
  Message?: string;
118
131
  /**
132
+ * @public
119
133
  * <p>The error type.</p>
120
134
  */
121
135
  Type?: string;
@@ -130,18 +144,22 @@ export declare class AccessDeniedException extends __BaseException {
130
144
  */
131
145
  export interface AccessKeyDetails {
132
146
  /**
147
+ * @public
133
148
  * <p>The access key ID of the user.</p>
134
149
  */
135
150
  AccessKeyId?: string;
136
151
  /**
152
+ * @public
137
153
  * <p>The principal ID of the user.</p>
138
154
  */
139
155
  PrincipalId?: string;
140
156
  /**
157
+ * @public
141
158
  * <p>The name of the user.</p>
142
159
  */
143
160
  UserName?: string;
144
161
  /**
162
+ * @public
145
163
  * <p>The type of the user.</p>
146
164
  */
147
165
  UserType?: string;
@@ -152,10 +170,12 @@ export interface AccessKeyDetails {
152
170
  */
153
171
  export interface AccountDetail {
154
172
  /**
173
+ * @public
155
174
  * <p>The member account ID.</p>
156
175
  */
157
176
  AccountId: string | undefined;
158
177
  /**
178
+ * @public
159
179
  * <p>The email address of the member account.</p>
160
180
  */
161
181
  Email: string | undefined;
@@ -167,6 +187,7 @@ export interface AccountDetail {
167
187
  */
168
188
  export interface DataSourceFreeTrial {
169
189
  /**
190
+ * @public
170
191
  * <p>A value that specifies the number of days left to use each enabled data source.</p>
171
192
  */
172
193
  FreeTrialDaysRemaining?: number;
@@ -178,6 +199,7 @@ export interface DataSourceFreeTrial {
178
199
  */
179
200
  export interface KubernetesDataSourceFreeTrial {
180
201
  /**
202
+ * @public
181
203
  * <p>Describes whether Kubernetes audit logs are enabled as a data source.</p>
182
204
  */
183
205
  AuditLogs?: DataSourceFreeTrial;
@@ -188,6 +210,7 @@ export interface KubernetesDataSourceFreeTrial {
188
210
  */
189
211
  export interface MalwareProtectionDataSourceFreeTrial {
190
212
  /**
213
+ * @public
191
214
  * <p>Describes whether Malware Protection for EC2 instances with findings is enabled as a data
192
215
  * source.</p>
193
216
  */
@@ -200,26 +223,32 @@ export interface MalwareProtectionDataSourceFreeTrial {
200
223
  */
201
224
  export interface DataSourcesFreeTrial {
202
225
  /**
226
+ * @public
203
227
  * <p>Describes whether any Amazon Web Services CloudTrail management event logs are enabled as data sources.</p>
204
228
  */
205
229
  CloudTrail?: DataSourceFreeTrial;
206
230
  /**
231
+ * @public
207
232
  * <p>Describes whether any DNS logs are enabled as data sources.</p>
208
233
  */
209
234
  DnsLogs?: DataSourceFreeTrial;
210
235
  /**
236
+ * @public
211
237
  * <p>Describes whether any VPC Flow logs are enabled as data sources.</p>
212
238
  */
213
239
  FlowLogs?: DataSourceFreeTrial;
214
240
  /**
241
+ * @public
215
242
  * <p>Describes whether any S3 data event logs are enabled as data sources.</p>
216
243
  */
217
244
  S3Logs?: DataSourceFreeTrial;
218
245
  /**
246
+ * @public
219
247
  * <p>Describes whether any Kubernetes logs are enabled as data sources.</p>
220
248
  */
221
249
  Kubernetes?: KubernetesDataSourceFreeTrial;
222
250
  /**
251
+ * @public
223
252
  * <p>Describes whether Malware Protection is enabled as a data source.</p>
224
253
  */
225
254
  MalwareProtection?: MalwareProtectionDataSourceFreeTrial;
@@ -249,10 +278,12 @@ export type FreeTrialFeatureResult = (typeof FreeTrialFeatureResult)[keyof typeo
249
278
  */
250
279
  export interface FreeTrialFeatureConfigurationResult {
251
280
  /**
281
+ * @public
252
282
  * <p>The name of the feature for which the free trial is configured.</p>
253
283
  */
254
284
  Name?: FreeTrialFeatureResult | string;
255
285
  /**
286
+ * @public
256
287
  * <p>The number of the remaining free trial days for the feature.</p>
257
288
  */
258
289
  FreeTrialDaysRemaining?: number;
@@ -263,16 +294,19 @@ export interface FreeTrialFeatureConfigurationResult {
263
294
  */
264
295
  export interface AccountFreeTrialInfo {
265
296
  /**
297
+ * @public
266
298
  * <p>The account identifier of the GuardDuty member account.</p>
267
299
  */
268
300
  AccountId?: string;
269
301
  /**
302
+ * @public
270
303
  * @deprecated
271
304
  *
272
305
  * <p>Describes the data source enabled for the GuardDuty member account.</p>
273
306
  */
274
307
  DataSources?: DataSourcesFreeTrial;
275
308
  /**
309
+ * @public
276
310
  * <p>A list of features enabled for the GuardDuty account.</p>
277
311
  */
278
312
  Features?: FreeTrialFeatureConfigurationResult[];
@@ -285,18 +319,22 @@ export interface AccountFreeTrialInfo {
285
319
  */
286
320
  export interface BlockPublicAccess {
287
321
  /**
322
+ * @public
288
323
  * <p>Indicates if S3 Block Public Access is set to <code>IgnorePublicAcls</code>.</p>
289
324
  */
290
325
  IgnorePublicAcls?: boolean;
291
326
  /**
327
+ * @public
292
328
  * <p>Indicates if S3 Block Public Access is set to <code>RestrictPublicBuckets</code>.</p>
293
329
  */
294
330
  RestrictPublicBuckets?: boolean;
295
331
  /**
332
+ * @public
296
333
  * <p>Indicates if S3 Block Public Access is set to <code>BlockPublicAcls</code>.</p>
297
334
  */
298
335
  BlockPublicAcls?: boolean;
299
336
  /**
337
+ * @public
300
338
  * <p>Indicates if S3 Block Public Access is set to <code>BlockPublicPolicy</code>.</p>
301
339
  */
302
340
  BlockPublicPolicy?: boolean;
@@ -307,6 +345,7 @@ export interface BlockPublicAccess {
307
345
  */
308
346
  export interface AccountLevelPermissions {
309
347
  /**
348
+ * @public
310
349
  * <p>Describes the S3 Block Public Access settings of the bucket's parent account.</p>
311
350
  */
312
351
  BlockPublicAccess?: BlockPublicAccess;
@@ -317,6 +356,7 @@ export interface AccountLevelPermissions {
317
356
  */
318
357
  export interface DomainDetails {
319
358
  /**
359
+ * @public
320
360
  * <p>The domain information for the Amazon Web Services API call.</p>
321
361
  */
322
362
  Domain?: string;
@@ -327,10 +367,12 @@ export interface DomainDetails {
327
367
  */
328
368
  export interface RemoteAccountDetails {
329
369
  /**
370
+ * @public
330
371
  * <p>The Amazon Web Services account ID of the remote API caller.</p>
331
372
  */
332
373
  AccountId?: string;
333
374
  /**
375
+ * @public
334
376
  * <p>Details on whether the Amazon Web Services account of the remote API caller is related to your GuardDuty
335
377
  * environment. If this value is <code>True</code> the API caller is affiliated to your account
336
378
  * in some way. If it is <code>False</code> the API caller is from outside your
@@ -344,6 +386,7 @@ export interface RemoteAccountDetails {
344
386
  */
345
387
  export interface City {
346
388
  /**
389
+ * @public
347
390
  * <p>The city name of the remote IP address.</p>
348
391
  */
349
392
  CityName?: string;
@@ -354,10 +397,12 @@ export interface City {
354
397
  */
355
398
  export interface Country {
356
399
  /**
400
+ * @public
357
401
  * <p>The country code of the remote IP address.</p>
358
402
  */
359
403
  CountryCode?: string;
360
404
  /**
405
+ * @public
361
406
  * <p>The country name of the remote IP address.</p>
362
407
  */
363
408
  CountryName?: string;
@@ -368,10 +413,12 @@ export interface Country {
368
413
  */
369
414
  export interface GeoLocation {
370
415
  /**
416
+ * @public
371
417
  * <p>The latitude information of the remote IP address.</p>
372
418
  */
373
419
  Lat?: number;
374
420
  /**
421
+ * @public
375
422
  * <p>The longitude information of the remote IP address.</p>
376
423
  */
377
424
  Lon?: number;
@@ -382,19 +429,23 @@ export interface GeoLocation {
382
429
  */
383
430
  export interface Organization {
384
431
  /**
432
+ * @public
385
433
  * <p>The Autonomous System Number (ASN) of the internet provider of the remote IP
386
434
  * address.</p>
387
435
  */
388
436
  Asn?: string;
389
437
  /**
438
+ * @public
390
439
  * <p>The organization that registered this ASN.</p>
391
440
  */
392
441
  AsnOrg?: string;
393
442
  /**
443
+ * @public
394
444
  * <p>The ISP information for the internet provider.</p>
395
445
  */
396
446
  Isp?: string;
397
447
  /**
448
+ * @public
398
449
  * <p>The name of the internet provider.</p>
399
450
  */
400
451
  Org?: string;
@@ -405,22 +456,27 @@ export interface Organization {
405
456
  */
406
457
  export interface RemoteIpDetails {
407
458
  /**
459
+ * @public
408
460
  * <p>The city information of the remote IP address.</p>
409
461
  */
410
462
  City?: City;
411
463
  /**
464
+ * @public
412
465
  * <p>The country code of the remote IP address.</p>
413
466
  */
414
467
  Country?: Country;
415
468
  /**
469
+ * @public
416
470
  * <p>The location information of the remote IP address.</p>
417
471
  */
418
472
  GeoLocation?: GeoLocation;
419
473
  /**
474
+ * @public
420
475
  * <p>The IPv4 remote address of the connection.</p>
421
476
  */
422
477
  IpAddressV4?: string;
423
478
  /**
479
+ * @public
424
480
  * <p>The ISP organization information of the remote IP address.</p>
425
481
  */
426
482
  Organization?: Organization;
@@ -431,39 +487,48 @@ export interface RemoteIpDetails {
431
487
  */
432
488
  export interface AwsApiCallAction {
433
489
  /**
490
+ * @public
434
491
  * <p>The Amazon Web Services API name.</p>
435
492
  */
436
493
  Api?: string;
437
494
  /**
495
+ * @public
438
496
  * <p>The Amazon Web Services API caller type.</p>
439
497
  */
440
498
  CallerType?: string;
441
499
  /**
500
+ * @public
442
501
  * <p>The domain information for the Amazon Web Services API call.</p>
443
502
  */
444
503
  DomainDetails?: DomainDetails;
445
504
  /**
505
+ * @public
446
506
  * <p>The error code of the failed Amazon Web Services API action.</p>
447
507
  */
448
508
  ErrorCode?: string;
449
509
  /**
510
+ * @public
450
511
  * <p>The agent through which the API request was made.</p>
451
512
  */
452
513
  UserAgent?: string;
453
514
  /**
515
+ * @public
454
516
  * <p>The remote IP information of the connection that initiated the Amazon Web Services API call.</p>
455
517
  */
456
518
  RemoteIpDetails?: RemoteIpDetails;
457
519
  /**
520
+ * @public
458
521
  * <p>The Amazon Web Services service name whose API was invoked.</p>
459
522
  */
460
523
  ServiceName?: string;
461
524
  /**
525
+ * @public
462
526
  * <p>The details of the Amazon Web Services account that made the API call. This field appears if the call
463
527
  * was made from outside your account.</p>
464
528
  */
465
529
  RemoteAccountDetails?: RemoteAccountDetails;
466
530
  /**
531
+ * @public
467
532
  * <p>The details of the Amazon Web Services account that made the API call. This field identifies the
468
533
  * resources that were affected by this API call.</p>
469
534
  */
@@ -475,15 +540,18 @@ export interface AwsApiCallAction {
475
540
  */
476
541
  export interface DnsRequestAction {
477
542
  /**
543
+ * @public
478
544
  * <p>The domain information for the DNS query.</p>
479
545
  */
480
546
  Domain?: string;
481
547
  /**
548
+ * @public
482
549
  * <p>The network connection protocol observed in the activity that prompted GuardDuty to
483
550
  * generate the finding.</p>
484
551
  */
485
552
  Protocol?: string;
486
553
  /**
554
+ * @public
487
555
  * <p>Indicates whether the targeted port is blocked.</p>
488
556
  */
489
557
  Blocked?: boolean;
@@ -494,31 +562,38 @@ export interface DnsRequestAction {
494
562
  */
495
563
  export interface KubernetesApiCallAction {
496
564
  /**
565
+ * @public
497
566
  * <p>The Kubernetes API request URI.</p>
498
567
  */
499
568
  RequestUri?: string;
500
569
  /**
570
+ * @public
501
571
  * <p>The Kubernetes API request HTTP verb.</p>
502
572
  */
503
573
  Verb?: string;
504
574
  /**
575
+ * @public
505
576
  * <p>The IP of the Kubernetes API caller and the IPs of any proxies or load balancers between
506
577
  * the caller and the API endpoint.</p>
507
578
  */
508
579
  SourceIps?: string[];
509
580
  /**
581
+ * @public
510
582
  * <p>The user agent of the caller of the Kubernetes API.</p>
511
583
  */
512
584
  UserAgent?: string;
513
585
  /**
586
+ * @public
514
587
  * <p>Contains information about the remote IP address of the connection.</p>
515
588
  */
516
589
  RemoteIpDetails?: RemoteIpDetails;
517
590
  /**
591
+ * @public
518
592
  * <p>The resulting HTTP response code of the Kubernetes API call action.</p>
519
593
  */
520
594
  StatusCode?: number;
521
595
  /**
596
+ * @public
522
597
  * <p>Parameters related to the Kubernetes API call action.</p>
523
598
  */
524
599
  Parameters?: string;
@@ -529,6 +604,7 @@ export interface KubernetesApiCallAction {
529
604
  */
530
605
  export interface LocalIpDetails {
531
606
  /**
607
+ * @public
532
608
  * <p>The IPv4 local address of the connection.</p>
533
609
  */
534
610
  IpAddressV4?: string;
@@ -539,10 +615,12 @@ export interface LocalIpDetails {
539
615
  */
540
616
  export interface LocalPortDetails {
541
617
  /**
618
+ * @public
542
619
  * <p>The port number of the local connection.</p>
543
620
  */
544
621
  Port?: number;
545
622
  /**
623
+ * @public
546
624
  * <p>The port name of the local connection.</p>
547
625
  */
548
626
  PortName?: string;
@@ -553,10 +631,12 @@ export interface LocalPortDetails {
553
631
  */
554
632
  export interface RemotePortDetails {
555
633
  /**
634
+ * @public
556
635
  * <p>The port number of the remote connection.</p>
557
636
  */
558
637
  Port?: number;
559
638
  /**
639
+ * @public
560
640
  * <p>The port name of the remote connection.</p>
561
641
  */
562
642
  PortName?: string;
@@ -567,30 +647,37 @@ export interface RemotePortDetails {
567
647
  */
568
648
  export interface NetworkConnectionAction {
569
649
  /**
650
+ * @public
570
651
  * <p>Indicates whether EC2 blocked the network connection to your instance.</p>
571
652
  */
572
653
  Blocked?: boolean;
573
654
  /**
655
+ * @public
574
656
  * <p>The network connection direction.</p>
575
657
  */
576
658
  ConnectionDirection?: string;
577
659
  /**
660
+ * @public
578
661
  * <p>The local port information of the connection.</p>
579
662
  */
580
663
  LocalPortDetails?: LocalPortDetails;
581
664
  /**
665
+ * @public
582
666
  * <p>The network connection protocol.</p>
583
667
  */
584
668
  Protocol?: string;
585
669
  /**
670
+ * @public
586
671
  * <p>The local IP information of the connection.</p>
587
672
  */
588
673
  LocalIpDetails?: LocalIpDetails;
589
674
  /**
675
+ * @public
590
676
  * <p>The remote IP information of the connection.</p>
591
677
  */
592
678
  RemoteIpDetails?: RemoteIpDetails;
593
679
  /**
680
+ * @public
594
681
  * <p>The remote port information of the connection.</p>
595
682
  */
596
683
  RemotePortDetails?: RemotePortDetails;
@@ -601,14 +688,17 @@ export interface NetworkConnectionAction {
601
688
  */
602
689
  export interface PortProbeDetail {
603
690
  /**
691
+ * @public
604
692
  * <p>The local port information of the connection.</p>
605
693
  */
606
694
  LocalPortDetails?: LocalPortDetails;
607
695
  /**
696
+ * @public
608
697
  * <p>The local IP information of the connection.</p>
609
698
  */
610
699
  LocalIpDetails?: LocalIpDetails;
611
700
  /**
701
+ * @public
612
702
  * <p>The remote IP information of the connection.</p>
613
703
  */
614
704
  RemoteIpDetails?: RemoteIpDetails;
@@ -619,10 +709,12 @@ export interface PortProbeDetail {
619
709
  */
620
710
  export interface PortProbeAction {
621
711
  /**
712
+ * @public
622
713
  * <p>Indicates whether EC2 blocked the port probe to the instance, such as with an ACL.</p>
623
714
  */
624
715
  Blocked?: boolean;
625
716
  /**
717
+ * @public
626
718
  * <p>A list of objects related to port probe details.</p>
627
719
  */
628
720
  PortProbeDetails?: PortProbeDetail[];
@@ -633,19 +725,23 @@ export interface PortProbeAction {
633
725
  */
634
726
  export interface LoginAttribute {
635
727
  /**
728
+ * @public
636
729
  * <p>Indicates the user name which attempted to log in.</p>
637
730
  */
638
731
  User?: string;
639
732
  /**
733
+ * @public
640
734
  * <p>Indicates the application name used to attempt log in.</p>
641
735
  */
642
736
  Application?: string;
643
737
  /**
738
+ * @public
644
739
  * <p>Represents the sum of failed (unsuccessful) login attempts made to establish a connection
645
740
  * to the database instance.</p>
646
741
  */
647
742
  FailedLoginAttempts?: number;
648
743
  /**
744
+ * @public
649
745
  * <p>Represents the sum of successful connections (a correct combination of login attributes)
650
746
  * made to the database instance by the actor.</p>
651
747
  */
@@ -658,10 +754,12 @@ export interface LoginAttribute {
658
754
  */
659
755
  export interface RdsLoginAttemptAction {
660
756
  /**
757
+ * @public
661
758
  * <p>Contains information about the remote IP address of the connection.</p>
662
759
  */
663
760
  RemoteIpDetails?: RemoteIpDetails;
664
761
  /**
762
+ * @public
665
763
  * <p>Indicates the login attributes used in the login attempt.</p>
666
764
  */
667
765
  LoginAttributes?: LoginAttribute[];
@@ -672,30 +770,37 @@ export interface RdsLoginAttemptAction {
672
770
  */
673
771
  export interface Action {
674
772
  /**
773
+ * @public
675
774
  * <p>The GuardDuty finding activity type.</p>
676
775
  */
677
776
  ActionType?: string;
678
777
  /**
778
+ * @public
679
779
  * <p>Information about the AWS_API_CALL action described in this finding.</p>
680
780
  */
681
781
  AwsApiCallAction?: AwsApiCallAction;
682
782
  /**
783
+ * @public
683
784
  * <p>Information about the DNS_REQUEST action described in this finding.</p>
684
785
  */
685
786
  DnsRequestAction?: DnsRequestAction;
686
787
  /**
788
+ * @public
687
789
  * <p>Information about the NETWORK_CONNECTION action described in this finding.</p>
688
790
  */
689
791
  NetworkConnectionAction?: NetworkConnectionAction;
690
792
  /**
793
+ * @public
691
794
  * <p>Information about the PORT_PROBE action described in this finding.</p>
692
795
  */
693
796
  PortProbeAction?: PortProbeAction;
694
797
  /**
798
+ * @public
695
799
  * <p>Information about the Kubernetes API call action described in this finding.</p>
696
800
  */
697
801
  KubernetesApiCallAction?: KubernetesApiCallAction;
698
802
  /**
803
+ * @public
699
804
  * <p>Information about <code>RDS_LOGIN_ATTEMPT</code> action described in this finding.</p>
700
805
  */
701
806
  RdsLoginAttemptAction?: RdsLoginAttemptAction;
@@ -706,10 +811,12 @@ export interface Action {
706
811
  */
707
812
  export interface AddonDetails {
708
813
  /**
814
+ * @public
709
815
  * <p>Version of the installed EKS add-on.</p>
710
816
  */
711
817
  AddonVersion?: string;
712
818
  /**
819
+ * @public
713
820
  * <p>Status of the installed EKS add-on.</p>
714
821
  */
715
822
  AddonStatus?: string;
@@ -733,10 +840,12 @@ export type AdminStatus = (typeof AdminStatus)[keyof typeof AdminStatus];
733
840
  */
734
841
  export interface AdminAccount {
735
842
  /**
843
+ * @public
736
844
  * <p>The Amazon Web Services account ID for the account.</p>
737
845
  */
738
846
  AdminAccountId?: string;
739
847
  /**
848
+ * @public
740
849
  * <p>Indicates whether the account is enabled as the delegated administrator.</p>
741
850
  */
742
851
  AdminStatus?: AdminStatus | string;
@@ -747,19 +856,23 @@ export interface AdminAccount {
747
856
  */
748
857
  export interface Administrator {
749
858
  /**
859
+ * @public
750
860
  * <p>The ID of the account used as the administrator account.</p>
751
861
  */
752
862
  AccountId?: string;
753
863
  /**
864
+ * @public
754
865
  * <p>The value that is used to validate the administrator account to the member
755
866
  * account.</p>
756
867
  */
757
868
  InvitationId?: string;
758
869
  /**
870
+ * @public
759
871
  * <p>The status of the relationship between the administrator and member accounts.</p>
760
872
  */
761
873
  RelationshipStatus?: string;
762
874
  /**
875
+ * @public
763
876
  * <p>The timestamp when the invitation was sent.</p>
764
877
  */
765
878
  InvitedAt?: string;
@@ -769,11 +882,13 @@ export interface Administrator {
769
882
  */
770
883
  export interface ArchiveFindingsRequest {
771
884
  /**
885
+ * @public
772
886
  * <p>The ID of the detector that specifies the GuardDuty service whose findings you want to
773
887
  * archive.</p>
774
888
  */
775
889
  DetectorId: string | undefined;
776
890
  /**
891
+ * @public
777
892
  * <p>The IDs of the findings that you want to archive.</p>
778
893
  */
779
894
  FindingIds: string[] | undefined;
@@ -802,11 +917,13 @@ export type AutoEnableMembers = (typeof AutoEnableMembers)[keyof typeof AutoEnab
802
917
  */
803
918
  export interface BucketPolicy {
804
919
  /**
920
+ * @public
805
921
  * <p>A value that indicates whether public read access for the bucket is enabled through a
806
922
  * bucket policy.</p>
807
923
  */
808
924
  AllowsPublicReadAccess?: boolean;
809
925
  /**
926
+ * @public
810
927
  * <p>A value that indicates whether public write access for the bucket is enabled through a
811
928
  * bucket policy.</p>
812
929
  */
@@ -818,14 +935,17 @@ export interface BucketPolicy {
818
935
  */
819
936
  export interface BucketLevelPermissions {
820
937
  /**
938
+ * @public
821
939
  * <p>Contains information on how Access Control Policies are applied to the bucket.</p>
822
940
  */
823
941
  AccessControlList?: AccessControlList;
824
942
  /**
943
+ * @public
825
944
  * <p>Contains information on the bucket policies for the S3 bucket.</p>
826
945
  */
827
946
  BucketPolicy?: BucketPolicy;
828
947
  /**
948
+ * @public
829
949
  * <p>Contains information on which account level S3 Block Public Access settings are applied to
830
950
  * the S3 bucket.</p>
831
951
  */
@@ -849,6 +969,7 @@ export type DataSourceStatus = (typeof DataSourceStatus)[keyof typeof DataSource
849
969
  */
850
970
  export interface CloudTrailConfigurationResult {
851
971
  /**
972
+ * @public
852
973
  * <p>Describes whether CloudTrail is enabled as a data source for the detector.</p>
853
974
  */
854
975
  Status: DataSourceStatus | string | undefined;
@@ -859,6 +980,7 @@ export interface CloudTrailConfigurationResult {
859
980
  */
860
981
  export interface Condition {
861
982
  /**
983
+ * @public
862
984
  * @deprecated
863
985
  *
864
986
  * <p>Represents the <i>equal</i> condition to be applied to a single field when
@@ -866,6 +988,7 @@ export interface Condition {
866
988
  */
867
989
  Eq?: string[];
868
990
  /**
991
+ * @public
869
992
  * @deprecated
870
993
  *
871
994
  * <p>Represents the <i>not equal</i> condition to be applied to a single field
@@ -873,6 +996,7 @@ export interface Condition {
873
996
  */
874
997
  Neq?: string[];
875
998
  /**
999
+ * @public
876
1000
  * @deprecated
877
1001
  *
878
1002
  * <p>Represents a <i>greater than</i> condition to be applied to a single field
@@ -880,6 +1004,7 @@ export interface Condition {
880
1004
  */
881
1005
  Gt?: number;
882
1006
  /**
1007
+ * @public
883
1008
  * @deprecated
884
1009
  *
885
1010
  * <p>Represents a <i>greater than or equal</i> condition to be applied to a
@@ -887,6 +1012,7 @@ export interface Condition {
887
1012
  */
888
1013
  Gte?: number;
889
1014
  /**
1015
+ * @public
890
1016
  * @deprecated
891
1017
  *
892
1018
  * <p>Represents a <i>less than</i> condition to be applied to a single field when
@@ -894,6 +1020,7 @@ export interface Condition {
894
1020
  */
895
1021
  Lt?: number;
896
1022
  /**
1023
+ * @public
897
1024
  * @deprecated
898
1025
  *
899
1026
  * <p>Represents a <i>less than or equal</i> condition to be applied to a single
@@ -901,33 +1028,39 @@ export interface Condition {
901
1028
  */
902
1029
  Lte?: number;
903
1030
  /**
1031
+ * @public
904
1032
  * <p>Represents an <i>equal</i>
905
1033
  * <b></b> condition to be applied to
906
1034
  * a single field when querying for findings.</p>
907
1035
  */
908
1036
  Equals?: string[];
909
1037
  /**
1038
+ * @public
910
1039
  * <p>Represents a <i>not equal</i>
911
1040
  * <b></b> condition to be applied
912
1041
  * to a single field when querying for findings.</p>
913
1042
  */
914
1043
  NotEquals?: string[];
915
1044
  /**
1045
+ * @public
916
1046
  * <p>Represents a <i>greater than</i> condition to be applied to a single field
917
1047
  * when querying for findings.</p>
918
1048
  */
919
1049
  GreaterThan?: number;
920
1050
  /**
1051
+ * @public
921
1052
  * <p>Represents a <i>greater than or equal</i> condition to be applied to a
922
1053
  * single field when querying for findings.</p>
923
1054
  */
924
1055
  GreaterThanOrEqual?: number;
925
1056
  /**
1057
+ * @public
926
1058
  * <p>Represents a <i>less than</i> condition to be applied to a single field when
927
1059
  * querying for findings.</p>
928
1060
  */
929
1061
  LessThan?: number;
930
1062
  /**
1063
+ * @public
931
1064
  * <p>Represents a <i>less than or equal</i> condition to be applied to a single
932
1065
  * field when querying for findings.</p>
933
1066
  */
@@ -941,10 +1074,12 @@ export declare class ConflictException extends __BaseException {
941
1074
  readonly name: "ConflictException";
942
1075
  readonly $fault: "client";
943
1076
  /**
1077
+ * @public
944
1078
  * <p>The error message.</p>
945
1079
  */
946
1080
  Message?: string;
947
1081
  /**
1082
+ * @public
948
1083
  * <p>The error type.</p>
949
1084
  */
950
1085
  Type?: string;
@@ -959,6 +1094,7 @@ export declare class ConflictException extends __BaseException {
959
1094
  */
960
1095
  export interface SecurityContext {
961
1096
  /**
1097
+ * @public
962
1098
  * <p>Whether the container is privileged.</p>
963
1099
  */
964
1100
  Privileged?: boolean;
@@ -969,10 +1105,12 @@ export interface SecurityContext {
969
1105
  */
970
1106
  export interface VolumeMount {
971
1107
  /**
1108
+ * @public
972
1109
  * <p>Volume mount name.</p>
973
1110
  */
974
1111
  Name?: string;
975
1112
  /**
1113
+ * @public
976
1114
  * <p>Volume mount path.</p>
977
1115
  */
978
1116
  MountPath?: string;
@@ -983,32 +1121,39 @@ export interface VolumeMount {
983
1121
  */
984
1122
  export interface Container {
985
1123
  /**
1124
+ * @public
986
1125
  * <p>The container runtime (such as, Docker or containerd) used to run the container.</p>
987
1126
  */
988
1127
  ContainerRuntime?: string;
989
1128
  /**
1129
+ * @public
990
1130
  * <p>Container ID.</p>
991
1131
  */
992
1132
  Id?: string;
993
1133
  /**
1134
+ * @public
994
1135
  * <p>Container name.</p>
995
1136
  */
996
1137
  Name?: string;
997
1138
  /**
1139
+ * @public
998
1140
  * <p>Container image.</p>
999
1141
  */
1000
1142
  Image?: string;
1001
1143
  /**
1144
+ * @public
1002
1145
  * <p>Part of the image name before the last slash. For example, imagePrefix for
1003
1146
  * public.ecr.aws/amazonlinux/amazonlinux:latest would be public.ecr.aws/amazonlinux. If the
1004
1147
  * image name is relative and does not have a slash, this field is empty.</p>
1005
1148
  */
1006
1149
  ImagePrefix?: string;
1007
1150
  /**
1151
+ * @public
1008
1152
  * <p>Container volume mounts.</p>
1009
1153
  */
1010
1154
  VolumeMounts?: VolumeMount[];
1011
1155
  /**
1156
+ * @public
1012
1157
  * <p>Container security context.</p>
1013
1158
  */
1014
1159
  SecurityContext?: SecurityContext;
@@ -1042,19 +1187,23 @@ export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
1042
1187
  */
1043
1188
  export interface CoverageEksClusterDetails {
1044
1189
  /**
1190
+ * @public
1045
1191
  * <p>Name of the EKS cluster.</p>
1046
1192
  */
1047
1193
  ClusterName?: string;
1048
1194
  /**
1195
+ * @public
1049
1196
  * <p>Represents the nodes within the EKS cluster that have a <code>HEALTHY</code> coverage
1050
1197
  * status.</p>
1051
1198
  */
1052
1199
  CoveredNodes?: number;
1053
1200
  /**
1201
+ * @public
1054
1202
  * <p>Represents all the nodes within the EKS cluster in your account.</p>
1055
1203
  */
1056
1204
  CompatibleNodes?: number;
1057
1205
  /**
1206
+ * @public
1058
1207
  * <p>Information about the installed EKS add-on.</p>
1059
1208
  */
1060
1209
  AddonDetails?: AddonDetails;
@@ -1066,11 +1215,13 @@ export interface CoverageEksClusterDetails {
1066
1215
  */
1067
1216
  export interface CoverageFilterCondition {
1068
1217
  /**
1218
+ * @public
1069
1219
  * <p>Represents an equal condition that is applied to a single field while retrieving the
1070
1220
  * coverage details.</p>
1071
1221
  */
1072
1222
  Equals?: string[];
1073
1223
  /**
1224
+ * @public
1074
1225
  * <p>Represents a not equal condition that is applied to a single field while retrieving the
1075
1226
  * coverage details.</p>
1076
1227
  */
@@ -1098,10 +1249,12 @@ export type CoverageFilterCriterionKey = (typeof CoverageFilterCriterionKey)[key
1098
1249
  */
1099
1250
  export interface CoverageFilterCriterion {
1100
1251
  /**
1252
+ * @public
1101
1253
  * <p>An enum value representing possible filter fields.</p>
1102
1254
  */
1103
1255
  CriterionKey?: CoverageFilterCriterionKey | string;
1104
1256
  /**
1257
+ * @public
1105
1258
  * <p>Contains information about the condition.</p>
1106
1259
  */
1107
1260
  FilterCondition?: CoverageFilterCondition;
@@ -1112,6 +1265,7 @@ export interface CoverageFilterCriterion {
1112
1265
  */
1113
1266
  export interface CoverageFilterCriteria {
1114
1267
  /**
1268
+ * @public
1115
1269
  * <p>Represents a condition that when matched will be added to the response of the
1116
1270
  * operation.</p>
1117
1271
  */
@@ -1123,10 +1277,12 @@ export interface CoverageFilterCriteria {
1123
1277
  */
1124
1278
  export interface CoverageResourceDetails {
1125
1279
  /**
1280
+ * @public
1126
1281
  * <p>EKS cluster details involved in the coverage statistics.</p>
1127
1282
  */
1128
1283
  EksClusterDetails?: CoverageEksClusterDetails;
1129
1284
  /**
1285
+ * @public
1130
1286
  * <p>The type of Amazon Web Services resource.</p>
1131
1287
  */
1132
1288
  ResourceType?: ResourceType | string;
@@ -1137,31 +1293,38 @@ export interface CoverageResourceDetails {
1137
1293
  */
1138
1294
  export interface CoverageResource {
1139
1295
  /**
1296
+ * @public
1140
1297
  * <p>The unique ID of the resource.</p>
1141
1298
  */
1142
1299
  ResourceId?: string;
1143
1300
  /**
1301
+ * @public
1144
1302
  * <p>The unique ID of the GuardDuty detector associated with the resource.</p>
1145
1303
  */
1146
1304
  DetectorId?: string;
1147
1305
  /**
1306
+ * @public
1148
1307
  * <p>The unique ID of the Amazon Web Services account.</p>
1149
1308
  */
1150
1309
  AccountId?: string;
1151
1310
  /**
1311
+ * @public
1152
1312
  * <p>Information about the resource for which the coverage statistics are retrieved.</p>
1153
1313
  */
1154
1314
  ResourceDetails?: CoverageResourceDetails;
1155
1315
  /**
1316
+ * @public
1156
1317
  * <p>Represents the status of the EKS cluster coverage.</p>
1157
1318
  */
1158
1319
  CoverageStatus?: CoverageStatus | string;
1159
1320
  /**
1321
+ * @public
1160
1322
  * <p>Represents the reason why a coverage status was <code>UNHEALTHY</code> for the EKS
1161
1323
  * cluster.</p>
1162
1324
  */
1163
1325
  Issue?: string;
1164
1326
  /**
1327
+ * @public
1165
1328
  * <p>The timestamp at which the coverage details for the resource were last updated. This is in
1166
1329
  * UTC format.</p>
1167
1330
  */
@@ -1201,10 +1364,12 @@ export type OrderBy = (typeof OrderBy)[keyof typeof OrderBy];
1201
1364
  */
1202
1365
  export interface CoverageSortCriteria {
1203
1366
  /**
1367
+ * @public
1204
1368
  * <p>Represents the field name used to sort the coverage details.</p>
1205
1369
  */
1206
1370
  AttributeName?: CoverageSortKey | string;
1207
1371
  /**
1372
+ * @public
1208
1373
  * <p>The order in which the sorted findings are to be displayed.</p>
1209
1374
  */
1210
1375
  OrderBy?: OrderBy | string;
@@ -1215,10 +1380,12 @@ export interface CoverageSortCriteria {
1215
1380
  */
1216
1381
  export interface CoverageStatistics {
1217
1382
  /**
1383
+ * @public
1218
1384
  * <p>Represents coverage statistics for EKS clusters aggregated by resource type.</p>
1219
1385
  */
1220
1386
  CountByResourceType?: Record<string, number>;
1221
1387
  /**
1388
+ * @public
1222
1389
  * <p>Represents coverage statistics for EKS clusters aggregated by coverage status.</p>
1223
1390
  */
1224
1391
  CountByCoverageStatus?: Record<string, number>;
@@ -1241,6 +1408,7 @@ export type CoverageStatisticsType = (typeof CoverageStatisticsType)[keyof typeo
1241
1408
  */
1242
1409
  export interface KubernetesAuditLogsConfiguration {
1243
1410
  /**
1411
+ * @public
1244
1412
  * <p>The status of Kubernetes audit logs as a data source.</p>
1245
1413
  */
1246
1414
  Enable: boolean | undefined;
@@ -1251,6 +1419,7 @@ export interface KubernetesAuditLogsConfiguration {
1251
1419
  */
1252
1420
  export interface KubernetesConfiguration {
1253
1421
  /**
1422
+ * @public
1254
1423
  * <p>The status of Kubernetes audit logs as a data source.</p>
1255
1424
  */
1256
1425
  AuditLogs: KubernetesAuditLogsConfiguration | undefined;
@@ -1262,6 +1431,7 @@ export interface KubernetesConfiguration {
1262
1431
  */
1263
1432
  export interface ScanEc2InstanceWithFindings {
1264
1433
  /**
1434
+ * @public
1265
1435
  * <p>Describes the configuration for scanning EBS volumes as data source.</p>
1266
1436
  */
1267
1437
  EbsVolumes?: boolean;
@@ -1272,6 +1442,7 @@ export interface ScanEc2InstanceWithFindings {
1272
1442
  */
1273
1443
  export interface MalwareProtectionConfiguration {
1274
1444
  /**
1445
+ * @public
1275
1446
  * <p>Describes the configuration of Malware Protection for EC2 instances with findings.</p>
1276
1447
  */
1277
1448
  ScanEc2InstanceWithFindings?: ScanEc2InstanceWithFindings;
@@ -1282,6 +1453,7 @@ export interface MalwareProtectionConfiguration {
1282
1453
  */
1283
1454
  export interface S3LogsConfiguration {
1284
1455
  /**
1456
+ * @public
1285
1457
  * <p> The status of S3 data event logs as a data source.</p>
1286
1458
  */
1287
1459
  Enable: boolean | undefined;
@@ -1292,14 +1464,17 @@ export interface S3LogsConfiguration {
1292
1464
  */
1293
1465
  export interface DataSourceConfigurations {
1294
1466
  /**
1467
+ * @public
1295
1468
  * <p>Describes whether S3 data event logs are enabled as a data source.</p>
1296
1469
  */
1297
1470
  S3Logs?: S3LogsConfiguration;
1298
1471
  /**
1472
+ * @public
1299
1473
  * <p>Describes whether any Kubernetes logs are enabled as data sources.</p>
1300
1474
  */
1301
1475
  Kubernetes?: KubernetesConfiguration;
1302
1476
  /**
1477
+ * @public
1303
1478
  * <p>Describes whether Malware Protection is enabled as a data source.</p>
1304
1479
  */
1305
1480
  MalwareProtection?: MalwareProtectionConfiguration;
@@ -1333,10 +1508,12 @@ export type FeatureStatus = (typeof FeatureStatus)[keyof typeof FeatureStatus];
1333
1508
  */
1334
1509
  export interface DetectorAdditionalConfiguration {
1335
1510
  /**
1511
+ * @public
1336
1512
  * <p>Name of the additional configuration.</p>
1337
1513
  */
1338
1514
  Name?: FeatureAdditionalConfiguration | string;
1339
1515
  /**
1516
+ * @public
1340
1517
  * <p>Status of the additional configuration.</p>
1341
1518
  */
1342
1519
  Status?: FeatureStatus | string;
@@ -1363,14 +1540,17 @@ export type DetectorFeature = (typeof DetectorFeature)[keyof typeof DetectorFeat
1363
1540
  */
1364
1541
  export interface DetectorFeatureConfiguration {
1365
1542
  /**
1543
+ * @public
1366
1544
  * <p>The name of the feature.</p>
1367
1545
  */
1368
1546
  Name?: DetectorFeature | string;
1369
1547
  /**
1548
+ * @public
1370
1549
  * <p>The status of the feature.</p>
1371
1550
  */
1372
1551
  Status?: FeatureStatus | string;
1373
1552
  /**
1553
+ * @public
1374
1554
  * <p>Additional configuration for a resource.</p>
1375
1555
  */
1376
1556
  AdditionalConfiguration?: DetectorAdditionalConfiguration[];
@@ -1393,18 +1573,22 @@ export type FindingPublishingFrequency = (typeof FindingPublishingFrequency)[key
1393
1573
  */
1394
1574
  export interface CreateDetectorRequest {
1395
1575
  /**
1576
+ * @public
1396
1577
  * <p>A Boolean value that specifies whether the detector is to be enabled.</p>
1397
1578
  */
1398
1579
  Enable: boolean | undefined;
1399
1580
  /**
1581
+ * @public
1400
1582
  * <p>The idempotency token for the create request.</p>
1401
1583
  */
1402
1584
  ClientToken?: string;
1403
1585
  /**
1586
+ * @public
1404
1587
  * <p>A value that specifies how frequently updated findings are exported.</p>
1405
1588
  */
1406
1589
  FindingPublishingFrequency?: FindingPublishingFrequency | string;
1407
1590
  /**
1591
+ * @public
1408
1592
  * @deprecated
1409
1593
  *
1410
1594
  * <p>Describes which data sources will be enabled for the detector.</p>
@@ -1414,10 +1598,12 @@ export interface CreateDetectorRequest {
1414
1598
  */
1415
1599
  DataSources?: DataSourceConfigurations;
1416
1600
  /**
1601
+ * @public
1417
1602
  * <p>The tags to be added to a new detector resource.</p>
1418
1603
  */
1419
1604
  Tags?: Record<string, string>;
1420
1605
  /**
1606
+ * @public
1421
1607
  * <p>A list of features that will be configured for the detector.</p>
1422
1608
  */
1423
1609
  Features?: DetectorFeatureConfiguration[];
@@ -1428,10 +1614,12 @@ export interface CreateDetectorRequest {
1428
1614
  */
1429
1615
  export interface EbsVolumesResult {
1430
1616
  /**
1617
+ * @public
1431
1618
  * <p>Describes whether scanning EBS volumes is enabled as a data source.</p>
1432
1619
  */
1433
1620
  Status?: DataSourceStatus | string;
1434
1621
  /**
1622
+ * @public
1435
1623
  * <p>Specifies the reason why scanning EBS volumes (Malware Protection) was not enabled as a
1436
1624
  * data source.</p>
1437
1625
  */
@@ -1444,6 +1632,7 @@ export interface EbsVolumesResult {
1444
1632
  */
1445
1633
  export interface ScanEc2InstanceWithFindingsResult {
1446
1634
  /**
1635
+ * @public
1447
1636
  * <p>Describes the configuration of scanning EBS volumes as a data source.</p>
1448
1637
  */
1449
1638
  EbsVolumes?: EbsVolumesResult;
@@ -1455,10 +1644,12 @@ export interface ScanEc2InstanceWithFindingsResult {
1455
1644
  */
1456
1645
  export interface MalwareProtectionConfigurationResult {
1457
1646
  /**
1647
+ * @public
1458
1648
  * <p>Describes the configuration of Malware Protection for EC2 instances with findings.</p>
1459
1649
  */
1460
1650
  ScanEc2InstanceWithFindings?: ScanEc2InstanceWithFindingsResult;
1461
1651
  /**
1652
+ * @public
1462
1653
  * <p>The GuardDuty Malware Protection service role.</p>
1463
1654
  */
1464
1655
  ServiceRole?: string;
@@ -1469,6 +1660,7 @@ export interface MalwareProtectionConfigurationResult {
1469
1660
  */
1470
1661
  export interface UnprocessedDataSourcesResult {
1471
1662
  /**
1663
+ * @public
1472
1664
  * <p>An object that contains information on the status of all Malware Protection data
1473
1665
  * sources.</p>
1474
1666
  */
@@ -1479,10 +1671,12 @@ export interface UnprocessedDataSourcesResult {
1479
1671
  */
1480
1672
  export interface CreateDetectorResponse {
1481
1673
  /**
1674
+ * @public
1482
1675
  * <p>The unique ID of the created detector.</p>
1483
1676
  */
1484
1677
  DetectorId?: string;
1485
1678
  /**
1679
+ * @public
1486
1680
  * <p>Specifies the data sources that couldn't be enabled when GuardDuty was enabled for the
1487
1681
  * first time.</p>
1488
1682
  */
@@ -1506,6 +1700,7 @@ export type FilterAction = (typeof FilterAction)[keyof typeof FilterAction];
1506
1700
  */
1507
1701
  export interface FindingCriteria {
1508
1702
  /**
1703
+ * @public
1509
1704
  * <p>Represents a map of finding properties that match specified conditions and values when
1510
1705
  * querying findings.</p>
1511
1706
  */
@@ -1516,16 +1711,19 @@ export interface FindingCriteria {
1516
1711
  */
1517
1712
  export interface CreateFilterRequest {
1518
1713
  /**
1714
+ * @public
1519
1715
  * <p>The ID of the detector belonging to the GuardDuty account that you want to create a filter
1520
1716
  * for.</p>
1521
1717
  */
1522
1718
  DetectorId: string | undefined;
1523
1719
  /**
1720
+ * @public
1524
1721
  * <p>The name of the filter. Valid characters include period (.), underscore (_), dash (-), and
1525
1722
  * alphanumeric characters. A whitespace is considered to be an invalid character.</p>
1526
1723
  */
1527
1724
  Name: string | undefined;
1528
1725
  /**
1726
+ * @public
1529
1727
  * <p>The description of the filter. Valid characters include alphanumeric characters, and
1530
1728
  * special characters such as hyphen, period, colon, underscore, parentheses (<code>\{ \}</code>,
1531
1729
  * <code>[ ]</code>, and <code>( )</code>), forward slash, horizontal tab, vertical tab,
@@ -1533,15 +1731,18 @@ export interface CreateFilterRequest {
1533
1731
  */
1534
1732
  Description?: string;
1535
1733
  /**
1734
+ * @public
1536
1735
  * <p>Specifies the action that is to be applied to the findings that match the filter.</p>
1537
1736
  */
1538
1737
  Action?: FilterAction | string;
1539
1738
  /**
1739
+ * @public
1540
1740
  * <p>Specifies the position of the filter in the list of current filters. Also specifies the
1541
1741
  * order in which this filter is applied to the findings.</p>
1542
1742
  */
1543
1743
  Rank?: number;
1544
1744
  /**
1745
+ * @public
1545
1746
  * <p>Represents the criteria to be used in the filter for querying findings.</p>
1546
1747
  * <p>You can only use the following attributes to query findings:</p>
1547
1748
  * <ul>
@@ -1716,10 +1917,12 @@ export interface CreateFilterRequest {
1716
1917
  */
1717
1918
  FindingCriteria: FindingCriteria | undefined;
1718
1919
  /**
1920
+ * @public
1719
1921
  * <p>The idempotency token for the create request.</p>
1720
1922
  */
1721
1923
  ClientToken?: string;
1722
1924
  /**
1925
+ * @public
1723
1926
  * <p>The tags to be added to a new filter resource.</p>
1724
1927
  */
1725
1928
  Tags?: Record<string, string>;
@@ -1729,6 +1932,7 @@ export interface CreateFilterRequest {
1729
1932
  */
1730
1933
  export interface CreateFilterResponse {
1731
1934
  /**
1935
+ * @public
1732
1936
  * <p>The name of the successfully created filter.</p>
1733
1937
  */
1734
1938
  Name: string | undefined;
@@ -1754,33 +1958,40 @@ export type IpSetFormat = (typeof IpSetFormat)[keyof typeof IpSetFormat];
1754
1958
  */
1755
1959
  export interface CreateIPSetRequest {
1756
1960
  /**
1961
+ * @public
1757
1962
  * <p>The unique ID of the detector of the GuardDuty account that you want to create an IPSet
1758
1963
  * for.</p>
1759
1964
  */
1760
1965
  DetectorId: string | undefined;
1761
1966
  /**
1967
+ * @public
1762
1968
  * <p>The user-friendly name to identify the IPSet.</p>
1763
1969
  * <p> Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).</p>
1764
1970
  */
1765
1971
  Name: string | undefined;
1766
1972
  /**
1973
+ * @public
1767
1974
  * <p>The format of the file that contains the IPSet.</p>
1768
1975
  */
1769
1976
  Format: IpSetFormat | string | undefined;
1770
1977
  /**
1978
+ * @public
1771
1979
  * <p>The URI of the file that contains the IPSet. </p>
1772
1980
  */
1773
1981
  Location: string | undefined;
1774
1982
  /**
1983
+ * @public
1775
1984
  * <p>A Boolean value that indicates whether GuardDuty is to start using the uploaded
1776
1985
  * IPSet.</p>
1777
1986
  */
1778
1987
  Activate: boolean | undefined;
1779
1988
  /**
1989
+ * @public
1780
1990
  * <p>The idempotency token for the create request.</p>
1781
1991
  */
1782
1992
  ClientToken?: string;
1783
1993
  /**
1994
+ * @public
1784
1995
  * <p>The tags to be added to a new IP set resource.</p>
1785
1996
  */
1786
1997
  Tags?: Record<string, string>;
@@ -1790,6 +2001,7 @@ export interface CreateIPSetRequest {
1790
2001
  */
1791
2002
  export interface CreateIPSetResponse {
1792
2003
  /**
2004
+ * @public
1793
2005
  * <p>The ID of the IPSet resource.</p>
1794
2006
  */
1795
2007
  IpSetId: string | undefined;
@@ -1799,11 +2011,13 @@ export interface CreateIPSetResponse {
1799
2011
  */
1800
2012
  export interface CreateMembersRequest {
1801
2013
  /**
2014
+ * @public
1802
2015
  * <p>The unique ID of the detector of the GuardDuty account that you want to associate member
1803
2016
  * accounts with.</p>
1804
2017
  */
1805
2018
  DetectorId: string | undefined;
1806
2019
  /**
2020
+ * @public
1807
2021
  * <p>A list of account ID and email address pairs of the accounts that you want to associate
1808
2022
  * with the GuardDuty administrator account.</p>
1809
2023
  */
@@ -1815,10 +2029,12 @@ export interface CreateMembersRequest {
1815
2029
  */
1816
2030
  export interface UnprocessedAccount {
1817
2031
  /**
2032
+ * @public
1818
2033
  * <p>The Amazon Web Services account ID.</p>
1819
2034
  */
1820
2035
  AccountId: string | undefined;
1821
2036
  /**
2037
+ * @public
1822
2038
  * <p>A reason why the account hasn't been processed.</p>
1823
2039
  */
1824
2040
  Result: string | undefined;
@@ -1828,6 +2044,7 @@ export interface UnprocessedAccount {
1828
2044
  */
1829
2045
  export interface CreateMembersResponse {
1830
2046
  /**
2047
+ * @public
1831
2048
  * <p>A list of objects that include the <code>accountIds</code> of the unprocessed accounts and
1832
2049
  * a result string that explains why each was unprocessed.</p>
1833
2050
  */
@@ -1840,6 +2057,7 @@ export interface CreateMembersResponse {
1840
2057
  */
1841
2058
  export interface DestinationProperties {
1842
2059
  /**
2060
+ * @public
1843
2061
  * <p>The ARN of the resource to publish to.</p>
1844
2062
  * <p>To specify an S3 bucket folder use the following format:
1845
2063
  * <code>arn:aws:s3:::DOC-EXAMPLE-BUCKET/myFolder/</code>
@@ -1847,6 +2065,7 @@ export interface DestinationProperties {
1847
2065
  */
1848
2066
  DestinationArn?: string;
1849
2067
  /**
2068
+ * @public
1850
2069
  * <p>The ARN of the KMS key to use for encryption.</p>
1851
2070
  */
1852
2071
  KmsKeyArn?: string;
@@ -1867,20 +2086,24 @@ export type DestinationType = (typeof DestinationType)[keyof typeof DestinationT
1867
2086
  */
1868
2087
  export interface CreatePublishingDestinationRequest {
1869
2088
  /**
2089
+ * @public
1870
2090
  * <p>The ID of the GuardDuty detector associated with the publishing destination.</p>
1871
2091
  */
1872
2092
  DetectorId: string | undefined;
1873
2093
  /**
2094
+ * @public
1874
2095
  * <p>The type of resource for the publishing destination. Currently only Amazon S3 buckets are
1875
2096
  * supported.</p>
1876
2097
  */
1877
2098
  DestinationType: DestinationType | string | undefined;
1878
2099
  /**
2100
+ * @public
1879
2101
  * <p>The properties of the publishing destination, including the ARNs for the destination and
1880
2102
  * the KMS key used for encryption.</p>
1881
2103
  */
1882
2104
  DestinationProperties: DestinationProperties | undefined;
1883
2105
  /**
2106
+ * @public
1884
2107
  * <p>The idempotency token for the request.</p>
1885
2108
  */
1886
2109
  ClientToken?: string;
@@ -1890,6 +2113,7 @@ export interface CreatePublishingDestinationRequest {
1890
2113
  */
1891
2114
  export interface CreatePublishingDestinationResponse {
1892
2115
  /**
2116
+ * @public
1893
2117
  * <p>The ID of the publishing destination that is created.</p>
1894
2118
  */
1895
2119
  DestinationId: string | undefined;
@@ -1899,10 +2123,12 @@ export interface CreatePublishingDestinationResponse {
1899
2123
  */
1900
2124
  export interface CreateSampleFindingsRequest {
1901
2125
  /**
2126
+ * @public
1902
2127
  * <p>The ID of the detector to create sample findings for.</p>
1903
2128
  */
1904
2129
  DetectorId: string | undefined;
1905
2130
  /**
2131
+ * @public
1906
2132
  * <p>The types of sample findings to generate.</p>
1907
2133
  */
1908
2134
  FindingTypes?: string[];
@@ -1933,33 +2159,40 @@ export type ThreatIntelSetFormat = (typeof ThreatIntelSetFormat)[keyof typeof Th
1933
2159
  */
1934
2160
  export interface CreateThreatIntelSetRequest {
1935
2161
  /**
2162
+ * @public
1936
2163
  * <p>The unique ID of the detector of the GuardDuty account that you want to create a
1937
2164
  * threatIntelSet for.</p>
1938
2165
  */
1939
2166
  DetectorId: string | undefined;
1940
2167
  /**
2168
+ * @public
1941
2169
  * <p>A user-friendly ThreatIntelSet name displayed in all findings that are generated by
1942
2170
  * activity that involves IP addresses included in this ThreatIntelSet.</p>
1943
2171
  */
1944
2172
  Name: string | undefined;
1945
2173
  /**
2174
+ * @public
1946
2175
  * <p>The format of the file that contains the ThreatIntelSet.</p>
1947
2176
  */
1948
2177
  Format: ThreatIntelSetFormat | string | undefined;
1949
2178
  /**
2179
+ * @public
1950
2180
  * <p>The URI of the file that contains the ThreatIntelSet. </p>
1951
2181
  */
1952
2182
  Location: string | undefined;
1953
2183
  /**
2184
+ * @public
1954
2185
  * <p>A Boolean value that indicates whether GuardDuty is to start using the uploaded
1955
2186
  * ThreatIntelSet.</p>
1956
2187
  */
1957
2188
  Activate: boolean | undefined;
1958
2189
  /**
2190
+ * @public
1959
2191
  * <p>The idempotency token for the create request.</p>
1960
2192
  */
1961
2193
  ClientToken?: string;
1962
2194
  /**
2195
+ * @public
1963
2196
  * <p>The tags to be added to a new threat list resource.</p>
1964
2197
  */
1965
2198
  Tags?: Record<string, string>;
@@ -1969,6 +2202,7 @@ export interface CreateThreatIntelSetRequest {
1969
2202
  */
1970
2203
  export interface CreateThreatIntelSetResponse {
1971
2204
  /**
2205
+ * @public
1972
2206
  * <p>The ID of the ThreatIntelSet resource.</p>
1973
2207
  */
1974
2208
  ThreatIntelSetId: string | undefined;
@@ -2012,6 +2246,7 @@ export type DataSource = (typeof DataSource)[keyof typeof DataSource];
2012
2246
  */
2013
2247
  export interface DNSLogsConfigurationResult {
2014
2248
  /**
2249
+ * @public
2015
2250
  * <p>Denotes whether DNS logs is enabled as a data source.</p>
2016
2251
  */
2017
2252
  Status: DataSourceStatus | string | undefined;
@@ -2022,6 +2257,7 @@ export interface DNSLogsConfigurationResult {
2022
2257
  */
2023
2258
  export interface FlowLogsConfigurationResult {
2024
2259
  /**
2260
+ * @public
2025
2261
  * <p>Denotes whether VPC flow logs is enabled as a data source.</p>
2026
2262
  */
2027
2263
  Status: DataSourceStatus | string | undefined;
@@ -2032,6 +2268,7 @@ export interface FlowLogsConfigurationResult {
2032
2268
  */
2033
2269
  export interface KubernetesAuditLogsConfigurationResult {
2034
2270
  /**
2271
+ * @public
2035
2272
  * <p>A value that describes whether Kubernetes audit logs are enabled as a data source.</p>
2036
2273
  */
2037
2274
  Status: DataSourceStatus | string | undefined;
@@ -2042,6 +2279,7 @@ export interface KubernetesAuditLogsConfigurationResult {
2042
2279
  */
2043
2280
  export interface KubernetesConfigurationResult {
2044
2281
  /**
2282
+ * @public
2045
2283
  * <p>Describes whether Kubernetes audit logs are enabled as a data source.</p>
2046
2284
  */
2047
2285
  AuditLogs: KubernetesAuditLogsConfigurationResult | undefined;
@@ -2052,6 +2290,7 @@ export interface KubernetesConfigurationResult {
2052
2290
  */
2053
2291
  export interface S3LogsConfigurationResult {
2054
2292
  /**
2293
+ * @public
2055
2294
  * <p>A value that describes whether S3 data event logs are automatically enabled for new
2056
2295
  * members of the organization.</p>
2057
2296
  */
@@ -2063,28 +2302,34 @@ export interface S3LogsConfigurationResult {
2063
2302
  */
2064
2303
  export interface DataSourceConfigurationsResult {
2065
2304
  /**
2305
+ * @public
2066
2306
  * <p>An object that contains information on the status of CloudTrail as a data source.</p>
2067
2307
  */
2068
2308
  CloudTrail: CloudTrailConfigurationResult | undefined;
2069
2309
  /**
2310
+ * @public
2070
2311
  * <p>An object that contains information on the status of DNS logs as a data source.</p>
2071
2312
  */
2072
2313
  DNSLogs: DNSLogsConfigurationResult | undefined;
2073
2314
  /**
2315
+ * @public
2074
2316
  * <p>An object that contains information on the status of VPC flow logs as a data
2075
2317
  * source.</p>
2076
2318
  */
2077
2319
  FlowLogs: FlowLogsConfigurationResult | undefined;
2078
2320
  /**
2321
+ * @public
2079
2322
  * <p>An object that contains information on the status of S3 Data event logs as a data
2080
2323
  * source.</p>
2081
2324
  */
2082
2325
  S3Logs: S3LogsConfigurationResult | undefined;
2083
2326
  /**
2327
+ * @public
2084
2328
  * <p>An object that contains information on the status of all Kubernetes data sources.</p>
2085
2329
  */
2086
2330
  Kubernetes?: KubernetesConfigurationResult;
2087
2331
  /**
2332
+ * @public
2088
2333
  * <p>Describes the configuration of Malware Protection data sources.</p>
2089
2334
  */
2090
2335
  MalwareProtection?: MalwareProtectionConfigurationResult;
@@ -2094,6 +2339,7 @@ export interface DataSourceConfigurationsResult {
2094
2339
  */
2095
2340
  export interface DeclineInvitationsRequest {
2096
2341
  /**
2342
+ * @public
2097
2343
  * <p>A list of account IDs of the Amazon Web Services accounts that sent invitations to the current member
2098
2344
  * account that you want to decline invitations from.</p>
2099
2345
  */
@@ -2104,6 +2350,7 @@ export interface DeclineInvitationsRequest {
2104
2350
  */
2105
2351
  export interface DeclineInvitationsResponse {
2106
2352
  /**
2353
+ * @public
2107
2354
  * <p>A list of objects that contain the unprocessed account and a result string that explains
2108
2355
  * why it was unprocessed.</p>
2109
2356
  */
@@ -2117,10 +2364,12 @@ export interface DeclineInvitationsResponse {
2117
2364
  */
2118
2365
  export interface DefaultServerSideEncryption {
2119
2366
  /**
2367
+ * @public
2120
2368
  * <p>The type of encryption used for objects within the S3 bucket.</p>
2121
2369
  */
2122
2370
  EncryptionType?: string;
2123
2371
  /**
2372
+ * @public
2124
2373
  * <p>The Amazon Resource Name (ARN) of the KMS encryption key. Only available if the bucket
2125
2374
  * <code>EncryptionType</code> is <code>aws:kms</code>.</p>
2126
2375
  */
@@ -2131,6 +2380,7 @@ export interface DefaultServerSideEncryption {
2131
2380
  */
2132
2381
  export interface DeleteDetectorRequest {
2133
2382
  /**
2383
+ * @public
2134
2384
  * <p>The unique ID of the detector that you want to delete.</p>
2135
2385
  */
2136
2386
  DetectorId: string | undefined;
@@ -2145,10 +2395,12 @@ export interface DeleteDetectorResponse {
2145
2395
  */
2146
2396
  export interface DeleteFilterRequest {
2147
2397
  /**
2398
+ * @public
2148
2399
  * <p>The unique ID of the detector that the filter is associated with.</p>
2149
2400
  */
2150
2401
  DetectorId: string | undefined;
2151
2402
  /**
2403
+ * @public
2152
2404
  * <p>The name of the filter that you want to delete.</p>
2153
2405
  */
2154
2406
  FilterName: string | undefined;
@@ -2163,6 +2415,7 @@ export interface DeleteFilterResponse {
2163
2415
  */
2164
2416
  export interface DeleteInvitationsRequest {
2165
2417
  /**
2418
+ * @public
2166
2419
  * <p>A list of account IDs of the Amazon Web Services accounts that sent invitations to the current member
2167
2420
  * account that you want to delete invitations from.</p>
2168
2421
  */
@@ -2173,6 +2426,7 @@ export interface DeleteInvitationsRequest {
2173
2426
  */
2174
2427
  export interface DeleteInvitationsResponse {
2175
2428
  /**
2429
+ * @public
2176
2430
  * <p>A list of objects that contain the unprocessed account and a result string that explains
2177
2431
  * why it was unprocessed.</p>
2178
2432
  */
@@ -2183,10 +2437,12 @@ export interface DeleteInvitationsResponse {
2183
2437
  */
2184
2438
  export interface DeleteIPSetRequest {
2185
2439
  /**
2440
+ * @public
2186
2441
  * <p>The unique ID of the detector associated with the IPSet.</p>
2187
2442
  */
2188
2443
  DetectorId: string | undefined;
2189
2444
  /**
2445
+ * @public
2190
2446
  * <p>The unique ID of the IPSet to delete.</p>
2191
2447
  */
2192
2448
  IpSetId: string | undefined;
@@ -2201,11 +2457,13 @@ export interface DeleteIPSetResponse {
2201
2457
  */
2202
2458
  export interface DeleteMembersRequest {
2203
2459
  /**
2460
+ * @public
2204
2461
  * <p>The unique ID of the detector of the GuardDuty account whose members you want to
2205
2462
  * delete.</p>
2206
2463
  */
2207
2464
  DetectorId: string | undefined;
2208
2465
  /**
2466
+ * @public
2209
2467
  * <p>A list of account IDs of the GuardDuty member accounts that you want to delete.</p>
2210
2468
  */
2211
2469
  AccountIds: string[] | undefined;
@@ -2215,6 +2473,7 @@ export interface DeleteMembersRequest {
2215
2473
  */
2216
2474
  export interface DeleteMembersResponse {
2217
2475
  /**
2476
+ * @public
2218
2477
  * <p>The accounts that could not be processed.</p>
2219
2478
  */
2220
2479
  UnprocessedAccounts: UnprocessedAccount[] | undefined;
@@ -2224,10 +2483,12 @@ export interface DeleteMembersResponse {
2224
2483
  */
2225
2484
  export interface DeletePublishingDestinationRequest {
2226
2485
  /**
2486
+ * @public
2227
2487
  * <p>The unique ID of the detector associated with the publishing destination to delete.</p>
2228
2488
  */
2229
2489
  DetectorId: string | undefined;
2230
2490
  /**
2491
+ * @public
2231
2492
  * <p>The ID of the publishing destination to delete.</p>
2232
2493
  */
2233
2494
  DestinationId: string | undefined;
@@ -2242,10 +2503,12 @@ export interface DeletePublishingDestinationResponse {
2242
2503
  */
2243
2504
  export interface DeleteThreatIntelSetRequest {
2244
2505
  /**
2506
+ * @public
2245
2507
  * <p>The unique ID of the detector that the threatIntelSet is associated with.</p>
2246
2508
  */
2247
2509
  DetectorId: string | undefined;
2248
2510
  /**
2511
+ * @public
2249
2512
  * <p>The unique ID of the threatIntelSet that you want to delete.</p>
2250
2513
  */
2251
2514
  ThreatIntelSetId: string | undefined;
@@ -2261,17 +2524,20 @@ export interface DeleteThreatIntelSetResponse {
2261
2524
  */
2262
2525
  export interface FilterCondition {
2263
2526
  /**
2527
+ * @public
2264
2528
  * <p>Represents an <i>equal</i>
2265
2529
  * <b></b> condition to be applied to
2266
2530
  * a single field when querying for scan entries.</p>
2267
2531
  */
2268
2532
  EqualsValue?: string;
2269
2533
  /**
2534
+ * @public
2270
2535
  * <p>Represents a <i>greater than</i> condition to be applied to a single field
2271
2536
  * when querying for scan entries.</p>
2272
2537
  */
2273
2538
  GreaterThan?: number;
2274
2539
  /**
2540
+ * @public
2275
2541
  * <p>Represents a <i>less than</i> condition to be applied to a single field when
2276
2542
  * querying for scan entries.</p>
2277
2543
  */
@@ -2286,11 +2552,13 @@ export interface FilterCondition {
2286
2552
  */
2287
2553
  export interface FilterCriterion {
2288
2554
  /**
2555
+ * @public
2289
2556
  * <p>An enum value representing possible scan properties to match with given scan
2290
2557
  * entries.</p>
2291
2558
  */
2292
2559
  CriterionKey?: CriterionKey | string;
2293
2560
  /**
2561
+ * @public
2294
2562
  * <p>Contains information about the condition.</p>
2295
2563
  */
2296
2564
  FilterCondition?: FilterCondition;
@@ -2301,6 +2569,7 @@ export interface FilterCriterion {
2301
2569
  */
2302
2570
  export interface FilterCriteria {
2303
2571
  /**
2572
+ * @public
2304
2573
  * <p>Represents a condition that when matched will be added to the response of the
2305
2574
  * operation.</p>
2306
2575
  */
@@ -2312,11 +2581,13 @@ export interface FilterCriteria {
2312
2581
  */
2313
2582
  export interface SortCriteria {
2314
2583
  /**
2584
+ * @public
2315
2585
  * <p>Represents the finding attribute, such as <code>accountId</code>, that sorts the
2316
2586
  * findings.</p>
2317
2587
  */
2318
2588
  AttributeName?: string;
2319
2589
  /**
2590
+ * @public
2320
2591
  * <p>The order by which the sorted findings are to be displayed.</p>
2321
2592
  */
2322
2593
  OrderBy?: OrderBy | string;
@@ -2326,10 +2597,12 @@ export interface SortCriteria {
2326
2597
  */
2327
2598
  export interface DescribeMalwareScansRequest {
2328
2599
  /**
2600
+ * @public
2329
2601
  * <p>The unique ID of the detector that the request is associated with.</p>
2330
2602
  */
2331
2603
  DetectorId: string | undefined;
2332
2604
  /**
2605
+ * @public
2333
2606
  * <p>You can use this parameter when paginating results. Set the value of this parameter to
2334
2607
  * null on your first call to the list action. For subsequent calls to the action, fill nextToken
2335
2608
  * in the request with the value of NextToken from the previous response to continue listing
@@ -2337,15 +2610,18 @@ export interface DescribeMalwareScansRequest {
2337
2610
  */
2338
2611
  NextToken?: string;
2339
2612
  /**
2613
+ * @public
2340
2614
  * <p>You can use this parameter to indicate the maximum number of items that you want in the
2341
2615
  * response. The default value is 50. The maximum value is 50.</p>
2342
2616
  */
2343
2617
  MaxResults?: number;
2344
2618
  /**
2619
+ * @public
2345
2620
  * <p>Represents the criteria to be used in the filter for describing scan entries.</p>
2346
2621
  */
2347
2622
  FilterCriteria?: FilterCriteria;
2348
2623
  /**
2624
+ * @public
2349
2625
  * <p>Represents the criteria used for sorting scan entries. The <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_SortCriteria.html#guardduty-Type-SortCriteria-attributeName">
2350
2626
  * <code>attributeName</code>
2351
2627
  * </a> is required and it must be
@@ -2359,30 +2635,37 @@ export interface DescribeMalwareScansRequest {
2359
2635
  */
2360
2636
  export interface VolumeDetail {
2361
2637
  /**
2638
+ * @public
2362
2639
  * <p>EBS volume Arn information.</p>
2363
2640
  */
2364
2641
  VolumeArn?: string;
2365
2642
  /**
2643
+ * @public
2366
2644
  * <p>The EBS volume type.</p>
2367
2645
  */
2368
2646
  VolumeType?: string;
2369
2647
  /**
2648
+ * @public
2370
2649
  * <p>The device name for the EBS volume.</p>
2371
2650
  */
2372
2651
  DeviceName?: string;
2373
2652
  /**
2653
+ * @public
2374
2654
  * <p>EBS volume size in GB.</p>
2375
2655
  */
2376
2656
  VolumeSizeInGB?: number;
2377
2657
  /**
2658
+ * @public
2378
2659
  * <p>EBS volume encryption type.</p>
2379
2660
  */
2380
2661
  EncryptionType?: string;
2381
2662
  /**
2663
+ * @public
2382
2664
  * <p>Snapshot Arn of the EBS volume.</p>
2383
2665
  */
2384
2666
  SnapshotArn?: string;
2385
2667
  /**
2668
+ * @public
2386
2669
  * <p>KMS key Arn used to encrypt the EBS volume.</p>
2387
2670
  */
2388
2671
  KmsKeyArn?: string;
@@ -2393,6 +2676,7 @@ export interface VolumeDetail {
2393
2676
  */
2394
2677
  export interface ResourceDetails {
2395
2678
  /**
2679
+ * @public
2396
2680
  * <p>InstanceArn that was scanned in the scan entry.</p>
2397
2681
  */
2398
2682
  InstanceArn?: string;
@@ -2415,6 +2699,7 @@ export type ScanResult = (typeof ScanResult)[keyof typeof ScanResult];
2415
2699
  */
2416
2700
  export interface ScanResultDetails {
2417
2701
  /**
2702
+ * @public
2418
2703
  * <p>An enum value representing possible scan results.</p>
2419
2704
  */
2420
2705
  ScanResult?: ScanResult | string;
@@ -2451,10 +2736,12 @@ export type ScanType = (typeof ScanType)[keyof typeof ScanType];
2451
2736
  */
2452
2737
  export interface TriggerDetails {
2453
2738
  /**
2739
+ * @public
2454
2740
  * <p>The ID of the GuardDuty finding that triggered the malware scan.</p>
2455
2741
  */
2456
2742
  GuardDutyFindingId?: string;
2457
2743
  /**
2744
+ * @public
2458
2745
  * <p>The description of the scan trigger.</p>
2459
2746
  */
2460
2747
  Description?: string;
@@ -2465,64 +2752,79 @@ export interface TriggerDetails {
2465
2752
  */
2466
2753
  export interface Scan {
2467
2754
  /**
2755
+ * @public
2468
2756
  * <p>The unique ID of the detector that the request is associated with.</p>
2469
2757
  */
2470
2758
  DetectorId?: string;
2471
2759
  /**
2760
+ * @public
2472
2761
  * <p>The unique detector ID of the administrator account that the request is associated with.
2473
2762
  * Note that this value will be the same as the one used for <code>DetectorId</code> if the
2474
2763
  * account is an administrator.</p>
2475
2764
  */
2476
2765
  AdminDetectorId?: string;
2477
2766
  /**
2767
+ * @public
2478
2768
  * <p>The unique scan ID associated with a scan entry.</p>
2479
2769
  */
2480
2770
  ScanId?: string;
2481
2771
  /**
2772
+ * @public
2482
2773
  * <p>An enum value representing possible scan statuses.</p>
2483
2774
  */
2484
2775
  ScanStatus?: ScanStatus | string;
2485
2776
  /**
2777
+ * @public
2486
2778
  * <p>Represents the reason for FAILED scan status.</p>
2487
2779
  */
2488
2780
  FailureReason?: string;
2489
2781
  /**
2782
+ * @public
2490
2783
  * <p>The timestamp of when the scan was triggered.</p>
2491
2784
  */
2492
2785
  ScanStartTime?: Date;
2493
2786
  /**
2787
+ * @public
2494
2788
  * <p>The timestamp of when the scan was finished.</p>
2495
2789
  */
2496
2790
  ScanEndTime?: Date;
2497
2791
  /**
2792
+ * @public
2498
2793
  * <p>Specifies the reason why the scan was initiated.</p>
2499
2794
  */
2500
2795
  TriggerDetails?: TriggerDetails;
2501
2796
  /**
2797
+ * @public
2502
2798
  * <p>Represents the resources that were scanned in the scan entry.</p>
2503
2799
  */
2504
2800
  ResourceDetails?: ResourceDetails;
2505
2801
  /**
2802
+ * @public
2506
2803
  * <p>Represents the result of the scan.</p>
2507
2804
  */
2508
2805
  ScanResultDetails?: ScanResultDetails;
2509
2806
  /**
2807
+ * @public
2510
2808
  * <p>The ID for the account that belongs to the scan.</p>
2511
2809
  */
2512
2810
  AccountId?: string;
2513
2811
  /**
2812
+ * @public
2514
2813
  * <p>Represents total bytes that were scanned.</p>
2515
2814
  */
2516
2815
  TotalBytes?: number;
2517
2816
  /**
2817
+ * @public
2518
2818
  * <p>Represents the number of files that were scanned.</p>
2519
2819
  */
2520
2820
  FileCount?: number;
2521
2821
  /**
2822
+ * @public
2522
2823
  * <p>List of volumes that were attached to the original instance to be scanned.</p>
2523
2824
  */
2524
2825
  AttachedVolumes?: VolumeDetail[];
2525
2826
  /**
2827
+ * @public
2526
2828
  * <p>Specifies the scan type that invoked the malware scan.</p>
2527
2829
  */
2528
2830
  ScanType?: ScanType | string;
@@ -2532,10 +2834,12 @@ export interface Scan {
2532
2834
  */
2533
2835
  export interface DescribeMalwareScansResponse {
2534
2836
  /**
2837
+ * @public
2535
2838
  * <p>Contains information about malware scans.</p>
2536
2839
  */
2537
2840
  Scans: Scan[] | undefined;
2538
2841
  /**
2842
+ * @public
2539
2843
  * <p>The pagination parameter to be used on the next list operation to retrieve more
2540
2844
  * items.</p>
2541
2845
  */
@@ -2546,16 +2850,19 @@ export interface DescribeMalwareScansResponse {
2546
2850
  */
2547
2851
  export interface DescribeOrganizationConfigurationRequest {
2548
2852
  /**
2853
+ * @public
2549
2854
  * <p>The ID of the detector to retrieve information about the delegated administrator
2550
2855
  * from.</p>
2551
2856
  */
2552
2857
  DetectorId: string | undefined;
2553
2858
  /**
2859
+ * @public
2554
2860
  * <p>You can use this parameter to indicate the maximum number of items that you want in the
2555
2861
  * response.</p>
2556
2862
  */
2557
2863
  MaxResults?: number;
2558
2864
  /**
2865
+ * @public
2559
2866
  * <p>You can use this parameter when paginating results. Set the value of this parameter to
2560
2867
  * null on your first call to the list action. For subsequent calls to the action, fill
2561
2868
  * <code>nextToken</code> in the request with the value of <code>NextToken</code> from the
@@ -2570,6 +2877,7 @@ export interface DescribeOrganizationConfigurationRequest {
2570
2877
  */
2571
2878
  export interface OrganizationKubernetesAuditLogsConfigurationResult {
2572
2879
  /**
2880
+ * @public
2573
2881
  * <p>Whether Kubernetes audit logs data source should be auto-enabled for new members joining
2574
2882
  * the organization.</p>
2575
2883
  */
@@ -2581,6 +2889,7 @@ export interface OrganizationKubernetesAuditLogsConfigurationResult {
2581
2889
  */
2582
2890
  export interface OrganizationKubernetesConfigurationResult {
2583
2891
  /**
2892
+ * @public
2584
2893
  * <p>The current configuration of Kubernetes audit logs as a data source for the
2585
2894
  * organization.</p>
2586
2895
  */
@@ -2593,6 +2902,7 @@ export interface OrganizationKubernetesConfigurationResult {
2593
2902
  */
2594
2903
  export interface OrganizationEbsVolumesResult {
2595
2904
  /**
2905
+ * @public
2596
2906
  * <p>An object that contains the status of whether scanning EBS volumes should be auto-enabled
2597
2907
  * for new members joining the organization.</p>
2598
2908
  */
@@ -2605,6 +2915,7 @@ export interface OrganizationEbsVolumesResult {
2605
2915
  */
2606
2916
  export interface OrganizationScanEc2InstanceWithFindingsResult {
2607
2917
  /**
2918
+ * @public
2608
2919
  * <p>Describes the configuration for scanning EBS volumes for an organization.</p>
2609
2920
  */
2610
2921
  EbsVolumes?: OrganizationEbsVolumesResult;
@@ -2616,6 +2927,7 @@ export interface OrganizationScanEc2InstanceWithFindingsResult {
2616
2927
  */
2617
2928
  export interface OrganizationMalwareProtectionConfigurationResult {
2618
2929
  /**
2930
+ * @public
2619
2931
  * <p>Describes the configuration for scanning EC2 instances with findings for an
2620
2932
  * organization.</p>
2621
2933
  */
@@ -2628,6 +2940,7 @@ export interface OrganizationMalwareProtectionConfigurationResult {
2628
2940
  */
2629
2941
  export interface OrganizationS3LogsConfigurationResult {
2630
2942
  /**
2943
+ * @public
2631
2944
  * <p>A value that describes whether S3 data event logs are automatically enabled for new
2632
2945
  * members of the organization.</p>
2633
2946
  */
@@ -2640,14 +2953,17 @@ export interface OrganizationS3LogsConfigurationResult {
2640
2953
  */
2641
2954
  export interface OrganizationDataSourceConfigurationsResult {
2642
2955
  /**
2956
+ * @public
2643
2957
  * <p>Describes whether S3 data event logs are enabled as a data source.</p>
2644
2958
  */
2645
2959
  S3Logs: OrganizationS3LogsConfigurationResult | undefined;
2646
2960
  /**
2961
+ * @public
2647
2962
  * <p>Describes the configuration of Kubernetes data sources.</p>
2648
2963
  */
2649
2964
  Kubernetes?: OrganizationKubernetesConfigurationResult;
2650
2965
  /**
2966
+ * @public
2651
2967
  * <p>Describes the configuration of Malware Protection data source for an organization.</p>
2652
2968
  */
2653
2969
  MalwareProtection?: OrganizationMalwareProtectionConfigurationResult;
@@ -2681,11 +2997,13 @@ export type OrgFeatureAdditionalConfiguration = (typeof OrgFeatureAdditionalConf
2681
2997
  */
2682
2998
  export interface OrganizationAdditionalConfigurationResult {
2683
2999
  /**
3000
+ * @public
2684
3001
  * <p>The name of the additional configuration that is configured for the member accounts within
2685
3002
  * the organization.</p>
2686
3003
  */
2687
3004
  Name?: OrgFeatureAdditionalConfiguration | string;
2688
3005
  /**
3006
+ * @public
2689
3007
  * <p>Describes how The status of the additional configuration that are configured for the
2690
3008
  * member accounts within the organization.</p>
2691
3009
  * <p>If you set <code>AutoEnable</code> to <code>NEW</code>, a feature will be configured for
@@ -2717,11 +3035,13 @@ export type OrgFeature = (typeof OrgFeature)[keyof typeof OrgFeature];
2717
3035
  */
2718
3036
  export interface OrganizationFeatureConfigurationResult {
2719
3037
  /**
3038
+ * @public
2720
3039
  * <p>The name of the feature that is configured for the member accounts within the
2721
3040
  * organization.</p>
2722
3041
  */
2723
3042
  Name?: OrgFeature | string;
2724
3043
  /**
3044
+ * @public
2725
3045
  * <p>Describes how The status of the feature that are configured for the member accounts within
2726
3046
  * the organization.</p>
2727
3047
  * <p>If you set <code>AutoEnable</code> to <code>NEW</code>, a feature will be configured for
@@ -2731,6 +3051,7 @@ export interface OrganizationFeatureConfigurationResult {
2731
3051
  */
2732
3052
  AutoEnable?: OrgFeatureStatus | string;
2733
3053
  /**
3054
+ * @public
2734
3055
  * <p>The additional configuration that is configured for the member accounts within the
2735
3056
  * organization.</p>
2736
3057
  */
@@ -2741,6 +3062,7 @@ export interface OrganizationFeatureConfigurationResult {
2741
3062
  */
2742
3063
  export interface DescribeOrganizationConfigurationResponse {
2743
3064
  /**
3065
+ * @public
2744
3066
  * @deprecated
2745
3067
  *
2746
3068
  * <p>Indicates whether GuardDuty is automatically enabled for accounts added to the
@@ -2750,26 +3072,31 @@ export interface DescribeOrganizationConfigurationResponse {
2750
3072
  */
2751
3073
  AutoEnable?: boolean;
2752
3074
  /**
3075
+ * @public
2753
3076
  * <p>Indicates whether the maximum number of allowed member accounts are already associated
2754
3077
  * with the delegated administrator account for your organization.</p>
2755
3078
  */
2756
3079
  MemberAccountLimitReached: boolean | undefined;
2757
3080
  /**
3081
+ * @public
2758
3082
  * @deprecated
2759
3083
  *
2760
3084
  * <p>Describes which data sources are enabled automatically for member accounts.</p>
2761
3085
  */
2762
3086
  DataSources?: OrganizationDataSourceConfigurationsResult;
2763
3087
  /**
3088
+ * @public
2764
3089
  * <p>A list of features that are configured for this organization.</p>
2765
3090
  */
2766
3091
  Features?: OrganizationFeatureConfigurationResult[];
2767
3092
  /**
3093
+ * @public
2768
3094
  * <p>The pagination parameter to be used on the next list operation to retrieve more
2769
3095
  * items.</p>
2770
3096
  */
2771
3097
  NextToken?: string;
2772
3098
  /**
3099
+ * @public
2773
3100
  * <p>Indicates the auto-enablement configuration of GuardDuty for the member accounts in the
2774
3101
  * organization.</p>
2775
3102
  * <ul>
@@ -2800,11 +3127,13 @@ export interface DescribeOrganizationConfigurationResponse {
2800
3127
  */
2801
3128
  export interface DescribePublishingDestinationRequest {
2802
3129
  /**
3130
+ * @public
2803
3131
  * <p>The unique ID of the detector associated with the publishing destination to
2804
3132
  * retrieve.</p>
2805
3133
  */
2806
3134
  DetectorId: string | undefined;
2807
3135
  /**
3136
+ * @public
2808
3137
  * <p>The ID of the publishing destination to retrieve.</p>
2809
3138
  */
2810
3139
  DestinationId: string | undefined;
@@ -2828,24 +3157,29 @@ export type PublishingStatus = (typeof PublishingStatus)[keyof typeof Publishing
2828
3157
  */
2829
3158
  export interface DescribePublishingDestinationResponse {
2830
3159
  /**
3160
+ * @public
2831
3161
  * <p>The ID of the publishing destination.</p>
2832
3162
  */
2833
3163
  DestinationId: string | undefined;
2834
3164
  /**
3165
+ * @public
2835
3166
  * <p>The type of publishing destination. Currently, only Amazon S3 buckets are
2836
3167
  * supported.</p>
2837
3168
  */
2838
3169
  DestinationType: DestinationType | string | undefined;
2839
3170
  /**
3171
+ * @public
2840
3172
  * <p>The status of the publishing destination.</p>
2841
3173
  */
2842
3174
  Status: PublishingStatus | string | undefined;
2843
3175
  /**
3176
+ * @public
2844
3177
  * <p>The time, in epoch millisecond format, at which GuardDuty was first unable to publish
2845
3178
  * findings to the destination.</p>
2846
3179
  */
2847
3180
  PublishingFailureStartTimestamp: number | undefined;
2848
3181
  /**
3182
+ * @public
2849
3183
  * <p>A <code>DestinationProperties</code> object that includes the <code>DestinationArn</code>
2850
3184
  * and <code>KmsKeyArn</code> of the publishing destination.</p>
2851
3185
  */
@@ -2858,15 +3192,18 @@ export interface DescribePublishingDestinationResponse {
2858
3192
  */
2859
3193
  export interface Destination {
2860
3194
  /**
3195
+ * @public
2861
3196
  * <p>The unique ID of the publishing destination.</p>
2862
3197
  */
2863
3198
  DestinationId: string | undefined;
2864
3199
  /**
3200
+ * @public
2865
3201
  * <p>The type of resource used for the publishing destination. Currently, only Amazon S3
2866
3202
  * buckets are supported.</p>
2867
3203
  */
2868
3204
  DestinationType: DestinationType | string | undefined;
2869
3205
  /**
3206
+ * @public
2870
3207
  * <p>The status of the publishing destination.</p>
2871
3208
  */
2872
3209
  Status: PublishingStatus | string | undefined;
@@ -2877,14 +3214,17 @@ export interface Destination {
2877
3214
  */
2878
3215
  export interface DetectorAdditionalConfigurationResult {
2879
3216
  /**
3217
+ * @public
2880
3218
  * <p>Name of the additional configuration.</p>
2881
3219
  */
2882
3220
  Name?: FeatureAdditionalConfiguration | string;
2883
3221
  /**
3222
+ * @public
2884
3223
  * <p>Status of the additional configuration.</p>
2885
3224
  */
2886
3225
  Status?: FeatureStatus | string;
2887
3226
  /**
3227
+ * @public
2888
3228
  * <p>The timestamp at which the additional configuration was last updated. This is in UTC
2889
3229
  * format.</p>
2890
3230
  */
@@ -2915,18 +3255,22 @@ export type DetectorFeatureResult = (typeof DetectorFeatureResult)[keyof typeof
2915
3255
  */
2916
3256
  export interface DetectorFeatureConfigurationResult {
2917
3257
  /**
3258
+ * @public
2918
3259
  * <p>Indicates the name of the feature that can be enabled for the detector.</p>
2919
3260
  */
2920
3261
  Name?: DetectorFeatureResult | string;
2921
3262
  /**
3263
+ * @public
2922
3264
  * <p>Indicates the status of the feature that is enabled for the detector.</p>
2923
3265
  */
2924
3266
  Status?: FeatureStatus | string;
2925
3267
  /**
3268
+ * @public
2926
3269
  * <p>The timestamp at which the feature object was updated.</p>
2927
3270
  */
2928
3271
  UpdatedAt?: Date;
2929
3272
  /**
3273
+ * @public
2930
3274
  * <p>Additional configuration for a resource.</p>
2931
3275
  */
2932
3276
  AdditionalConfiguration?: DetectorAdditionalConfigurationResult[];
@@ -2948,6 +3292,7 @@ export type DetectorStatus = (typeof DetectorStatus)[keyof typeof DetectorStatus
2948
3292
  */
2949
3293
  export interface DisableOrganizationAdminAccountRequest {
2950
3294
  /**
3295
+ * @public
2951
3296
  * <p>The Amazon Web Services Account ID for the organizations account to be disabled as a GuardDuty delegated
2952
3297
  * administrator.</p>
2953
3298
  */
@@ -2963,6 +3308,7 @@ export interface DisableOrganizationAdminAccountResponse {
2963
3308
  */
2964
3309
  export interface DisassociateFromAdministratorAccountRequest {
2965
3310
  /**
3311
+ * @public
2966
3312
  * <p>The unique ID of the detector of the GuardDuty member account.</p>
2967
3313
  */
2968
3314
  DetectorId: string | undefined;
@@ -2977,6 +3323,7 @@ export interface DisassociateFromAdministratorAccountResponse {
2977
3323
  */
2978
3324
  export interface DisassociateFromMasterAccountRequest {
2979
3325
  /**
3326
+ * @public
2980
3327
  * <p>The unique ID of the detector of the GuardDuty member account.</p>
2981
3328
  */
2982
3329
  DetectorId: string | undefined;
@@ -2991,11 +3338,13 @@ export interface DisassociateFromMasterAccountResponse {
2991
3338
  */
2992
3339
  export interface DisassociateMembersRequest {
2993
3340
  /**
3341
+ * @public
2994
3342
  * <p>The unique ID of the detector of the GuardDuty account whose members you want to
2995
3343
  * disassociate from the administrator account.</p>
2996
3344
  */
2997
3345
  DetectorId: string | undefined;
2998
3346
  /**
3347
+ * @public
2999
3348
  * <p>A list of account IDs of the GuardDuty member accounts that you want to disassociate from
3000
3349
  * the administrator account.</p>
3001
3350
  */
@@ -3006,6 +3355,7 @@ export interface DisassociateMembersRequest {
3006
3355
  */
3007
3356
  export interface DisassociateMembersResponse {
3008
3357
  /**
3358
+ * @public
3009
3359
  * <p>A list of objects that contain the unprocessed account and a result string that explains
3010
3360
  * why it was unprocessed.</p>
3011
3361
  */
@@ -3029,10 +3379,12 @@ export type EbsSnapshotPreservation = (typeof EbsSnapshotPreservation)[keyof typ
3029
3379
  */
3030
3380
  export interface EbsVolumeDetails {
3031
3381
  /**
3382
+ * @public
3032
3383
  * <p>List of EBS volumes that were scanned.</p>
3033
3384
  */
3034
3385
  ScannedVolumeDetails?: VolumeDetail[];
3035
3386
  /**
3387
+ * @public
3036
3388
  * <p>List of EBS volumes that were skipped from the malware scan.</p>
3037
3389
  */
3038
3390
  SkippedVolumeDetails?: VolumeDetail[];
@@ -3044,14 +3396,17 @@ export interface EbsVolumeDetails {
3044
3396
  */
3045
3397
  export interface HighestSeverityThreatDetails {
3046
3398
  /**
3399
+ * @public
3047
3400
  * <p>Severity level of the highest severity threat detected.</p>
3048
3401
  */
3049
3402
  Severity?: string;
3050
3403
  /**
3404
+ * @public
3051
3405
  * <p>Threat name of the highest severity threat detected as part of the malware scan.</p>
3052
3406
  */
3053
3407
  ThreatName?: string;
3054
3408
  /**
3409
+ * @public
3055
3410
  * <p>Total number of infected files with the highest severity threat detected.</p>
3056
3411
  */
3057
3412
  Count?: number;
@@ -3062,14 +3417,17 @@ export interface HighestSeverityThreatDetails {
3062
3417
  */
3063
3418
  export interface ScannedItemCount {
3064
3419
  /**
3420
+ * @public
3065
3421
  * <p>Total GB of files scanned for malware.</p>
3066
3422
  */
3067
3423
  TotalGb?: number;
3068
3424
  /**
3425
+ * @public
3069
3426
  * <p>Number of files scanned.</p>
3070
3427
  */
3071
3428
  Files?: number;
3072
3429
  /**
3430
+ * @public
3073
3431
  * <p>Total number of scanned volumes.</p>
3074
3432
  */
3075
3433
  Volumes?: number;
@@ -3080,18 +3438,22 @@ export interface ScannedItemCount {
3080
3438
  */
3081
3439
  export interface ScanFilePath {
3082
3440
  /**
3441
+ * @public
3083
3442
  * <p>The file path of the infected file.</p>
3084
3443
  */
3085
3444
  FilePath?: string;
3086
3445
  /**
3446
+ * @public
3087
3447
  * <p>EBS volume Arn details of the infected file.</p>
3088
3448
  */
3089
3449
  VolumeArn?: string;
3090
3450
  /**
3451
+ * @public
3091
3452
  * <p>The hash value of the infected file.</p>
3092
3453
  */
3093
3454
  Hash?: string;
3094
3455
  /**
3456
+ * @public
3095
3457
  * <p>File name of the infected file.</p>
3096
3458
  */
3097
3459
  FileName?: string;
@@ -3103,18 +3465,22 @@ export interface ScanFilePath {
3103
3465
  */
3104
3466
  export interface ScanThreatName {
3105
3467
  /**
3468
+ * @public
3106
3469
  * <p>The name of the identified threat.</p>
3107
3470
  */
3108
3471
  Name?: string;
3109
3472
  /**
3473
+ * @public
3110
3474
  * <p>Severity of threat identified as part of the malware scan.</p>
3111
3475
  */
3112
3476
  Severity?: string;
3113
3477
  /**
3478
+ * @public
3114
3479
  * <p>Total number of files infected with given threat.</p>
3115
3480
  */
3116
3481
  ItemCount?: number;
3117
3482
  /**
3483
+ * @public
3118
3484
  * <p>List of infected files in EBS volume with details.</p>
3119
3485
  */
3120
3486
  FilePaths?: ScanFilePath[];
@@ -3125,19 +3491,23 @@ export interface ScanThreatName {
3125
3491
  */
3126
3492
  export interface ThreatDetectedByName {
3127
3493
  /**
3494
+ * @public
3128
3495
  * <p>Total number of infected files identified.</p>
3129
3496
  */
3130
3497
  ItemCount?: number;
3131
3498
  /**
3499
+ * @public
3132
3500
  * <p>Total number of unique threats by name identified, as part of the malware scan.</p>
3133
3501
  */
3134
3502
  UniqueThreatNameCount?: number;
3135
3503
  /**
3504
+ * @public
3136
3505
  * <p>Flag to determine if the finding contains every single infected file-path and/or every
3137
3506
  * threat.</p>
3138
3507
  */
3139
3508
  Shortened?: boolean;
3140
3509
  /**
3510
+ * @public
3141
3511
  * <p>List of identified threats with details, organized by threat name.</p>
3142
3512
  */
3143
3513
  ThreatNames?: ScanThreatName[];
@@ -3148,6 +3518,7 @@ export interface ThreatDetectedByName {
3148
3518
  */
3149
3519
  export interface ThreatsDetectedItemCount {
3150
3520
  /**
3521
+ * @public
3151
3522
  * <p>Total number of infected files.</p>
3152
3523
  */
3153
3524
  Files?: number;
@@ -3158,19 +3529,23 @@ export interface ThreatsDetectedItemCount {
3158
3529
  */
3159
3530
  export interface ScanDetections {
3160
3531
  /**
3532
+ * @public
3161
3533
  * <p>Total number of scanned files.</p>
3162
3534
  */
3163
3535
  ScannedItemCount?: ScannedItemCount;
3164
3536
  /**
3537
+ * @public
3165
3538
  * <p>Total number of infected files.</p>
3166
3539
  */
3167
3540
  ThreatsDetectedItemCount?: ThreatsDetectedItemCount;
3168
3541
  /**
3542
+ * @public
3169
3543
  * <p>Details of the highest severity threat detected during malware scan and number of infected
3170
3544
  * files.</p>
3171
3545
  */
3172
3546
  HighestSeverityThreatDetails?: HighestSeverityThreatDetails;
3173
3547
  /**
3548
+ * @public
3174
3549
  * <p>Contains details about identified threats organized by threat name.</p>
3175
3550
  */
3176
3551
  ThreatDetectedByName?: ThreatDetectedByName;
@@ -3181,30 +3556,37 @@ export interface ScanDetections {
3181
3556
  */
3182
3557
  export interface EbsVolumeScanDetails {
3183
3558
  /**
3559
+ * @public
3184
3560
  * <p>Unique Id of the malware scan that generated the finding.</p>
3185
3561
  */
3186
3562
  ScanId?: string;
3187
3563
  /**
3564
+ * @public
3188
3565
  * <p>Returns the start date and time of the malware scan.</p>
3189
3566
  */
3190
3567
  ScanStartedAt?: Date;
3191
3568
  /**
3569
+ * @public
3192
3570
  * <p>Returns the completion date and time of the malware scan.</p>
3193
3571
  */
3194
3572
  ScanCompletedAt?: Date;
3195
3573
  /**
3574
+ * @public
3196
3575
  * <p>GuardDuty finding ID that triggered a malware scan.</p>
3197
3576
  */
3198
3577
  TriggerFindingId?: string;
3199
3578
  /**
3579
+ * @public
3200
3580
  * <p>Contains list of threat intelligence sources used to detect threats.</p>
3201
3581
  */
3202
3582
  Sources?: string[];
3203
3583
  /**
3584
+ * @public
3204
3585
  * <p>Contains a complete view providing malware scan result details.</p>
3205
3586
  */
3206
3587
  ScanDetections?: ScanDetections;
3207
3588
  /**
3589
+ * @public
3208
3590
  * <p>Specifies the scan type that invoked the malware scan.</p>
3209
3591
  */
3210
3592
  ScanType?: ScanType | string;
@@ -3215,10 +3597,12 @@ export interface EbsVolumeScanDetails {
3215
3597
  */
3216
3598
  export interface Tag {
3217
3599
  /**
3600
+ * @public
3218
3601
  * <p>The EC2 instance tag key.</p>
3219
3602
  */
3220
3603
  Key?: string;
3221
3604
  /**
3605
+ * @public
3222
3606
  * <p>The EC2 instance tag value.</p>
3223
3607
  */
3224
3608
  Value?: string;
@@ -3230,6 +3614,7 @@ export interface Tag {
3230
3614
  */
3231
3615
  export interface HostPath {
3232
3616
  /**
3617
+ * @public
3233
3618
  * <p>Path of the file or directory on the host that the volume maps to.</p>
3234
3619
  */
3235
3620
  Path?: string;
@@ -3240,10 +3625,12 @@ export interface HostPath {
3240
3625
  */
3241
3626
  export interface Volume {
3242
3627
  /**
3628
+ * @public
3243
3629
  * <p>Volume name.</p>
3244
3630
  */
3245
3631
  Name?: string;
3246
3632
  /**
3633
+ * @public
3247
3634
  * <p>Represents a pre-existing file or directory on the host machine that the volume maps
3248
3635
  * to.</p>
3249
3636
  */
@@ -3255,42 +3642,52 @@ export interface Volume {
3255
3642
  */
3256
3643
  export interface EcsTaskDetails {
3257
3644
  /**
3645
+ * @public
3258
3646
  * <p>The Amazon Resource Name (ARN) of the task.</p>
3259
3647
  */
3260
3648
  Arn?: string;
3261
3649
  /**
3650
+ * @public
3262
3651
  * <p>The ARN of the task definition that creates the task.</p>
3263
3652
  */
3264
3653
  DefinitionArn?: string;
3265
3654
  /**
3655
+ * @public
3266
3656
  * <p>The version counter for the task.</p>
3267
3657
  */
3268
3658
  Version?: string;
3269
3659
  /**
3660
+ * @public
3270
3661
  * <p>The Unix timestamp for the time when the task was created.</p>
3271
3662
  */
3272
3663
  TaskCreatedAt?: Date;
3273
3664
  /**
3665
+ * @public
3274
3666
  * <p>The Unix timestamp for the time when the task started.</p>
3275
3667
  */
3276
3668
  StartedAt?: Date;
3277
3669
  /**
3670
+ * @public
3278
3671
  * <p>Contains the tag specified when a task is started.</p>
3279
3672
  */
3280
3673
  StartedBy?: string;
3281
3674
  /**
3675
+ * @public
3282
3676
  * <p>The tags of the ECS Task.</p>
3283
3677
  */
3284
3678
  Tags?: Tag[];
3285
3679
  /**
3680
+ * @public
3286
3681
  * <p>The list of data volume definitions for the task.</p>
3287
3682
  */
3288
3683
  Volumes?: Volume[];
3289
3684
  /**
3685
+ * @public
3290
3686
  * <p>The containers that's associated with the task.</p>
3291
3687
  */
3292
3688
  Containers?: Container[];
3293
3689
  /**
3690
+ * @public
3294
3691
  * <p>The name of the task group that's associated with the task.</p>
3295
3692
  */
3296
3693
  Group?: string;
@@ -3301,34 +3698,42 @@ export interface EcsTaskDetails {
3301
3698
  */
3302
3699
  export interface EcsClusterDetails {
3303
3700
  /**
3701
+ * @public
3304
3702
  * <p>The name of the ECS Cluster.</p>
3305
3703
  */
3306
3704
  Name?: string;
3307
3705
  /**
3706
+ * @public
3308
3707
  * <p>The Amazon Resource Name (ARN) that identifies the cluster.</p>
3309
3708
  */
3310
3709
  Arn?: string;
3311
3710
  /**
3711
+ * @public
3312
3712
  * <p>The status of the ECS cluster.</p>
3313
3713
  */
3314
3714
  Status?: string;
3315
3715
  /**
3716
+ * @public
3316
3717
  * <p>The number of services that are running on the cluster in an ACTIVE state.</p>
3317
3718
  */
3318
3719
  ActiveServicesCount?: number;
3319
3720
  /**
3721
+ * @public
3320
3722
  * <p>The number of container instances registered into the cluster.</p>
3321
3723
  */
3322
3724
  RegisteredContainerInstancesCount?: number;
3323
3725
  /**
3726
+ * @public
3324
3727
  * <p>The number of tasks in the cluster that are in the RUNNING state.</p>
3325
3728
  */
3326
3729
  RunningTasksCount?: number;
3327
3730
  /**
3731
+ * @public
3328
3732
  * <p>The tags of the ECS Cluster.</p>
3329
3733
  */
3330
3734
  Tags?: Tag[];
3331
3735
  /**
3736
+ * @public
3332
3737
  * <p>Contains information about the details of the ECS Task.</p>
3333
3738
  */
3334
3739
  TaskDetails?: EcsTaskDetails;
@@ -3339,26 +3744,32 @@ export interface EcsClusterDetails {
3339
3744
  */
3340
3745
  export interface EksClusterDetails {
3341
3746
  /**
3747
+ * @public
3342
3748
  * <p>EKS cluster name.</p>
3343
3749
  */
3344
3750
  Name?: string;
3345
3751
  /**
3752
+ * @public
3346
3753
  * <p>EKS cluster ARN.</p>
3347
3754
  */
3348
3755
  Arn?: string;
3349
3756
  /**
3757
+ * @public
3350
3758
  * <p>The VPC ID to which the EKS cluster is attached.</p>
3351
3759
  */
3352
3760
  VpcId?: string;
3353
3761
  /**
3762
+ * @public
3354
3763
  * <p>The EKS cluster status.</p>
3355
3764
  */
3356
3765
  Status?: string;
3357
3766
  /**
3767
+ * @public
3358
3768
  * <p>The EKS cluster tags.</p>
3359
3769
  */
3360
3770
  Tags?: Tag[];
3361
3771
  /**
3772
+ * @public
3362
3773
  * <p>The timestamp when the EKS cluster was created.</p>
3363
3774
  */
3364
3775
  CreatedAt?: Date;
@@ -3368,6 +3779,7 @@ export interface EksClusterDetails {
3368
3779
  */
3369
3780
  export interface EnableOrganizationAdminAccountRequest {
3370
3781
  /**
3782
+ * @public
3371
3783
  * <p>The Amazon Web Services Account ID for the organization account to be enabled as a GuardDuty delegated
3372
3784
  * administrator.</p>
3373
3785
  */
@@ -3385,10 +3797,12 @@ export interface EnableOrganizationAdminAccountResponse {
3385
3797
  */
3386
3798
  export interface ThreatIntelligenceDetail {
3387
3799
  /**
3800
+ * @public
3388
3801
  * <p>The name of the threat intelligence list that triggered the finding.</p>
3389
3802
  */
3390
3803
  ThreatListName?: string;
3391
3804
  /**
3805
+ * @public
3392
3806
  * <p>A list of names of the threats in the threat intelligence list that triggered the
3393
3807
  * finding.</p>
3394
3808
  */
@@ -3400,6 +3814,7 @@ export interface ThreatIntelligenceDetail {
3400
3814
  */
3401
3815
  export interface Evidence {
3402
3816
  /**
3817
+ * @public
3403
3818
  * <p>A list of threat intelligence details related to the evidence.</p>
3404
3819
  */
3405
3820
  ThreatIntelligenceDetails?: ThreatIntelligenceDetail[];
@@ -3422,10 +3837,12 @@ export type Feedback = (typeof Feedback)[keyof typeof Feedback];
3422
3837
  */
3423
3838
  export interface IamInstanceProfile {
3424
3839
  /**
3840
+ * @public
3425
3841
  * <p>The profile ARN of the EC2 instance.</p>
3426
3842
  */
3427
3843
  Arn?: string;
3428
3844
  /**
3845
+ * @public
3429
3846
  * <p>The profile ID of the EC2 instance.</p>
3430
3847
  */
3431
3848
  Id?: string;
@@ -3436,10 +3853,12 @@ export interface IamInstanceProfile {
3436
3853
  */
3437
3854
  export interface PrivateIpAddressDetails {
3438
3855
  /**
3856
+ * @public
3439
3857
  * <p>The private DNS name of the EC2 instance.</p>
3440
3858
  */
3441
3859
  PrivateDnsName?: string;
3442
3860
  /**
3861
+ * @public
3443
3862
  * <p>The private IP address of the EC2 instance.</p>
3444
3863
  */
3445
3864
  PrivateIpAddress?: string;
@@ -3450,10 +3869,12 @@ export interface PrivateIpAddressDetails {
3450
3869
  */
3451
3870
  export interface SecurityGroup {
3452
3871
  /**
3872
+ * @public
3453
3873
  * <p>The security group ID of the EC2 instance.</p>
3454
3874
  */
3455
3875
  GroupId?: string;
3456
3876
  /**
3877
+ * @public
3457
3878
  * <p>The security group name of the EC2 instance.</p>
3458
3879
  */
3459
3880
  GroupName?: string;
@@ -3464,42 +3885,52 @@ export interface SecurityGroup {
3464
3885
  */
3465
3886
  export interface NetworkInterface {
3466
3887
  /**
3888
+ * @public
3467
3889
  * <p>A list of IPv6 addresses for the EC2 instance.</p>
3468
3890
  */
3469
3891
  Ipv6Addresses?: string[];
3470
3892
  /**
3893
+ * @public
3471
3894
  * <p>The ID of the network interface.</p>
3472
3895
  */
3473
3896
  NetworkInterfaceId?: string;
3474
3897
  /**
3898
+ * @public
3475
3899
  * <p>The private DNS name of the EC2 instance.</p>
3476
3900
  */
3477
3901
  PrivateDnsName?: string;
3478
3902
  /**
3903
+ * @public
3479
3904
  * <p>The private IP address of the EC2 instance.</p>
3480
3905
  */
3481
3906
  PrivateIpAddress?: string;
3482
3907
  /**
3908
+ * @public
3483
3909
  * <p>Other private IP address information of the EC2 instance.</p>
3484
3910
  */
3485
3911
  PrivateIpAddresses?: PrivateIpAddressDetails[];
3486
3912
  /**
3913
+ * @public
3487
3914
  * <p>The public DNS name of the EC2 instance.</p>
3488
3915
  */
3489
3916
  PublicDnsName?: string;
3490
3917
  /**
3918
+ * @public
3491
3919
  * <p>The public IP address of the EC2 instance.</p>
3492
3920
  */
3493
3921
  PublicIp?: string;
3494
3922
  /**
3923
+ * @public
3495
3924
  * <p>The security groups associated with the EC2 instance.</p>
3496
3925
  */
3497
3926
  SecurityGroups?: SecurityGroup[];
3498
3927
  /**
3928
+ * @public
3499
3929
  * <p>The subnet ID of the EC2 instance.</p>
3500
3930
  */
3501
3931
  SubnetId?: string;
3502
3932
  /**
3933
+ * @public
3503
3934
  * <p>The VPC ID of the EC2 instance.</p>
3504
3935
  */
3505
3936
  VpcId?: string;
@@ -3510,10 +3941,12 @@ export interface NetworkInterface {
3510
3941
  */
3511
3942
  export interface ProductCode {
3512
3943
  /**
3944
+ * @public
3513
3945
  * <p>The product code information.</p>
3514
3946
  */
3515
3947
  Code?: string;
3516
3948
  /**
3949
+ * @public
3517
3950
  * <p>The product code type.</p>
3518
3951
  */
3519
3952
  ProductType?: string;
@@ -3524,55 +3957,68 @@ export interface ProductCode {
3524
3957
  */
3525
3958
  export interface InstanceDetails {
3526
3959
  /**
3960
+ * @public
3527
3961
  * <p>The Availability Zone of the EC2 instance.</p>
3528
3962
  */
3529
3963
  AvailabilityZone?: string;
3530
3964
  /**
3965
+ * @public
3531
3966
  * <p>The profile information of the EC2 instance.</p>
3532
3967
  */
3533
3968
  IamInstanceProfile?: IamInstanceProfile;
3534
3969
  /**
3970
+ * @public
3535
3971
  * <p>The image description of the EC2 instance.</p>
3536
3972
  */
3537
3973
  ImageDescription?: string;
3538
3974
  /**
3975
+ * @public
3539
3976
  * <p>The image ID of the EC2 instance.</p>
3540
3977
  */
3541
3978
  ImageId?: string;
3542
3979
  /**
3980
+ * @public
3543
3981
  * <p>The ID of the EC2 instance.</p>
3544
3982
  */
3545
3983
  InstanceId?: string;
3546
3984
  /**
3985
+ * @public
3547
3986
  * <p>The state of the EC2 instance.</p>
3548
3987
  */
3549
3988
  InstanceState?: string;
3550
3989
  /**
3990
+ * @public
3551
3991
  * <p>The type of the EC2 instance.</p>
3552
3992
  */
3553
3993
  InstanceType?: string;
3554
3994
  /**
3995
+ * @public
3555
3996
  * <p>The Amazon Resource Name (ARN) of the Amazon Web Services Outpost. Only applicable to Amazon Web Services Outposts
3556
3997
  * instances.</p>
3557
3998
  */
3558
3999
  OutpostArn?: string;
3559
4000
  /**
4001
+ * @public
3560
4002
  * <p>The launch time of the EC2 instance.</p>
3561
4003
  */
3562
4004
  LaunchTime?: string;
3563
4005
  /**
4006
+ * @public
3564
4007
  * <p>The elastic network interface information of the EC2 instance.</p>
3565
4008
  */
3566
4009
  NetworkInterfaces?: NetworkInterface[];
3567
4010
  /**
4011
+ * @public
3568
4012
  * <p>The platform of the EC2 instance.</p>
3569
4013
  */
3570
4014
  Platform?: string;
3571
4015
  /**
4016
+ * @public
3572
4017
  * <p>The product code of the EC2 instance.</p>
3573
4018
  */
3574
4019
  ProductCodes?: ProductCode[];
3575
4020
  /**
4021
+ * @public
3576
4022
  * <p>The tags of the EC2 instance.</p>
3577
4023
  */
3578
4024
  Tags?: Tag[];
@@ -3583,18 +4029,22 @@ export interface InstanceDetails {
3583
4029
  */
3584
4030
  export interface KubernetesUserDetails {
3585
4031
  /**
4032
+ * @public
3586
4033
  * <p>The username of the user who called the Kubernetes API.</p>
3587
4034
  */
3588
4035
  Username?: string;
3589
4036
  /**
4037
+ * @public
3590
4038
  * <p>The user ID of the user who called the Kubernetes API.</p>
3591
4039
  */
3592
4040
  Uid?: string;
3593
4041
  /**
4042
+ * @public
3594
4043
  * <p>The groups that include the user who called the Kubernetes API.</p>
3595
4044
  */
3596
4045
  Groups?: string[];
3597
4046
  /**
4047
+ * @public
3598
4048
  * <p>Entity that assumes the IAM role
3599
4049
  * when Kubernetes RBAC permissions are assigned to that role.</p>
3600
4050
  */
@@ -3606,30 +4056,37 @@ export interface KubernetesUserDetails {
3606
4056
  */
3607
4057
  export interface KubernetesWorkloadDetails {
3608
4058
  /**
4059
+ * @public
3609
4060
  * <p>Kubernetes workload name.</p>
3610
4061
  */
3611
4062
  Name?: string;
3612
4063
  /**
4064
+ * @public
3613
4065
  * <p>Kubernetes workload type (e.g. Pod, Deployment, etc.).</p>
3614
4066
  */
3615
4067
  Type?: string;
3616
4068
  /**
4069
+ * @public
3617
4070
  * <p>Kubernetes workload ID.</p>
3618
4071
  */
3619
4072
  Uid?: string;
3620
4073
  /**
4074
+ * @public
3621
4075
  * <p>Kubernetes namespace that the workload is part of.</p>
3622
4076
  */
3623
4077
  Namespace?: string;
3624
4078
  /**
4079
+ * @public
3625
4080
  * <p>Whether the hostNetwork flag is enabled for the pods included in the workload.</p>
3626
4081
  */
3627
4082
  HostNetwork?: boolean;
3628
4083
  /**
4084
+ * @public
3629
4085
  * <p>Containers running as part of the Kubernetes workload.</p>
3630
4086
  */
3631
4087
  Containers?: Container[];
3632
4088
  /**
4089
+ * @public
3633
4090
  * <p>Volumes used by the Kubernetes workload.</p>
3634
4091
  */
3635
4092
  Volumes?: Volume[];
@@ -3641,10 +4098,12 @@ export interface KubernetesWorkloadDetails {
3641
4098
  */
3642
4099
  export interface KubernetesDetails {
3643
4100
  /**
4101
+ * @public
3644
4102
  * <p>Details about the Kubernetes user involved in a Kubernetes finding.</p>
3645
4103
  */
3646
4104
  KubernetesUserDetails?: KubernetesUserDetails;
3647
4105
  /**
4106
+ * @public
3648
4107
  * <p>Details about the Kubernetes workload involved in a Kubernetes finding.</p>
3649
4108
  */
3650
4109
  KubernetesWorkloadDetails?: KubernetesWorkloadDetails;
@@ -3655,14 +4114,17 @@ export interface KubernetesDetails {
3655
4114
  */
3656
4115
  export interface VpcConfig {
3657
4116
  /**
4117
+ * @public
3658
4118
  * <p>The identifiers of the subnets that are associated with your Lambda function.</p>
3659
4119
  */
3660
4120
  SubnetIds?: string[];
3661
4121
  /**
4122
+ * @public
3662
4123
  * <p>The identifier of the Amazon Virtual Private Cloud.</p>
3663
4124
  */
3664
4125
  VpcId?: string;
3665
4126
  /**
4127
+ * @public
3666
4128
  * <p>The identifier of the security group attached to the Lambda function.</p>
3667
4129
  */
3668
4130
  SecurityGroups?: SecurityGroup[];
@@ -3673,39 +4135,48 @@ export interface VpcConfig {
3673
4135
  */
3674
4136
  export interface LambdaDetails {
3675
4137
  /**
4138
+ * @public
3676
4139
  * <p>Amazon Resource Name (ARN) of the Lambda function.</p>
3677
4140
  */
3678
4141
  FunctionArn?: string;
3679
4142
  /**
4143
+ * @public
3680
4144
  * <p>Name of the Lambda function.</p>
3681
4145
  */
3682
4146
  FunctionName?: string;
3683
4147
  /**
4148
+ * @public
3684
4149
  * <p>Description of the Lambda function.</p>
3685
4150
  */
3686
4151
  Description?: string;
3687
4152
  /**
4153
+ * @public
3688
4154
  * <p>The timestamp when the Lambda function was last modified. This field is in the UTC date string
3689
4155
  * format <code>(2023-03-22T19:37:20.168Z)</code>.</p>
3690
4156
  */
3691
4157
  LastModifiedAt?: Date;
3692
4158
  /**
4159
+ * @public
3693
4160
  * <p>The revision ID of the Lambda function version.</p>
3694
4161
  */
3695
4162
  RevisionId?: string;
3696
4163
  /**
4164
+ * @public
3697
4165
  * <p>The version of the Lambda function.</p>
3698
4166
  */
3699
4167
  FunctionVersion?: string;
3700
4168
  /**
4169
+ * @public
3701
4170
  * <p>The execution role of the Lambda function.</p>
3702
4171
  */
3703
4172
  Role?: string;
3704
4173
  /**
4174
+ * @public
3705
4175
  * <p>Amazon Virtual Private Cloud configuration details associated with your Lambda function.</p>
3706
4176
  */
3707
4177
  VpcConfig?: VpcConfig;
3708
4178
  /**
4179
+ * @public
3709
4180
  * <p>A list of tags attached to this resource, listed in the format of
3710
4181
  * <code>key</code>:<code>value</code> pair.</p>
3711
4182
  */
@@ -3718,29 +4189,35 @@ export interface LambdaDetails {
3718
4189
  */
3719
4190
  export interface RdsDbInstanceDetails {
3720
4191
  /**
4192
+ * @public
3721
4193
  * <p>The identifier associated to the database instance that was involved in the
3722
4194
  * finding.</p>
3723
4195
  */
3724
4196
  DbInstanceIdentifier?: string;
3725
4197
  /**
4198
+ * @public
3726
4199
  * <p>The database engine of the database instance involved in the finding.</p>
3727
4200
  */
3728
4201
  Engine?: string;
3729
4202
  /**
4203
+ * @public
3730
4204
  * <p>The version of the database engine that was involved in the finding.</p>
3731
4205
  */
3732
4206
  EngineVersion?: string;
3733
4207
  /**
4208
+ * @public
3734
4209
  * <p>The identifier of the database cluster that contains the database instance ID involved in
3735
4210
  * the finding.</p>
3736
4211
  */
3737
4212
  DbClusterIdentifier?: string;
3738
4213
  /**
4214
+ * @public
3739
4215
  * <p>The Amazon Resource Name (ARN) that identifies the database instance involved in the
3740
4216
  * finding.</p>
3741
4217
  */
3742
4218
  DbInstanceArn?: string;
3743
4219
  /**
4220
+ * @public
3744
4221
  * <p>Instance tag key-value pairs associated with the database instance ID.</p>
3745
4222
  */
3746
4223
  Tags?: Tag[];
@@ -3752,22 +4229,27 @@ export interface RdsDbInstanceDetails {
3752
4229
  */
3753
4230
  export interface RdsDbUserDetails {
3754
4231
  /**
4232
+ * @public
3755
4233
  * <p>The user name used in the anomalous login attempt.</p>
3756
4234
  */
3757
4235
  User?: string;
3758
4236
  /**
4237
+ * @public
3759
4238
  * <p>The application name used in the anomalous login attempt.</p>
3760
4239
  */
3761
4240
  Application?: string;
3762
4241
  /**
4242
+ * @public
3763
4243
  * <p>The name of the database instance involved in the anomalous login attempt.</p>
3764
4244
  */
3765
4245
  Database?: string;
3766
4246
  /**
4247
+ * @public
3767
4248
  * <p>The version of the Secure Socket Layer (SSL) used for the network.</p>
3768
4249
  */
3769
4250
  Ssl?: string;
3770
4251
  /**
4252
+ * @public
3771
4253
  * <p>The authentication method used by the user involved in the finding.</p>
3772
4254
  */
3773
4255
  AuthMethod?: string;
@@ -3778,6 +4260,7 @@ export interface RdsDbUserDetails {
3778
4260
  */
3779
4261
  export interface Owner {
3780
4262
  /**
4263
+ * @public
3781
4264
  * <p>The canonical user ID of the bucket owner. For information about locating your canonical
3782
4265
  * user ID see <a href="https://docs.aws.amazon.com/general/latest/gr/acct-identifiers.html#FindingCanonicalId">Finding Your Account
3783
4266
  * Canonical User ID.</a>
@@ -3791,10 +4274,12 @@ export interface Owner {
3791
4274
  */
3792
4275
  export interface PermissionConfiguration {
3793
4276
  /**
4277
+ * @public
3794
4278
  * <p>Contains information about the bucket level permissions for the S3 bucket.</p>
3795
4279
  */
3796
4280
  BucketLevelPermissions?: BucketLevelPermissions;
3797
4281
  /**
4282
+ * @public
3798
4283
  * <p>Contains information about the account level permissions on the S3 bucket.</p>
3799
4284
  */
3800
4285
  AccountLevelPermissions?: AccountLevelPermissions;
@@ -3805,10 +4290,12 @@ export interface PermissionConfiguration {
3805
4290
  */
3806
4291
  export interface PublicAccess {
3807
4292
  /**
4293
+ * @public
3808
4294
  * <p>Contains information about how permissions are configured for the S3 bucket.</p>
3809
4295
  */
3810
4296
  PermissionConfiguration?: PermissionConfiguration;
3811
4297
  /**
4298
+ * @public
3812
4299
  * <p>Describes the effective permission on this bucket after factoring all attached
3813
4300
  * policies.</p>
3814
4301
  */
@@ -3820,34 +4307,42 @@ export interface PublicAccess {
3820
4307
  */
3821
4308
  export interface S3BucketDetail {
3822
4309
  /**
4310
+ * @public
3823
4311
  * <p>The Amazon Resource Name (ARN) of the S3 bucket.</p>
3824
4312
  */
3825
4313
  Arn?: string;
3826
4314
  /**
4315
+ * @public
3827
4316
  * <p>The name of the S3 bucket.</p>
3828
4317
  */
3829
4318
  Name?: string;
3830
4319
  /**
4320
+ * @public
3831
4321
  * <p>Describes whether the bucket is a source or destination bucket.</p>
3832
4322
  */
3833
4323
  Type?: string;
3834
4324
  /**
4325
+ * @public
3835
4326
  * <p>The date and time the bucket was created at.</p>
3836
4327
  */
3837
4328
  CreatedAt?: Date;
3838
4329
  /**
4330
+ * @public
3839
4331
  * <p>The owner of the S3 bucket.</p>
3840
4332
  */
3841
4333
  Owner?: Owner;
3842
4334
  /**
4335
+ * @public
3843
4336
  * <p>All tags attached to the S3 bucket</p>
3844
4337
  */
3845
4338
  Tags?: Tag[];
3846
4339
  /**
4340
+ * @public
3847
4341
  * <p>Describes the server side encryption method used in the S3 bucket.</p>
3848
4342
  */
3849
4343
  DefaultServerSideEncryption?: DefaultServerSideEncryption;
3850
4344
  /**
4345
+ * @public
3851
4346
  * <p>Describes the public access policies that apply to the S3 bucket.</p>
3852
4347
  */
3853
4348
  PublicAccess?: PublicAccess;
@@ -3859,54 +4354,66 @@ export interface S3BucketDetail {
3859
4354
  */
3860
4355
  export interface Resource {
3861
4356
  /**
4357
+ * @public
3862
4358
  * <p>The IAM access key details (user information) of a user that engaged in the activity that
3863
4359
  * prompted GuardDuty to generate a finding.</p>
3864
4360
  */
3865
4361
  AccessKeyDetails?: AccessKeyDetails;
3866
4362
  /**
4363
+ * @public
3867
4364
  * <p>Contains information on the S3 bucket.</p>
3868
4365
  */
3869
4366
  S3BucketDetails?: S3BucketDetail[];
3870
4367
  /**
4368
+ * @public
3871
4369
  * <p>The information about the EC2 instance associated with the activity that prompted
3872
4370
  * GuardDuty to generate a finding.</p>
3873
4371
  */
3874
4372
  InstanceDetails?: InstanceDetails;
3875
4373
  /**
4374
+ * @public
3876
4375
  * <p>Details about the EKS cluster involved in a Kubernetes finding.</p>
3877
4376
  */
3878
4377
  EksClusterDetails?: EksClusterDetails;
3879
4378
  /**
4379
+ * @public
3880
4380
  * <p>Details about the Kubernetes user and workload involved in a Kubernetes finding.</p>
3881
4381
  */
3882
4382
  KubernetesDetails?: KubernetesDetails;
3883
4383
  /**
4384
+ * @public
3884
4385
  * <p>The type of Amazon Web Services resource.</p>
3885
4386
  */
3886
4387
  ResourceType?: string;
3887
4388
  /**
4389
+ * @public
3888
4390
  * <p>Contains list of scanned and skipped EBS volumes with details.</p>
3889
4391
  */
3890
4392
  EbsVolumeDetails?: EbsVolumeDetails;
3891
4393
  /**
4394
+ * @public
3892
4395
  * <p>Contains information about the details of the ECS Cluster.</p>
3893
4396
  */
3894
4397
  EcsClusterDetails?: EcsClusterDetails;
3895
4398
  /**
4399
+ * @public
3896
4400
  * <p>Details of a container.</p>
3897
4401
  */
3898
4402
  ContainerDetails?: Container;
3899
4403
  /**
4404
+ * @public
3900
4405
  * <p>Contains information about the database instance to which an anomalous login attempt was
3901
4406
  * made.</p>
3902
4407
  */
3903
4408
  RdsDbInstanceDetails?: RdsDbInstanceDetails;
3904
4409
  /**
4410
+ * @public
3905
4411
  * <p>Contains information about the user details through which anomalous login attempt was
3906
4412
  * made.</p>
3907
4413
  */
3908
4414
  RdsDbUserDetails?: RdsDbUserDetails;
3909
4415
  /**
4416
+ * @public
3910
4417
  * <p>Contains information about the Lambda function that was involved in a finding.</p>
3911
4418
  */
3912
4419
  LambdaDetails?: LambdaDetails;
@@ -3917,10 +4424,12 @@ export interface Resource {
3917
4424
  */
3918
4425
  export interface ServiceAdditionalInfo {
3919
4426
  /**
4427
+ * @public
3920
4428
  * <p>This field specifies the value of the additional information.</p>
3921
4429
  */
3922
4430
  Value?: string;
3923
4431
  /**
4432
+ * @public
3924
4433
  * <p>Describes the type of the additional information.</p>
3925
4434
  */
3926
4435
  Type?: string;
@@ -3931,38 +4440,47 @@ export interface ServiceAdditionalInfo {
3931
4440
  */
3932
4441
  export interface LineageObject {
3933
4442
  /**
4443
+ * @public
3934
4444
  * <p>The time when the process started. This is in UTC format.</p>
3935
4445
  */
3936
4446
  StartTime?: Date;
3937
4447
  /**
4448
+ * @public
3938
4449
  * <p>The process ID of the child process.</p>
3939
4450
  */
3940
4451
  NamespacePid?: number;
3941
4452
  /**
4453
+ * @public
3942
4454
  * <p>The user ID of the user that executed the process.</p>
3943
4455
  */
3944
4456
  UserId?: number;
3945
4457
  /**
4458
+ * @public
3946
4459
  * <p>The name of the process.</p>
3947
4460
  */
3948
4461
  Name?: string;
3949
4462
  /**
4463
+ * @public
3950
4464
  * <p>The ID of the process.</p>
3951
4465
  */
3952
4466
  Pid?: number;
3953
4467
  /**
4468
+ * @public
3954
4469
  * <p>The unique ID assigned to the process by GuardDuty.</p>
3955
4470
  */
3956
4471
  Uuid?: string;
3957
4472
  /**
4473
+ * @public
3958
4474
  * <p>The absolute path of the process executable file.</p>
3959
4475
  */
3960
4476
  ExecutablePath?: string;
3961
4477
  /**
4478
+ * @public
3962
4479
  * <p>The effective user ID that was used to execute the process.</p>
3963
4480
  */
3964
4481
  Euid?: number;
3965
4482
  /**
4483
+ * @public
3966
4484
  * <p>The unique ID of the parent process. This ID is assigned to the parent process by
3967
4485
  * GuardDuty.</p>
3968
4486
  */
@@ -3974,55 +4492,68 @@ export interface LineageObject {
3974
4492
  */
3975
4493
  export interface ProcessDetails {
3976
4494
  /**
4495
+ * @public
3977
4496
  * <p>The name of the process.</p>
3978
4497
  */
3979
4498
  Name?: string;
3980
4499
  /**
4500
+ * @public
3981
4501
  * <p>The absolute path of the process executable file.</p>
3982
4502
  */
3983
4503
  ExecutablePath?: string;
3984
4504
  /**
4505
+ * @public
3985
4506
  * <p>The <code>SHA256</code> hash of the process executable.</p>
3986
4507
  */
3987
4508
  ExecutableSha256?: string;
3988
4509
  /**
4510
+ * @public
3989
4511
  * <p>The ID of the child process.</p>
3990
4512
  */
3991
4513
  NamespacePid?: number;
3992
4514
  /**
4515
+ * @public
3993
4516
  * <p>The present working directory of the process.</p>
3994
4517
  */
3995
4518
  Pwd?: string;
3996
4519
  /**
4520
+ * @public
3997
4521
  * <p>The ID of the process.</p>
3998
4522
  */
3999
4523
  Pid?: number;
4000
4524
  /**
4525
+ * @public
4001
4526
  * <p>The time when the process started. This is in UTC format.</p>
4002
4527
  */
4003
4528
  StartTime?: Date;
4004
4529
  /**
4530
+ * @public
4005
4531
  * <p>The unique ID assigned to the process by GuardDuty.</p>
4006
4532
  */
4007
4533
  Uuid?: string;
4008
4534
  /**
4535
+ * @public
4009
4536
  * <p>The unique ID of the parent process. This ID is assigned to the parent process by
4010
4537
  * GuardDuty.</p>
4011
4538
  */
4012
4539
  ParentUuid?: string;
4013
4540
  /**
4541
+ * @public
4014
4542
  * <p>The user that executed the process.</p>
4015
4543
  */
4016
4544
  User?: string;
4017
4545
  /**
4546
+ * @public
4018
4547
  * <p>The unique ID of the user that executed the process.</p>
4019
4548
  */
4020
4549
  UserId?: number;
4021
4550
  /**
4551
+ * @public
4022
4552
  * <p>The effective user ID of the user that executed the process.</p>
4023
4553
  */
4024
4554
  Euid?: number;
4025
4555
  /**
4556
+ * @public
4026
4557
  * <p>Information about the process's lineage.</p>
4027
4558
  */
4028
4559
  Lineage?: LineageObject[];
@@ -4033,88 +4564,108 @@ export interface ProcessDetails {
4033
4564
  */
4034
4565
  export interface RuntimeContext {
4035
4566
  /**
4567
+ * @public
4036
4568
  * <p>Information about the process that modified the current process. This is available for
4037
4569
  * multiple finding types.</p>
4038
4570
  */
4039
4571
  ModifyingProcess?: ProcessDetails;
4040
4572
  /**
4573
+ * @public
4041
4574
  * <p>The timestamp at which the process modified the current process. The timestamp is in UTC date string
4042
4575
  * format.</p>
4043
4576
  */
4044
4577
  ModifiedAt?: Date;
4045
4578
  /**
4579
+ * @public
4046
4580
  * <p>The path to the script that was executed.</p>
4047
4581
  */
4048
4582
  ScriptPath?: string;
4049
4583
  /**
4584
+ * @public
4050
4585
  * <p>The path to the new library that was loaded.</p>
4051
4586
  */
4052
4587
  LibraryPath?: string;
4053
4588
  /**
4589
+ * @public
4054
4590
  * <p>The value of the LD_PRELOAD environment variable.</p>
4055
4591
  */
4056
4592
  LdPreloadValue?: string;
4057
4593
  /**
4594
+ * @public
4058
4595
  * <p>The path to the docket socket that was accessed.</p>
4059
4596
  */
4060
4597
  SocketPath?: string;
4061
4598
  /**
4599
+ * @public
4062
4600
  * <p>The path to the leveraged <code>runc</code> implementation.</p>
4063
4601
  */
4064
4602
  RuncBinaryPath?: string;
4065
4603
  /**
4604
+ * @public
4066
4605
  * <p>The path in the container that modified the release agent file.</p>
4067
4606
  */
4068
4607
  ReleaseAgentPath?: string;
4069
4608
  /**
4609
+ * @public
4070
4610
  * <p>The path on the host that is mounted by the container.</p>
4071
4611
  */
4072
4612
  MountSource?: string;
4073
4613
  /**
4614
+ * @public
4074
4615
  * <p>The path in the container that is mapped to the host directory.</p>
4075
4616
  */
4076
4617
  MountTarget?: string;
4077
4618
  /**
4619
+ * @public
4078
4620
  * <p>Represents the type of mounted fileSystem.</p>
4079
4621
  */
4080
4622
  FileSystemType?: string;
4081
4623
  /**
4624
+ * @public
4082
4625
  * <p>Represents options that control the behavior of a runtime operation or action. For
4083
4626
  * example, a filesystem mount operation may contain a read-only flag.</p>
4084
4627
  */
4085
4628
  Flags?: string[];
4086
4629
  /**
4630
+ * @public
4087
4631
  * <p>The name of the module loaded into the kernel.</p>
4088
4632
  */
4089
4633
  ModuleName?: string;
4090
4634
  /**
4635
+ * @public
4091
4636
  * <p>The path to the module loaded into the kernel.</p>
4092
4637
  */
4093
4638
  ModuleFilePath?: string;
4094
4639
  /**
4640
+ * @public
4095
4641
  * <p>The <code>SHA256</code> hash of the module.</p>
4096
4642
  */
4097
4643
  ModuleSha256?: string;
4098
4644
  /**
4645
+ * @public
4099
4646
  * <p>The path to the modified shell history file.</p>
4100
4647
  */
4101
4648
  ShellHistoryFilePath?: string;
4102
4649
  /**
4650
+ * @public
4103
4651
  * <p>Information about the process that had its memory overwritten by the current process.</p>
4104
4652
  */
4105
4653
  TargetProcess?: ProcessDetails;
4106
4654
  /**
4655
+ * @public
4107
4656
  * <p>Represents the communication protocol associated with the address. For example, the address
4108
4657
  * family <code>AF_INET</code> is used for IP version of 4 protocol.</p>
4109
4658
  */
4110
4659
  AddressFamily?: string;
4111
4660
  /**
4661
+ * @public
4112
4662
  * <p>Specifies a particular protocol within the address family. Usually there is a single
4113
4663
  * protocol in address families. For example, the address family <code>AF_INET</code> only has
4114
4664
  * the IP protocol.</p>
4115
4665
  */
4116
4666
  IanaProtocolNumber?: number;
4117
4667
  /**
4668
+ * @public
4118
4669
  * <p>Specifies the Region of a process's address space such as stack and heap.</p>
4119
4670
  */
4120
4671
  MemoryRegions?: string[];
@@ -4126,10 +4677,12 @@ export interface RuntimeContext {
4126
4677
  */
4127
4678
  export interface RuntimeDetails {
4128
4679
  /**
4680
+ * @public
4129
4681
  * <p>Information about the observed process.</p>
4130
4682
  */
4131
4683
  Process?: ProcessDetails;
4132
4684
  /**
4685
+ * @public
4133
4686
  * <p>Additional information about the suspicious activity.</p>
4134
4687
  */
4135
4688
  Context?: RuntimeContext;
@@ -4140,60 +4693,74 @@ export interface RuntimeDetails {
4140
4693
  */
4141
4694
  export interface Service {
4142
4695
  /**
4696
+ * @public
4143
4697
  * <p>Information about the activity that is described in a finding.</p>
4144
4698
  */
4145
4699
  Action?: Action;
4146
4700
  /**
4701
+ * @public
4147
4702
  * <p>An evidence object associated with the service.</p>
4148
4703
  */
4149
4704
  Evidence?: Evidence;
4150
4705
  /**
4706
+ * @public
4151
4707
  * <p>Indicates whether this finding is archived.</p>
4152
4708
  */
4153
4709
  Archived?: boolean;
4154
4710
  /**
4711
+ * @public
4155
4712
  * <p>The total count of the occurrences of this finding type.</p>
4156
4713
  */
4157
4714
  Count?: number;
4158
4715
  /**
4716
+ * @public
4159
4717
  * <p>The detector ID for the GuardDuty service.</p>
4160
4718
  */
4161
4719
  DetectorId?: string;
4162
4720
  /**
4721
+ * @public
4163
4722
  * <p>The first-seen timestamp of the activity that prompted GuardDuty to generate this
4164
4723
  * finding.</p>
4165
4724
  */
4166
4725
  EventFirstSeen?: string;
4167
4726
  /**
4727
+ * @public
4168
4728
  * <p>The last-seen timestamp of the activity that prompted GuardDuty to generate this
4169
4729
  * finding.</p>
4170
4730
  */
4171
4731
  EventLastSeen?: string;
4172
4732
  /**
4733
+ * @public
4173
4734
  * <p>The resource role information for this finding.</p>
4174
4735
  */
4175
4736
  ResourceRole?: string;
4176
4737
  /**
4738
+ * @public
4177
4739
  * <p>The name of the Amazon Web Services service (GuardDuty) that generated a finding.</p>
4178
4740
  */
4179
4741
  ServiceName?: string;
4180
4742
  /**
4743
+ * @public
4181
4744
  * <p>Feedback that was submitted about the finding.</p>
4182
4745
  */
4183
4746
  UserFeedback?: string;
4184
4747
  /**
4748
+ * @public
4185
4749
  * <p>Contains additional information about the generated finding.</p>
4186
4750
  */
4187
4751
  AdditionalInfo?: ServiceAdditionalInfo;
4188
4752
  /**
4753
+ * @public
4189
4754
  * <p>The name of the feature that generated a finding.</p>
4190
4755
  */
4191
4756
  FeatureName?: string;
4192
4757
  /**
4758
+ * @public
4193
4759
  * <p>Returns details from the malware scan that created a finding.</p>
4194
4760
  */
4195
4761
  EbsVolumeScanDetails?: EbsVolumeScanDetails;
4196
4762
  /**
4763
+ * @public
4197
4764
  * <p>Information about the process and any required context values for a specific
4198
4765
  * finding</p>
4199
4766
  */
@@ -4206,63 +4773,78 @@ export interface Service {
4206
4773
  */
4207
4774
  export interface Finding {
4208
4775
  /**
4776
+ * @public
4209
4777
  * <p>The ID of the account in which the finding was generated.</p>
4210
4778
  */
4211
4779
  AccountId: string | undefined;
4212
4780
  /**
4781
+ * @public
4213
4782
  * <p>The ARN of the finding.</p>
4214
4783
  */
4215
4784
  Arn: string | undefined;
4216
4785
  /**
4786
+ * @public
4217
4787
  * <p>The confidence score for the finding.</p>
4218
4788
  */
4219
4789
  Confidence?: number;
4220
4790
  /**
4791
+ * @public
4221
4792
  * <p>The time and date when the finding was created.</p>
4222
4793
  */
4223
4794
  CreatedAt: string | undefined;
4224
4795
  /**
4796
+ * @public
4225
4797
  * <p>The description of the finding.</p>
4226
4798
  */
4227
4799
  Description?: string;
4228
4800
  /**
4801
+ * @public
4229
4802
  * <p>The ID of the finding.</p>
4230
4803
  */
4231
4804
  Id: string | undefined;
4232
4805
  /**
4806
+ * @public
4233
4807
  * <p>The partition associated with the finding.</p>
4234
4808
  */
4235
4809
  Partition?: string;
4236
4810
  /**
4811
+ * @public
4237
4812
  * <p>The Region where the finding was generated.</p>
4238
4813
  */
4239
4814
  Region: string | undefined;
4240
4815
  /**
4816
+ * @public
4241
4817
  * <p>Contains information about the Amazon Web Services resource associated with the activity that prompted
4242
4818
  * GuardDuty to generate a finding.</p>
4243
4819
  */
4244
4820
  Resource: Resource | undefined;
4245
4821
  /**
4822
+ * @public
4246
4823
  * <p>The version of the schema used for the finding.</p>
4247
4824
  */
4248
4825
  SchemaVersion: string | undefined;
4249
4826
  /**
4827
+ * @public
4250
4828
  * <p>Contains additional information about the generated finding.</p>
4251
4829
  */
4252
4830
  Service?: Service;
4253
4831
  /**
4832
+ * @public
4254
4833
  * <p>The severity of the finding.</p>
4255
4834
  */
4256
4835
  Severity: number | undefined;
4257
4836
  /**
4837
+ * @public
4258
4838
  * <p>The title of the finding.</p>
4259
4839
  */
4260
4840
  Title?: string;
4261
4841
  /**
4842
+ * @public
4262
4843
  * <p>The type of finding.</p>
4263
4844
  */
4264
4845
  Type: string | undefined;
4265
4846
  /**
4847
+ * @public
4266
4848
  * <p>The time and date when the finding was last updated.</p>
4267
4849
  */
4268
4850
  UpdatedAt: string | undefined;
@@ -4273,6 +4855,7 @@ export interface Finding {
4273
4855
  */
4274
4856
  export interface FindingStatistics {
4275
4857
  /**
4858
+ * @public
4276
4859
  * <p>Represents a map of severity to count statistics for a set of findings.</p>
4277
4860
  */
4278
4861
  CountBySeverity?: Record<string, number>;
@@ -4293,6 +4876,7 @@ export type FindingStatisticType = (typeof FindingStatisticType)[keyof typeof Fi
4293
4876
  */
4294
4877
  export interface GetAdministratorAccountRequest {
4295
4878
  /**
4879
+ * @public
4296
4880
  * <p>The unique ID of the detector of the GuardDuty member account.</p>
4297
4881
  */
4298
4882
  DetectorId: string | undefined;
@@ -4302,6 +4886,7 @@ export interface GetAdministratorAccountRequest {
4302
4886
  */
4303
4887
  export interface GetAdministratorAccountResponse {
4304
4888
  /**
4889
+ * @public
4305
4890
  * <p>The administrator account details.</p>
4306
4891
  */
4307
4892
  Administrator: Administrator | undefined;
@@ -4311,14 +4896,17 @@ export interface GetAdministratorAccountResponse {
4311
4896
  */
4312
4897
  export interface GetCoverageStatisticsRequest {
4313
4898
  /**
4899
+ * @public
4314
4900
  * <p>The unique ID of the GuardDuty detector associated to the coverage statistics.</p>
4315
4901
  */
4316
4902
  DetectorId: string | undefined;
4317
4903
  /**
4904
+ * @public
4318
4905
  * <p>Represents the criteria used to filter the coverage statistics</p>
4319
4906
  */
4320
4907
  FilterCriteria?: CoverageFilterCriteria;
4321
4908
  /**
4909
+ * @public
4322
4910
  * <p>Represents the statistics type used to aggregate the coverage details.</p>
4323
4911
  */
4324
4912
  StatisticsType: (CoverageStatisticsType | string)[] | undefined;
@@ -4328,6 +4916,7 @@ export interface GetCoverageStatisticsRequest {
4328
4916
  */
4329
4917
  export interface GetCoverageStatisticsResponse {
4330
4918
  /**
4919
+ * @public
4331
4920
  * <p>Represents the count aggregated by the <code>statusCode</code> and
4332
4921
  * <code>resourceType</code>.</p>
4333
4922
  */
@@ -4338,6 +4927,7 @@ export interface GetCoverageStatisticsResponse {
4338
4927
  */
4339
4928
  export interface GetDetectorRequest {
4340
4929
  /**
4930
+ * @public
4341
4931
  * <p>The unique ID of the detector that you want to get.</p>
4342
4932
  */
4343
4933
  DetectorId: string | undefined;
@@ -4347,36 +4937,44 @@ export interface GetDetectorRequest {
4347
4937
  */
4348
4938
  export interface GetDetectorResponse {
4349
4939
  /**
4940
+ * @public
4350
4941
  * <p>The timestamp of when the detector was created.</p>
4351
4942
  */
4352
4943
  CreatedAt?: string;
4353
4944
  /**
4945
+ * @public
4354
4946
  * <p>The publishing frequency of the finding.</p>
4355
4947
  */
4356
4948
  FindingPublishingFrequency?: FindingPublishingFrequency | string;
4357
4949
  /**
4950
+ * @public
4358
4951
  * <p>The GuardDuty service role.</p>
4359
4952
  */
4360
4953
  ServiceRole: string | undefined;
4361
4954
  /**
4955
+ * @public
4362
4956
  * <p>The detector status.</p>
4363
4957
  */
4364
4958
  Status: DetectorStatus | string | undefined;
4365
4959
  /**
4960
+ * @public
4366
4961
  * <p>The last-updated timestamp for the detector.</p>
4367
4962
  */
4368
4963
  UpdatedAt?: string;
4369
4964
  /**
4965
+ * @public
4370
4966
  * @deprecated
4371
4967
  *
4372
4968
  * <p>Describes which data sources are enabled for the detector.</p>
4373
4969
  */
4374
4970
  DataSources?: DataSourceConfigurationsResult;
4375
4971
  /**
4972
+ * @public
4376
4973
  * <p>The tags of the detector resource.</p>
4377
4974
  */
4378
4975
  Tags?: Record<string, string>;
4379
4976
  /**
4977
+ * @public
4380
4978
  * <p>Describes the features that have been enabled for the detector.</p>
4381
4979
  */
4382
4980
  Features?: DetectorFeatureConfigurationResult[];
@@ -4386,10 +4984,12 @@ export interface GetDetectorResponse {
4386
4984
  */
4387
4985
  export interface GetFilterRequest {
4388
4986
  /**
4987
+ * @public
4389
4988
  * <p>The unique ID of the detector that the filter is associated with.</p>
4390
4989
  */
4391
4990
  DetectorId: string | undefined;
4392
4991
  /**
4992
+ * @public
4393
4993
  * <p>The name of the filter you want to get.</p>
4394
4994
  */
4395
4995
  FilterName: string | undefined;
@@ -4399,27 +4999,33 @@ export interface GetFilterRequest {
4399
4999
  */
4400
5000
  export interface GetFilterResponse {
4401
5001
  /**
5002
+ * @public
4402
5003
  * <p>The name of the filter.</p>
4403
5004
  */
4404
5005
  Name: string | undefined;
4405
5006
  /**
5007
+ * @public
4406
5008
  * <p>The description of the filter.</p>
4407
5009
  */
4408
5010
  Description?: string;
4409
5011
  /**
5012
+ * @public
4410
5013
  * <p>Specifies the action that is to be applied to the findings that match the filter.</p>
4411
5014
  */
4412
5015
  Action: FilterAction | string | undefined;
4413
5016
  /**
5017
+ * @public
4414
5018
  * <p>Specifies the position of the filter in the list of current filters. Also specifies the
4415
5019
  * order in which this filter is applied to the findings.</p>
4416
5020
  */
4417
5021
  Rank?: number;
4418
5022
  /**
5023
+ * @public
4419
5024
  * <p>Represents the criteria to be used in the filter for querying findings.</p>
4420
5025
  */
4421
5026
  FindingCriteria: FindingCriteria | undefined;
4422
5027
  /**
5028
+ * @public
4423
5029
  * <p>The tags of the filter resource.</p>
4424
5030
  */
4425
5031
  Tags?: Record<string, string>;
@@ -4429,15 +5035,18 @@ export interface GetFilterResponse {
4429
5035
  */
4430
5036
  export interface GetFindingsRequest {
4431
5037
  /**
5038
+ * @public
4432
5039
  * <p>The ID of the detector that specifies the GuardDuty service whose findings you want to
4433
5040
  * retrieve.</p>
4434
5041
  */
4435
5042
  DetectorId: string | undefined;
4436
5043
  /**
5044
+ * @public
4437
5045
  * <p>The IDs of the findings that you want to retrieve.</p>
4438
5046
  */
4439
5047
  FindingIds: string[] | undefined;
4440
5048
  /**
5049
+ * @public
4441
5050
  * <p>Represents the criteria used for sorting findings.</p>
4442
5051
  */
4443
5052
  SortCriteria?: SortCriteria;
@@ -4447,6 +5056,7 @@ export interface GetFindingsRequest {
4447
5056
  */
4448
5057
  export interface GetFindingsResponse {
4449
5058
  /**
5059
+ * @public
4450
5060
  * <p>A list of findings.</p>
4451
5061
  */
4452
5062
  Findings: Finding[] | undefined;
@@ -4456,15 +5066,18 @@ export interface GetFindingsResponse {
4456
5066
  */
4457
5067
  export interface GetFindingsStatisticsRequest {
4458
5068
  /**
5069
+ * @public
4459
5070
  * <p>The ID of the detector that specifies the GuardDuty service whose findings' statistics you
4460
5071
  * want to retrieve.</p>
4461
5072
  */
4462
5073
  DetectorId: string | undefined;
4463
5074
  /**
5075
+ * @public
4464
5076
  * <p>The types of finding statistics to retrieve.</p>
4465
5077
  */
4466
5078
  FindingStatisticTypes: (FindingStatisticType | string)[] | undefined;
4467
5079
  /**
5080
+ * @public
4468
5081
  * <p>Represents the criteria that is used for querying findings.</p>
4469
5082
  */
4470
5083
  FindingCriteria?: FindingCriteria;
@@ -4474,6 +5087,7 @@ export interface GetFindingsStatisticsRequest {
4474
5087
  */
4475
5088
  export interface GetFindingsStatisticsResponse {
4476
5089
  /**
5090
+ * @public
4477
5091
  * <p>The finding statistics object.</p>
4478
5092
  */
4479
5093
  FindingStatistics: FindingStatistics | undefined;
@@ -4488,6 +5102,7 @@ export interface GetInvitationsCountRequest {
4488
5102
  */
4489
5103
  export interface GetInvitationsCountResponse {
4490
5104
  /**
5105
+ * @public
4491
5106
  * <p>The number of received invitations.</p>
4492
5107
  */
4493
5108
  InvitationsCount?: number;
@@ -4497,10 +5112,12 @@ export interface GetInvitationsCountResponse {
4497
5112
  */
4498
5113
  export interface GetIPSetRequest {
4499
5114
  /**
5115
+ * @public
4500
5116
  * <p>The unique ID of the detector that the IPSet is associated with.</p>
4501
5117
  */
4502
5118
  DetectorId: string | undefined;
4503
5119
  /**
5120
+ * @public
4504
5121
  * <p>The unique ID of the IPSet to retrieve.</p>
4505
5122
  */
4506
5123
  IpSetId: string | undefined;
@@ -4527,22 +5144,27 @@ export type IpSetStatus = (typeof IpSetStatus)[keyof typeof IpSetStatus];
4527
5144
  */
4528
5145
  export interface GetIPSetResponse {
4529
5146
  /**
5147
+ * @public
4530
5148
  * <p>The user-friendly name for the IPSet.</p>
4531
5149
  */
4532
5150
  Name: string | undefined;
4533
5151
  /**
5152
+ * @public
4534
5153
  * <p>The format of the file that contains the IPSet.</p>
4535
5154
  */
4536
5155
  Format: IpSetFormat | string | undefined;
4537
5156
  /**
5157
+ * @public
4538
5158
  * <p>The URI of the file that contains the IPSet.</p>
4539
5159
  */
4540
5160
  Location: string | undefined;
4541
5161
  /**
5162
+ * @public
4542
5163
  * <p>The status of IPSet file that was uploaded.</p>
4543
5164
  */
4544
5165
  Status: IpSetStatus | string | undefined;
4545
5166
  /**
5167
+ * @public
4546
5168
  * <p>The tags of the IPSet resource.</p>
4547
5169
  */
4548
5170
  Tags?: Record<string, string>;
@@ -4552,6 +5174,7 @@ export interface GetIPSetResponse {
4552
5174
  */
4553
5175
  export interface GetMalwareScanSettingsRequest {
4554
5176
  /**
5177
+ * @public
4555
5178
  * <p>The unique ID of the detector that the scan setting is associated with.</p>
4556
5179
  */
4557
5180
  DetectorId: string | undefined;
@@ -4573,11 +5196,13 @@ export type ScanCriterionKey = (typeof ScanCriterionKey)[keyof typeof ScanCriter
4573
5196
  */
4574
5197
  export interface ScanConditionPair {
4575
5198
  /**
5199
+ * @public
4576
5200
  * <p>Represents <i>key</i>
4577
5201
  * <b></b> in the map condition.</p>
4578
5202
  */
4579
5203
  Key: string | undefined;
4580
5204
  /**
5205
+ * @public
4581
5206
  * <p>Represents optional <i>value</i>
4582
5207
  * <b></b> in the map
4583
5208
  * condition. If not specified, only <i>key</i>
@@ -4592,6 +5217,7 @@ export interface ScanConditionPair {
4592
5217
  */
4593
5218
  export interface ScanCondition {
4594
5219
  /**
5220
+ * @public
4595
5221
  * <p>Represents an <i>mapEqual</i>
4596
5222
  * <b></b> condition to be applied
4597
5223
  * to a single field when triggering for malware scan.</p>
@@ -4605,11 +5231,13 @@ export interface ScanCondition {
4605
5231
  */
4606
5232
  export interface ScanResourceCriteria {
4607
5233
  /**
5234
+ * @public
4608
5235
  * <p>Represents condition that when matched will allow a malware scan for a certain
4609
5236
  * resource.</p>
4610
5237
  */
4611
5238
  Include?: Record<string, ScanCondition>;
4612
5239
  /**
5240
+ * @public
4613
5241
  * <p>Represents condition that when matched will prevent a malware scan for a certain
4614
5242
  * resource.</p>
4615
5243
  */
@@ -4620,10 +5248,12 @@ export interface ScanResourceCriteria {
4620
5248
  */
4621
5249
  export interface GetMalwareScanSettingsResponse {
4622
5250
  /**
5251
+ * @public
4623
5252
  * <p>Represents the criteria to be used in the filter for scanning resources.</p>
4624
5253
  */
4625
5254
  ScanResourceCriteria?: ScanResourceCriteria;
4626
5255
  /**
5256
+ * @public
4627
5257
  * <p>An enum value representing possible snapshot preservation settings.</p>
4628
5258
  */
4629
5259
  EbsSnapshotPreservation?: EbsSnapshotPreservation | string;
@@ -4633,6 +5263,7 @@ export interface GetMalwareScanSettingsResponse {
4633
5263
  */
4634
5264
  export interface GetMasterAccountRequest {
4635
5265
  /**
5266
+ * @public
4636
5267
  * <p>The unique ID of the detector of the GuardDuty member account.</p>
4637
5268
  */
4638
5269
  DetectorId: string | undefined;
@@ -4643,18 +5274,22 @@ export interface GetMasterAccountRequest {
4643
5274
  */
4644
5275
  export interface Master {
4645
5276
  /**
5277
+ * @public
4646
5278
  * <p>The ID of the account used as the administrator account.</p>
4647
5279
  */
4648
5280
  AccountId?: string;
4649
5281
  /**
5282
+ * @public
4650
5283
  * <p>The value used to validate the administrator account to the member account.</p>
4651
5284
  */
4652
5285
  InvitationId?: string;
4653
5286
  /**
5287
+ * @public
4654
5288
  * <p>The status of the relationship between the administrator and member accounts.</p>
4655
5289
  */
4656
5290
  RelationshipStatus?: string;
4657
5291
  /**
5292
+ * @public
4658
5293
  * <p>The timestamp when the invitation was sent.</p>
4659
5294
  */
4660
5295
  InvitedAt?: string;
@@ -4664,6 +5299,7 @@ export interface Master {
4664
5299
  */
4665
5300
  export interface GetMasterAccountResponse {
4666
5301
  /**
5302
+ * @public
4667
5303
  * <p>The administrator account details.</p>
4668
5304
  */
4669
5305
  Master: Master | undefined;
@@ -4673,10 +5309,12 @@ export interface GetMasterAccountResponse {
4673
5309
  */
4674
5310
  export interface GetMemberDetectorsRequest {
4675
5311
  /**
5312
+ * @public
4676
5313
  * <p>The detector ID for the administrator account.</p>
4677
5314
  */
4678
5315
  DetectorId: string | undefined;
4679
5316
  /**
5317
+ * @public
4680
5318
  * <p>The account ID of the member account.</p>
4681
5319
  */
4682
5320
  AccountIds: string[] | undefined;
@@ -4687,16 +5325,19 @@ export interface GetMemberDetectorsRequest {
4687
5325
  */
4688
5326
  export interface MemberAdditionalConfigurationResult {
4689
5327
  /**
5328
+ * @public
4690
5329
  * <p>Indicates the name of the additional configuration that is set for the member
4691
5330
  * account.</p>
4692
5331
  */
4693
5332
  Name?: OrgFeatureAdditionalConfiguration | string;
4694
5333
  /**
5334
+ * @public
4695
5335
  * <p>Indicates the status of the additional configuration that is set for the member
4696
5336
  * account.</p>
4697
5337
  */
4698
5338
  Status?: FeatureStatus | string;
4699
5339
  /**
5340
+ * @public
4700
5341
  * <p>The timestamp at which the additional configuration was set for the member account. This
4701
5342
  * is in UTC format.</p>
4702
5343
  */
@@ -4708,18 +5349,22 @@ export interface MemberAdditionalConfigurationResult {
4708
5349
  */
4709
5350
  export interface MemberFeaturesConfigurationResult {
4710
5351
  /**
5352
+ * @public
4711
5353
  * <p>Indicates the name of the feature that is enabled for the detector.</p>
4712
5354
  */
4713
5355
  Name?: OrgFeature | string;
4714
5356
  /**
5357
+ * @public
4715
5358
  * <p>Indicates the status of the feature that is enabled for the detector.</p>
4716
5359
  */
4717
5360
  Status?: FeatureStatus | string;
4718
5361
  /**
5362
+ * @public
4719
5363
  * <p>The timestamp at which the feature object was updated.</p>
4720
5364
  */
4721
5365
  UpdatedAt?: Date;
4722
5366
  /**
5367
+ * @public
4723
5368
  * <p>Indicates the additional configuration of the feature that is configured for the member
4724
5369
  * account.</p>
4725
5370
  */
@@ -4731,16 +5376,19 @@ export interface MemberFeaturesConfigurationResult {
4731
5376
  */
4732
5377
  export interface MemberDataSourceConfiguration {
4733
5378
  /**
5379
+ * @public
4734
5380
  * <p>The account ID for the member account.</p>
4735
5381
  */
4736
5382
  AccountId: string | undefined;
4737
5383
  /**
5384
+ * @public
4738
5385
  * @deprecated
4739
5386
  *
4740
5387
  * <p>Contains information on the status of data sources for the account.</p>
4741
5388
  */
4742
5389
  DataSources?: DataSourceConfigurationsResult;
4743
5390
  /**
5391
+ * @public
4744
5392
  * <p>Contains information about the status of the features for the member account.</p>
4745
5393
  */
4746
5394
  Features?: MemberFeaturesConfigurationResult[];
@@ -4750,10 +5398,12 @@ export interface MemberDataSourceConfiguration {
4750
5398
  */
4751
5399
  export interface GetMemberDetectorsResponse {
4752
5400
  /**
5401
+ * @public
4753
5402
  * <p>An object that describes which data sources are enabled for a member account.</p>
4754
5403
  */
4755
5404
  MemberDataSourceConfigurations: MemberDataSourceConfiguration[] | undefined;
4756
5405
  /**
5406
+ * @public
4757
5407
  * <p>A list of member account IDs that were unable to be processed along with an explanation
4758
5408
  * for why they were not processed.</p>
4759
5409
  */
@@ -4764,11 +5414,13 @@ export interface GetMemberDetectorsResponse {
4764
5414
  */
4765
5415
  export interface GetMembersRequest {
4766
5416
  /**
5417
+ * @public
4767
5418
  * <p>The unique ID of the detector of the GuardDuty account whose members you want to
4768
5419
  * retrieve.</p>
4769
5420
  */
4770
5421
  DetectorId: string | undefined;
4771
5422
  /**
5423
+ * @public
4772
5424
  * <p>A list of account IDs of the GuardDuty member accounts that you want to describe.</p>
4773
5425
  */
4774
5426
  AccountIds: string[] | undefined;
@@ -4779,34 +5431,42 @@ export interface GetMembersRequest {
4779
5431
  */
4780
5432
  export interface Member {
4781
5433
  /**
5434
+ * @public
4782
5435
  * <p>The ID of the member account.</p>
4783
5436
  */
4784
5437
  AccountId: string | undefined;
4785
5438
  /**
5439
+ * @public
4786
5440
  * <p>The detector ID of the member account.</p>
4787
5441
  */
4788
5442
  DetectorId?: string;
4789
5443
  /**
5444
+ * @public
4790
5445
  * <p>The administrator account ID.</p>
4791
5446
  */
4792
5447
  MasterId: string | undefined;
4793
5448
  /**
5449
+ * @public
4794
5450
  * <p>The email address of the member account.</p>
4795
5451
  */
4796
5452
  Email: string | undefined;
4797
5453
  /**
5454
+ * @public
4798
5455
  * <p>The status of the relationship between the member and the administrator.</p>
4799
5456
  */
4800
5457
  RelationshipStatus: string | undefined;
4801
5458
  /**
5459
+ * @public
4802
5460
  * <p>The timestamp when the invitation was sent.</p>
4803
5461
  */
4804
5462
  InvitedAt?: string;
4805
5463
  /**
5464
+ * @public
4806
5465
  * <p>The last-updated timestamp of the member.</p>
4807
5466
  */
4808
5467
  UpdatedAt: string | undefined;
4809
5468
  /**
5469
+ * @public
4810
5470
  * <p>The administrator account ID.</p>
4811
5471
  */
4812
5472
  AdministratorId?: string;
@@ -4816,10 +5476,12 @@ export interface Member {
4816
5476
  */
4817
5477
  export interface GetMembersResponse {
4818
5478
  /**
5479
+ * @public
4819
5480
  * <p>A list of members.</p>
4820
5481
  */
4821
5482
  Members: Member[] | undefined;
4822
5483
  /**
5484
+ * @public
4823
5485
  * <p>A list of objects that contain the unprocessed account and a result string that explains
4824
5486
  * why it was unprocessed.</p>
4825
5487
  */
@@ -4830,10 +5492,12 @@ export interface GetMembersResponse {
4830
5492
  */
4831
5493
  export interface GetRemainingFreeTrialDaysRequest {
4832
5494
  /**
5495
+ * @public
4833
5496
  * <p>The unique ID of the detector of the GuardDuty member account.</p>
4834
5497
  */
4835
5498
  DetectorId: string | undefined;
4836
5499
  /**
5500
+ * @public
4837
5501
  * <p>A list of account identifiers of the GuardDuty member account.</p>
4838
5502
  */
4839
5503
  AccountIds?: string[];
@@ -4843,11 +5507,13 @@ export interface GetRemainingFreeTrialDaysRequest {
4843
5507
  */
4844
5508
  export interface GetRemainingFreeTrialDaysResponse {
4845
5509
  /**
5510
+ * @public
4846
5511
  * <p>The member accounts which were included in a request and were processed
4847
5512
  * successfully.</p>
4848
5513
  */
4849
5514
  Accounts?: AccountFreeTrialInfo[];
4850
5515
  /**
5516
+ * @public
4851
5517
  * <p>The member account that was included in a request but for which the request could not be
4852
5518
  * processed.</p>
4853
5519
  */
@@ -4858,10 +5524,12 @@ export interface GetRemainingFreeTrialDaysResponse {
4858
5524
  */
4859
5525
  export interface GetThreatIntelSetRequest {
4860
5526
  /**
5527
+ * @public
4861
5528
  * <p>The unique ID of the detector that the threatIntelSet is associated with.</p>
4862
5529
  */
4863
5530
  DetectorId: string | undefined;
4864
5531
  /**
5532
+ * @public
4865
5533
  * <p>The unique ID of the threatIntelSet that you want to get.</p>
4866
5534
  */
4867
5535
  ThreatIntelSetId: string | undefined;
@@ -4888,23 +5556,28 @@ export type ThreatIntelSetStatus = (typeof ThreatIntelSetStatus)[keyof typeof Th
4888
5556
  */
4889
5557
  export interface GetThreatIntelSetResponse {
4890
5558
  /**
5559
+ * @public
4891
5560
  * <p>A user-friendly ThreatIntelSet name displayed in all findings that are generated by
4892
5561
  * activity that involves IP addresses included in this ThreatIntelSet.</p>
4893
5562
  */
4894
5563
  Name: string | undefined;
4895
5564
  /**
5565
+ * @public
4896
5566
  * <p>The format of the threatIntelSet.</p>
4897
5567
  */
4898
5568
  Format: ThreatIntelSetFormat | string | undefined;
4899
5569
  /**
5570
+ * @public
4900
5571
  * <p>The URI of the file that contains the ThreatIntelSet. </p>
4901
5572
  */
4902
5573
  Location: string | undefined;
4903
5574
  /**
5575
+ * @public
4904
5576
  * <p>The status of threatIntelSet file uploaded.</p>
4905
5577
  */
4906
5578
  Status: ThreatIntelSetStatus | string | undefined;
4907
5579
  /**
5580
+ * @public
4908
5581
  * <p>The tags of the threat list resource.</p>
4909
5582
  */
4910
5583
  Tags?: Record<string, string>;
@@ -4934,21 +5607,25 @@ export type UsageFeature = (typeof UsageFeature)[keyof typeof UsageFeature];
4934
5607
  */
4935
5608
  export interface UsageCriteria {
4936
5609
  /**
5610
+ * @public
4937
5611
  * <p>The account IDs to aggregate usage statistics from.</p>
4938
5612
  */
4939
5613
  AccountIds?: string[];
4940
5614
  /**
5615
+ * @public
4941
5616
  * @deprecated
4942
5617
  *
4943
5618
  * <p>The data sources to aggregate usage statistics from.</p>
4944
5619
  */
4945
5620
  DataSources?: (DataSource | string)[];
4946
5621
  /**
5622
+ * @public
4947
5623
  * <p>The resources to aggregate usage statistics from. Only accepts exact resource
4948
5624
  * names.</p>
4949
5625
  */
4950
5626
  Resources?: string[];
4951
5627
  /**
5628
+ * @public
4952
5629
  * <p>The features to aggregate usage statistics from.</p>
4953
5630
  */
4954
5631
  Features?: (UsageFeature | string)[];
@@ -4973,28 +5650,34 @@ export type UsageStatisticType = (typeof UsageStatisticType)[keyof typeof UsageS
4973
5650
  */
4974
5651
  export interface GetUsageStatisticsRequest {
4975
5652
  /**
5653
+ * @public
4976
5654
  * <p>The ID of the detector that specifies the GuardDuty service whose usage statistics you
4977
5655
  * want to retrieve.</p>
4978
5656
  */
4979
5657
  DetectorId: string | undefined;
4980
5658
  /**
5659
+ * @public
4981
5660
  * <p>The type of usage statistics to retrieve.</p>
4982
5661
  */
4983
5662
  UsageStatisticType: UsageStatisticType | string | undefined;
4984
5663
  /**
5664
+ * @public
4985
5665
  * <p>Represents the criteria used for querying usage.</p>
4986
5666
  */
4987
5667
  UsageCriteria: UsageCriteria | undefined;
4988
5668
  /**
5669
+ * @public
4989
5670
  * <p>The currency unit you would like to view your usage statistics in. Current valid values
4990
5671
  * are USD.</p>
4991
5672
  */
4992
5673
  Unit?: string;
4993
5674
  /**
5675
+ * @public
4994
5676
  * <p>The maximum number of results to return in the response.</p>
4995
5677
  */
4996
5678
  MaxResults?: number;
4997
5679
  /**
5680
+ * @public
4998
5681
  * <p>A token to use for paginating results that are returned in the response. Set the value of
4999
5682
  * this parameter to null for the first request to a list action. For subsequent calls, use the
5000
5683
  * NextToken value returned from the previous request to continue listing results after the first
@@ -5008,10 +5691,12 @@ export interface GetUsageStatisticsRequest {
5008
5691
  */
5009
5692
  export interface Total {
5010
5693
  /**
5694
+ * @public
5011
5695
  * <p>The total usage.</p>
5012
5696
  */
5013
5697
  Amount?: string;
5014
5698
  /**
5699
+ * @public
5015
5700
  * <p>The currency unit that the amount is given in.</p>
5016
5701
  */
5017
5702
  Unit?: string;
@@ -5022,10 +5707,12 @@ export interface Total {
5022
5707
  */
5023
5708
  export interface UsageAccountResult {
5024
5709
  /**
5710
+ * @public
5025
5711
  * <p>The Account ID that generated usage.</p>
5026
5712
  */
5027
5713
  AccountId?: string;
5028
5714
  /**
5715
+ * @public
5029
5716
  * <p>Represents the total of usage for the Account ID.</p>
5030
5717
  */
5031
5718
  Total?: Total;
@@ -5036,10 +5723,12 @@ export interface UsageAccountResult {
5036
5723
  */
5037
5724
  export interface UsageDataSourceResult {
5038
5725
  /**
5726
+ * @public
5039
5727
  * <p>The data source type that generated usage.</p>
5040
5728
  */
5041
5729
  DataSource?: DataSource | string;
5042
5730
  /**
5731
+ * @public
5043
5732
  * <p>Represents the total of usage for the specified data source.</p>
5044
5733
  */
5045
5734
  Total?: Total;
@@ -5050,10 +5739,12 @@ export interface UsageDataSourceResult {
5050
5739
  */
5051
5740
  export interface UsageFeatureResult {
5052
5741
  /**
5742
+ * @public
5053
5743
  * <p>The feature that generated the usage cost.</p>
5054
5744
  */
5055
5745
  Feature?: UsageFeature | string;
5056
5746
  /**
5747
+ * @public
5057
5748
  * <p>Contains the total usage with the corresponding currency unit for that value.</p>
5058
5749
  */
5059
5750
  Total?: Total;
@@ -5064,10 +5755,12 @@ export interface UsageFeatureResult {
5064
5755
  */
5065
5756
  export interface UsageResourceResult {
5066
5757
  /**
5758
+ * @public
5067
5759
  * <p>The Amazon Web Services resource that generated usage.</p>
5068
5760
  */
5069
5761
  Resource?: string;
5070
5762
  /**
5763
+ * @public
5071
5764
  * <p>Represents the sum total of usage for the specified resource type.</p>
5072
5765
  */
5073
5766
  Total?: Total;
@@ -5079,23 +5772,28 @@ export interface UsageResourceResult {
5079
5772
  */
5080
5773
  export interface UsageStatistics {
5081
5774
  /**
5775
+ * @public
5082
5776
  * <p>The usage statistic sum organized by account ID.</p>
5083
5777
  */
5084
5778
  SumByAccount?: UsageAccountResult[];
5085
5779
  /**
5780
+ * @public
5086
5781
  * <p>The usage statistic sum organized by on data source.</p>
5087
5782
  */
5088
5783
  SumByDataSource?: UsageDataSourceResult[];
5089
5784
  /**
5785
+ * @public
5090
5786
  * <p>The usage statistic sum organized by resource.</p>
5091
5787
  */
5092
5788
  SumByResource?: UsageResourceResult[];
5093
5789
  /**
5790
+ * @public
5094
5791
  * <p>Lists the top 50 resources that have generated the most GuardDuty usage, in order from
5095
5792
  * most to least expensive.</p>
5096
5793
  */
5097
5794
  TopResources?: UsageResourceResult[];
5098
5795
  /**
5796
+ * @public
5099
5797
  * <p>The usage statistic sum organized by feature.</p>
5100
5798
  */
5101
5799
  SumByFeature?: UsageFeatureResult[];
@@ -5105,11 +5803,13 @@ export interface UsageStatistics {
5105
5803
  */
5106
5804
  export interface GetUsageStatisticsResponse {
5107
5805
  /**
5806
+ * @public
5108
5807
  * <p>The usage statistics object. If a UsageStatisticType was provided, the objects
5109
5808
  * representing other types will be null.</p>
5110
5809
  */
5111
5810
  UsageStatistics?: UsageStatistics;
5112
5811
  /**
5812
+ * @public
5113
5813
  * <p>The pagination parameter to be used on the next list operation to retrieve more
5114
5814
  * items.</p>
5115
5815
  */
@@ -5120,21 +5820,25 @@ export interface GetUsageStatisticsResponse {
5120
5820
  */
5121
5821
  export interface InviteMembersRequest {
5122
5822
  /**
5823
+ * @public
5123
5824
  * <p>The unique ID of the detector of the GuardDuty account that you want to invite members
5124
5825
  * with.</p>
5125
5826
  */
5126
5827
  DetectorId: string | undefined;
5127
5828
  /**
5829
+ * @public
5128
5830
  * <p>A list of account IDs of the accounts that you want to invite to GuardDuty as
5129
5831
  * members.</p>
5130
5832
  */
5131
5833
  AccountIds: string[] | undefined;
5132
5834
  /**
5835
+ * @public
5133
5836
  * <p>A Boolean value that specifies whether you want to disable email notification to the
5134
5837
  * accounts that you are inviting to GuardDuty as members.</p>
5135
5838
  */
5136
5839
  DisableEmailNotification?: boolean;
5137
5840
  /**
5841
+ * @public
5138
5842
  * <p>The invitation message that you want to send to the accounts that you're inviting to
5139
5843
  * GuardDuty as members.</p>
5140
5844
  */
@@ -5145,6 +5849,7 @@ export interface InviteMembersRequest {
5145
5849
  */
5146
5850
  export interface InviteMembersResponse {
5147
5851
  /**
5852
+ * @public
5148
5853
  * <p>A list of objects that contain the unprocessed account and a result string that explains
5149
5854
  * why it was unprocessed.</p>
5150
5855
  */
@@ -5155,10 +5860,12 @@ export interface InviteMembersResponse {
5155
5860
  */
5156
5861
  export interface ListCoverageRequest {
5157
5862
  /**
5863
+ * @public
5158
5864
  * <p>The unique ID of the detector whose coverage details you want to retrieve.</p>
5159
5865
  */
5160
5866
  DetectorId: string | undefined;
5161
5867
  /**
5868
+ * @public
5162
5869
  * <p>A token to use for paginating results that are returned in the response. Set the value of
5163
5870
  * this parameter to null for the first request to a list action. For subsequent calls, use the
5164
5871
  * NextToken value returned from the previous request to continue listing results after the first
@@ -5166,14 +5873,17 @@ export interface ListCoverageRequest {
5166
5873
  */
5167
5874
  NextToken?: string;
5168
5875
  /**
5876
+ * @public
5169
5877
  * <p>The maximum number of results to return in the response.</p>
5170
5878
  */
5171
5879
  MaxResults?: number;
5172
5880
  /**
5881
+ * @public
5173
5882
  * <p>Represents the criteria used to filter the coverage details.</p>
5174
5883
  */
5175
5884
  FilterCriteria?: CoverageFilterCriteria;
5176
5885
  /**
5886
+ * @public
5177
5887
  * <p>Represents the criteria used to sort the coverage details.</p>
5178
5888
  */
5179
5889
  SortCriteria?: CoverageSortCriteria;
@@ -5183,10 +5893,12 @@ export interface ListCoverageRequest {
5183
5893
  */
5184
5894
  export interface ListCoverageResponse {
5185
5895
  /**
5896
+ * @public
5186
5897
  * <p>A list of resources and their attributes providing cluster details.</p>
5187
5898
  */
5188
5899
  Resources: CoverageResource[] | undefined;
5189
5900
  /**
5901
+ * @public
5190
5902
  * <p>The pagination parameter to be used on the next list operation to retrieve more
5191
5903
  * items.</p>
5192
5904
  */
@@ -5197,11 +5909,13 @@ export interface ListCoverageResponse {
5197
5909
  */
5198
5910
  export interface ListDetectorsRequest {
5199
5911
  /**
5912
+ * @public
5200
5913
  * <p>You can use this parameter to indicate the maximum number of items that you want in the
5201
5914
  * response. The default value is 50. The maximum value is 50.</p>
5202
5915
  */
5203
5916
  MaxResults?: number;
5204
5917
  /**
5918
+ * @public
5205
5919
  * <p>You can use this parameter when paginating results. Set the value of this parameter to
5206
5920
  * null on your first call to the list action. For subsequent calls to the action, fill nextToken
5207
5921
  * in the request with the value of NextToken from the previous response to continue listing
@@ -5214,10 +5928,12 @@ export interface ListDetectorsRequest {
5214
5928
  */
5215
5929
  export interface ListDetectorsResponse {
5216
5930
  /**
5931
+ * @public
5217
5932
  * <p>A list of detector IDs.</p>
5218
5933
  */
5219
5934
  DetectorIds: string[] | undefined;
5220
5935
  /**
5936
+ * @public
5221
5937
  * <p>The pagination parameter to be used on the next list operation to retrieve more
5222
5938
  * items.</p>
5223
5939
  */
@@ -5228,15 +5944,18 @@ export interface ListDetectorsResponse {
5228
5944
  */
5229
5945
  export interface ListFiltersRequest {
5230
5946
  /**
5947
+ * @public
5231
5948
  * <p>The unique ID of the detector that the filter is associated with.</p>
5232
5949
  */
5233
5950
  DetectorId: string | undefined;
5234
5951
  /**
5952
+ * @public
5235
5953
  * <p>You can use this parameter to indicate the maximum number of items that you want in the
5236
5954
  * response. The default value is 50. The maximum value is 50.</p>
5237
5955
  */
5238
5956
  MaxResults?: number;
5239
5957
  /**
5958
+ * @public
5240
5959
  * <p>You can use this parameter when paginating results. Set the value of this parameter to
5241
5960
  * null on your first call to the list action. For subsequent calls to the action, fill nextToken
5242
5961
  * in the request with the value of NextToken from the previous response to continue listing
@@ -5249,10 +5968,12 @@ export interface ListFiltersRequest {
5249
5968
  */
5250
5969
  export interface ListFiltersResponse {
5251
5970
  /**
5971
+ * @public
5252
5972
  * <p>A list of filter names.</p>
5253
5973
  */
5254
5974
  FilterNames: string[] | undefined;
5255
5975
  /**
5976
+ * @public
5256
5977
  * <p>The pagination parameter to be used on the next list operation to retrieve more
5257
5978
  * items.</p>
5258
5979
  */
@@ -5263,11 +5984,13 @@ export interface ListFiltersResponse {
5263
5984
  */
5264
5985
  export interface ListFindingsRequest {
5265
5986
  /**
5987
+ * @public
5266
5988
  * <p>The ID of the detector that specifies the GuardDuty service whose findings you want to
5267
5989
  * list.</p>
5268
5990
  */
5269
5991
  DetectorId: string | undefined;
5270
5992
  /**
5993
+ * @public
5271
5994
  * <p>Represents the criteria used for querying findings. Valid values include:</p>
5272
5995
  * <ul>
5273
5996
  * <li>
@@ -5422,15 +6145,18 @@ export interface ListFindingsRequest {
5422
6145
  */
5423
6146
  FindingCriteria?: FindingCriteria;
5424
6147
  /**
6148
+ * @public
5425
6149
  * <p>Represents the criteria used for sorting findings.</p>
5426
6150
  */
5427
6151
  SortCriteria?: SortCriteria;
5428
6152
  /**
6153
+ * @public
5429
6154
  * <p>You can use this parameter to indicate the maximum number of items you want in the
5430
6155
  * response. The default value is 50. The maximum value is 50.</p>
5431
6156
  */
5432
6157
  MaxResults?: number;
5433
6158
  /**
6159
+ * @public
5434
6160
  * <p>You can use this parameter when paginating results. Set the value of this parameter to
5435
6161
  * null on your first call to the list action. For subsequent calls to the action, fill nextToken
5436
6162
  * in the request with the value of NextToken from the previous response to continue listing
@@ -5443,10 +6169,12 @@ export interface ListFindingsRequest {
5443
6169
  */
5444
6170
  export interface ListFindingsResponse {
5445
6171
  /**
6172
+ * @public
5446
6173
  * <p>The IDs of the findings that you're listing.</p>
5447
6174
  */
5448
6175
  FindingIds: string[] | undefined;
5449
6176
  /**
6177
+ * @public
5450
6178
  * <p>The pagination parameter to be used on the next list operation to retrieve more
5451
6179
  * items.</p>
5452
6180
  */
@@ -5457,11 +6185,13 @@ export interface ListFindingsResponse {
5457
6185
  */
5458
6186
  export interface ListInvitationsRequest {
5459
6187
  /**
6188
+ * @public
5460
6189
  * <p>You can use this parameter to indicate the maximum number of items that you want in the
5461
6190
  * response. The default value is 50. The maximum value is 50.</p>
5462
6191
  */
5463
6192
  MaxResults?: number;
5464
6193
  /**
6194
+ * @public
5465
6195
  * <p>You can use this parameter when paginating results. Set the value of this parameter to
5466
6196
  * null on your first call to the list action. For subsequent calls to the action, fill nextToken
5467
6197
  * in the request with the value of NextToken from the previous response to continue listing
@@ -5475,19 +6205,23 @@ export interface ListInvitationsRequest {
5475
6205
  */
5476
6206
  export interface Invitation {
5477
6207
  /**
6208
+ * @public
5478
6209
  * <p>The ID of the account that the invitation was sent from.</p>
5479
6210
  */
5480
6211
  AccountId?: string;
5481
6212
  /**
6213
+ * @public
5482
6214
  * <p>The ID of the invitation. This value is used to validate the inviter account to the member
5483
6215
  * account.</p>
5484
6216
  */
5485
6217
  InvitationId?: string;
5486
6218
  /**
6219
+ * @public
5487
6220
  * <p>The status of the relationship between the inviter and invitee accounts.</p>
5488
6221
  */
5489
6222
  RelationshipStatus?: string;
5490
6223
  /**
6224
+ * @public
5491
6225
  * <p>The timestamp when the invitation was sent.</p>
5492
6226
  */
5493
6227
  InvitedAt?: string;
@@ -5497,10 +6231,12 @@ export interface Invitation {
5497
6231
  */
5498
6232
  export interface ListInvitationsResponse {
5499
6233
  /**
6234
+ * @public
5500
6235
  * <p>A list of invitation descriptions.</p>
5501
6236
  */
5502
6237
  Invitations?: Invitation[];
5503
6238
  /**
6239
+ * @public
5504
6240
  * <p>The pagination parameter to be used on the next list operation to retrieve more
5505
6241
  * items.</p>
5506
6242
  */
@@ -5511,15 +6247,18 @@ export interface ListInvitationsResponse {
5511
6247
  */
5512
6248
  export interface ListIPSetsRequest {
5513
6249
  /**
6250
+ * @public
5514
6251
  * <p>The unique ID of the detector that the IPSet is associated with.</p>
5515
6252
  */
5516
6253
  DetectorId: string | undefined;
5517
6254
  /**
6255
+ * @public
5518
6256
  * <p>You can use this parameter to indicate the maximum number of items you want in the
5519
6257
  * response. The default value is 50. The maximum value is 50.</p>
5520
6258
  */
5521
6259
  MaxResults?: number;
5522
6260
  /**
6261
+ * @public
5523
6262
  * <p>You can use this parameter when paginating results. Set the value of this parameter to
5524
6263
  * null on your first call to the list action. For subsequent calls to the action, fill nextToken
5525
6264
  * in the request with the value of NextToken from the previous response to continue listing
@@ -5532,10 +6271,12 @@ export interface ListIPSetsRequest {
5532
6271
  */
5533
6272
  export interface ListIPSetsResponse {
5534
6273
  /**
6274
+ * @public
5535
6275
  * <p>The IDs of the IPSet resources.</p>
5536
6276
  */
5537
6277
  IpSetIds: string[] | undefined;
5538
6278
  /**
6279
+ * @public
5539
6280
  * <p>The pagination parameter to be used on the next list operation to retrieve more
5540
6281
  * items.</p>
5541
6282
  */
@@ -5546,15 +6287,18 @@ export interface ListIPSetsResponse {
5546
6287
  */
5547
6288
  export interface ListMembersRequest {
5548
6289
  /**
6290
+ * @public
5549
6291
  * <p>The unique ID of the detector the member is associated with.</p>
5550
6292
  */
5551
6293
  DetectorId: string | undefined;
5552
6294
  /**
6295
+ * @public
5553
6296
  * <p>You can use this parameter to indicate the maximum number of items you want in the
5554
6297
  * response. The default value is 50. The maximum value is 50.</p>
5555
6298
  */
5556
6299
  MaxResults?: number;
5557
6300
  /**
6301
+ * @public
5558
6302
  * <p>You can use this parameter when paginating results. Set the value of this parameter to
5559
6303
  * null on your first call to the list action. For subsequent calls to the action, fill nextToken
5560
6304
  * in the request with the value of NextToken from the previous response to continue listing
@@ -5562,6 +6306,7 @@ export interface ListMembersRequest {
5562
6306
  */
5563
6307
  NextToken?: string;
5564
6308
  /**
6309
+ * @public
5565
6310
  * <p>Specifies whether to only return associated members or to return all members (including
5566
6311
  * members who haven't been invited yet or have been disassociated). Member accounts must have
5567
6312
  * been previously associated with the GuardDuty administrator account using <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html">
@@ -5576,10 +6321,12 @@ export interface ListMembersRequest {
5576
6321
  */
5577
6322
  export interface ListMembersResponse {
5578
6323
  /**
6324
+ * @public
5579
6325
  * <p>A list of members.</p>
5580
6326
  */
5581
6327
  Members?: Member[];
5582
6328
  /**
6329
+ * @public
5583
6330
  * <p>The pagination parameter to be used on the next list operation to retrieve more
5584
6331
  * items.</p>
5585
6332
  */
@@ -5590,10 +6337,12 @@ export interface ListMembersResponse {
5590
6337
  */
5591
6338
  export interface ListOrganizationAdminAccountsRequest {
5592
6339
  /**
6340
+ * @public
5593
6341
  * <p>The maximum number of results to return in the response.</p>
5594
6342
  */
5595
6343
  MaxResults?: number;
5596
6344
  /**
6345
+ * @public
5597
6346
  * <p>A token to use for paginating results that are returned in the response. Set the value of
5598
6347
  * this parameter to null for the first request to a list action. For subsequent calls, use the
5599
6348
  * <code>NextToken</code> value returned from the previous request to continue listing results
@@ -5606,10 +6355,12 @@ export interface ListOrganizationAdminAccountsRequest {
5606
6355
  */
5607
6356
  export interface ListOrganizationAdminAccountsResponse {
5608
6357
  /**
6358
+ * @public
5609
6359
  * <p>A list of accounts configured as GuardDuty delegated administrators.</p>
5610
6360
  */
5611
6361
  AdminAccounts?: AdminAccount[];
5612
6362
  /**
6363
+ * @public
5613
6364
  * <p>The pagination parameter to be used on the next list operation to retrieve more
5614
6365
  * items.</p>
5615
6366
  */
@@ -5620,14 +6371,17 @@ export interface ListOrganizationAdminAccountsResponse {
5620
6371
  */
5621
6372
  export interface ListPublishingDestinationsRequest {
5622
6373
  /**
6374
+ * @public
5623
6375
  * <p>The ID of the detector to retrieve publishing destinations for.</p>
5624
6376
  */
5625
6377
  DetectorId: string | undefined;
5626
6378
  /**
6379
+ * @public
5627
6380
  * <p>The maximum number of results to return in the response.</p>
5628
6381
  */
5629
6382
  MaxResults?: number;
5630
6383
  /**
6384
+ * @public
5631
6385
  * <p>A token to use for paginating results that are returned in the response. Set the value of
5632
6386
  * this parameter to null for the first request to a list action. For subsequent calls, use the
5633
6387
  * <code>NextToken</code> value returned from the previous request to continue listing results
@@ -5640,11 +6394,13 @@ export interface ListPublishingDestinationsRequest {
5640
6394
  */
5641
6395
  export interface ListPublishingDestinationsResponse {
5642
6396
  /**
6397
+ * @public
5643
6398
  * <p>A <code>Destinations</code> object that includes information about each publishing
5644
6399
  * destination returned.</p>
5645
6400
  */
5646
6401
  Destinations: Destination[] | undefined;
5647
6402
  /**
6403
+ * @public
5648
6404
  * <p>A token to use for paginating results that are returned in the response. Set the value of
5649
6405
  * this parameter to null for the first request to a list action. For subsequent calls, use the
5650
6406
  * <code>NextToken</code> value returned from the previous request to continue listing results
@@ -5657,6 +6413,7 @@ export interface ListPublishingDestinationsResponse {
5657
6413
  */
5658
6414
  export interface ListTagsForResourceRequest {
5659
6415
  /**
6416
+ * @public
5660
6417
  * <p>The Amazon Resource Name (ARN) for the given GuardDuty resource. </p>
5661
6418
  */
5662
6419
  ResourceArn: string | undefined;
@@ -5666,6 +6423,7 @@ export interface ListTagsForResourceRequest {
5666
6423
  */
5667
6424
  export interface ListTagsForResourceResponse {
5668
6425
  /**
6426
+ * @public
5669
6427
  * <p>The tags associated with the resource.</p>
5670
6428
  */
5671
6429
  Tags?: Record<string, string>;
@@ -5675,15 +6433,18 @@ export interface ListTagsForResourceResponse {
5675
6433
  */
5676
6434
  export interface ListThreatIntelSetsRequest {
5677
6435
  /**
6436
+ * @public
5678
6437
  * <p>The unique ID of the detector that the threatIntelSet is associated with.</p>
5679
6438
  */
5680
6439
  DetectorId: string | undefined;
5681
6440
  /**
6441
+ * @public
5682
6442
  * <p>You can use this parameter to indicate the maximum number of items that you want in the
5683
6443
  * response. The default value is 50. The maximum value is 50.</p>
5684
6444
  */
5685
6445
  MaxResults?: number;
5686
6446
  /**
6447
+ * @public
5687
6448
  * <p>You can use this parameter to paginate results in the response. Set the value of this
5688
6449
  * parameter to null on your first call to the list action. For subsequent calls to the action,
5689
6450
  * fill nextToken in the request with the value of NextToken from the previous response to
@@ -5696,10 +6457,12 @@ export interface ListThreatIntelSetsRequest {
5696
6457
  */
5697
6458
  export interface ListThreatIntelSetsResponse {
5698
6459
  /**
6460
+ * @public
5699
6461
  * <p>The IDs of the ThreatIntelSet resources.</p>
5700
6462
  */
5701
6463
  ThreatIntelSetIds: string[] | undefined;
5702
6464
  /**
6465
+ * @public
5703
6466
  * <p>The pagination parameter to be used on the next list operation to retrieve more
5704
6467
  * items.</p>
5705
6468
  */
@@ -5710,6 +6473,7 @@ export interface ListThreatIntelSetsResponse {
5710
6473
  */
5711
6474
  export interface StartMalwareScanRequest {
5712
6475
  /**
6476
+ * @public
5713
6477
  * <p>Amazon Resource Name (ARN) of the resource for which you invoked the API.</p>
5714
6478
  */
5715
6479
  ResourceArn: string | undefined;
@@ -5719,6 +6483,7 @@ export interface StartMalwareScanRequest {
5719
6483
  */
5720
6484
  export interface StartMalwareScanResponse {
5721
6485
  /**
6486
+ * @public
5722
6487
  * <p>A unique identifier that gets generated when you invoke the API without any error. Each malware scan has
5723
6488
  * a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.</p>
5724
6489
  */
@@ -5729,11 +6494,13 @@ export interface StartMalwareScanResponse {
5729
6494
  */
5730
6495
  export interface StartMonitoringMembersRequest {
5731
6496
  /**
6497
+ * @public
5732
6498
  * <p>The unique ID of the detector of the GuardDuty administrator account associated with the
5733
6499
  * member accounts to monitor.</p>
5734
6500
  */
5735
6501
  DetectorId: string | undefined;
5736
6502
  /**
6503
+ * @public
5737
6504
  * <p>A list of account IDs of the GuardDuty member accounts to start monitoring.</p>
5738
6505
  */
5739
6506
  AccountIds: string[] | undefined;