@aws-sdk/client-inspector2 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.
@@ -34,18 +34,22 @@ export type Status = (typeof Status)[keyof typeof Status];
34
34
  */
35
35
  export interface ResourceStatus {
36
36
  /**
37
+ * @public
37
38
  * <p>The status of Amazon Inspector scanning for Amazon EC2 resources.</p>
38
39
  */
39
40
  ec2: Status | string | undefined;
40
41
  /**
42
+ * @public
41
43
  * <p>The status of Amazon Inspector scanning for Amazon ECR resources.</p>
42
44
  */
43
45
  ecr: Status | string | undefined;
44
46
  /**
47
+ * @public
45
48
  * <p>The status of Amazon Inspector scanning for AWS Lambda function.</p>
46
49
  */
47
50
  lambda?: Status | string;
48
51
  /**
52
+ * @public
49
53
  * <p>The status of Amazon Inspector scanning for custom application code for Amazon Web Services Lambda functions.
50
54
  * </p>
51
55
  */
@@ -57,14 +61,17 @@ export interface ResourceStatus {
57
61
  */
58
62
  export interface Account {
59
63
  /**
64
+ * @public
60
65
  * <p>The ID of the Amazon Web Services account.</p>
61
66
  */
62
67
  accountId: string | undefined;
63
68
  /**
69
+ * @public
64
70
  * <p>The status of Amazon Inspector for the account.</p>
65
71
  */
66
72
  status: Status | string | undefined;
67
73
  /**
74
+ * @public
68
75
  * <p>Details of the status of Amazon Inspector scans by resource type.</p>
69
76
  */
70
77
  resourceStatus: ResourceStatus | undefined;
@@ -127,18 +134,22 @@ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
127
134
  */
128
135
  export interface AccountAggregation {
129
136
  /**
137
+ * @public
130
138
  * <p>The type of finding.</p>
131
139
  */
132
140
  findingType?: AggregationFindingType | string;
133
141
  /**
142
+ * @public
134
143
  * <p>The type of resource.</p>
135
144
  */
136
145
  resourceType?: AggregationResourceType | string;
137
146
  /**
147
+ * @public
138
148
  * <p>The sort order (ascending or descending).</p>
139
149
  */
140
150
  sortOrder?: SortOrder | string;
141
151
  /**
152
+ * @public
142
153
  * <p>The value to sort by.</p>
143
154
  */
144
155
  sortBy?: AccountSortBy | string;
@@ -149,18 +160,22 @@ export interface AccountAggregation {
149
160
  */
150
161
  export interface SeverityCounts {
151
162
  /**
163
+ * @public
152
164
  * <p>The total count of findings from all severities.</p>
153
165
  */
154
166
  all?: number;
155
167
  /**
168
+ * @public
156
169
  * <p>The total count of medium severity findings.</p>
157
170
  */
158
171
  medium?: number;
159
172
  /**
173
+ * @public
160
174
  * <p>The total count of high severity findings.</p>
161
175
  */
162
176
  high?: number;
163
177
  /**
178
+ * @public
164
179
  * <p>The total count of critical severity findings.</p>
165
180
  */
166
181
  critical?: number;
@@ -171,10 +186,12 @@ export interface SeverityCounts {
171
186
  */
172
187
  export interface AccountAggregationResponse {
173
188
  /**
189
+ * @public
174
190
  * <p>The Amazon Web Services account ID.</p>
175
191
  */
176
192
  accountId?: string;
177
193
  /**
194
+ * @public
178
195
  * <p>The number of findings by severity.</p>
179
196
  */
180
197
  severityCounts?: SeverityCounts;
@@ -209,14 +226,17 @@ export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
209
226
  */
210
227
  export interface State {
211
228
  /**
229
+ * @public
212
230
  * <p>The status of Amazon Inspector for the account.</p>
213
231
  */
214
232
  status: Status | string | undefined;
215
233
  /**
234
+ * @public
216
235
  * <p>The error code explaining why the account failed to enable Amazon Inspector.</p>
217
236
  */
218
237
  errorCode: ErrorCode | string | undefined;
219
238
  /**
239
+ * @public
220
240
  * <p>The error message received when the account failed to enable Amazon Inspector.</p>
221
241
  */
222
242
  errorMessage: string | undefined;
@@ -227,18 +247,22 @@ export interface State {
227
247
  */
228
248
  export interface ResourceState {
229
249
  /**
250
+ * @public
230
251
  * <p>An object detailing the state of Amazon Inspector scanning for Amazon EC2 resources.</p>
231
252
  */
232
253
  ec2: State | undefined;
233
254
  /**
255
+ * @public
234
256
  * <p>An object detailing the state of Amazon Inspector scanning for Amazon ECR resources.</p>
235
257
  */
236
258
  ecr: State | undefined;
237
259
  /**
260
+ * @public
238
261
  * <p>An object that described the state of Amazon Inspector scans for an account.</p>
239
262
  */
240
263
  lambda?: State;
241
264
  /**
265
+ * @public
242
266
  * <p>An object that described the state of Amazon Inspector scans for an account.</p>
243
267
  */
244
268
  lambdaCode?: State;
@@ -249,14 +273,17 @@ export interface ResourceState {
249
273
  */
250
274
  export interface AccountState {
251
275
  /**
276
+ * @public
252
277
  * <p>The Amazon Web Services account ID.</p>
253
278
  */
254
279
  accountId: string | undefined;
255
280
  /**
281
+ * @public
256
282
  * <p>An object detailing the status of Amazon Inspector for the account.</p>
257
283
  */
258
284
  state: State | undefined;
259
285
  /**
286
+ * @public
260
287
  * <p>An object detailing which resources Amazon Inspector is enabled to scan for the account.</p>
261
288
  */
262
289
  resourceState: ResourceState | undefined;
@@ -280,10 +307,12 @@ export type StringComparison = (typeof StringComparison)[keyof typeof StringComp
280
307
  */
281
308
  export interface StringFilter {
282
309
  /**
310
+ * @public
283
311
  * <p>The operator to use when comparing values in the filter.</p>
284
312
  */
285
313
  comparison: StringComparison | string | undefined;
286
314
  /**
315
+ * @public
287
316
  * <p>The value to filter on.</p>
288
317
  */
289
318
  value: string | undefined;
@@ -308,14 +337,17 @@ export type AmiSortBy = (typeof AmiSortBy)[keyof typeof AmiSortBy];
308
337
  */
309
338
  export interface AmiAggregation {
310
339
  /**
340
+ * @public
311
341
  * <p>The IDs of AMIs to aggregate findings for.</p>
312
342
  */
313
343
  amis?: StringFilter[];
314
344
  /**
345
+ * @public
315
346
  * <p>The order to sort results by.</p>
316
347
  */
317
348
  sortOrder?: SortOrder | string;
318
349
  /**
350
+ * @public
319
351
  * <p>The value to sort results by.</p>
320
352
  */
321
353
  sortBy?: AmiSortBy | string;
@@ -339,30 +371,37 @@ export type AwsEcrContainerSortBy = (typeof AwsEcrContainerSortBy)[keyof typeof
339
371
  */
340
372
  export interface AwsEcrContainerAggregation {
341
373
  /**
374
+ * @public
342
375
  * <p>The container resource IDs.</p>
343
376
  */
344
377
  resourceIds?: StringFilter[];
345
378
  /**
379
+ * @public
346
380
  * <p>The image SHA values.</p>
347
381
  */
348
382
  imageShas?: StringFilter[];
349
383
  /**
384
+ * @public
350
385
  * <p>The container repositories.</p>
351
386
  */
352
387
  repositories?: StringFilter[];
353
388
  /**
389
+ * @public
354
390
  * <p>The architecture of the containers.</p>
355
391
  */
356
392
  architectures?: StringFilter[];
357
393
  /**
394
+ * @public
358
395
  * <p>The image tags.</p>
359
396
  */
360
397
  imageTags?: StringFilter[];
361
398
  /**
399
+ * @public
362
400
  * <p>The sort order (ascending or descending).</p>
363
401
  */
364
402
  sortOrder?: SortOrder | string;
365
403
  /**
404
+ * @public
366
405
  * <p>The value to sort by.</p>
367
406
  */
368
407
  sortBy?: AwsEcrContainerSortBy | string;
@@ -384,14 +423,17 @@ export type MapComparison = (typeof MapComparison)[keyof typeof MapComparison];
384
423
  */
385
424
  export interface MapFilter {
386
425
  /**
426
+ * @public
387
427
  * <p>The operator to use when comparing values in the filter.</p>
388
428
  */
389
429
  comparison: MapComparison | string | undefined;
390
430
  /**
431
+ * @public
391
432
  * <p>The tag key used in the filter.</p>
392
433
  */
393
434
  key: string | undefined;
394
435
  /**
436
+ * @public
395
437
  * <p>The tag value used in the filter.</p>
396
438
  */
397
439
  value?: string;
@@ -416,28 +458,34 @@ export type Ec2InstanceSortBy = (typeof Ec2InstanceSortBy)[keyof typeof Ec2Insta
416
458
  */
417
459
  export interface Ec2InstanceAggregation {
418
460
  /**
461
+ * @public
419
462
  * <p>The AMI IDs associated with the Amazon EC2 instances to aggregate findings for.</p>
420
463
  */
421
464
  amis?: StringFilter[];
422
465
  /**
466
+ * @public
423
467
  * <p>The operating system types to aggregate findings for. Valid values must be uppercase and
424
468
  * underscore separated, examples are <code>ORACLE_LINUX_7</code> and
425
469
  * <code>ALPINE_LINUX_3_8</code>.</p>
426
470
  */
427
471
  operatingSystems?: StringFilter[];
428
472
  /**
473
+ * @public
429
474
  * <p>The Amazon EC2 instance IDs to aggregate findings for.</p>
430
475
  */
431
476
  instanceIds?: StringFilter[];
432
477
  /**
478
+ * @public
433
479
  * <p>The Amazon EC2 instance tags to aggregate findings for.</p>
434
480
  */
435
481
  instanceTags?: MapFilter[];
436
482
  /**
483
+ * @public
437
484
  * <p>The order to sort results by.</p>
438
485
  */
439
486
  sortOrder?: SortOrder | string;
440
487
  /**
488
+ * @public
441
489
  * <p>The value to sort results by.</p>
442
490
  */
443
491
  sortBy?: Ec2InstanceSortBy | string;
@@ -461,18 +509,22 @@ export type FindingTypeSortBy = (typeof FindingTypeSortBy)[keyof typeof FindingT
461
509
  */
462
510
  export interface FindingTypeAggregation {
463
511
  /**
512
+ * @public
464
513
  * <p>The finding type to aggregate.</p>
465
514
  */
466
515
  findingType?: AggregationFindingType | string;
467
516
  /**
517
+ * @public
468
518
  * <p>The resource type to aggregate.</p>
469
519
  */
470
520
  resourceType?: AggregationResourceType | string;
471
521
  /**
522
+ * @public
472
523
  * <p>The order to sort results by.</p>
473
524
  */
474
525
  sortOrder?: SortOrder | string;
475
526
  /**
527
+ * @public
476
528
  * <p>The value to sort results by.</p>
477
529
  */
478
530
  sortBy?: FindingTypeSortBy | string;
@@ -496,22 +548,27 @@ export type ImageLayerSortBy = (typeof ImageLayerSortBy)[keyof typeof ImageLayer
496
548
  */
497
549
  export interface ImageLayerAggregation {
498
550
  /**
551
+ * @public
499
552
  * <p>The repository associated with the container image hosting the layers.</p>
500
553
  */
501
554
  repositories?: StringFilter[];
502
555
  /**
556
+ * @public
503
557
  * <p>The ID of the container image layer.</p>
504
558
  */
505
559
  resourceIds?: StringFilter[];
506
560
  /**
561
+ * @public
507
562
  * <p>The hashes associated with the layers.</p>
508
563
  */
509
564
  layerHashes?: StringFilter[];
510
565
  /**
566
+ * @public
511
567
  * <p>The order to sort results by.</p>
512
568
  */
513
569
  sortOrder?: SortOrder | string;
514
570
  /**
571
+ * @public
515
572
  * <p>The value to sort results by.</p>
516
573
  */
517
574
  sortBy?: ImageLayerSortBy | string;
@@ -535,26 +592,32 @@ export type LambdaFunctionSortBy = (typeof LambdaFunctionSortBy)[keyof typeof La
535
592
  */
536
593
  export interface LambdaFunctionAggregation {
537
594
  /**
595
+ * @public
538
596
  * <p>The resource IDs to include in the aggregation results.</p>
539
597
  */
540
598
  resourceIds?: StringFilter[];
541
599
  /**
600
+ * @public
542
601
  * <p>The AWS Lambda function names to include in the aggregation results.</p>
543
602
  */
544
603
  functionNames?: StringFilter[];
545
604
  /**
605
+ * @public
546
606
  * <p>Returns findings aggregated by AWS Lambda function runtime environments.</p>
547
607
  */
548
608
  runtimes?: StringFilter[];
549
609
  /**
610
+ * @public
550
611
  * <p>The tags to include in the aggregation results.</p>
551
612
  */
552
613
  functionTags?: MapFilter[];
553
614
  /**
615
+ * @public
554
616
  * <p>The order to use for sorting the results.</p>
555
617
  */
556
618
  sortOrder?: SortOrder | string;
557
619
  /**
620
+ * @public
558
621
  * <p>The finding severity to use for sorting the results.</p>
559
622
  */
560
623
  sortBy?: LambdaFunctionSortBy | string;
@@ -578,23 +641,28 @@ export type LambdaLayerSortBy = (typeof LambdaLayerSortBy)[keyof typeof LambdaLa
578
641
  */
579
642
  export interface LambdaLayerAggregation {
580
643
  /**
644
+ * @public
581
645
  * <p>The names of the AWS Lambda functions associated with the layers.</p>
582
646
  */
583
647
  functionNames?: StringFilter[];
584
648
  /**
649
+ * @public
585
650
  * <p>The resource IDs for the AWS Lambda function layers.</p>
586
651
  */
587
652
  resourceIds?: StringFilter[];
588
653
  /**
654
+ * @public
589
655
  * <p>The Amazon Resource Name (ARN) of the AWS Lambda function layer.
590
656
  * </p>
591
657
  */
592
658
  layerArns?: StringFilter[];
593
659
  /**
660
+ * @public
594
661
  * <p>The order to use for sorting the results.</p>
595
662
  */
596
663
  sortOrder?: SortOrder | string;
597
664
  /**
665
+ * @public
598
666
  * <p>The finding severity to use for sorting the results.</p>
599
667
  */
600
668
  sortBy?: LambdaLayerSortBy | string;
@@ -618,14 +686,17 @@ export type PackageSortBy = (typeof PackageSortBy)[keyof typeof PackageSortBy];
618
686
  */
619
687
  export interface PackageAggregation {
620
688
  /**
689
+ * @public
621
690
  * <p>The names of packages to aggregate findings on.</p>
622
691
  */
623
692
  packageNames?: StringFilter[];
624
693
  /**
694
+ * @public
625
695
  * <p>The order to sort results by.</p>
626
696
  */
627
697
  sortOrder?: SortOrder | string;
628
698
  /**
699
+ * @public
629
700
  * <p>The value to sort results by.</p>
630
701
  */
631
702
  sortBy?: PackageSortBy | string;
@@ -650,14 +721,17 @@ export type RepositorySortBy = (typeof RepositorySortBy)[keyof typeof Repository
650
721
  */
651
722
  export interface RepositoryAggregation {
652
723
  /**
724
+ * @public
653
725
  * <p>The names of repositories to aggregate findings on.</p>
654
726
  */
655
727
  repositories?: StringFilter[];
656
728
  /**
729
+ * @public
657
730
  * <p>The order to sort results by.</p>
658
731
  */
659
732
  sortOrder?: SortOrder | string;
660
733
  /**
734
+ * @public
661
735
  * <p>The value to sort results by.</p>
662
736
  */
663
737
  sortBy?: RepositorySortBy | string;
@@ -681,26 +755,32 @@ export type TitleSortBy = (typeof TitleSortBy)[keyof typeof TitleSortBy];
681
755
  */
682
756
  export interface TitleAggregation {
683
757
  /**
758
+ * @public
684
759
  * <p>The finding titles to aggregate on.</p>
685
760
  */
686
761
  titles?: StringFilter[];
687
762
  /**
763
+ * @public
688
764
  * <p>The vulnerability IDs of the findings.</p>
689
765
  */
690
766
  vulnerabilityIds?: StringFilter[];
691
767
  /**
768
+ * @public
692
769
  * <p>The resource type to aggregate on.</p>
693
770
  */
694
771
  resourceType?: AggregationResourceType | string;
695
772
  /**
773
+ * @public
696
774
  * <p>The order to sort results by.</p>
697
775
  */
698
776
  sortOrder?: SortOrder | string;
699
777
  /**
778
+ * @public
700
779
  * <p>The value to sort results by.</p>
701
780
  */
702
781
  sortBy?: TitleSortBy | string;
703
782
  /**
783
+ * @public
704
784
  * <p>The type of finding to aggregate on.</p>
705
785
  */
706
786
  findingType?: AggregationFindingType | string;
@@ -715,6 +795,7 @@ export type AggregationRequest = AggregationRequest.AccountAggregationMember | A
715
795
  */
716
796
  export declare namespace AggregationRequest {
717
797
  /**
798
+ * @public
718
799
  * <p>An object that contains details about an aggregation request based on Amazon Web Services account
719
800
  * IDs.</p>
720
801
  */
@@ -733,6 +814,7 @@ export declare namespace AggregationRequest {
733
814
  $unknown?: never;
734
815
  }
735
816
  /**
817
+ * @public
736
818
  * <p>An object that contains details about an aggregation request based on Amazon Machine
737
819
  * Images (AMIs).</p>
738
820
  */
@@ -751,6 +833,7 @@ export declare namespace AggregationRequest {
751
833
  $unknown?: never;
752
834
  }
753
835
  /**
836
+ * @public
754
837
  * <p>An object that contains details about an aggregation request based on Amazon ECR container
755
838
  * images.</p>
756
839
  */
@@ -769,6 +852,7 @@ export declare namespace AggregationRequest {
769
852
  $unknown?: never;
770
853
  }
771
854
  /**
855
+ * @public
772
856
  * <p>An object that contains details about an aggregation request based on Amazon EC2
773
857
  * instances.</p>
774
858
  */
@@ -787,6 +871,7 @@ export declare namespace AggregationRequest {
787
871
  $unknown?: never;
788
872
  }
789
873
  /**
874
+ * @public
790
875
  * <p>An object that contains details about an aggregation request based on finding types.</p>
791
876
  */
792
877
  interface FindingTypeAggregationMember {
@@ -804,6 +889,7 @@ export declare namespace AggregationRequest {
804
889
  $unknown?: never;
805
890
  }
806
891
  /**
892
+ * @public
807
893
  * <p>An object that contains details about an aggregation request based on container image
808
894
  * layers.</p>
809
895
  */
@@ -822,6 +908,7 @@ export declare namespace AggregationRequest {
822
908
  $unknown?: never;
823
909
  }
824
910
  /**
911
+ * @public
825
912
  * <p>An object that contains details about an aggregation request based on operating system
826
913
  * package type.</p>
827
914
  */
@@ -840,6 +927,7 @@ export declare namespace AggregationRequest {
840
927
  $unknown?: never;
841
928
  }
842
929
  /**
930
+ * @public
843
931
  * <p>An object that contains details about an aggregation request based on Amazon ECR repositories.</p>
844
932
  */
845
933
  interface RepositoryAggregationMember {
@@ -857,6 +945,7 @@ export declare namespace AggregationRequest {
857
945
  $unknown?: never;
858
946
  }
859
947
  /**
948
+ * @public
860
949
  * <p>An object that contains details about an aggregation request based on finding title.</p>
861
950
  */
862
951
  interface TitleAggregationMember {
@@ -874,6 +963,7 @@ export declare namespace AggregationRequest {
874
963
  $unknown?: never;
875
964
  }
876
965
  /**
966
+ * @public
877
967
  * <p>Returns an object with findings aggregated by AWS Lambda layer.</p>
878
968
  */
879
969
  interface LambdaLayerAggregationMember {
@@ -891,6 +981,7 @@ export declare namespace AggregationRequest {
891
981
  $unknown?: never;
892
982
  }
893
983
  /**
984
+ * @public
894
985
  * <p>Returns an object with findings aggregated by AWS Lambda function.</p>
895
986
  */
896
987
  interface LambdaFunctionAggregationMember {
@@ -907,6 +998,9 @@ export declare namespace AggregationRequest {
907
998
  lambdaFunctionAggregation: LambdaFunctionAggregation;
908
999
  $unknown?: never;
909
1000
  }
1001
+ /**
1002
+ * @public
1003
+ */
910
1004
  interface $UnknownMember {
911
1005
  accountAggregation?: never;
912
1006
  amiAggregation?: never;
@@ -943,18 +1037,22 @@ export declare namespace AggregationRequest {
943
1037
  */
944
1038
  export interface AmiAggregationResponse {
945
1039
  /**
1040
+ * @public
946
1041
  * <p>The ID of the AMI that findings were aggregated for.</p>
947
1042
  */
948
1043
  ami: string | undefined;
949
1044
  /**
1045
+ * @public
950
1046
  * <p>The Amazon Web Services account ID for the AMI.</p>
951
1047
  */
952
1048
  accountId?: string;
953
1049
  /**
1050
+ * @public
954
1051
  * <p>An object that contains the count of matched findings per severity.</p>
955
1052
  */
956
1053
  severityCounts?: SeverityCounts;
957
1054
  /**
1055
+ * @public
958
1056
  * <p>The IDs of Amazon EC2 instances using this AMI.</p>
959
1057
  */
960
1058
  affectedInstances?: number;
@@ -965,30 +1063,37 @@ export interface AmiAggregationResponse {
965
1063
  */
966
1064
  export interface AwsEcrContainerAggregationResponse {
967
1065
  /**
1066
+ * @public
968
1067
  * <p>The resource ID of the container.</p>
969
1068
  */
970
1069
  resourceId: string | undefined;
971
1070
  /**
1071
+ * @public
972
1072
  * <p>The SHA value of the container image.</p>
973
1073
  */
974
1074
  imageSha?: string;
975
1075
  /**
1076
+ * @public
976
1077
  * <p>The container repository.</p>
977
1078
  */
978
1079
  repository?: string;
979
1080
  /**
1081
+ * @public
980
1082
  * <p>The architecture of the container.</p>
981
1083
  */
982
1084
  architecture?: string;
983
1085
  /**
1086
+ * @public
984
1087
  * <p>The container image stags.</p>
985
1088
  */
986
1089
  imageTags?: string[];
987
1090
  /**
1091
+ * @public
988
1092
  * <p>The Amazon Web Services account ID of the account that owns the container.</p>
989
1093
  */
990
1094
  accountId?: string;
991
1095
  /**
1096
+ * @public
992
1097
  * <p>The number of finding by severity.</p>
993
1098
  */
994
1099
  severityCounts?: SeverityCounts;
@@ -999,30 +1104,37 @@ export interface AwsEcrContainerAggregationResponse {
999
1104
  */
1000
1105
  export interface Ec2InstanceAggregationResponse {
1001
1106
  /**
1107
+ * @public
1002
1108
  * <p>The Amazon EC2 instance ID.</p>
1003
1109
  */
1004
1110
  instanceId: string | undefined;
1005
1111
  /**
1112
+ * @public
1006
1113
  * <p>The Amazon Machine Image (AMI) of the Amazon EC2 instance.</p>
1007
1114
  */
1008
1115
  ami?: string;
1009
1116
  /**
1117
+ * @public
1010
1118
  * <p>The operating system of the Amazon EC2 instance.</p>
1011
1119
  */
1012
1120
  operatingSystem?: string;
1013
1121
  /**
1122
+ * @public
1014
1123
  * <p>The tags attached to the instance.</p>
1015
1124
  */
1016
1125
  instanceTags?: Record<string, string>;
1017
1126
  /**
1127
+ * @public
1018
1128
  * <p>The Amazon Web Services account for the Amazon EC2 instance.</p>
1019
1129
  */
1020
1130
  accountId?: string;
1021
1131
  /**
1132
+ * @public
1022
1133
  * <p>An object that contains the count of matched findings per severity.</p>
1023
1134
  */
1024
1135
  severityCounts?: SeverityCounts;
1025
1136
  /**
1137
+ * @public
1026
1138
  * <p>The number of network findings for the Amazon EC2 instance.</p>
1027
1139
  */
1028
1140
  networkFindings?: number;
@@ -1033,10 +1145,12 @@ export interface Ec2InstanceAggregationResponse {
1033
1145
  */
1034
1146
  export interface FindingTypeAggregationResponse {
1035
1147
  /**
1148
+ * @public
1036
1149
  * <p>The ID of the Amazon Web Services account associated with the findings.</p>
1037
1150
  */
1038
1151
  accountId?: string;
1039
1152
  /**
1153
+ * @public
1040
1154
  * <p>The value to sort results by.</p>
1041
1155
  */
1042
1156
  severityCounts?: SeverityCounts;
@@ -1047,22 +1161,27 @@ export interface FindingTypeAggregationResponse {
1047
1161
  */
1048
1162
  export interface ImageLayerAggregationResponse {
1049
1163
  /**
1164
+ * @public
1050
1165
  * <p>The repository the layer resides in.</p>
1051
1166
  */
1052
1167
  repository: string | undefined;
1053
1168
  /**
1169
+ * @public
1054
1170
  * <p>The resource ID of the container image layer.</p>
1055
1171
  */
1056
1172
  resourceId: string | undefined;
1057
1173
  /**
1174
+ * @public
1058
1175
  * <p>The layer hash.</p>
1059
1176
  */
1060
1177
  layerHash: string | undefined;
1061
1178
  /**
1179
+ * @public
1062
1180
  * <p>The ID of the Amazon Web Services account that owns the container image hosting the layer image.</p>
1063
1181
  */
1064
1182
  accountId: string | undefined;
1065
1183
  /**
1184
+ * @public
1066
1185
  * <p>An object that represents the count of matched findings per severity.</p>
1067
1186
  */
1068
1187
  severityCounts?: SeverityCounts;
@@ -1073,31 +1192,38 @@ export interface ImageLayerAggregationResponse {
1073
1192
  */
1074
1193
  export interface LambdaFunctionAggregationResponse {
1075
1194
  /**
1195
+ * @public
1076
1196
  * <p>The resource IDs included in the aggregation results.</p>
1077
1197
  */
1078
1198
  resourceId: string | undefined;
1079
1199
  /**
1200
+ * @public
1080
1201
  * <p>The AWS Lambda function names included in the aggregation results.</p>
1081
1202
  */
1082
1203
  functionName?: string;
1083
1204
  /**
1205
+ * @public
1084
1206
  * <p>The runtimes included in the aggregation results.</p>
1085
1207
  */
1086
1208
  runtime?: string;
1087
1209
  /**
1210
+ * @public
1088
1211
  * <p>The tags included in the aggregation results.</p>
1089
1212
  */
1090
1213
  lambdaTags?: Record<string, string>;
1091
1214
  /**
1215
+ * @public
1092
1216
  * <p>The ID of the AWS account that owns the AWS Lambda function.
1093
1217
  * </p>
1094
1218
  */
1095
1219
  accountId?: string;
1096
1220
  /**
1221
+ * @public
1097
1222
  * <p>An object that contains the counts of aggregated finding per severity.</p>
1098
1223
  */
1099
1224
  severityCounts?: SeverityCounts;
1100
1225
  /**
1226
+ * @public
1101
1227
  * <p>The date that the AWS Lambda function included in the aggregation results was last changed.</p>
1102
1228
  */
1103
1229
  lastModifiedAt?: Date;
@@ -1108,22 +1234,27 @@ export interface LambdaFunctionAggregationResponse {
1108
1234
  */
1109
1235
  export interface LambdaLayerAggregationResponse {
1110
1236
  /**
1237
+ * @public
1111
1238
  * <p>The names of the AWS Lambda functions associated with the layers.</p>
1112
1239
  */
1113
1240
  functionName: string | undefined;
1114
1241
  /**
1242
+ * @public
1115
1243
  * <p>The Resource ID of the AWS Lambda function layer.</p>
1116
1244
  */
1117
1245
  resourceId: string | undefined;
1118
1246
  /**
1247
+ * @public
1119
1248
  * <p>The Amazon Resource Name (ARN) of the AWS Lambda function layer.</p>
1120
1249
  */
1121
1250
  layerArn: string | undefined;
1122
1251
  /**
1252
+ * @public
1123
1253
  * <p>The account ID of the AWS Lambda function layer.</p>
1124
1254
  */
1125
1255
  accountId: string | undefined;
1126
1256
  /**
1257
+ * @public
1127
1258
  * <p>An object that contains the counts of aggregated finding per severity.</p>
1128
1259
  */
1129
1260
  severityCounts?: SeverityCounts;
@@ -1134,14 +1265,17 @@ export interface LambdaLayerAggregationResponse {
1134
1265
  */
1135
1266
  export interface PackageAggregationResponse {
1136
1267
  /**
1268
+ * @public
1137
1269
  * <p>The name of the operating system package.</p>
1138
1270
  */
1139
1271
  packageName: string | undefined;
1140
1272
  /**
1273
+ * @public
1141
1274
  * <p>The ID of the Amazon Web Services account associated with the findings.</p>
1142
1275
  */
1143
1276
  accountId?: string;
1144
1277
  /**
1278
+ * @public
1145
1279
  * <p>An object that contains the count of matched findings per severity.</p>
1146
1280
  */
1147
1281
  severityCounts?: SeverityCounts;
@@ -1152,18 +1286,22 @@ export interface PackageAggregationResponse {
1152
1286
  */
1153
1287
  export interface RepositoryAggregationResponse {
1154
1288
  /**
1289
+ * @public
1155
1290
  * <p>The name of the repository associated with the findings.</p>
1156
1291
  */
1157
1292
  repository: string | undefined;
1158
1293
  /**
1294
+ * @public
1159
1295
  * <p>The ID of the Amazon Web Services account associated with the findings.</p>
1160
1296
  */
1161
1297
  accountId?: string;
1162
1298
  /**
1299
+ * @public
1163
1300
  * <p>An object that represent the count of matched findings per severity.</p>
1164
1301
  */
1165
1302
  severityCounts?: SeverityCounts;
1166
1303
  /**
1304
+ * @public
1167
1305
  * <p>The number of container images impacted by the findings.</p>
1168
1306
  */
1169
1307
  affectedImages?: number;
@@ -1174,18 +1312,22 @@ export interface RepositoryAggregationResponse {
1174
1312
  */
1175
1313
  export interface TitleAggregationResponse {
1176
1314
  /**
1315
+ * @public
1177
1316
  * <p>The title that the findings were aggregated on.</p>
1178
1317
  */
1179
1318
  title: string | undefined;
1180
1319
  /**
1320
+ * @public
1181
1321
  * <p>The vulnerability ID of the finding.</p>
1182
1322
  */
1183
1323
  vulnerabilityId?: string;
1184
1324
  /**
1325
+ * @public
1185
1326
  * <p>The ID of the Amazon Web Services account associated with the findings.</p>
1186
1327
  */
1187
1328
  accountId?: string;
1188
1329
  /**
1330
+ * @public
1189
1331
  * <p>An object that represent the count of matched findings per severity.</p>
1190
1332
  */
1191
1333
  severityCounts?: SeverityCounts;
@@ -1200,6 +1342,7 @@ export type AggregationResponse = AggregationResponse.AccountAggregationMember |
1200
1342
  */
1201
1343
  export declare namespace AggregationResponse {
1202
1344
  /**
1345
+ * @public
1203
1346
  * <p>An object that contains details about an aggregation response based on Amazon Web Services account
1204
1347
  * IDs.</p>
1205
1348
  */
@@ -1218,6 +1361,7 @@ export declare namespace AggregationResponse {
1218
1361
  $unknown?: never;
1219
1362
  }
1220
1363
  /**
1364
+ * @public
1221
1365
  * <p>An object that contains details about an aggregation response based on Amazon Machine
1222
1366
  * Images (AMIs).</p>
1223
1367
  */
@@ -1236,6 +1380,7 @@ export declare namespace AggregationResponse {
1236
1380
  $unknown?: never;
1237
1381
  }
1238
1382
  /**
1383
+ * @public
1239
1384
  * <p>An object that contains details about an aggregation response based on Amazon ECR container
1240
1385
  * images.</p>
1241
1386
  */
@@ -1254,6 +1399,7 @@ export declare namespace AggregationResponse {
1254
1399
  $unknown?: never;
1255
1400
  }
1256
1401
  /**
1402
+ * @public
1257
1403
  * <p>An object that contains details about an aggregation response based on Amazon EC2
1258
1404
  * instances.</p>
1259
1405
  */
@@ -1272,6 +1418,7 @@ export declare namespace AggregationResponse {
1272
1418
  $unknown?: never;
1273
1419
  }
1274
1420
  /**
1421
+ * @public
1275
1422
  * <p>An object that contains details about an aggregation response based on finding types.</p>
1276
1423
  */
1277
1424
  interface FindingTypeAggregationMember {
@@ -1289,6 +1436,7 @@ export declare namespace AggregationResponse {
1289
1436
  $unknown?: never;
1290
1437
  }
1291
1438
  /**
1439
+ * @public
1292
1440
  * <p>An object that contains details about an aggregation response based on container image
1293
1441
  * layers.</p>
1294
1442
  */
@@ -1307,6 +1455,7 @@ export declare namespace AggregationResponse {
1307
1455
  $unknown?: never;
1308
1456
  }
1309
1457
  /**
1458
+ * @public
1310
1459
  * <p>An object that contains details about an aggregation response based on operating system
1311
1460
  * package type.</p>
1312
1461
  */
@@ -1325,6 +1474,7 @@ export declare namespace AggregationResponse {
1325
1474
  $unknown?: never;
1326
1475
  }
1327
1476
  /**
1477
+ * @public
1328
1478
  * <p>An object that contains details about an aggregation response based on Amazon ECR
1329
1479
  * repositories.</p>
1330
1480
  */
@@ -1343,6 +1493,7 @@ export declare namespace AggregationResponse {
1343
1493
  $unknown?: never;
1344
1494
  }
1345
1495
  /**
1496
+ * @public
1346
1497
  * <p>An object that contains details about an aggregation response based on finding title.</p>
1347
1498
  */
1348
1499
  interface TitleAggregationMember {
@@ -1360,6 +1511,7 @@ export declare namespace AggregationResponse {
1360
1511
  $unknown?: never;
1361
1512
  }
1362
1513
  /**
1514
+ * @public
1363
1515
  * <p>An aggregation of findings by AWS Lambda layer.</p>
1364
1516
  */
1365
1517
  interface LambdaLayerAggregationMember {
@@ -1377,6 +1529,7 @@ export declare namespace AggregationResponse {
1377
1529
  $unknown?: never;
1378
1530
  }
1379
1531
  /**
1532
+ * @public
1380
1533
  * <p>An aggregation of findings by AWS Lambda function.</p>
1381
1534
  */
1382
1535
  interface LambdaFunctionAggregationMember {
@@ -1393,6 +1546,9 @@ export declare namespace AggregationResponse {
1393
1546
  lambdaFunctionAggregation: LambdaFunctionAggregationResponse;
1394
1547
  $unknown?: never;
1395
1548
  }
1549
+ /**
1550
+ * @public
1551
+ */
1396
1552
  interface $UnknownMember {
1397
1553
  accountAggregation?: never;
1398
1554
  amiAggregation?: never;
@@ -1461,6 +1617,7 @@ export type Architecture = (typeof Architecture)[keyof typeof Architecture];
1461
1617
  */
1462
1618
  export interface AssociateMemberRequest {
1463
1619
  /**
1620
+ * @public
1464
1621
  * <p>The Amazon Web Services account ID of the member account to be associated.</p>
1465
1622
  */
1466
1623
  accountId: string | undefined;
@@ -1470,6 +1627,7 @@ export interface AssociateMemberRequest {
1470
1627
  */
1471
1628
  export interface AssociateMemberResponse {
1472
1629
  /**
1630
+ * @public
1473
1631
  * <p>The Amazon Web Services account ID of the successfully associated member account.</p>
1474
1632
  */
1475
1633
  accountId: string | undefined;
@@ -1483,6 +1641,7 @@ export declare class InternalServerException extends __BaseException {
1483
1641
  readonly $fault: "server";
1484
1642
  $retryable: {};
1485
1643
  /**
1644
+ * @public
1486
1645
  * <p>The number of seconds to wait before retrying the request.</p>
1487
1646
  */
1488
1647
  retryAfterSeconds?: number;
@@ -1502,6 +1661,7 @@ export declare class ThrottlingException extends __BaseException {
1502
1661
  throttling: boolean;
1503
1662
  };
1504
1663
  /**
1664
+ * @public
1505
1665
  * <p>The number of seconds to wait before retrying the request.</p>
1506
1666
  */
1507
1667
  retryAfterSeconds?: number;
@@ -1516,10 +1676,12 @@ export declare class ThrottlingException extends __BaseException {
1516
1676
  */
1517
1677
  export interface ValidationExceptionField {
1518
1678
  /**
1679
+ * @public
1519
1680
  * <p>The name of the validation exception.</p>
1520
1681
  */
1521
1682
  name: string | undefined;
1522
1683
  /**
1684
+ * @public
1523
1685
  * <p>The validation exception message.</p>
1524
1686
  */
1525
1687
  message: string | undefined;
@@ -1546,10 +1708,12 @@ export declare class ValidationException extends __BaseException {
1546
1708
  readonly name: "ValidationException";
1547
1709
  readonly $fault: "client";
1548
1710
  /**
1711
+ * @public
1549
1712
  * <p>The reason for the validation failure.</p>
1550
1713
  */
1551
1714
  reason: ValidationExceptionReason | string | undefined;
1552
1715
  /**
1716
+ * @public
1553
1717
  * <p>The fields that failed validation.</p>
1554
1718
  */
1555
1719
  fields?: ValidationExceptionField[];
@@ -1564,18 +1728,22 @@ export declare class ValidationException extends __BaseException {
1564
1728
  */
1565
1729
  export interface AtigData {
1566
1730
  /**
1731
+ * @public
1567
1732
  * <p>The date and time this vulnerability was first observed.</p>
1568
1733
  */
1569
1734
  firstSeen?: Date;
1570
1735
  /**
1736
+ * @public
1571
1737
  * <p>The date and time this vulnerability was last observed.</p>
1572
1738
  */
1573
1739
  lastSeen?: Date;
1574
1740
  /**
1741
+ * @public
1575
1742
  * <p>The commercial sectors this vulnerability targets.</p>
1576
1743
  */
1577
1744
  targets?: string[];
1578
1745
  /**
1746
+ * @public
1579
1747
  * <p>The <a href="https://attack.mitre.org/">MITRE ATT&amp;CK</a> tactics, techniques, and procedures (TTPs) associated with vulnerability.</p>
1580
1748
  */
1581
1749
  ttps?: string[];
@@ -1586,21 +1754,25 @@ export interface AtigData {
1586
1754
  */
1587
1755
  export interface AutoEnable {
1588
1756
  /**
1757
+ * @public
1589
1758
  * <p>Represents whether Amazon EC2 scans are automatically enabled for new members of your Amazon Inspector
1590
1759
  * organization.</p>
1591
1760
  */
1592
1761
  ec2: boolean | undefined;
1593
1762
  /**
1763
+ * @public
1594
1764
  * <p>Represents whether Amazon ECR scans are automatically enabled for new members of your Amazon Inspector
1595
1765
  * organization.</p>
1596
1766
  */
1597
1767
  ecr: boolean | undefined;
1598
1768
  /**
1769
+ * @public
1599
1770
  * <p>Represents whether AWS Lambda standard scans are automatically enabled for new members of your Amazon Inspector organization.
1600
1771
  * </p>
1601
1772
  */
1602
1773
  lambda?: boolean;
1603
1774
  /**
1775
+ * @public
1604
1776
  * <p>Represents whether AWS Lambda code scans are automatically enabled for new members of your Amazon Inspector organization.
1605
1777
  *
1606
1778
  * </p>
@@ -1613,42 +1785,52 @@ export interface AutoEnable {
1613
1785
  */
1614
1786
  export interface AwsEc2InstanceDetails {
1615
1787
  /**
1788
+ * @public
1616
1789
  * <p>The type of the Amazon EC2 instance.</p>
1617
1790
  */
1618
1791
  type?: string;
1619
1792
  /**
1793
+ * @public
1620
1794
  * <p>The image ID of the Amazon EC2 instance.</p>
1621
1795
  */
1622
1796
  imageId?: string;
1623
1797
  /**
1798
+ * @public
1624
1799
  * <p>The IPv4 addresses of the Amazon EC2 instance.</p>
1625
1800
  */
1626
1801
  ipV4Addresses?: string[];
1627
1802
  /**
1803
+ * @public
1628
1804
  * <p>The IPv6 addresses of the Amazon EC2 instance.</p>
1629
1805
  */
1630
1806
  ipV6Addresses?: string[];
1631
1807
  /**
1808
+ * @public
1632
1809
  * <p>The name of the key pair used to launch the Amazon EC2 instance.</p>
1633
1810
  */
1634
1811
  keyName?: string;
1635
1812
  /**
1813
+ * @public
1636
1814
  * <p>The IAM instance profile ARN of the Amazon EC2 instance.</p>
1637
1815
  */
1638
1816
  iamInstanceProfileArn?: string;
1639
1817
  /**
1818
+ * @public
1640
1819
  * <p>The VPC ID of the Amazon EC2 instance.</p>
1641
1820
  */
1642
1821
  vpcId?: string;
1643
1822
  /**
1823
+ * @public
1644
1824
  * <p>The subnet ID of the Amazon EC2 instance.</p>
1645
1825
  */
1646
1826
  subnetId?: string;
1647
1827
  /**
1828
+ * @public
1648
1829
  * <p>The date and time the Amazon EC2 instance was launched at.</p>
1649
1830
  */
1650
1831
  launchedAt?: Date;
1651
1832
  /**
1833
+ * @public
1652
1834
  * <p>The platform of the Amazon EC2 instance.</p>
1653
1835
  */
1654
1836
  platform?: string;
@@ -1659,34 +1841,42 @@ export interface AwsEc2InstanceDetails {
1659
1841
  */
1660
1842
  export interface AwsEcrContainerImageDetails {
1661
1843
  /**
1844
+ * @public
1662
1845
  * <p>The name of the repository the Amazon ECR container image resides in.</p>
1663
1846
  */
1664
1847
  repositoryName: string | undefined;
1665
1848
  /**
1849
+ * @public
1666
1850
  * <p>The image tags attached to the Amazon ECR container image.</p>
1667
1851
  */
1668
1852
  imageTags?: string[];
1669
1853
  /**
1854
+ * @public
1670
1855
  * <p>The date and time the Amazon ECR container image was pushed.</p>
1671
1856
  */
1672
1857
  pushedAt?: Date;
1673
1858
  /**
1859
+ * @public
1674
1860
  * <p>The image author of the Amazon ECR container image.</p>
1675
1861
  */
1676
1862
  author?: string;
1677
1863
  /**
1864
+ * @public
1678
1865
  * <p>The architecture of the Amazon ECR container image.</p>
1679
1866
  */
1680
1867
  architecture?: string;
1681
1868
  /**
1869
+ * @public
1682
1870
  * <p>The image hash of the Amazon ECR container image.</p>
1683
1871
  */
1684
1872
  imageHash: string | undefined;
1685
1873
  /**
1874
+ * @public
1686
1875
  * <p>The registry for the Amazon ECR container image.</p>
1687
1876
  */
1688
1877
  registry: string | undefined;
1689
1878
  /**
1879
+ * @public
1690
1880
  * <p>The platform of the Amazon ECR container image.</p>
1691
1881
  */
1692
1882
  platform?: string;
@@ -1734,14 +1924,17 @@ export type Runtime = (typeof Runtime)[keyof typeof Runtime];
1734
1924
  */
1735
1925
  export interface LambdaVpcConfig {
1736
1926
  /**
1927
+ * @public
1737
1928
  * <p>A list of VPC subnet IDs.</p>
1738
1929
  */
1739
1930
  subnetIds?: string[];
1740
1931
  /**
1932
+ * @public
1741
1933
  * <p>The VPC security groups and subnets that are attached to an AWS Lambda function. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html">VPC Settings</a>.</p>
1742
1934
  */
1743
1935
  securityGroupIds?: string[];
1744
1936
  /**
1937
+ * @public
1745
1938
  * <p>The ID of the VPC.</p>
1746
1939
  */
1747
1940
  vpcId?: string;
@@ -1752,44 +1945,54 @@ export interface LambdaVpcConfig {
1752
1945
  */
1753
1946
  export interface AwsLambdaFunctionDetails {
1754
1947
  /**
1948
+ * @public
1755
1949
  * <p>The name of the AWS Lambda function.</p>
1756
1950
  */
1757
1951
  functionName: string | undefined;
1758
1952
  /**
1953
+ * @public
1759
1954
  * <p>The runtime environment for the AWS Lambda function.</p>
1760
1955
  */
1761
1956
  runtime: Runtime | string | undefined;
1762
1957
  /**
1958
+ * @public
1763
1959
  * <p>The SHA256 hash of the AWS Lambda function's deployment package.</p>
1764
1960
  */
1765
1961
  codeSha256: string | undefined;
1766
1962
  /**
1963
+ * @public
1767
1964
  * <p>The version of the AWS Lambda function.</p>
1768
1965
  */
1769
1966
  version: string | undefined;
1770
1967
  /**
1968
+ * @public
1771
1969
  * <p>The AWS Lambda function's execution role.</p>
1772
1970
  */
1773
1971
  executionRoleArn: string | undefined;
1774
1972
  /**
1973
+ * @public
1775
1974
  * <p>The AWS Lambda function's <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html">
1776
1975
  * layers</a>. A Lambda function can have up to five layers.</p>
1777
1976
  */
1778
1977
  layers?: string[];
1779
1978
  /**
1979
+ * @public
1780
1980
  * <p>The AWS Lambda function's networking configuration.</p>
1781
1981
  */
1782
1982
  vpcConfig?: LambdaVpcConfig;
1783
1983
  /**
1984
+ * @public
1784
1985
  * <p>The type of deployment package. Set to <code>Image</code> for container image and set <code>Zip</code> for .zip file archive.</p>
1785
1986
  */
1786
1987
  packageType?: PackageType | string;
1787
1988
  /**
1989
+ * @public
1788
1990
  * <p>The instruction set architecture that the AWS Lambda function supports. Architecture is a string array with one of the
1789
1991
  * valid values. The default architecture value is <code>x86_64</code>.</p>
1790
1992
  */
1791
1993
  architectures?: (Architecture | string)[];
1792
1994
  /**
1995
+ * @public
1793
1996
  * <p>The date and time that a user last updated the configuration, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601 format</a>
1794
1997
  * </p>
1795
1998
  */
@@ -1812,6 +2015,7 @@ export declare class BadRequestException extends __BaseException {
1812
2015
  */
1813
2016
  export interface BatchGetAccountStatusRequest {
1814
2017
  /**
2018
+ * @public
1815
2019
  * <p>The 12-digit Amazon Web Services account IDs of the accounts to retrieve Amazon Inspector status for.</p>
1816
2020
  */
1817
2021
  accountIds?: string[];
@@ -1822,22 +2026,27 @@ export interface BatchGetAccountStatusRequest {
1822
2026
  */
1823
2027
  export interface FailedAccount {
1824
2028
  /**
2029
+ * @public
1825
2030
  * <p>The Amazon Web Services account ID.</p>
1826
2031
  */
1827
2032
  accountId: string | undefined;
1828
2033
  /**
2034
+ * @public
1829
2035
  * <p>The status of Amazon Inspector for the account.</p>
1830
2036
  */
1831
2037
  status?: Status | string;
1832
2038
  /**
2039
+ * @public
1833
2040
  * <p>An object detailing which resources Amazon Inspector is enabled to scan for the account.</p>
1834
2041
  */
1835
2042
  resourceStatus?: ResourceStatus;
1836
2043
  /**
2044
+ * @public
1837
2045
  * <p>The error code explaining why the account failed to enable Amazon Inspector.</p>
1838
2046
  */
1839
2047
  errorCode: ErrorCode | string | undefined;
1840
2048
  /**
2049
+ * @public
1841
2050
  * <p>The error message received when the account failed to enable Amazon Inspector.</p>
1842
2051
  */
1843
2052
  errorMessage: string | undefined;
@@ -1847,10 +2056,12 @@ export interface FailedAccount {
1847
2056
  */
1848
2057
  export interface BatchGetAccountStatusResponse {
1849
2058
  /**
2059
+ * @public
1850
2060
  * <p>An array of objects that provide details on the status of Amazon Inspector for each of the requested accounts.</p>
1851
2061
  */
1852
2062
  accounts: AccountState[] | undefined;
1853
2063
  /**
2064
+ * @public
1854
2065
  * <p>An array of objects detailing any accounts that failed to enable Amazon Inspector and why.</p>
1855
2066
  */
1856
2067
  failedAccounts?: FailedAccount[];
@@ -1872,6 +2083,7 @@ export declare class ResourceNotFoundException extends __BaseException {
1872
2083
  */
1873
2084
  export interface BatchGetCodeSnippetRequest {
1874
2085
  /**
2086
+ * @public
1875
2087
  * <p>An array of finding ARNs for the findings you want to retrieve code snippets from.</p>
1876
2088
  */
1877
2089
  findingArns: string[] | undefined;
@@ -1882,10 +2094,12 @@ export interface BatchGetCodeSnippetRequest {
1882
2094
  */
1883
2095
  export interface CodeLine {
1884
2096
  /**
2097
+ * @public
1885
2098
  * <p>The content of a line of code</p>
1886
2099
  */
1887
2100
  content: string | undefined;
1888
2101
  /**
2102
+ * @public
1889
2103
  * <p>The line number that a section of code is located at.</p>
1890
2104
  */
1891
2105
  lineNumber: number | undefined;
@@ -1896,10 +2110,12 @@ export interface CodeLine {
1896
2110
  */
1897
2111
  export interface SuggestedFix {
1898
2112
  /**
2113
+ * @public
1899
2114
  * <p>The fix's description.</p>
1900
2115
  */
1901
2116
  description?: string;
1902
2117
  /**
2118
+ * @public
1903
2119
  * <p>The fix's code.</p>
1904
2120
  */
1905
2121
  code?: string;
@@ -1910,22 +2126,27 @@ export interface SuggestedFix {
1910
2126
  */
1911
2127
  export interface CodeSnippetResult {
1912
2128
  /**
2129
+ * @public
1913
2130
  * <p>The ARN of a finding that the code snippet is associated with.</p>
1914
2131
  */
1915
2132
  findingArn?: string;
1916
2133
  /**
2134
+ * @public
1917
2135
  * <p>The line number of the first line of a code snippet.</p>
1918
2136
  */
1919
2137
  startLine?: number;
1920
2138
  /**
2139
+ * @public
1921
2140
  * <p>The line number of the last line of a code snippet.</p>
1922
2141
  */
1923
2142
  endLine?: number;
1924
2143
  /**
2144
+ * @public
1925
2145
  * <p>Contains information on the retrieved code snippet.</p>
1926
2146
  */
1927
2147
  codeSnippet?: CodeLine[];
1928
2148
  /**
2149
+ * @public
1929
2150
  * <p>Details of a suggested code fix.</p>
1930
2151
  */
1931
2152
  suggestedFixes?: SuggestedFix[];
@@ -1950,14 +2171,17 @@ export type CodeSnippetErrorCode = (typeof CodeSnippetErrorCode)[keyof typeof Co
1950
2171
  */
1951
2172
  export interface CodeSnippetError {
1952
2173
  /**
2174
+ * @public
1953
2175
  * <p>The ARN of the finding that a code snippet couldn't be retrieved for.</p>
1954
2176
  */
1955
2177
  findingArn: string | undefined;
1956
2178
  /**
2179
+ * @public
1957
2180
  * <p>The error code for the error that prevented a code snippet from being retrieved.</p>
1958
2181
  */
1959
2182
  errorCode: CodeSnippetErrorCode | string | undefined;
1960
2183
  /**
2184
+ * @public
1961
2185
  * <p>The error message received when Amazon Inspector failed to retrieve a code snippet.</p>
1962
2186
  */
1963
2187
  errorMessage: string | undefined;
@@ -1967,19 +2191,196 @@ export interface CodeSnippetError {
1967
2191
  */
1968
2192
  export interface BatchGetCodeSnippetResponse {
1969
2193
  /**
2194
+ * @public
1970
2195
  * <p>The retrieved code snippets associated with the provided finding ARNs.</p>
1971
2196
  */
1972
2197
  codeSnippetResults?: CodeSnippetResult[];
1973
2198
  /**
2199
+ * @public
1974
2200
  * <p>Any errors Amazon Inspector encountered while trying to retrieve the requested code snippets.</p>
1975
2201
  */
1976
2202
  errors?: CodeSnippetError[];
1977
2203
  }
2204
+ /**
2205
+ * @public
2206
+ */
2207
+ export interface BatchGetFindingDetailsRequest {
2208
+ /**
2209
+ * @public
2210
+ * <p>A list of finding ARNs.</p>
2211
+ */
2212
+ findingArns: string[] | undefined;
2213
+ }
2214
+ /**
2215
+ * @public
2216
+ * @enum
2217
+ */
2218
+ export declare const FindingDetailsErrorCode: {
2219
+ readonly ACCESS_DENIED: "ACCESS_DENIED";
2220
+ readonly FINDING_DETAILS_NOT_FOUND: "FINDING_DETAILS_NOT_FOUND";
2221
+ readonly INTERNAL_ERROR: "INTERNAL_ERROR";
2222
+ readonly INVALID_INPUT: "INVALID_INPUT";
2223
+ };
2224
+ /**
2225
+ * @public
2226
+ */
2227
+ export type FindingDetailsErrorCode = (typeof FindingDetailsErrorCode)[keyof typeof FindingDetailsErrorCode];
2228
+ /**
2229
+ * @public
2230
+ * <p>Details about an error encountered when trying to return vulnerability data for a finding.</p>
2231
+ */
2232
+ export interface FindingDetailsError {
2233
+ /**
2234
+ * @public
2235
+ * <p>The finding ARN that returned an error.</p>
2236
+ */
2237
+ findingArn: string | undefined;
2238
+ /**
2239
+ * @public
2240
+ * <p>The error code.</p>
2241
+ */
2242
+ errorCode: FindingDetailsErrorCode | string | undefined;
2243
+ /**
2244
+ * @public
2245
+ * <p>The error message.</p>
2246
+ */
2247
+ errorMessage: string | undefined;
2248
+ }
2249
+ /**
2250
+ * @public
2251
+ * <p>The Cybersecurity and Infrastructure Security Agency (CISA) details for a specific vulnerability.</p>
2252
+ */
2253
+ export interface CisaData {
2254
+ /**
2255
+ * @public
2256
+ * <p>The date and time CISA added this vulnerability to their catalogue.</p>
2257
+ */
2258
+ dateAdded?: Date;
2259
+ /**
2260
+ * @public
2261
+ * <p>The date and time CISA expects a fix to have been provided vulnerability.</p>
2262
+ */
2263
+ dateDue?: Date;
2264
+ /**
2265
+ * @public
2266
+ * <p>The remediation action recommended by CISA for this vulnerability.</p>
2267
+ */
2268
+ action?: string;
2269
+ }
2270
+ /**
2271
+ * @public
2272
+ * <p>Details of the evidence for a vulnerability identified in a finding.</p>
2273
+ */
2274
+ export interface Evidence {
2275
+ /**
2276
+ * @public
2277
+ * <p>The evidence rule.</p>
2278
+ */
2279
+ evidenceRule?: string;
2280
+ /**
2281
+ * @public
2282
+ * <p>The evidence details.</p>
2283
+ */
2284
+ evidenceDetail?: string;
2285
+ /**
2286
+ * @public
2287
+ * <p>The evidence severity.</p>
2288
+ */
2289
+ severity?: string;
2290
+ }
2291
+ /**
2292
+ * @public
2293
+ * <p>Contains information on when this exploit was observed.</p>
2294
+ */
2295
+ export interface ExploitObserved {
2296
+ /**
2297
+ * @public
2298
+ * <p>The date an time when the exploit was last seen.</p>
2299
+ */
2300
+ lastSeen?: Date;
2301
+ /**
2302
+ * @public
2303
+ * <p>The date an time when the exploit was first seen.</p>
2304
+ */
2305
+ firstSeen?: Date;
2306
+ }
2307
+ /**
2308
+ * @public
2309
+ * <p>Details of the vulnerability identified in a finding.</p>
2310
+ */
2311
+ export interface FindingDetail {
2312
+ /**
2313
+ * @public
2314
+ * <p>The finding ARN that the vulnerability details are associated with.</p>
2315
+ */
2316
+ findingArn?: string;
2317
+ /**
2318
+ * @public
2319
+ * <p>The Cybersecurity and Infrastructure Security Agency (CISA) details for a specific vulnerability.</p>
2320
+ */
2321
+ cisaData?: CisaData;
2322
+ /**
2323
+ * @public
2324
+ * <p>The risk score of the vulnerability.</p>
2325
+ */
2326
+ riskScore?: number;
2327
+ /**
2328
+ * @public
2329
+ * <p>Information on the evidence of the vulnerability.</p>
2330
+ */
2331
+ evidences?: Evidence[];
2332
+ /**
2333
+ * @public
2334
+ * <p>The MITRE adversary tactics, techniques, or procedures (TTPs) associated with the vulnerability.</p>
2335
+ */
2336
+ ttps?: string[];
2337
+ /**
2338
+ * @public
2339
+ * <p>The known malware tools or kits that can exploit the vulnerability.</p>
2340
+ */
2341
+ tools?: string[];
2342
+ /**
2343
+ * @public
2344
+ * <p>Contains information on when this exploit was observed.</p>
2345
+ */
2346
+ exploitObserved?: ExploitObserved;
2347
+ /**
2348
+ * @public
2349
+ * <p>The reference URLs for the vulnerability data.</p>
2350
+ */
2351
+ referenceUrls?: string[];
2352
+ /**
2353
+ * @public
2354
+ * <p>The Common Weakness Enumerations (CWEs) associated with the vulnerability.</p>
2355
+ */
2356
+ cwes?: string[];
2357
+ /**
2358
+ * @public
2359
+ * <p>The Exploit Prediction Scoring System (EPSS) score of the vulnerability.</p>
2360
+ */
2361
+ epssScore?: number;
2362
+ }
2363
+ /**
2364
+ * @public
2365
+ */
2366
+ export interface BatchGetFindingDetailsResponse {
2367
+ /**
2368
+ * @public
2369
+ * <p>A finding's vulnerability details.</p>
2370
+ */
2371
+ findingDetails?: FindingDetail[];
2372
+ /**
2373
+ * @public
2374
+ * <p>Error information for findings that details could not be returned for.</p>
2375
+ */
2376
+ errors?: FindingDetailsError[];
2377
+ }
1978
2378
  /**
1979
2379
  * @public
1980
2380
  */
1981
2381
  export interface BatchGetFreeTrialInfoRequest {
1982
2382
  /**
2383
+ * @public
1983
2384
  * <p>The account IDs to get free trial status for.</p>
1984
2385
  */
1985
2386
  accountIds: string[] | undefined;
@@ -2016,18 +2417,22 @@ export type FreeTrialType = (typeof FreeTrialType)[keyof typeof FreeTrialType];
2016
2417
  */
2017
2418
  export interface FreeTrialInfo {
2018
2419
  /**
2420
+ * @public
2019
2421
  * <p>The type of scan covered by the Amazon Inspector free trail.</p>
2020
2422
  */
2021
2423
  type: FreeTrialType | string | undefined;
2022
2424
  /**
2425
+ * @public
2023
2426
  * <p>The date and time that the Amazon Inspector free trail started for a given account.</p>
2024
2427
  */
2025
2428
  start: Date | undefined;
2026
2429
  /**
2430
+ * @public
2027
2431
  * <p>The date and time that the Amazon Inspector free trail ends for a given account.</p>
2028
2432
  */
2029
2433
  end: Date | undefined;
2030
2434
  /**
2435
+ * @public
2031
2436
  * <p>The order to sort results by.</p>
2032
2437
  */
2033
2438
  status: FreeTrialStatus | string | undefined;
@@ -2038,10 +2443,12 @@ export interface FreeTrialInfo {
2038
2443
  */
2039
2444
  export interface FreeTrialAccountInfo {
2040
2445
  /**
2446
+ * @public
2041
2447
  * <p>The account associated with the Amazon Inspector free trial information.</p>
2042
2448
  */
2043
2449
  accountId: string | undefined;
2044
2450
  /**
2451
+ * @public
2045
2452
  * <p>Contains information about the Amazon Inspector free trial for an account.</p>
2046
2453
  */
2047
2454
  freeTrialInfo: FreeTrialInfo[] | undefined;
@@ -2064,14 +2471,17 @@ export type FreeTrialInfoErrorCode = (typeof FreeTrialInfoErrorCode)[keyof typeo
2064
2471
  */
2065
2472
  export interface FreeTrialInfoError {
2066
2473
  /**
2474
+ * @public
2067
2475
  * <p>The account associated with the Amazon Inspector free trial information.</p>
2068
2476
  */
2069
2477
  accountId: string | undefined;
2070
2478
  /**
2479
+ * @public
2071
2480
  * <p>The error code.</p>
2072
2481
  */
2073
2482
  code: FreeTrialInfoErrorCode | string | undefined;
2074
2483
  /**
2484
+ * @public
2075
2485
  * <p>The error message returned.</p>
2076
2486
  */
2077
2487
  message: string | undefined;
@@ -2081,11 +2491,13 @@ export interface FreeTrialInfoError {
2081
2491
  */
2082
2492
  export interface BatchGetFreeTrialInfoResponse {
2083
2493
  /**
2494
+ * @public
2084
2495
  * <p>An array of objects that provide Amazon Inspector free trial details for each of the requested accounts.
2085
2496
  * </p>
2086
2497
  */
2087
2498
  accounts: FreeTrialAccountInfo[] | undefined;
2088
2499
  /**
2500
+ * @public
2089
2501
  * <p>An array of objects detailing any accounts that free trial data could not be returned for.</p>
2090
2502
  */
2091
2503
  failedAccounts: FreeTrialInfoError[] | undefined;
@@ -2095,6 +2507,7 @@ export interface BatchGetFreeTrialInfoResponse {
2095
2507
  */
2096
2508
  export interface BatchGetMemberEc2DeepInspectionStatusRequest {
2097
2509
  /**
2510
+ * @public
2098
2511
  * <p>The unique identifiers for the Amazon Web Services accounts to retrieve Amazon Inspector deep inspection activation status for.
2099
2512
  *
2100
2513
  * </p>
@@ -2121,14 +2534,17 @@ export type Ec2DeepInspectionStatus = (typeof Ec2DeepInspectionStatus)[keyof typ
2121
2534
  */
2122
2535
  export interface MemberAccountEc2DeepInspectionStatusState {
2123
2536
  /**
2537
+ * @public
2124
2538
  * <p>The unique identifier for the Amazon Web Services account of the organization member</p>
2125
2539
  */
2126
2540
  accountId: string | undefined;
2127
2541
  /**
2542
+ * @public
2128
2543
  * <p>The state of Amazon Inspector deep inspection in the member account.</p>
2129
2544
  */
2130
2545
  status?: Ec2DeepInspectionStatus | string;
2131
2546
  /**
2547
+ * @public
2132
2548
  * <p>The error message explaining why the account failed to activate Amazon Inspector deep inspection.</p>
2133
2549
  */
2134
2550
  errorMessage?: string;
@@ -2139,14 +2555,17 @@ export interface MemberAccountEc2DeepInspectionStatusState {
2139
2555
  */
2140
2556
  export interface FailedMemberAccountEc2DeepInspectionStatusState {
2141
2557
  /**
2558
+ * @public
2142
2559
  * <p>The unique identifier for the Amazon Web Services account of the organization member that failed to activate Amazon Inspector deep inspection.</p>
2143
2560
  */
2144
2561
  accountId: string | undefined;
2145
2562
  /**
2563
+ * @public
2146
2564
  * <p>The status of EC2 scanning in the account that failed to activate Amazon Inspector deep inspection.</p>
2147
2565
  */
2148
2566
  ec2ScanStatus?: Status | string;
2149
2567
  /**
2568
+ * @public
2150
2569
  * <p>The error message explaining why the account failed to activate Amazon Inspector deep inspection.</p>
2151
2570
  */
2152
2571
  errorMessage?: string;
@@ -2156,12 +2575,14 @@ export interface FailedMemberAccountEc2DeepInspectionStatusState {
2156
2575
  */
2157
2576
  export interface BatchGetMemberEc2DeepInspectionStatusResponse {
2158
2577
  /**
2578
+ * @public
2159
2579
  * <p>An array of objects that provide details on the activation status of Amazon Inspector deep inspection for each of the requested accounts.
2160
2580
  *
2161
2581
  * </p>
2162
2582
  */
2163
2583
  accountIds?: MemberAccountEc2DeepInspectionStatusState[];
2164
2584
  /**
2585
+ * @public
2165
2586
  * <p>An array of objects that provide details on any accounts that failed to activate Amazon Inspector deep inspection and why.
2166
2587
  *
2167
2588
  * </p>
@@ -2174,10 +2595,12 @@ export interface BatchGetMemberEc2DeepInspectionStatusResponse {
2174
2595
  */
2175
2596
  export interface MemberAccountEc2DeepInspectionStatus {
2176
2597
  /**
2598
+ * @public
2177
2599
  * <p>The unique identifier for the Amazon Web Services account of the organization member.</p>
2178
2600
  */
2179
2601
  accountId: string | undefined;
2180
2602
  /**
2603
+ * @public
2181
2604
  * <p>Whether Amazon Inspector deep inspection is active in the account. If <code>TRUE</code> Amazon Inspector deep inspection is active, if <code>FALSE</code> it is not active.</p>
2182
2605
  */
2183
2606
  activateDeepInspection: boolean | undefined;
@@ -2187,6 +2610,7 @@ export interface MemberAccountEc2DeepInspectionStatus {
2187
2610
  */
2188
2611
  export interface BatchUpdateMemberEc2DeepInspectionStatusRequest {
2189
2612
  /**
2613
+ * @public
2190
2614
  * <p>The unique identifiers for the Amazon Web Services accounts to change Amazon Inspector deep inspection status for.</p>
2191
2615
  */
2192
2616
  accountIds: MemberAccountEc2DeepInspectionStatus[] | undefined;
@@ -2196,11 +2620,13 @@ export interface BatchUpdateMemberEc2DeepInspectionStatusRequest {
2196
2620
  */
2197
2621
  export interface BatchUpdateMemberEc2DeepInspectionStatusResponse {
2198
2622
  /**
2623
+ * @public
2199
2624
  * <p>An array of objects that provide details for each of the accounts that Amazon Inspector deep inspection status was successfully changed for.
2200
2625
  * </p>
2201
2626
  */
2202
2627
  accountIds?: MemberAccountEc2DeepInspectionStatusState[];
2203
2628
  /**
2629
+ * @public
2204
2630
  * <p>An array of objects that provide details for each of the accounts that Amazon Inspector deep inspection status could not be successfully changed for.
2205
2631
  * </p>
2206
2632
  */
@@ -2211,6 +2637,7 @@ export interface BatchUpdateMemberEc2DeepInspectionStatusResponse {
2211
2637
  */
2212
2638
  export interface CancelFindingsReportRequest {
2213
2639
  /**
2640
+ * @public
2214
2641
  * <p>The ID of the report to be canceled.</p>
2215
2642
  */
2216
2643
  reportId: string | undefined;
@@ -2220,6 +2647,7 @@ export interface CancelFindingsReportRequest {
2220
2647
  */
2221
2648
  export interface CancelFindingsReportResponse {
2222
2649
  /**
2650
+ * @public
2223
2651
  * <p>The ID of the canceled report.</p>
2224
2652
  */
2225
2653
  reportId: string | undefined;
@@ -2229,6 +2657,7 @@ export interface CancelFindingsReportResponse {
2229
2657
  */
2230
2658
  export interface CancelSbomExportRequest {
2231
2659
  /**
2660
+ * @public
2232
2661
  * <p>The report ID of the SBOM export to cancel.</p>
2233
2662
  */
2234
2663
  reportId: string | undefined;
@@ -2238,46 +2667,33 @@ export interface CancelSbomExportRequest {
2238
2667
  */
2239
2668
  export interface CancelSbomExportResponse {
2240
2669
  /**
2670
+ * @public
2241
2671
  * <p>The report ID of the canceled SBOM export.</p>
2242
2672
  */
2243
2673
  reportId?: string;
2244
2674
  }
2245
- /**
2246
- * @public
2247
- * <p>The Cybersecurity and Infrastructure Security Agency (CISA) details for a specific vulnerability.</p>
2248
- */
2249
- export interface CisaData {
2250
- /**
2251
- * <p>The date and time CISA added this vulnerability to their catalogue.</p>
2252
- */
2253
- dateAdded?: Date;
2254
- /**
2255
- * <p>The date and time CISA expects a fix to have been provided vulnerability.</p>
2256
- */
2257
- dateDue?: Date;
2258
- /**
2259
- * <p>The remediation action recommended by CISA for this vulnerability.</p>
2260
- */
2261
- action?: string;
2262
- }
2263
2675
  /**
2264
2676
  * @public
2265
2677
  * <p>Contains information on where a code vulnerability is located in your Lambda function.</p>
2266
2678
  */
2267
2679
  export interface CodeFilePath {
2268
2680
  /**
2681
+ * @public
2269
2682
  * <p>The name of the file the code vulnerability was found in.</p>
2270
2683
  */
2271
2684
  fileName: string | undefined;
2272
2685
  /**
2686
+ * @public
2273
2687
  * <p>The file path to the code that a vulnerability was found in.</p>
2274
2688
  */
2275
2689
  filePath: string | undefined;
2276
2690
  /**
2691
+ * @public
2277
2692
  * <p>The line number of the first line of code that a vulnerability was found in.</p>
2278
2693
  */
2279
2694
  startLine: number | undefined;
2280
2695
  /**
2696
+ * @public
2281
2697
  * <p>The line number of the last line of code that a vulnerability was found in.</p>
2282
2698
  */
2283
2699
  endLine: number | undefined;
@@ -2288,35 +2704,43 @@ export interface CodeFilePath {
2288
2704
  */
2289
2705
  export interface CodeVulnerabilityDetails {
2290
2706
  /**
2707
+ * @public
2291
2708
  * <p>Contains information on where the code vulnerability is located in your code.</p>
2292
2709
  */
2293
2710
  filePath: CodeFilePath | undefined;
2294
2711
  /**
2712
+ * @public
2295
2713
  * <p>The detector tag associated with the vulnerability. Detector tags group related vulnerabilities by common themes or tactics. For a list of available tags by programming language, see <a href="https://docs.aws.amazon.com/codeguru/detector-library/java/tags/">Java tags</a>, or <a href="https://docs.aws.amazon.com/codeguru/detector-library/python/tags/">Python tags</a>. </p>
2296
2714
  */
2297
2715
  detectorTags?: string[];
2298
2716
  /**
2717
+ * @public
2299
2718
  * <p>A URL containing supporting documentation about the code vulnerability detected.</p>
2300
2719
  */
2301
2720
  referenceUrls?: string[];
2302
2721
  /**
2722
+ * @public
2303
2723
  * <p>The identifier for a rule that was used to detect the code vulnerability.</p>
2304
2724
  */
2305
2725
  ruleId?: string;
2306
2726
  /**
2727
+ * @public
2307
2728
  * <p>The Amazon Resource Name (ARN) of the Lambda layer that the code vulnerability was detected in.</p>
2308
2729
  */
2309
2730
  sourceLambdaLayerArn?: string;
2310
2731
  /**
2732
+ * @public
2311
2733
  * <p>The ID for the Amazon CodeGuru detector associated with the finding. For more information on detectors see <a href="https://docs.aws.amazon.com/codeguru/detector-library">Amazon CodeGuru
2312
2734
  * Detector Library</a>.</p>
2313
2735
  */
2314
2736
  detectorId: string | undefined;
2315
2737
  /**
2738
+ * @public
2316
2739
  * <p>The name of the detector used to identify the code vulnerability. For more information on detectors see <a href="https://docs.aws.amazon.com/codeguru/detector-library">CodeGuru Detector Library</a>.</p>
2317
2740
  */
2318
2741
  detectorName: string | undefined;
2319
2742
  /**
2743
+ * @public
2320
2744
  * <p>The Common Weakness Enumeration (CWE) item associated with the detected vulnerability.</p>
2321
2745
  */
2322
2746
  cwes: string[] | undefined;
@@ -2329,10 +2753,12 @@ export declare class ConflictException extends __BaseException {
2329
2753
  readonly name: "ConflictException";
2330
2754
  readonly $fault: "client";
2331
2755
  /**
2756
+ * @public
2332
2757
  * <p>The ID of the conflicting resource.</p>
2333
2758
  */
2334
2759
  resourceId: string | undefined;
2335
2760
  /**
2761
+ * @public
2336
2762
  * <p>The type of the conflicting resource.</p>
2337
2763
  */
2338
2764
  resourceType: string | undefined;
@@ -2362,10 +2788,12 @@ export type GroupKey = (typeof GroupKey)[keyof typeof GroupKey];
2362
2788
  */
2363
2789
  export interface Counts {
2364
2790
  /**
2791
+ * @public
2365
2792
  * <p>The number of resources.</p>
2366
2793
  */
2367
2794
  count?: number;
2368
2795
  /**
2796
+ * @public
2369
2797
  * <p>The key associated with this group</p>
2370
2798
  */
2371
2799
  groupKey?: GroupKey | string;
@@ -2376,10 +2804,12 @@ export interface Counts {
2376
2804
  */
2377
2805
  export interface CoverageDateFilter {
2378
2806
  /**
2807
+ * @public
2379
2808
  * <p>A timestamp representing the start of the time period to filter results by.</p>
2380
2809
  */
2381
2810
  startInclusive?: Date;
2382
2811
  /**
2812
+ * @public
2383
2813
  * <p>A timestamp representing the end of the time period to filter results by.</p>
2384
2814
  */
2385
2815
  endInclusive?: Date;
@@ -2402,10 +2832,12 @@ export type CoverageStringComparison = (typeof CoverageStringComparison)[keyof t
2402
2832
  */
2403
2833
  export interface CoverageStringFilter {
2404
2834
  /**
2835
+ * @public
2405
2836
  * <p>The operator to compare strings on.</p>
2406
2837
  */
2407
2838
  comparison: CoverageStringComparison | string | undefined;
2408
2839
  /**
2840
+ * @public
2409
2841
  * <p>The value to compare strings on.</p>
2410
2842
  */
2411
2843
  value: string | undefined;
@@ -2427,14 +2859,17 @@ export type CoverageMapComparison = (typeof CoverageMapComparison)[keyof typeof
2427
2859
  */
2428
2860
  export interface CoverageMapFilter {
2429
2861
  /**
2862
+ * @public
2430
2863
  * <p>The operator to compare coverage on.</p>
2431
2864
  */
2432
2865
  comparison: CoverageMapComparison | string | undefined;
2433
2866
  /**
2867
+ * @public
2434
2868
  * <p>The tag key associated with the coverage map filter.</p>
2435
2869
  */
2436
2870
  key: string | undefined;
2437
2871
  /**
2872
+ * @public
2438
2873
  * <p>The tag value associated with the coverage map filter.</p>
2439
2874
  */
2440
2875
  value?: string;
@@ -2445,54 +2880,67 @@ export interface CoverageMapFilter {
2445
2880
  */
2446
2881
  export interface CoverageFilterCriteria {
2447
2882
  /**
2883
+ * @public
2448
2884
  * <p>The scan status code to filter on.</p>
2449
2885
  */
2450
2886
  scanStatusCode?: CoverageStringFilter[];
2451
2887
  /**
2888
+ * @public
2452
2889
  * <p>The scan status reason to filter on.</p>
2453
2890
  */
2454
2891
  scanStatusReason?: CoverageStringFilter[];
2455
2892
  /**
2893
+ * @public
2456
2894
  * <p>An array of Amazon Web Services account IDs to return coverage statistics for.</p>
2457
2895
  */
2458
2896
  accountId?: CoverageStringFilter[];
2459
2897
  /**
2898
+ * @public
2460
2899
  * <p>An array of Amazon Web Services resource IDs to return coverage statistics for.</p>
2461
2900
  */
2462
2901
  resourceId?: CoverageStringFilter[];
2463
2902
  /**
2903
+ * @public
2464
2904
  * <p>An array of Amazon Web Services resource types to return coverage statistics for. The values can be <code>AWS_EC2_INSTANCE</code>, <code>AWS_LAMBDA_FUNCTION</code> or <code>AWS_ECR_REPOSITORY</code>.</p>
2465
2905
  */
2466
2906
  resourceType?: CoverageStringFilter[];
2467
2907
  /**
2908
+ * @public
2468
2909
  * <p>An array of Amazon Inspector scan types to return coverage statistics for.</p>
2469
2910
  */
2470
2911
  scanType?: CoverageStringFilter[];
2471
2912
  /**
2913
+ * @public
2472
2914
  * <p>The Amazon ECR repository name to filter on.</p>
2473
2915
  */
2474
2916
  ecrRepositoryName?: CoverageStringFilter[];
2475
2917
  /**
2918
+ * @public
2476
2919
  * <p>The Amazon ECR image tags to filter on.</p>
2477
2920
  */
2478
2921
  ecrImageTags?: CoverageStringFilter[];
2479
2922
  /**
2923
+ * @public
2480
2924
  * <p>The Amazon EC2 instance tags to filter on.</p>
2481
2925
  */
2482
2926
  ec2InstanceTags?: CoverageMapFilter[];
2483
2927
  /**
2928
+ * @public
2484
2929
  * <p>Returns coverage statistics for AWS Lambda functions filtered by function names.</p>
2485
2930
  */
2486
2931
  lambdaFunctionName?: CoverageStringFilter[];
2487
2932
  /**
2933
+ * @public
2488
2934
  * <p>Returns coverage statistics for AWS Lambda functions filtered by tag.</p>
2489
2935
  */
2490
2936
  lambdaFunctionTags?: CoverageMapFilter[];
2491
2937
  /**
2938
+ * @public
2492
2939
  * <p>Returns coverage statistics for AWS Lambda functions filtered by runtime.</p>
2493
2940
  */
2494
2941
  lambdaFunctionRuntime?: CoverageStringFilter[];
2495
2942
  /**
2943
+ * @public
2496
2944
  * <p>Filters Amazon Web Services resources based on whether Amazon Inspector has checked them for vulnerabilities within the specified time range.</p>
2497
2945
  */
2498
2946
  lastScannedAt?: CoverageDateFilter[];
@@ -2530,14 +2978,17 @@ export type Ec2Platform = (typeof Ec2Platform)[keyof typeof Ec2Platform];
2530
2978
  */
2531
2979
  export interface Ec2Metadata {
2532
2980
  /**
2981
+ * @public
2533
2982
  * <p>The tags attached to the instance.</p>
2534
2983
  */
2535
2984
  tags?: Record<string, string>;
2536
2985
  /**
2986
+ * @public
2537
2987
  * <p>The ID of the Amazon Machine Image (AMI) used to launch the instance.</p>
2538
2988
  */
2539
2989
  amiId?: string;
2540
2990
  /**
2991
+ * @public
2541
2992
  * <p>The platform of the instance.</p>
2542
2993
  */
2543
2994
  platform?: Ec2Platform | string;
@@ -2548,6 +2999,7 @@ export interface Ec2Metadata {
2548
2999
  */
2549
3000
  export interface EcrContainerImageMetadata {
2550
3001
  /**
3002
+ * @public
2551
3003
  * <p>Tags associated with the Amazon ECR image metadata.</p>
2552
3004
  */
2553
3005
  tags?: string[];
@@ -2571,10 +3023,12 @@ export type EcrScanFrequency = (typeof EcrScanFrequency)[keyof typeof EcrScanFre
2571
3023
  */
2572
3024
  export interface EcrRepositoryMetadata {
2573
3025
  /**
3026
+ * @public
2574
3027
  * <p>The name of the Amazon ECR repository.</p>
2575
3028
  */
2576
3029
  name?: string;
2577
3030
  /**
3031
+ * @public
2578
3032
  * <p>The frequency of scans.</p>
2579
3033
  */
2580
3034
  scanFrequency?: EcrScanFrequency | string;
@@ -2585,18 +3039,22 @@ export interface EcrRepositoryMetadata {
2585
3039
  */
2586
3040
  export interface LambdaFunctionMetadata {
2587
3041
  /**
3042
+ * @public
2588
3043
  * <p>The resource tags on an AWS Lambda function.</p>
2589
3044
  */
2590
3045
  functionTags?: Record<string, string>;
2591
3046
  /**
3047
+ * @public
2592
3048
  * <p>The layers for an AWS Lambda function. A Lambda function can have up to five layers.</p>
2593
3049
  */
2594
3050
  layers?: string[];
2595
3051
  /**
3052
+ * @public
2596
3053
  * <p>The name of a function.</p>
2597
3054
  */
2598
3055
  functionName?: string;
2599
3056
  /**
3057
+ * @public
2600
3058
  * <p>An AWS Lambda function's runtime.</p>
2601
3059
  */
2602
3060
  runtime?: Runtime | string;
@@ -2607,18 +3065,22 @@ export interface LambdaFunctionMetadata {
2607
3065
  */
2608
3066
  export interface ResourceScanMetadata {
2609
3067
  /**
3068
+ * @public
2610
3069
  * <p>An object that contains details about the repository an Amazon ECR image resides in.</p>
2611
3070
  */
2612
3071
  ecrRepository?: EcrRepositoryMetadata;
2613
3072
  /**
3073
+ * @public
2614
3074
  * <p>An object that contains details about the container metadata for an Amazon ECR image.</p>
2615
3075
  */
2616
3076
  ecrImage?: EcrContainerImageMetadata;
2617
3077
  /**
3078
+ * @public
2618
3079
  * <p>An object that contains metadata details for an Amazon EC2 instance.</p>
2619
3080
  */
2620
3081
  ec2?: Ec2Metadata;
2621
3082
  /**
3083
+ * @public
2622
3084
  * <p>An object that contains metadata details for an AWS Lambda function.</p>
2623
3085
  */
2624
3086
  lambdaFunction?: LambdaFunctionMetadata;
@@ -2675,10 +3137,12 @@ export type ScanStatusCode = (typeof ScanStatusCode)[keyof typeof ScanStatusCode
2675
3137
  */
2676
3138
  export interface ScanStatus {
2677
3139
  /**
3140
+ * @public
2678
3141
  * <p>The status code of the scan.</p>
2679
3142
  */
2680
3143
  statusCode: ScanStatusCode | string | undefined;
2681
3144
  /**
3145
+ * @public
2682
3146
  * <p>The reason for the scan.</p>
2683
3147
  */
2684
3148
  reason: ScanStatusReason | string | undefined;
@@ -2702,30 +3166,37 @@ export type ScanType = (typeof ScanType)[keyof typeof ScanType];
2702
3166
  */
2703
3167
  export interface CoveredResource {
2704
3168
  /**
3169
+ * @public
2705
3170
  * <p>The type of the covered resource.</p>
2706
3171
  */
2707
3172
  resourceType: CoverageResourceType | string | undefined;
2708
3173
  /**
3174
+ * @public
2709
3175
  * <p>The ID of the covered resource.</p>
2710
3176
  */
2711
3177
  resourceId: string | undefined;
2712
3178
  /**
3179
+ * @public
2713
3180
  * <p>The Amazon Web Services account ID of the covered resource.</p>
2714
3181
  */
2715
3182
  accountId: string | undefined;
2716
3183
  /**
3184
+ * @public
2717
3185
  * <p>The Amazon Inspector scan type covering the resource.</p>
2718
3186
  */
2719
3187
  scanType: ScanType | string | undefined;
2720
3188
  /**
3189
+ * @public
2721
3190
  * <p>The status of the scan covering the resource.</p>
2722
3191
  */
2723
3192
  scanStatus?: ScanStatus;
2724
3193
  /**
3194
+ * @public
2725
3195
  * <p>An object that contains details about the metadata.</p>
2726
3196
  */
2727
3197
  resourceMetadata?: ResourceScanMetadata;
2728
3198
  /**
3199
+ * @public
2729
3200
  * <p>The date and time the resource was last checked for vulnerabilities.</p>
2730
3201
  */
2731
3202
  lastScannedAt?: Date;
@@ -2748,10 +3219,12 @@ export type FilterAction = (typeof FilterAction)[keyof typeof FilterAction];
2748
3219
  */
2749
3220
  export interface DateFilter {
2750
3221
  /**
3222
+ * @public
2751
3223
  * <p>A timestamp representing the start of the time period filtered on.</p>
2752
3224
  */
2753
3225
  startInclusive?: Date;
2754
3226
  /**
3227
+ * @public
2755
3228
  * <p>A timestamp representing the end of the time period filtered on.</p>
2756
3229
  */
2757
3230
  endInclusive?: Date;
@@ -2762,10 +3235,12 @@ export interface DateFilter {
2762
3235
  */
2763
3236
  export interface NumberFilter {
2764
3237
  /**
3238
+ * @public
2765
3239
  * <p>The highest number to be included in the filter.</p>
2766
3240
  */
2767
3241
  upperInclusive?: number;
2768
3242
  /**
3243
+ * @public
2769
3244
  * <p>The lowest number to be included in the filter.</p>
2770
3245
  */
2771
3246
  lowerInclusive?: number;
@@ -2776,10 +3251,12 @@ export interface NumberFilter {
2776
3251
  */
2777
3252
  export interface PortRangeFilter {
2778
3253
  /**
3254
+ * @public
2779
3255
  * <p>The port number the port range begins at.</p>
2780
3256
  */
2781
3257
  beginInclusive?: number;
2782
3258
  /**
3259
+ * @public
2783
3260
  * <p>The port number the port range ends at.</p>
2784
3261
  */
2785
3262
  endInclusive?: number;
@@ -2790,30 +3267,37 @@ export interface PortRangeFilter {
2790
3267
  */
2791
3268
  export interface PackageFilter {
2792
3269
  /**
3270
+ * @public
2793
3271
  * <p>An object that contains details on the name of the package to filter on.</p>
2794
3272
  */
2795
3273
  name?: StringFilter;
2796
3274
  /**
3275
+ * @public
2797
3276
  * <p>The package version to filter on.</p>
2798
3277
  */
2799
3278
  version?: StringFilter;
2800
3279
  /**
3280
+ * @public
2801
3281
  * <p>An object that contains details on the package epoch to filter on.</p>
2802
3282
  */
2803
3283
  epoch?: NumberFilter;
2804
3284
  /**
3285
+ * @public
2805
3286
  * <p>An object that contains details on the package release to filter on.</p>
2806
3287
  */
2807
3288
  release?: StringFilter;
2808
3289
  /**
3290
+ * @public
2809
3291
  * <p>An object that contains details on the package architecture type to filter on.</p>
2810
3292
  */
2811
3293
  architecture?: StringFilter;
2812
3294
  /**
3295
+ * @public
2813
3296
  * <p>An object that contains details on the source layer hash to filter on.</p>
2814
3297
  */
2815
3298
  sourceLayerHash?: StringFilter;
2816
3299
  /**
3300
+ * @public
2817
3301
  * <p>An object that describes the details of a string filter.</p>
2818
3302
  */
2819
3303
  sourceLambdaLayerArn?: StringFilter;
@@ -2824,172 +3308,214 @@ export interface PackageFilter {
2824
3308
  */
2825
3309
  export interface FilterCriteria {
2826
3310
  /**
3311
+ * @public
2827
3312
  * <p>Details on the finding ARNs used to filter findings.</p>
2828
3313
  */
2829
3314
  findingArn?: StringFilter[];
2830
3315
  /**
3316
+ * @public
2831
3317
  * <p>Details of the Amazon Web Services account IDs used to filter findings.</p>
2832
3318
  */
2833
3319
  awsAccountId?: StringFilter[];
2834
3320
  /**
3321
+ * @public
2835
3322
  * <p>Details on the finding types used to filter findings.</p>
2836
3323
  */
2837
3324
  findingType?: StringFilter[];
2838
3325
  /**
3326
+ * @public
2839
3327
  * <p>Details on the severity used to filter findings.</p>
2840
3328
  */
2841
3329
  severity?: StringFilter[];
2842
3330
  /**
3331
+ * @public
2843
3332
  * <p>Details on the date and time a finding was first seen used to filter findings.</p>
2844
3333
  */
2845
3334
  firstObservedAt?: DateFilter[];
2846
3335
  /**
3336
+ * @public
2847
3337
  * <p>Details on the date and time a finding was last seen used to filter findings.</p>
2848
3338
  */
2849
3339
  lastObservedAt?: DateFilter[];
2850
3340
  /**
3341
+ * @public
2851
3342
  * <p>Details on the date and time a finding was last updated at used to filter findings.</p>
2852
3343
  */
2853
3344
  updatedAt?: DateFilter[];
2854
3345
  /**
3346
+ * @public
2855
3347
  * <p>Details on the finding status types used to filter findings.</p>
2856
3348
  */
2857
3349
  findingStatus?: StringFilter[];
2858
3350
  /**
3351
+ * @public
2859
3352
  * <p>Details on the finding title used to filter findings.</p>
2860
3353
  */
2861
3354
  title?: StringFilter[];
2862
3355
  /**
3356
+ * @public
2863
3357
  * <p>The Amazon Inspector score to filter on.</p>
2864
3358
  */
2865
3359
  inspectorScore?: NumberFilter[];
2866
3360
  /**
3361
+ * @public
2867
3362
  * <p>Details on the resource types used to filter findings.</p>
2868
3363
  */
2869
3364
  resourceType?: StringFilter[];
2870
3365
  /**
3366
+ * @public
2871
3367
  * <p>Details on the resource IDs used to filter findings.</p>
2872
3368
  */
2873
3369
  resourceId?: StringFilter[];
2874
3370
  /**
3371
+ * @public
2875
3372
  * <p>Details on the resource tags used to filter findings.</p>
2876
3373
  */
2877
3374
  resourceTags?: MapFilter[];
2878
3375
  /**
3376
+ * @public
2879
3377
  * <p>Details of the Amazon EC2 instance image IDs used to filter findings.</p>
2880
3378
  */
2881
3379
  ec2InstanceImageId?: StringFilter[];
2882
3380
  /**
3381
+ * @public
2883
3382
  * <p>Details of the Amazon EC2 instance VPC IDs used to filter findings.</p>
2884
3383
  */
2885
3384
  ec2InstanceVpcId?: StringFilter[];
2886
3385
  /**
3386
+ * @public
2887
3387
  * <p>Details of the Amazon EC2 instance subnet IDs used to filter findings.</p>
2888
3388
  */
2889
3389
  ec2InstanceSubnetId?: StringFilter[];
2890
3390
  /**
3391
+ * @public
2891
3392
  * <p>Details on the Amazon ECR image push date and time used to filter findings.</p>
2892
3393
  */
2893
3394
  ecrImagePushedAt?: DateFilter[];
2894
3395
  /**
3396
+ * @public
2895
3397
  * <p>Details of the Amazon ECR image architecture types used to filter findings.</p>
2896
3398
  */
2897
3399
  ecrImageArchitecture?: StringFilter[];
2898
3400
  /**
3401
+ * @public
2899
3402
  * <p>Details on the Amazon ECR registry used to filter findings.</p>
2900
3403
  */
2901
3404
  ecrImageRegistry?: StringFilter[];
2902
3405
  /**
3406
+ * @public
2903
3407
  * <p>Details on the name of the Amazon ECR repository used to filter findings.</p>
2904
3408
  */
2905
3409
  ecrImageRepositoryName?: StringFilter[];
2906
3410
  /**
3411
+ * @public
2907
3412
  * <p>The tags attached to the Amazon ECR container image.</p>
2908
3413
  */
2909
3414
  ecrImageTags?: StringFilter[];
2910
3415
  /**
3416
+ * @public
2911
3417
  * <p>Details of the Amazon ECR image hashes used to filter findings.</p>
2912
3418
  */
2913
3419
  ecrImageHash?: StringFilter[];
2914
3420
  /**
3421
+ * @public
2915
3422
  * <p>Details on the port ranges used to filter findings.</p>
2916
3423
  */
2917
3424
  portRange?: PortRangeFilter[];
2918
3425
  /**
2919
- * <p>Details on the ingress source addresses used to filter findings.</p>
3426
+ * @public
3427
+ * <p>Details on network protocol used to filter findings.</p>
2920
3428
  */
2921
3429
  networkProtocol?: StringFilter[];
2922
3430
  /**
3431
+ * @public
2923
3432
  * <p>Details of the component IDs used to filter findings.</p>
2924
3433
  */
2925
3434
  componentId?: StringFilter[];
2926
3435
  /**
3436
+ * @public
2927
3437
  * <p>Details of the component types used to filter findings.</p>
2928
3438
  */
2929
3439
  componentType?: StringFilter[];
2930
3440
  /**
3441
+ * @public
2931
3442
  * <p>Details on the vulnerability ID used to filter findings.</p>
2932
3443
  */
2933
3444
  vulnerabilityId?: StringFilter[];
2934
3445
  /**
3446
+ * @public
2935
3447
  * <p>Details on the vulnerability type used to filter findings.</p>
2936
3448
  */
2937
3449
  vulnerabilitySource?: StringFilter[];
2938
3450
  /**
3451
+ * @public
2939
3452
  * <p>Details on the vendor severity used to filter findings.</p>
2940
3453
  */
2941
3454
  vendorSeverity?: StringFilter[];
2942
3455
  /**
3456
+ * @public
2943
3457
  * <p>Details on the vulnerable packages used to filter findings.</p>
2944
3458
  */
2945
3459
  vulnerablePackages?: PackageFilter[];
2946
3460
  /**
3461
+ * @public
2947
3462
  * <p>Details on the related vulnerabilities used to filter findings.</p>
2948
3463
  */
2949
3464
  relatedVulnerabilities?: StringFilter[];
2950
3465
  /**
3466
+ * @public
2951
3467
  * <p>Details on whether a fix is available through a version update. This value can be <code>YES</code>, <code>NO</code>, or <code>PARTIAL</code>. A <code>PARTIAL</code> fix means that some, but not all, of the packages identified in the finding have fixes available through updated versions.</p>
2952
3468
  */
2953
3469
  fixAvailable?: StringFilter[];
2954
3470
  /**
3471
+ * @public
2955
3472
  * <p>Filters the list of AWS Lambda functions by the name of the function.</p>
2956
3473
  */
2957
3474
  lambdaFunctionName?: StringFilter[];
2958
3475
  /**
3476
+ * @public
2959
3477
  * <p>Filters the list of AWS Lambda functions by the function's <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html">
2960
3478
  * layers</a>. A Lambda function can have up to five layers.</p>
2961
3479
  */
2962
3480
  lambdaFunctionLayers?: StringFilter[];
2963
3481
  /**
3482
+ * @public
2964
3483
  * <p>Filters the list of AWS Lambda functions by the runtime environment for the Lambda function.</p>
2965
3484
  */
2966
3485
  lambdaFunctionRuntime?: StringFilter[];
2967
3486
  /**
3487
+ * @public
2968
3488
  * <p>Filters the list of AWS Lambda functions by the date and time that a user last updated the configuration, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601 format</a>
2969
3489
  * </p>
2970
3490
  */
2971
3491
  lambdaFunctionLastModifiedAt?: DateFilter[];
2972
3492
  /**
3493
+ * @public
2973
3494
  * <p>Filters the list of AWS Lambda functions by execution role.</p>
2974
3495
  */
2975
3496
  lambdaFunctionExecutionRoleArn?: StringFilter[];
2976
3497
  /**
3498
+ * @public
2977
3499
  * <p>Filters the list of AWS Lambda findings by the availability of exploits.</p>
2978
3500
  */
2979
3501
  exploitAvailable?: StringFilter[];
2980
3502
  /**
3503
+ * @public
2981
3504
  * <p>The name of the detector used to identify a code vulnerability in a Lambda function used to filter findings.</p>
2982
3505
  */
2983
3506
  codeVulnerabilityDetectorName?: StringFilter[];
2984
3507
  /**
3508
+ * @public
2985
3509
  * <p>The detector type tag associated with the vulnerability used to filter findings. Detector tags group related vulnerabilities by common themes or tactics. For a list of available tags by programming language, see <a href="https://docs.aws.amazon.com/codeguru/detector-library/java/tags/">Java tags</a>, or <a href="https://docs.aws.amazon.com/codeguru/detector-library/python/tags/">Python tags</a>. </p>
2986
3510
  */
2987
3511
  codeVulnerabilityDetectorTags?: StringFilter[];
2988
3512
  /**
3513
+ * @public
2989
3514
  * <p>The file path to the file in a Lambda function that contains a code vulnerability used to filter findings.</p>
2990
3515
  */
2991
3516
  codeVulnerabilityFilePath?: StringFilter[];
2992
3517
  /**
3518
+ * @public
2993
3519
  * <p>The EPSS score used to filter findings.</p>
2994
3520
  */
2995
3521
  epssScore?: NumberFilter[];
@@ -2999,28 +3525,34 @@ export interface FilterCriteria {
2999
3525
  */
3000
3526
  export interface CreateFilterRequest {
3001
3527
  /**
3528
+ * @public
3002
3529
  * <p>Defines the action that is to be applied to the findings that match the filter.</p>
3003
3530
  */
3004
3531
  action: FilterAction | string | undefined;
3005
3532
  /**
3533
+ * @public
3006
3534
  * <p>A description of the filter.</p>
3007
3535
  */
3008
3536
  description?: string;
3009
3537
  /**
3538
+ * @public
3010
3539
  * <p>Defines the criteria to be used in the filter for querying findings.</p>
3011
3540
  */
3012
3541
  filterCriteria: FilterCriteria | undefined;
3013
3542
  /**
3543
+ * @public
3014
3544
  * <p>The name of the filter. Minimum length of 3. Maximum length of 64. Valid characters
3015
3545
  * include alphanumeric characters, dot (.), underscore (_), and dash (-). Spaces are not
3016
3546
  * allowed.</p>
3017
3547
  */
3018
3548
  name: string | undefined;
3019
3549
  /**
3550
+ * @public
3020
3551
  * <p>A list of tags for the filter.</p>
3021
3552
  */
3022
3553
  tags?: Record<string, string>;
3023
3554
  /**
3555
+ * @public
3024
3556
  * <p>The reason for creating the filter.</p>
3025
3557
  */
3026
3558
  reason?: string;
@@ -3030,6 +3562,7 @@ export interface CreateFilterRequest {
3030
3562
  */
3031
3563
  export interface CreateFilterResponse {
3032
3564
  /**
3565
+ * @public
3033
3566
  * <p>The Amazon Resource Number (ARN) of the successfully created filter.</p>
3034
3567
  */
3035
3568
  arn: string | undefined;
@@ -3043,6 +3576,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
3043
3576
  readonly name: "ServiceQuotaExceededException";
3044
3577
  readonly $fault: "client";
3045
3578
  /**
3579
+ * @public
3046
3580
  * <p>The ID of the resource that exceeds a service quota.</p>
3047
3581
  */
3048
3582
  resourceId: string | undefined;
@@ -3069,14 +3603,17 @@ export type ReportFormat = (typeof ReportFormat)[keyof typeof ReportFormat];
3069
3603
  */
3070
3604
  export interface Destination {
3071
3605
  /**
3606
+ * @public
3072
3607
  * <p>The name of the Amazon S3 bucket to export findings to.</p>
3073
3608
  */
3074
3609
  bucketName: string | undefined;
3075
3610
  /**
3076
- * <p>The prefix of the Amazon S3 bucket used to export findings.</p>
3611
+ * @public
3612
+ * <p>The prefix that the findings will be written under.</p>
3077
3613
  */
3078
3614
  keyPrefix?: string;
3079
3615
  /**
3616
+ * @public
3080
3617
  * <p>The ARN of the KMS key used to encrypt data when exporting findings.</p>
3081
3618
  */
3082
3619
  kmsKeyArn: string | undefined;
@@ -3086,14 +3623,17 @@ export interface Destination {
3086
3623
  */
3087
3624
  export interface CreateFindingsReportRequest {
3088
3625
  /**
3626
+ * @public
3089
3627
  * <p>The filter criteria to apply to the results of the finding report.</p>
3090
3628
  */
3091
3629
  filterCriteria?: FilterCriteria;
3092
3630
  /**
3631
+ * @public
3093
3632
  * <p>The format to generate the report in.</p>
3094
3633
  */
3095
3634
  reportFormat: ReportFormat | string | undefined;
3096
3635
  /**
3636
+ * @public
3097
3637
  * <p>The Amazon S3 export destination for the report.</p>
3098
3638
  */
3099
3639
  s3Destination: Destination | undefined;
@@ -3103,6 +3643,7 @@ export interface CreateFindingsReportRequest {
3103
3643
  */
3104
3644
  export interface CreateFindingsReportResponse {
3105
3645
  /**
3646
+ * @public
3106
3647
  * <p>The ID of the report.</p>
3107
3648
  */
3108
3649
  reportId?: string;
@@ -3137,10 +3678,12 @@ export type ResourceStringComparison = (typeof ResourceStringComparison)[keyof t
3137
3678
  */
3138
3679
  export interface ResourceStringFilter {
3139
3680
  /**
3681
+ * @public
3140
3682
  * <p>The filter's comparison.</p>
3141
3683
  */
3142
3684
  comparison: ResourceStringComparison | string | undefined;
3143
3685
  /**
3686
+ * @public
3144
3687
  * <p>The filter's value.</p>
3145
3688
  */
3146
3689
  value: string | undefined;
@@ -3162,14 +3705,17 @@ export type ResourceMapComparison = (typeof ResourceMapComparison)[keyof typeof
3162
3705
  */
3163
3706
  export interface ResourceMapFilter {
3164
3707
  /**
3708
+ * @public
3165
3709
  * <p>The filter's comparison.</p>
3166
3710
  */
3167
3711
  comparison: ResourceMapComparison | string | undefined;
3168
3712
  /**
3713
+ * @public
3169
3714
  * <p>The filter's key.</p>
3170
3715
  */
3171
3716
  key: string | undefined;
3172
3717
  /**
3718
+ * @public
3173
3719
  * <p>The filter's value.</p>
3174
3720
  */
3175
3721
  value?: string;
@@ -3180,34 +3726,42 @@ export interface ResourceMapFilter {
3180
3726
  */
3181
3727
  export interface ResourceFilterCriteria {
3182
3728
  /**
3729
+ * @public
3183
3730
  * <p>The account IDs used as resource filter criteria.</p>
3184
3731
  */
3185
3732
  accountId?: ResourceStringFilter[];
3186
3733
  /**
3734
+ * @public
3187
3735
  * <p>The resource IDs used as resource filter criteria.</p>
3188
3736
  */
3189
3737
  resourceId?: ResourceStringFilter[];
3190
3738
  /**
3739
+ * @public
3191
3740
  * <p>The resource types used as resource filter criteria.</p>
3192
3741
  */
3193
3742
  resourceType?: ResourceStringFilter[];
3194
3743
  /**
3744
+ * @public
3195
3745
  * <p>The ECR repository names used as resource filter criteria.</p>
3196
3746
  */
3197
3747
  ecrRepositoryName?: ResourceStringFilter[];
3198
3748
  /**
3749
+ * @public
3199
3750
  * <p>The AWS Lambda function name used as resource filter criteria.</p>
3200
3751
  */
3201
3752
  lambdaFunctionName?: ResourceStringFilter[];
3202
3753
  /**
3754
+ * @public
3203
3755
  * <p>The ECR image tags used as resource filter criteria.</p>
3204
3756
  */
3205
3757
  ecrImageTags?: ResourceStringFilter[];
3206
3758
  /**
3759
+ * @public
3207
3760
  * <p>The EC2 instance tags used as resource filter criteria.</p>
3208
3761
  */
3209
3762
  ec2InstanceTags?: ResourceMapFilter[];
3210
3763
  /**
3764
+ * @public
3211
3765
  * <p>The AWS Lambda function tags used as resource filter criteria.</p>
3212
3766
  */
3213
3767
  lambdaFunctionTags?: ResourceMapFilter[];
@@ -3217,14 +3771,17 @@ export interface ResourceFilterCriteria {
3217
3771
  */
3218
3772
  export interface CreateSbomExportRequest {
3219
3773
  /**
3774
+ * @public
3220
3775
  * <p>The resource filter criteria for the software bill of materials (SBOM) report.</p>
3221
3776
  */
3222
3777
  resourceFilterCriteria?: ResourceFilterCriteria;
3223
3778
  /**
3779
+ * @public
3224
3780
  * <p>The output format for the software bill of materials (SBOM) report.</p>
3225
3781
  */
3226
3782
  reportFormat: SbomReportFormat | string | undefined;
3227
3783
  /**
3784
+ * @public
3228
3785
  * <p>Contains details of the Amazon S3 bucket and KMS key used to export findings.</p>
3229
3786
  */
3230
3787
  s3Destination: Destination | undefined;
@@ -3234,6 +3791,7 @@ export interface CreateSbomExportRequest {
3234
3791
  */
3235
3792
  export interface CreateSbomExportResponse {
3236
3793
  /**
3794
+ * @public
3237
3795
  * <p>The report ID for the software bill of materials (SBOM) report.</p>
3238
3796
  */
3239
3797
  reportId?: string;
@@ -3255,10 +3813,12 @@ export type Currency = (typeof Currency)[keyof typeof Currency];
3255
3813
  */
3256
3814
  export interface Cvss2 {
3257
3815
  /**
3816
+ * @public
3258
3817
  * <p>The CVSS v2 base score for the vulnerability.</p>
3259
3818
  */
3260
3819
  baseScore?: number;
3261
3820
  /**
3821
+ * @public
3262
3822
  * <p>The scoring vector associated with the CVSS v2 score.</p>
3263
3823
  */
3264
3824
  scoringVector?: string;
@@ -3269,10 +3829,12 @@ export interface Cvss2 {
3269
3829
  */
3270
3830
  export interface Cvss3 {
3271
3831
  /**
3832
+ * @public
3272
3833
  * <p>The CVSS v3 base score for the vulnerability.</p>
3273
3834
  */
3274
3835
  baseScore?: number;
3275
3836
  /**
3837
+ * @public
3276
3838
  * <p>The scoring vector associated with the CVSS v3 score.</p>
3277
3839
  */
3278
3840
  scoringVector?: string;
@@ -3283,18 +3845,22 @@ export interface Cvss3 {
3283
3845
  */
3284
3846
  export interface CvssScore {
3285
3847
  /**
3848
+ * @public
3286
3849
  * <p>The base CVSS score used for the finding.</p>
3287
3850
  */
3288
3851
  baseScore: number | undefined;
3289
3852
  /**
3853
+ * @public
3290
3854
  * <p>The vector string of the CVSS score.</p>
3291
3855
  */
3292
3856
  scoringVector: string | undefined;
3293
3857
  /**
3858
+ * @public
3294
3859
  * <p>The version of CVSS used for the score.</p>
3295
3860
  */
3296
3861
  version: string | undefined;
3297
3862
  /**
3863
+ * @public
3298
3864
  * <p>The source of the CVSS score.</p>
3299
3865
  */
3300
3866
  source: string | undefined;
@@ -3305,10 +3871,12 @@ export interface CvssScore {
3305
3871
  */
3306
3872
  export interface CvssScoreAdjustment {
3307
3873
  /**
3874
+ * @public
3308
3875
  * <p>The metric used to adjust the CVSS score.</p>
3309
3876
  */
3310
3877
  metric: string | undefined;
3311
3878
  /**
3879
+ * @public
3312
3880
  * <p>The reason the CVSS score has been adjustment.</p>
3313
3881
  */
3314
3882
  reason: string | undefined;
@@ -3319,26 +3887,32 @@ export interface CvssScoreAdjustment {
3319
3887
  */
3320
3888
  export interface CvssScoreDetails {
3321
3889
  /**
3890
+ * @public
3322
3891
  * <p>The source for the CVSS score.</p>
3323
3892
  */
3324
3893
  scoreSource: string | undefined;
3325
3894
  /**
3895
+ * @public
3326
3896
  * <p>The source of the CVSS data.</p>
3327
3897
  */
3328
3898
  cvssSource?: string;
3329
3899
  /**
3900
+ * @public
3330
3901
  * <p>The CVSS version used in scoring.</p>
3331
3902
  */
3332
3903
  version: string | undefined;
3333
3904
  /**
3905
+ * @public
3334
3906
  * <p>The CVSS score.</p>
3335
3907
  */
3336
3908
  score: number | undefined;
3337
3909
  /**
3910
+ * @public
3338
3911
  * <p>The vector for the CVSS score.</p>
3339
3912
  */
3340
3913
  scoringVector: string | undefined;
3341
3914
  /**
3915
+ * @public
3342
3916
  * <p>An object that contains details about adjustment Amazon Inspector made to the CVSS score.</p>
3343
3917
  */
3344
3918
  adjustments?: CvssScoreAdjustment[];
@@ -3371,10 +3945,12 @@ export type RelationshipStatus = (typeof RelationshipStatus)[keyof typeof Relati
3371
3945
  */
3372
3946
  export interface DelegatedAdmin {
3373
3947
  /**
3948
+ * @public
3374
3949
  * <p>The Amazon Web Services account ID of the Amazon Inspector delegated administrator for your organization.</p>
3375
3950
  */
3376
3951
  accountId?: string;
3377
3952
  /**
3953
+ * @public
3378
3954
  * <p>The status of the Amazon Inspector delegated administrator.</p>
3379
3955
  */
3380
3956
  relationshipStatus?: RelationshipStatus | string;
@@ -3397,10 +3973,12 @@ export type DelegatedAdminStatus = (typeof DelegatedAdminStatus)[keyof typeof De
3397
3973
  */
3398
3974
  export interface DelegatedAdminAccount {
3399
3975
  /**
3976
+ * @public
3400
3977
  * <p>The Amazon Web Services account ID of the Amazon Inspector delegated administrator for your organization.</p>
3401
3978
  */
3402
3979
  accountId?: string;
3403
3980
  /**
3981
+ * @public
3404
3982
  * <p>The status of the Amazon Inspector delegated administrator.</p>
3405
3983
  */
3406
3984
  status?: DelegatedAdminStatus | string;
@@ -3410,6 +3988,7 @@ export interface DelegatedAdminAccount {
3410
3988
  */
3411
3989
  export interface DeleteFilterRequest {
3412
3990
  /**
3991
+ * @public
3413
3992
  * <p>The Amazon Resource Number (ARN) of the filter to be deleted.</p>
3414
3993
  */
3415
3994
  arn: string | undefined;
@@ -3419,6 +3998,7 @@ export interface DeleteFilterRequest {
3419
3998
  */
3420
3999
  export interface DeleteFilterResponse {
3421
4000
  /**
4001
+ * @public
3422
4002
  * <p>The Amazon Resource Number (ARN) of the filter that has been deleted.</p>
3423
4003
  */
3424
4004
  arn: string | undefined;
@@ -3433,10 +4013,12 @@ export interface DescribeOrganizationConfigurationRequest {
3433
4013
  */
3434
4014
  export interface DescribeOrganizationConfigurationResponse {
3435
4015
  /**
4016
+ * @public
3436
4017
  * <p>The scan types are automatically enabled for new members of your organization.</p>
3437
4018
  */
3438
4019
  autoEnable?: AutoEnable;
3439
4020
  /**
4021
+ * @public
3440
4022
  * <p>Represents whether your organization has reached the maximum Amazon Web Services account limit for Amazon Inspector.</p>
3441
4023
  */
3442
4024
  maxAccountLimitReached?: boolean;
@@ -3460,10 +4042,12 @@ export type ResourceScanType = (typeof ResourceScanType)[keyof typeof ResourceSc
3460
4042
  */
3461
4043
  export interface DisableRequest {
3462
4044
  /**
4045
+ * @public
3463
4046
  * <p>An array of account IDs you want to disable Amazon Inspector scans for.</p>
3464
4047
  */
3465
4048
  accountIds?: string[];
3466
4049
  /**
4050
+ * @public
3467
4051
  * <p>The resource scan types you want to disable.</p>
3468
4052
  */
3469
4053
  resourceTypes?: (ResourceScanType | string)[];
@@ -3473,11 +4057,13 @@ export interface DisableRequest {
3473
4057
  */
3474
4058
  export interface DisableResponse {
3475
4059
  /**
4060
+ * @public
3476
4061
  * <p>Information on the accounts that have had Amazon Inspector scans successfully disabled. Details are
3477
4062
  * provided for each account.</p>
3478
4063
  */
3479
4064
  accounts: Account[] | undefined;
3480
4065
  /**
4066
+ * @public
3481
4067
  * <p>Information on any accounts for which Amazon Inspector scans could not be disabled. Details are
3482
4068
  * provided for each account.</p>
3483
4069
  */
@@ -3488,6 +4074,7 @@ export interface DisableResponse {
3488
4074
  */
3489
4075
  export interface DisableDelegatedAdminAccountRequest {
3490
4076
  /**
4077
+ * @public
3491
4078
  * <p>The Amazon Web Services account ID of the current Amazon Inspector delegated administrator.</p>
3492
4079
  */
3493
4080
  delegatedAdminAccountId: string | undefined;
@@ -3497,6 +4084,7 @@ export interface DisableDelegatedAdminAccountRequest {
3497
4084
  */
3498
4085
  export interface DisableDelegatedAdminAccountResponse {
3499
4086
  /**
4087
+ * @public
3500
4088
  * <p>The Amazon Web Services account ID of the successfully disabled delegated administrator.</p>
3501
4089
  */
3502
4090
  delegatedAdminAccountId: string | undefined;
@@ -3506,6 +4094,7 @@ export interface DisableDelegatedAdminAccountResponse {
3506
4094
  */
3507
4095
  export interface DisassociateMemberRequest {
3508
4096
  /**
4097
+ * @public
3509
4098
  * <p>The Amazon Web Services account ID of the member account to disassociate.</p>
3510
4099
  */
3511
4100
  accountId: string | undefined;
@@ -3515,6 +4104,7 @@ export interface DisassociateMemberRequest {
3515
4104
  */
3516
4105
  export interface DisassociateMemberResponse {
3517
4106
  /**
4107
+ * @public
3518
4108
  * <p>The Amazon Web Services account ID of the successfully disassociated member.</p>
3519
4109
  */
3520
4110
  accountId: string | undefined;
@@ -3538,6 +4128,7 @@ export type EcrRescanDuration = (typeof EcrRescanDuration)[keyof typeof EcrResca
3538
4128
  */
3539
4129
  export interface EcrConfiguration {
3540
4130
  /**
4131
+ * @public
3541
4132
  * <p>The ECR automated re-scan duration defines how long an ECR image will be actively scanned by Amazon Inspector. When the number of days since an image was last pushed exceeds the automated re-scan duration the monitoring state of that image becomes <code>inactive</code> and all associated findings are scheduled for closure.</p>
3542
4133
  */
3543
4134
  rescanDuration: EcrRescanDuration | string | undefined;
@@ -3561,14 +4152,17 @@ export type EcrRescanDurationStatus = (typeof EcrRescanDurationStatus)[keyof typ
3561
4152
  */
3562
4153
  export interface EcrRescanDurationState {
3563
4154
  /**
4155
+ * @public
3564
4156
  * <p>The ECR automated re-scan duration defines how long an ECR image will be actively scanned by Amazon Inspector. When the number of days since an image was last pushed exceeds the automated re-scan duration the monitoring state of that image becomes <code>inactive</code> and all associated findings are scheduled for closure.</p>
3565
4157
  */
3566
4158
  rescanDuration?: EcrRescanDuration | string;
3567
4159
  /**
4160
+ * @public
3568
4161
  * <p>The status of changes to the ECR automated re-scan duration.</p>
3569
4162
  */
3570
4163
  status?: EcrRescanDurationStatus | string;
3571
4164
  /**
4165
+ * @public
3572
4166
  * <p>A timestamp representing when the last time the ECR scan duration setting was changed.</p>
3573
4167
  */
3574
4168
  updatedAt?: Date;
@@ -3579,6 +4173,7 @@ export interface EcrRescanDurationState {
3579
4173
  */
3580
4174
  export interface EcrConfigurationState {
3581
4175
  /**
4176
+ * @public
3582
4177
  * <p>An object that contains details about the state of the ECR automated re-scan setting.</p>
3583
4178
  */
3584
4179
  rescanDurationState?: EcrRescanDurationState;
@@ -3588,14 +4183,17 @@ export interface EcrConfigurationState {
3588
4183
  */
3589
4184
  export interface EnableRequest {
3590
4185
  /**
4186
+ * @public
3591
4187
  * <p>A list of account IDs you want to enable Amazon Inspector scans for.</p>
3592
4188
  */
3593
4189
  accountIds?: string[];
3594
4190
  /**
4191
+ * @public
3595
4192
  * <p>The resource scan types you want to enable.</p>
3596
4193
  */
3597
4194
  resourceTypes: (ResourceScanType | string)[] | undefined;
3598
4195
  /**
4196
+ * @public
3599
4197
  * <p>The idempotency token for the request.</p>
3600
4198
  */
3601
4199
  clientToken?: string;
@@ -3605,11 +4203,13 @@ export interface EnableRequest {
3605
4203
  */
3606
4204
  export interface EnableResponse {
3607
4205
  /**
4206
+ * @public
3608
4207
  * <p>Information on the accounts that have had Amazon Inspector scans successfully enabled. Details are
3609
4208
  * provided for each account.</p>
3610
4209
  */
3611
4210
  accounts: Account[] | undefined;
3612
4211
  /**
4212
+ * @public
3613
4213
  * <p>Information on any accounts for which Amazon Inspector scans could not be enabled. Details are
3614
4214
  * provided for each account.</p>
3615
4215
  */
@@ -3620,10 +4220,12 @@ export interface EnableResponse {
3620
4220
  */
3621
4221
  export interface EnableDelegatedAdminAccountRequest {
3622
4222
  /**
4223
+ * @public
3623
4224
  * <p>The Amazon Web Services account ID of the Amazon Inspector delegated administrator.</p>
3624
4225
  */
3625
4226
  delegatedAdminAccountId: string | undefined;
3626
4227
  /**
4228
+ * @public
3627
4229
  * <p>The idempotency token for the request.</p>
3628
4230
  */
3629
4231
  clientToken?: string;
@@ -3633,6 +4235,7 @@ export interface EnableDelegatedAdminAccountRequest {
3633
4235
  */
3634
4236
  export interface EnableDelegatedAdminAccountResponse {
3635
4237
  /**
4238
+ * @public
3636
4239
  * <p>The Amazon Web Services account ID of the successfully Amazon Inspector delegated administrator.</p>
3637
4240
  */
3638
4241
  delegatedAdminAccountId: string | undefined;
@@ -3643,6 +4246,7 @@ export interface EnableDelegatedAdminAccountResponse {
3643
4246
  */
3644
4247
  export interface Epss {
3645
4248
  /**
4249
+ * @public
3646
4250
  * <p>The Exploit Prediction Scoring System (EPSS) score.</p>
3647
4251
  */
3648
4252
  score?: number;
@@ -3653,6 +4257,7 @@ export interface Epss {
3653
4257
  */
3654
4258
  export interface EpssDetails {
3655
4259
  /**
4260
+ * @public
3656
4261
  * <p>The EPSS score.</p>
3657
4262
  */
3658
4263
  score?: number;
@@ -3663,6 +4268,7 @@ export interface EpssDetails {
3663
4268
  */
3664
4269
  export interface ExploitabilityDetails {
3665
4270
  /**
4271
+ * @public
3666
4272
  * <p>The date and time of the last exploit associated with a finding discovered in your environment.</p>
3667
4273
  */
3668
4274
  lastKnownExploitAt?: Date;
@@ -3679,20 +4285,6 @@ export declare const ExploitAvailable: {
3679
4285
  * @public
3680
4286
  */
3681
4287
  export type ExploitAvailable = (typeof ExploitAvailable)[keyof typeof ExploitAvailable];
3682
- /**
3683
- * @public
3684
- * <p>Contains information on when this exploit was observed.</p>
3685
- */
3686
- export interface ExploitObserved {
3687
- /**
3688
- * <p>The date an time when the exploit was last seen.</p>
3689
- */
3690
- lastSeen?: Date;
3691
- /**
3692
- * <p>The date an time when the exploit was first seen.</p>
3693
- */
3694
- firstSeen?: Date;
3695
- }
3696
4288
  /**
3697
4289
  * @public
3698
4290
  * @enum
@@ -3713,42 +4305,52 @@ export type ExternalReportStatus = (typeof ExternalReportStatus)[keyof typeof Ex
3713
4305
  */
3714
4306
  export interface Filter {
3715
4307
  /**
4308
+ * @public
3716
4309
  * <p>The Amazon Resource Number (ARN) associated with this filter.</p>
3717
4310
  */
3718
4311
  arn: string | undefined;
3719
4312
  /**
4313
+ * @public
3720
4314
  * <p>The Amazon Web Services account ID of the account that created the filter.</p>
3721
4315
  */
3722
4316
  ownerId: string | undefined;
3723
4317
  /**
4318
+ * @public
3724
4319
  * <p>The name of the filter.</p>
3725
4320
  */
3726
4321
  name: string | undefined;
3727
4322
  /**
4323
+ * @public
3728
4324
  * <p>Details on the filter criteria associated with this filter.</p>
3729
4325
  */
3730
4326
  criteria: FilterCriteria | undefined;
3731
4327
  /**
4328
+ * @public
3732
4329
  * <p>The action that is to be applied to the findings that match the filter.</p>
3733
4330
  */
3734
4331
  action: FilterAction | string | undefined;
3735
4332
  /**
4333
+ * @public
3736
4334
  * <p>The date and time this filter was created at.</p>
3737
4335
  */
3738
4336
  createdAt: Date | undefined;
3739
4337
  /**
4338
+ * @public
3740
4339
  * <p>The date and time the filter was last updated at.</p>
3741
4340
  */
3742
4341
  updatedAt: Date | undefined;
3743
4342
  /**
4343
+ * @public
3744
4344
  * <p>A description of the filter.</p>
3745
4345
  */
3746
4346
  description?: string;
3747
4347
  /**
4348
+ * @public
3748
4349
  * <p>The reason for the filter.</p>
3749
4350
  */
3750
4351
  reason?: string;
3751
4352
  /**
4353
+ * @public
3752
4354
  * <p>The tags attached to the filter.</p>
3753
4355
  */
3754
4356
  tags?: Record<string, string>;
@@ -3772,6 +4374,7 @@ export type FixAvailable = (typeof FixAvailable)[keyof typeof FixAvailable];
3772
4374
  */
3773
4375
  export interface InspectorScoreDetails {
3774
4376
  /**
4377
+ * @public
3775
4378
  * <p>An object that contains details about the CVSS score given to a finding.</p>
3776
4379
  */
3777
4380
  adjustedCvss?: CvssScoreDetails;
@@ -3782,10 +4385,12 @@ export interface InspectorScoreDetails {
3782
4385
  */
3783
4386
  export interface Step {
3784
4387
  /**
4388
+ * @public
3785
4389
  * <p>The component ID.</p>
3786
4390
  */
3787
4391
  componentId: string | undefined;
3788
4392
  /**
4393
+ * @public
3789
4394
  * <p>The component type.</p>
3790
4395
  */
3791
4396
  componentType: string | undefined;
@@ -3796,6 +4401,7 @@ export interface Step {
3796
4401
  */
3797
4402
  export interface NetworkPath {
3798
4403
  /**
4404
+ * @public
3799
4405
  * <p>The details on the steps in the network path.</p>
3800
4406
  */
3801
4407
  steps?: Step[];
@@ -3806,10 +4412,12 @@ export interface NetworkPath {
3806
4412
  */
3807
4413
  export interface PortRange {
3808
4414
  /**
4415
+ * @public
3809
4416
  * <p>The beginning port in a port range.</p>
3810
4417
  */
3811
4418
  begin: number | undefined;
3812
4419
  /**
4420
+ * @public
3813
4421
  * <p>The ending port in a port range.</p>
3814
4422
  */
3815
4423
  end: number | undefined;
@@ -3832,14 +4440,17 @@ export type NetworkProtocol = (typeof NetworkProtocol)[keyof typeof NetworkProto
3832
4440
  */
3833
4441
  export interface NetworkReachabilityDetails {
3834
4442
  /**
4443
+ * @public
3835
4444
  * <p>An object that contains details about the open port range associated with a finding.</p>
3836
4445
  */
3837
4446
  openPortRange: PortRange | undefined;
3838
4447
  /**
4448
+ * @public
3839
4449
  * <p>The protocol associated with a finding.</p>
3840
4450
  */
3841
4451
  protocol: NetworkProtocol | string | undefined;
3842
4452
  /**
4453
+ * @public
3843
4454
  * <p>An object that contains details about a network path associated with a finding.</p>
3844
4455
  */
3845
4456
  networkPath: NetworkPath | undefined;
@@ -3877,46 +4488,57 @@ export type PackageManager = (typeof PackageManager)[keyof typeof PackageManager
3877
4488
  */
3878
4489
  export interface VulnerablePackage {
3879
4490
  /**
4491
+ * @public
3880
4492
  * <p>The name of the vulnerable package.</p>
3881
4493
  */
3882
4494
  name: string | undefined;
3883
4495
  /**
4496
+ * @public
3884
4497
  * <p>The version of the vulnerable package.</p>
3885
4498
  */
3886
4499
  version: string | undefined;
3887
4500
  /**
4501
+ * @public
3888
4502
  * <p>The source layer hash of the vulnerable package.</p>
3889
4503
  */
3890
4504
  sourceLayerHash?: string;
3891
4505
  /**
4506
+ * @public
3892
4507
  * <p>The epoch of the vulnerable package.</p>
3893
4508
  */
3894
4509
  epoch?: number;
3895
4510
  /**
4511
+ * @public
3896
4512
  * <p>The release of the vulnerable package.</p>
3897
4513
  */
3898
4514
  release?: string;
3899
4515
  /**
4516
+ * @public
3900
4517
  * <p>The architecture of the vulnerable package.</p>
3901
4518
  */
3902
4519
  arch?: string;
3903
4520
  /**
4521
+ * @public
3904
4522
  * <p>The package manager of the vulnerable package.</p>
3905
4523
  */
3906
4524
  packageManager?: PackageManager | string;
3907
4525
  /**
4526
+ * @public
3908
4527
  * <p>The file path of the vulnerable package.</p>
3909
4528
  */
3910
4529
  filePath?: string;
3911
4530
  /**
4531
+ * @public
3912
4532
  * <p>The version of the package that contains the vulnerability fix.</p>
3913
4533
  */
3914
4534
  fixedInVersion?: string;
3915
4535
  /**
4536
+ * @public
3916
4537
  * <p>The code to run in your environment to update packages with a fix available.</p>
3917
4538
  */
3918
4539
  remediation?: string;
3919
4540
  /**
4541
+ * @public
3920
4542
  * <p>The Amazon Resource Number (ARN) of the AWS Lambda function affected by a finding.</p>
3921
4543
  */
3922
4544
  sourceLambdaLayerArn?: string;
@@ -3927,42 +4549,52 @@ export interface VulnerablePackage {
3927
4549
  */
3928
4550
  export interface PackageVulnerabilityDetails {
3929
4551
  /**
4552
+ * @public
3930
4553
  * <p>The ID given to this vulnerability.</p>
3931
4554
  */
3932
4555
  vulnerabilityId: string | undefined;
3933
4556
  /**
4557
+ * @public
3934
4558
  * <p>The packages impacted by this vulnerability.</p>
3935
4559
  */
3936
4560
  vulnerablePackages?: VulnerablePackage[];
3937
4561
  /**
4562
+ * @public
3938
4563
  * <p>The source of the vulnerability information.</p>
3939
4564
  */
3940
4565
  source: string | undefined;
3941
4566
  /**
4567
+ * @public
3942
4568
  * <p>An object that contains details about the CVSS score of a finding.</p>
3943
4569
  */
3944
4570
  cvss?: CvssScore[];
3945
4571
  /**
4572
+ * @public
3946
4573
  * <p>One or more vulnerabilities related to the one identified in this finding.</p>
3947
4574
  */
3948
4575
  relatedVulnerabilities?: string[];
3949
4576
  /**
4577
+ * @public
3950
4578
  * <p>A URL to the source of the vulnerability information.</p>
3951
4579
  */
3952
4580
  sourceUrl?: string;
3953
4581
  /**
4582
+ * @public
3954
4583
  * <p>The severity the vendor has given to this vulnerability type.</p>
3955
4584
  */
3956
4585
  vendorSeverity?: string;
3957
4586
  /**
4587
+ * @public
3958
4588
  * <p>The date and time that this vulnerability was first added to the vendor's database.</p>
3959
4589
  */
3960
4590
  vendorCreatedAt?: Date;
3961
4591
  /**
4592
+ * @public
3962
4593
  * <p>The date and time the vendor last updated this vulnerability in their database.</p>
3963
4594
  */
3964
4595
  vendorUpdatedAt?: Date;
3965
4596
  /**
4597
+ * @public
3966
4598
  * <p>One or more URLs that contain details about this vulnerability type.</p>
3967
4599
  */
3968
4600
  referenceUrls?: string[];
@@ -3973,10 +4605,12 @@ export interface PackageVulnerabilityDetails {
3973
4605
  */
3974
4606
  export interface Recommendation {
3975
4607
  /**
4608
+ * @public
3976
4609
  * <p>The recommended course of action to remediate the finding.</p>
3977
4610
  */
3978
4611
  text?: string;
3979
4612
  /**
4613
+ * @public
3980
4614
  * <p>The URL address to the CVE remediation recommendations.</p>
3981
4615
  */
3982
4616
  Url?: string;
@@ -3987,6 +4621,7 @@ export interface Recommendation {
3987
4621
  */
3988
4622
  export interface Remediation {
3989
4623
  /**
4624
+ * @public
3990
4625
  * <p>An object that contains information about the recommended course of action to remediate the finding.</p>
3991
4626
  */
3992
4627
  recommendation?: Recommendation;
@@ -3997,14 +4632,17 @@ export interface Remediation {
3997
4632
  */
3998
4633
  export interface ResourceDetails {
3999
4634
  /**
4635
+ * @public
4000
4636
  * <p>An object that contains details about the Amazon EC2 instance involved in the finding.</p>
4001
4637
  */
4002
4638
  awsEc2Instance?: AwsEc2InstanceDetails;
4003
4639
  /**
4640
+ * @public
4004
4641
  * <p>An object that contains details about the Amazon ECR container image involved in the finding.</p>
4005
4642
  */
4006
4643
  awsEcrContainerImage?: AwsEcrContainerImageDetails;
4007
4644
  /**
4645
+ * @public
4008
4646
  * <p>A summary of the information about an AWS Lambda function affected by a finding.</p>
4009
4647
  */
4010
4648
  awsLambdaFunction?: AwsLambdaFunctionDetails;
@@ -4029,26 +4667,32 @@ export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
4029
4667
  */
4030
4668
  export interface Resource {
4031
4669
  /**
4670
+ * @public
4032
4671
  * <p>The type of resource.</p>
4033
4672
  */
4034
4673
  type: ResourceType | string | undefined;
4035
4674
  /**
4675
+ * @public
4036
4676
  * <p>The ID of the resource.</p>
4037
4677
  */
4038
4678
  id: string | undefined;
4039
4679
  /**
4680
+ * @public
4040
4681
  * <p>The partition of the resource.</p>
4041
4682
  */
4042
4683
  partition?: string;
4043
4684
  /**
4685
+ * @public
4044
4686
  * <p>The Amazon Web Services Region the impacted resource is located in.</p>
4045
4687
  */
4046
4688
  region?: string;
4047
4689
  /**
4690
+ * @public
4048
4691
  * <p>The tags attached to the resource.</p>
4049
4692
  */
4050
4693
  tags?: Record<string, string>;
4051
4694
  /**
4695
+ * @public
4052
4696
  * <p>An object that contains details about the resource involved in a finding.</p>
4053
4697
  */
4054
4698
  details?: ResourceDetails;
@@ -4101,86 +4745,107 @@ export type FindingType = (typeof FindingType)[keyof typeof FindingType];
4101
4745
  */
4102
4746
  export interface Finding {
4103
4747
  /**
4748
+ * @public
4104
4749
  * <p>The Amazon Resource Number (ARN) of the finding.</p>
4105
4750
  */
4106
4751
  findingArn: string | undefined;
4107
4752
  /**
4753
+ * @public
4108
4754
  * <p>The Amazon Web Services account ID associated with the finding.</p>
4109
4755
  */
4110
4756
  awsAccountId: string | undefined;
4111
4757
  /**
4758
+ * @public
4112
4759
  * <p>The type of the finding.</p>
4113
4760
  */
4114
4761
  type: FindingType | string | undefined;
4115
4762
  /**
4763
+ * @public
4116
4764
  * <p>The description of the finding.</p>
4117
4765
  */
4118
4766
  description: string | undefined;
4119
4767
  /**
4768
+ * @public
4120
4769
  * <p>The title of the finding.</p>
4121
4770
  */
4122
4771
  title?: string;
4123
4772
  /**
4773
+ * @public
4124
4774
  * <p>An object that contains the details about how to remediate a finding.</p>
4125
4775
  */
4126
4776
  remediation: Remediation | undefined;
4127
4777
  /**
4778
+ * @public
4128
4779
  * <p>The severity of the finding.</p>
4129
4780
  */
4130
4781
  severity: Severity | string | undefined;
4131
4782
  /**
4783
+ * @public
4132
4784
  * <p>The date and time that the finding was first observed.</p>
4133
4785
  */
4134
4786
  firstObservedAt: Date | undefined;
4135
4787
  /**
4788
+ * @public
4136
4789
  * <p>The date and time that the finding was last observed.</p>
4137
4790
  */
4138
4791
  lastObservedAt: Date | undefined;
4139
4792
  /**
4793
+ * @public
4140
4794
  * <p>The date and time the finding was last updated at.</p>
4141
4795
  */
4142
4796
  updatedAt?: Date;
4143
4797
  /**
4798
+ * @public
4144
4799
  * <p>The status of the finding.</p>
4145
4800
  */
4146
4801
  status: FindingStatus | string | undefined;
4147
4802
  /**
4803
+ * @public
4148
4804
  * <p>Contains information on the resources involved in a finding.</p>
4149
4805
  */
4150
4806
  resources: Resource[] | undefined;
4151
4807
  /**
4808
+ * @public
4152
4809
  * <p>The Amazon Inspector score given to the finding.</p>
4153
4810
  */
4154
4811
  inspectorScore?: number;
4155
4812
  /**
4813
+ * @public
4156
4814
  * <p>An object that contains details of the Amazon Inspector score.</p>
4157
4815
  */
4158
4816
  inspectorScoreDetails?: InspectorScoreDetails;
4159
4817
  /**
4818
+ * @public
4160
4819
  * <p>An object that contains the details of a network reachability finding.</p>
4161
4820
  */
4162
4821
  networkReachabilityDetails?: NetworkReachabilityDetails;
4163
4822
  /**
4823
+ * @public
4164
4824
  * <p>An object that contains the details of a package vulnerability finding.</p>
4165
4825
  */
4166
4826
  packageVulnerabilityDetails?: PackageVulnerabilityDetails;
4167
4827
  /**
4828
+ * @public
4168
4829
  * <p>Details on whether a fix is available through a version update. This value can be <code>YES</code>, <code>NO</code>, or <code>PARTIAL</code>. A <code>PARTIAL</code> fix means that some, but not all, of the packages identified in the finding have fixes available through updated versions.</p>
4169
4830
  */
4170
4831
  fixAvailable?: FixAvailable | string;
4171
4832
  /**
4833
+ * @public
4172
4834
  * <p>If a finding discovered in your environment has an exploit available.</p>
4173
4835
  */
4174
4836
  exploitAvailable?: ExploitAvailable | string;
4175
4837
  /**
4838
+ * @public
4176
4839
  * <p>The details of an exploit available for a finding discovered in your environment.</p>
4177
4840
  */
4178
4841
  exploitabilityDetails?: ExploitabilityDetails;
4179
4842
  /**
4843
+ * @public
4180
4844
  * <p>Details about the code vulnerability identified in a Lambda function used to filter findings.</p>
4181
4845
  */
4182
4846
  codeVulnerabilityDetails?: CodeVulnerabilityDetails;
4183
4847
  /**
4848
+ * @public
4184
4849
  * <p>The finding's EPSS score.</p>
4185
4850
  */
4186
4851
  epss?: EpssDetails;
@@ -4195,6 +4860,7 @@ export interface GetConfigurationRequest {
4195
4860
  */
4196
4861
  export interface GetConfigurationResponse {
4197
4862
  /**
4863
+ * @public
4198
4864
  * <p>Specifies how the ECR automated re-scan duration is currently configured for your environment.</p>
4199
4865
  */
4200
4866
  ecrConfiguration?: EcrConfigurationState;
@@ -4209,6 +4875,7 @@ export interface GetDelegatedAdminAccountRequest {
4209
4875
  */
4210
4876
  export interface GetDelegatedAdminAccountResponse {
4211
4877
  /**
4878
+ * @public
4212
4879
  * <p>The Amazon Web Services account ID of the Amazon Inspector delegated administrator.</p>
4213
4880
  */
4214
4881
  delegatedAdmin?: DelegatedAdmin;
@@ -4223,18 +4890,22 @@ export interface GetEc2DeepInspectionConfigurationRequest {
4223
4890
  */
4224
4891
  export interface GetEc2DeepInspectionConfigurationResponse {
4225
4892
  /**
4893
+ * @public
4226
4894
  * <p>The Amazon Inspector deep inspection custom paths for your account.</p>
4227
4895
  */
4228
4896
  packagePaths?: string[];
4229
4897
  /**
4898
+ * @public
4230
4899
  * <p>The Amazon Inspector deep inspection custom paths for your organization.</p>
4231
4900
  */
4232
4901
  orgPackagePaths?: string[];
4233
4902
  /**
4903
+ * @public
4234
4904
  * <p>The activation status of Amazon Inspector deep inspection in your account.</p>
4235
4905
  */
4236
4906
  status?: Ec2DeepInspectionStatus | string;
4237
4907
  /**
4908
+ * @public
4238
4909
  * <p>An error message explaining why Amazon Inspector deep inspection configurations could not be retrieved for your account.</p>
4239
4910
  */
4240
4911
  errorMessage?: string;
@@ -4244,10 +4915,12 @@ export interface GetEc2DeepInspectionConfigurationResponse {
4244
4915
  */
4245
4916
  export interface GetEncryptionKeyRequest {
4246
4917
  /**
4918
+ * @public
4247
4919
  * <p>The scan type the key encrypts.</p>
4248
4920
  */
4249
4921
  scanType: ScanType | string | undefined;
4250
4922
  /**
4923
+ * @public
4251
4924
  * <p>The resource type the key encrypts.</p>
4252
4925
  */
4253
4926
  resourceType: ResourceType | string | undefined;
@@ -4257,6 +4930,7 @@ export interface GetEncryptionKeyRequest {
4257
4930
  */
4258
4931
  export interface GetEncryptionKeyResponse {
4259
4932
  /**
4933
+ * @public
4260
4934
  * <p>A kms key ID.</p>
4261
4935
  */
4262
4936
  kmsKeyId: string | undefined;
@@ -4266,6 +4940,7 @@ export interface GetEncryptionKeyResponse {
4266
4940
  */
4267
4941
  export interface GetFindingsReportStatusRequest {
4268
4942
  /**
4943
+ * @public
4269
4944
  * <p>The ID of the report to retrieve the status of.</p>
4270
4945
  */
4271
4946
  reportId?: string;
@@ -4291,26 +4966,32 @@ export type ReportingErrorCode = (typeof ReportingErrorCode)[keyof typeof Report
4291
4966
  */
4292
4967
  export interface GetFindingsReportStatusResponse {
4293
4968
  /**
4969
+ * @public
4294
4970
  * <p>The ID of the report.</p>
4295
4971
  */
4296
4972
  reportId?: string;
4297
4973
  /**
4974
+ * @public
4298
4975
  * <p>The status of the report.</p>
4299
4976
  */
4300
4977
  status?: ExternalReportStatus | string;
4301
4978
  /**
4979
+ * @public
4302
4980
  * <p>The error code of the report.</p>
4303
4981
  */
4304
4982
  errorCode?: ReportingErrorCode | string;
4305
4983
  /**
4984
+ * @public
4306
4985
  * <p>The error message of the report.</p>
4307
4986
  */
4308
4987
  errorMessage?: string;
4309
4988
  /**
4989
+ * @public
4310
4990
  * <p>The destination of the report.</p>
4311
4991
  */
4312
4992
  destination?: Destination;
4313
4993
  /**
4994
+ * @public
4314
4995
  * <p>The filter criteria associated with the report.</p>
4315
4996
  */
4316
4997
  filterCriteria?: FilterCriteria;
@@ -4320,6 +5001,7 @@ export interface GetFindingsReportStatusResponse {
4320
5001
  */
4321
5002
  export interface GetMemberRequest {
4322
5003
  /**
5004
+ * @public
4323
5005
  * <p>The Amazon Web Services account ID of the member account to retrieve information on.</p>
4324
5006
  */
4325
5007
  accountId: string | undefined;
@@ -4330,18 +5012,22 @@ export interface GetMemberRequest {
4330
5012
  */
4331
5013
  export interface Member {
4332
5014
  /**
5015
+ * @public
4333
5016
  * <p>The Amazon Web Services account ID of the member account.</p>
4334
5017
  */
4335
5018
  accountId?: string;
4336
5019
  /**
5020
+ * @public
4337
5021
  * <p>The status of the member account.</p>
4338
5022
  */
4339
5023
  relationshipStatus?: RelationshipStatus | string;
4340
5024
  /**
5025
+ * @public
4341
5026
  * <p>The Amazon Web Services account ID of the Amazon Inspector delegated administrator for this member account.</p>
4342
5027
  */
4343
5028
  delegatedAdminAccountId?: string;
4344
5029
  /**
5030
+ * @public
4345
5031
  * <p>A timestamp showing when the status of this member was last updated.</p>
4346
5032
  */
4347
5033
  updatedAt?: Date;
@@ -4351,6 +5037,7 @@ export interface Member {
4351
5037
  */
4352
5038
  export interface GetMemberResponse {
4353
5039
  /**
5040
+ * @public
4354
5041
  * <p>Details of the retrieved member account.</p>
4355
5042
  */
4356
5043
  member?: Member;
@@ -4360,6 +5047,7 @@ export interface GetMemberResponse {
4360
5047
  */
4361
5048
  export interface GetSbomExportRequest {
4362
5049
  /**
5050
+ * @public
4363
5051
  * <p>The report ID of the SBOM export to get details for.</p>
4364
5052
  */
4365
5053
  reportId: string | undefined;
@@ -4369,30 +5057,37 @@ export interface GetSbomExportRequest {
4369
5057
  */
4370
5058
  export interface GetSbomExportResponse {
4371
5059
  /**
5060
+ * @public
4372
5061
  * <p>The report ID of the software bill of materials (SBOM) report.</p>
4373
5062
  */
4374
5063
  reportId?: string;
4375
5064
  /**
5065
+ * @public
4376
5066
  * <p>The format of the software bill of materials (SBOM) report.</p>
4377
5067
  */
4378
5068
  format?: SbomReportFormat | string;
4379
5069
  /**
5070
+ * @public
4380
5071
  * <p>The status of the software bill of materials (SBOM) report.</p>
4381
5072
  */
4382
5073
  status?: ExternalReportStatus | string;
4383
5074
  /**
5075
+ * @public
4384
5076
  * <p>An error code.</p>
4385
5077
  */
4386
5078
  errorCode?: ReportingErrorCode | string;
4387
5079
  /**
5080
+ * @public
4388
5081
  * <p>An error message.</p>
4389
5082
  */
4390
5083
  errorMessage?: string;
4391
5084
  /**
5085
+ * @public
4392
5086
  * <p>Contains details of the Amazon S3 bucket and KMS key used to export findings.</p>
4393
5087
  */
4394
5088
  s3Destination?: Destination;
4395
5089
  /**
5090
+ * @public
4396
5091
  * <p>Contains details about the resource filter criteria used for the software bill of materials (SBOM) report.</p>
4397
5092
  */
4398
5093
  filterCriteria?: ResourceFilterCriteria;
@@ -4415,14 +5110,17 @@ export type Service = (typeof Service)[keyof typeof Service];
4415
5110
  */
4416
5111
  export interface ListAccountPermissionsRequest {
4417
5112
  /**
5113
+ * @public
4418
5114
  * <p>The service scan type to check permissions for.</p>
4419
5115
  */
4420
5116
  service?: Service | string;
4421
5117
  /**
5118
+ * @public
4422
5119
  * <p>The maximum number of results to return in the response.</p>
4423
5120
  */
4424
5121
  maxResults?: number;
4425
5122
  /**
5123
+ * @public
4426
5124
  * <p>A token to use for paginating results that are returned in the response. Set the value
4427
5125
  * of this parameter to null for the first request to a list action. For subsequent calls, use
4428
5126
  * the <code>NextToken</code> value returned from the previous request to continue listing
@@ -4450,10 +5148,12 @@ export type Operation = (typeof Operation)[keyof typeof Operation];
4450
5148
  */
4451
5149
  export interface Permission {
4452
5150
  /**
5151
+ * @public
4453
5152
  * <p>The services that the permissions allow an account to perform the given operations for.</p>
4454
5153
  */
4455
5154
  service: Service | string | undefined;
4456
5155
  /**
5156
+ * @public
4457
5157
  * <p>The operations that can be performed with the given permissions.</p>
4458
5158
  */
4459
5159
  operation: Operation | string | undefined;
@@ -4463,10 +5163,12 @@ export interface Permission {
4463
5163
  */
4464
5164
  export interface ListAccountPermissionsResponse {
4465
5165
  /**
5166
+ * @public
4466
5167
  * <p>Contains details on the permissions an account has to configure Amazon Inspector.</p>
4467
5168
  */
4468
5169
  permissions: Permission[] | undefined;
4469
5170
  /**
5171
+ * @public
4470
5172
  * <p>A token to use for paginating results that are returned in the response. Set the value
4471
5173
  * of this parameter to null for the first request to a list action. For subsequent calls, use
4472
5174
  * the <code>NextToken</code> value returned from the previous request to continue listing
@@ -4479,10 +5181,12 @@ export interface ListAccountPermissionsResponse {
4479
5181
  */
4480
5182
  export interface ListCoverageRequest {
4481
5183
  /**
5184
+ * @public
4482
5185
  * <p>The maximum number of results to return in the response.</p>
4483
5186
  */
4484
5187
  maxResults?: number;
4485
5188
  /**
5189
+ * @public
4486
5190
  * <p>A token to use for paginating results that are returned in the response. Set the value
4487
5191
  * of this parameter to null for the first request to a list action. For subsequent calls, use
4488
5192
  * the <code>NextToken</code> value returned from the previous request to continue listing
@@ -4490,6 +5194,7 @@ export interface ListCoverageRequest {
4490
5194
  */
4491
5195
  nextToken?: string;
4492
5196
  /**
5197
+ * @public
4493
5198
  * <p>An object that contains details on the filters to apply to the coverage data for your
4494
5199
  * environment.</p>
4495
5200
  */
@@ -4500,6 +5205,7 @@ export interface ListCoverageRequest {
4500
5205
  */
4501
5206
  export interface ListCoverageResponse {
4502
5207
  /**
5208
+ * @public
4503
5209
  * <p>A token to use for paginating results that are returned in the response. Set the value
4504
5210
  * of this parameter to null for the first request to a list action. For subsequent calls, use
4505
5211
  * the <code>NextToken</code> value returned from the previous request to continue listing
@@ -4507,6 +5213,7 @@ export interface ListCoverageResponse {
4507
5213
  */
4508
5214
  nextToken?: string;
4509
5215
  /**
5216
+ * @public
4510
5217
  * <p>An object that contains details on the covered resources in your environment.</p>
4511
5218
  */
4512
5219
  coveredResources?: CoveredResource[];
@@ -4516,15 +5223,18 @@ export interface ListCoverageResponse {
4516
5223
  */
4517
5224
  export interface ListCoverageStatisticsRequest {
4518
5225
  /**
5226
+ * @public
4519
5227
  * <p>An object that contains details on the filters to apply to the coverage data for your
4520
5228
  * environment.</p>
4521
5229
  */
4522
5230
  filterCriteria?: CoverageFilterCriteria;
4523
5231
  /**
5232
+ * @public
4524
5233
  * <p>The value to group the results by.</p>
4525
5234
  */
4526
5235
  groupBy?: GroupKey | string;
4527
5236
  /**
5237
+ * @public
4528
5238
  * <p>A token to use for paginating results that are returned in the response. Set the value
4529
5239
  * of this parameter to null for the first request to a list action. For subsequent calls, use
4530
5240
  * the <code>NextToken</code> value returned from the previous request to continue listing
@@ -4537,14 +5247,17 @@ export interface ListCoverageStatisticsRequest {
4537
5247
  */
4538
5248
  export interface ListCoverageStatisticsResponse {
4539
5249
  /**
5250
+ * @public
4540
5251
  * <p>An array with the number for each group.</p>
4541
5252
  */
4542
5253
  countsByGroup?: Counts[];
4543
5254
  /**
5255
+ * @public
4544
5256
  * <p>The total number for all groups.</p>
4545
5257
  */
4546
5258
  totalCounts: number | undefined;
4547
5259
  /**
5260
+ * @public
4548
5261
  * <p>A token to use for paginating results that are returned in the response. Set the value
4549
5262
  * of this parameter to null for the first request to a list action. For subsequent calls, use
4550
5263
  * the <code>NextToken</code> value returned from the previous request to continue listing
@@ -4557,10 +5270,12 @@ export interface ListCoverageStatisticsResponse {
4557
5270
  */
4558
5271
  export interface ListDelegatedAdminAccountsRequest {
4559
5272
  /**
5273
+ * @public
4560
5274
  * <p>The maximum number of results to return in the response.</p>
4561
5275
  */
4562
5276
  maxResults?: number;
4563
5277
  /**
5278
+ * @public
4564
5279
  * <p>A token to use for paginating results that are returned in the response. Set the value
4565
5280
  * of this parameter to null for the first request to a list action. For subsequent calls, use
4566
5281
  * the <code>NextToken</code> value returned from the previous request to continue listing
@@ -4573,10 +5288,12 @@ export interface ListDelegatedAdminAccountsRequest {
4573
5288
  */
4574
5289
  export interface ListDelegatedAdminAccountsResponse {
4575
5290
  /**
5291
+ * @public
4576
5292
  * <p>Details of the Amazon Inspector delegated administrator of your organization.</p>
4577
5293
  */
4578
5294
  delegatedAdminAccounts?: DelegatedAdminAccount[];
4579
5295
  /**
5296
+ * @public
4580
5297
  * <p>A token to use for paginating results that are returned in the response. Set the value
4581
5298
  * of this parameter to null for the first request to a list action. For subsequent calls, use
4582
5299
  * the <code>NextToken</code> value returned from the previous request to continue listing
@@ -4589,14 +5306,17 @@ export interface ListDelegatedAdminAccountsResponse {
4589
5306
  */
4590
5307
  export interface ListFiltersRequest {
4591
5308
  /**
5309
+ * @public
4592
5310
  * <p>The Amazon resource number (ARN) of the filter.</p>
4593
5311
  */
4594
5312
  arns?: string[];
4595
5313
  /**
5314
+ * @public
4596
5315
  * <p>The action the filter applies to matched findings.</p>
4597
5316
  */
4598
5317
  action?: FilterAction | string;
4599
5318
  /**
5319
+ * @public
4600
5320
  * <p>A token to use for paginating results that are returned in the response. Set the value
4601
5321
  * of this parameter to null for the first request to a list action. For subsequent calls, use
4602
5322
  * the <code>NextToken</code> value returned from the previous request to continue listing
@@ -4604,6 +5324,7 @@ export interface ListFiltersRequest {
4604
5324
  */
4605
5325
  nextToken?: string;
4606
5326
  /**
5327
+ * @public
4607
5328
  * <p>The maximum number of results to return in the response.</p>
4608
5329
  */
4609
5330
  maxResults?: number;
@@ -4613,10 +5334,12 @@ export interface ListFiltersRequest {
4613
5334
  */
4614
5335
  export interface ListFiltersResponse {
4615
5336
  /**
5337
+ * @public
4616
5338
  * <p>Contains details on the filters associated with your account.</p>
4617
5339
  */
4618
5340
  filters: Filter[] | undefined;
4619
5341
  /**
5342
+ * @public
4620
5343
  * <p>A token to use for paginating results that are returned in the response. Set the value
4621
5344
  * of this parameter to null for the first request to a list action. For subsequent calls, use
4622
5345
  * the <code>NextToken</code> value returned from the previous request to continue listing
@@ -4629,10 +5352,12 @@ export interface ListFiltersResponse {
4629
5352
  */
4630
5353
  export interface ListFindingAggregationsRequest {
4631
5354
  /**
5355
+ * @public
4632
5356
  * <p>The type of the aggregation request.</p>
4633
5357
  */
4634
5358
  aggregationType: AggregationType | string | undefined;
4635
5359
  /**
5360
+ * @public
4636
5361
  * <p>A token to use for paginating results that are returned in the response. Set the value
4637
5362
  * of this parameter to null for the first request to a list action. For subsequent calls, use
4638
5363
  * the <code>NextToken</code> value returned from the previous request to continue listing
@@ -4640,14 +5365,17 @@ export interface ListFindingAggregationsRequest {
4640
5365
  */
4641
5366
  nextToken?: string;
4642
5367
  /**
5368
+ * @public
4643
5369
  * <p>The maximum number of results to return in the response.</p>
4644
5370
  */
4645
5371
  maxResults?: number;
4646
5372
  /**
5373
+ * @public
4647
5374
  * <p>The Amazon Web Services account IDs to retrieve finding aggregation data for.</p>
4648
5375
  */
4649
5376
  accountIds?: StringFilter[];
4650
5377
  /**
5378
+ * @public
4651
5379
  * <p>Details of the aggregation request that is used to filter your aggregation results.</p>
4652
5380
  */
4653
5381
  aggregationRequest?: AggregationRequest;
@@ -4657,14 +5385,17 @@ export interface ListFindingAggregationsRequest {
4657
5385
  */
4658
5386
  export interface ListFindingAggregationsResponse {
4659
5387
  /**
5388
+ * @public
4660
5389
  * <p>The type of aggregation to perform.</p>
4661
5390
  */
4662
5391
  aggregationType: AggregationType | string | undefined;
4663
5392
  /**
5393
+ * @public
4664
5394
  * <p>Objects that contain the results of an aggregation operation.</p>
4665
5395
  */
4666
5396
  responses?: AggregationResponse[];
4667
5397
  /**
5398
+ * @public
4668
5399
  * <p>A token to use for paginating results that are returned in the response. Set the value
4669
5400
  * of this parameter to null for the first request to a list action. For subsequent calls, use
4670
5401
  * the <code>NextToken</code> value returned from the previous request to continue listing
@@ -4705,10 +5436,12 @@ export type SortField = (typeof SortField)[keyof typeof SortField];
4705
5436
  */
4706
5437
  export interface SortCriteria {
4707
5438
  /**
5439
+ * @public
4708
5440
  * <p>The finding detail field by which results are sorted.</p>
4709
5441
  */
4710
5442
  field: SortField | string | undefined;
4711
5443
  /**
5444
+ * @public
4712
5445
  * <p>The order by which findings are sorted.</p>
4713
5446
  */
4714
5447
  sortOrder: SortOrder | string | undefined;
@@ -4718,10 +5451,12 @@ export interface SortCriteria {
4718
5451
  */
4719
5452
  export interface ListFindingsRequest {
4720
5453
  /**
5454
+ * @public
4721
5455
  * <p>The maximum number of results to return in the response.</p>
4722
5456
  */
4723
5457
  maxResults?: number;
4724
5458
  /**
5459
+ * @public
4725
5460
  * <p>A token to use for paginating results that are returned in the response. Set the value
4726
5461
  * of this parameter to null for the first request to a list action. For subsequent calls, use
4727
5462
  * the <code>NextToken</code> value returned from the previous request to continue listing
@@ -4729,10 +5464,12 @@ export interface ListFindingsRequest {
4729
5464
  */
4730
5465
  nextToken?: string;
4731
5466
  /**
5467
+ * @public
4732
5468
  * <p>Details on the filters to apply to your finding results.</p>
4733
5469
  */
4734
5470
  filterCriteria?: FilterCriteria;
4735
5471
  /**
5472
+ * @public
4736
5473
  * <p>Details on the sort criteria to apply to your finding results.</p>
4737
5474
  */
4738
5475
  sortCriteria?: SortCriteria;
@@ -4742,6 +5479,7 @@ export interface ListFindingsRequest {
4742
5479
  */
4743
5480
  export interface ListFindingsResponse {
4744
5481
  /**
5482
+ * @public
4745
5483
  * <p>A token to use for paginating results that are returned in the response. Set the value
4746
5484
  * of this parameter to null for the first request to a list action. For subsequent calls, use
4747
5485
  * the <code>NextToken</code> value returned from the previous request to continue listing
@@ -4749,6 +5487,7 @@ export interface ListFindingsResponse {
4749
5487
  */
4750
5488
  nextToken?: string;
4751
5489
  /**
5490
+ * @public
4752
5491
  * <p>Contains details on the findings in your environment.</p>
4753
5492
  */
4754
5493
  findings?: Finding[];
@@ -4758,15 +5497,18 @@ export interface ListFindingsResponse {
4758
5497
  */
4759
5498
  export interface ListMembersRequest {
4760
5499
  /**
5500
+ * @public
4761
5501
  * <p>Specifies whether to list only currently associated members if <code>True</code> or to
4762
5502
  * list all members within the organization if <code>False</code>.</p>
4763
5503
  */
4764
5504
  onlyAssociated?: boolean;
4765
5505
  /**
5506
+ * @public
4766
5507
  * <p>The maximum number of results to return in the response.</p>
4767
5508
  */
4768
5509
  maxResults?: number;
4769
5510
  /**
5511
+ * @public
4770
5512
  * <p>A token to use for paginating results that are returned in the response. Set the value
4771
5513
  * of this parameter to null for the first request to a list action. For subsequent calls, use
4772
5514
  * the <code>NextToken</code> value returned from the previous request to continue listing
@@ -4779,10 +5521,12 @@ export interface ListMembersRequest {
4779
5521
  */
4780
5522
  export interface ListMembersResponse {
4781
5523
  /**
5524
+ * @public
4782
5525
  * <p>An object that contains details for each member account.</p>
4783
5526
  */
4784
5527
  members?: Member[];
4785
5528
  /**
5529
+ * @public
4786
5530
  * <p>The pagination parameter to be used on the next list operation to retrieve more
4787
5531
  * items.</p>
4788
5532
  */
@@ -4793,6 +5537,7 @@ export interface ListMembersResponse {
4793
5537
  */
4794
5538
  export interface ListTagsForResourceRequest {
4795
5539
  /**
5540
+ * @public
4796
5541
  * <p>The Amazon resource number (ARN) of the resource to list tags of.</p>
4797
5542
  */
4798
5543
  resourceArn: string | undefined;
@@ -4802,6 +5547,7 @@ export interface ListTagsForResourceRequest {
4802
5547
  */
4803
5548
  export interface ListTagsForResourceResponse {
4804
5549
  /**
5550
+ * @public
4805
5551
  * <p>The tags associated with the resource.</p>
4806
5552
  */
4807
5553
  tags?: Record<string, string>;
@@ -4811,10 +5557,12 @@ export interface ListTagsForResourceResponse {
4811
5557
  */
4812
5558
  export interface ListUsageTotalsRequest {
4813
5559
  /**
5560
+ * @public
4814
5561
  * <p>The maximum number of results to return in the response.</p>
4815
5562
  */
4816
5563
  maxResults?: number;
4817
5564
  /**
5565
+ * @public
4818
5566
  * <p>A token to use for paginating results that are returned in the response. Set the value
4819
5567
  * of this parameter to null for the first request to a list action. For subsequent calls, use
4820
5568
  * the <code>NextToken</code> value returned from the previous request to continue listing
@@ -4822,6 +5570,7 @@ export interface ListUsageTotalsRequest {
4822
5570
  */
4823
5571
  nextToken?: string;
4824
5572
  /**
5573
+ * @public
4825
5574
  * <p>The Amazon Web Services account IDs to retrieve usage totals for.</p>
4826
5575
  */
4827
5576
  accountIds?: string[];
@@ -4847,18 +5596,22 @@ export type UsageType = (typeof UsageType)[keyof typeof UsageType];
4847
5596
  */
4848
5597
  export interface Usage {
4849
5598
  /**
5599
+ * @public
4850
5600
  * <p>The type scan.</p>
4851
5601
  */
4852
5602
  type?: UsageType | string;
4853
5603
  /**
5604
+ * @public
4854
5605
  * <p>The total of usage.</p>
4855
5606
  */
4856
5607
  total?: number;
4857
5608
  /**
5609
+ * @public
4858
5610
  * <p>The estimated monthly cost of Amazon Inspector.</p>
4859
5611
  */
4860
5612
  estimatedMonthlyCost?: number;
4861
5613
  /**
5614
+ * @public
4862
5615
  * <p>The currency type used when calculating usage data.</p>
4863
5616
  */
4864
5617
  currency?: Currency | string;
@@ -4869,10 +5622,12 @@ export interface Usage {
4869
5622
  */
4870
5623
  export interface UsageTotal {
4871
5624
  /**
5625
+ * @public
4872
5626
  * <p>The account ID of the account that usage data was retrieved for.</p>
4873
5627
  */
4874
5628
  accountId?: string;
4875
5629
  /**
5630
+ * @public
4876
5631
  * <p>An object representing the total usage for an account.</p>
4877
5632
  */
4878
5633
  usage?: Usage[];
@@ -4882,10 +5637,12 @@ export interface UsageTotal {
4882
5637
  */
4883
5638
  export interface ListUsageTotalsResponse {
4884
5639
  /**
5640
+ * @public
4885
5641
  * <p>The pagination parameter to be used on the next list operation to retrieve more items.</p>
4886
5642
  */
4887
5643
  nextToken?: string;
4888
5644
  /**
5645
+ * @public
4889
5646
  * <p>An object with details on the total usage for the requested account.</p>
4890
5647
  */
4891
5648
  totals?: UsageTotal[];
@@ -4895,10 +5652,12 @@ export interface ListUsageTotalsResponse {
4895
5652
  */
4896
5653
  export interface ResetEncryptionKeyRequest {
4897
5654
  /**
5655
+ * @public
4898
5656
  * <p>The scan type the key encrypts.</p>
4899
5657
  */
4900
5658
  scanType: ScanType | string | undefined;
4901
5659
  /**
5660
+ * @public
4902
5661
  * <p>The resource type the key encrypts.</p>
4903
5662
  */
4904
5663
  resourceType: ResourceType | string | undefined;
@@ -4915,6 +5674,7 @@ export interface ResetEncryptionKeyResponse {
4915
5674
  */
4916
5675
  export interface SearchVulnerabilitiesFilterCriteria {
4917
5676
  /**
5677
+ * @public
4918
5678
  * <p>The IDs for specific vulnerabilities.</p>
4919
5679
  */
4920
5680
  vulnerabilityIds: string[] | undefined;
@@ -4924,10 +5684,12 @@ export interface SearchVulnerabilitiesFilterCriteria {
4924
5684
  */
4925
5685
  export interface SearchVulnerabilitiesRequest {
4926
5686
  /**
5687
+ * @public
4927
5688
  * <p>The criteria used to filter the results of a vulnerability search.</p>
4928
5689
  */
4929
5690
  filterCriteria: SearchVulnerabilitiesFilterCriteria | undefined;
4930
5691
  /**
5692
+ * @public
4931
5693
  * <p>A token to use for paginating results that are returned in the response. Set the value
4932
5694
  * of this parameter to null for the first request to a list action. For subsequent calls, use
4933
5695
  * the <code>NextToken</code> value returned from the previous request to continue listing
@@ -4952,70 +5714,87 @@ export type VulnerabilitySource = (typeof VulnerabilitySource)[keyof typeof Vuln
4952
5714
  */
4953
5715
  export interface Vulnerability {
4954
5716
  /**
5717
+ * @public
4955
5718
  * <p>The ID for the specific vulnerability.</p>
4956
5719
  */
4957
5720
  id: string | undefined;
4958
5721
  /**
5722
+ * @public
4959
5723
  * <p>The Common Weakness Enumeration (CWE) associated with the vulnerability.</p>
4960
5724
  */
4961
5725
  cwes?: string[];
4962
5726
  /**
5727
+ * @public
4963
5728
  * <p>An object that contains the Cybersecurity and Infrastructure Security Agency (CISA) details for the vulnerability.</p>
4964
5729
  */
4965
5730
  cisaData?: CisaData;
4966
5731
  /**
5732
+ * @public
4967
5733
  * <p>The source of the vulnerability information.</p>
4968
5734
  */
4969
5735
  source?: VulnerabilitySource | string;
4970
5736
  /**
5737
+ * @public
4971
5738
  * <p>A description of the vulnerability.</p>
4972
5739
  */
4973
5740
  description?: string;
4974
5741
  /**
5742
+ * @public
4975
5743
  * <p>An object that contains information about the Amazon Web Services Threat Intel Group (ATIG) details for the vulnerability.</p>
4976
5744
  */
4977
5745
  atigData?: AtigData;
4978
5746
  /**
5747
+ * @public
4979
5748
  * <p>The severity assigned by the vendor.</p>
4980
5749
  */
4981
5750
  vendorSeverity?: string;
4982
5751
  /**
5752
+ * @public
4983
5753
  * <p>An object that contains the Common Vulnerability Scoring System (CVSS) Version 3 details for the vulnerability.</p>
4984
5754
  */
4985
5755
  cvss3?: Cvss3;
4986
5756
  /**
5757
+ * @public
4987
5758
  * <p>A list of related vulnerabilities.</p>
4988
5759
  */
4989
5760
  relatedVulnerabilities?: string[];
4990
5761
  /**
5762
+ * @public
4991
5763
  * <p>An object that contains the Common Vulnerability Scoring System (CVSS) Version 2 details for the vulnerability.</p>
4992
5764
  */
4993
5765
  cvss2?: Cvss2;
4994
5766
  /**
5767
+ * @public
4995
5768
  * <p>The date and time when the vendor created this vulnerability.</p>
4996
5769
  */
4997
5770
  vendorCreatedAt?: Date;
4998
5771
  /**
5772
+ * @public
4999
5773
  * <p>The date and time when the vendor last updated this vulnerability.</p>
5000
5774
  */
5001
5775
  vendorUpdatedAt?: Date;
5002
5776
  /**
5777
+ * @public
5003
5778
  * <p>A link to the official source material for this vulnerability.</p>
5004
5779
  */
5005
5780
  sourceUrl?: string;
5006
5781
  /**
5782
+ * @public
5007
5783
  * <p>Links to various resources with more information on this vulnerability. </p>
5008
5784
  */
5009
5785
  referenceUrls?: string[];
5010
5786
  /**
5787
+ * @public
5011
5788
  * <p>An object that contains details on when the exploit was observed.</p>
5012
5789
  */
5013
5790
  exploitObserved?: ExploitObserved;
5014
5791
  /**
5792
+ * @public
5015
5793
  * <p>Platforms that the vulnerability can be detected on.</p>
5016
5794
  */
5017
5795
  detectionPlatforms?: string[];
5018
5796
  /**
5797
+ * @public
5019
5798
  * <p>An object that contains the Exploit Prediction Scoring System (EPSS) score for a vulnerability.</p>
5020
5799
  */
5021
5800
  epss?: Epss;
@@ -5025,10 +5804,12 @@ export interface Vulnerability {
5025
5804
  */
5026
5805
  export interface SearchVulnerabilitiesResponse {
5027
5806
  /**
5807
+ * @public
5028
5808
  * <p>Details about the listed vulnerability.</p>
5029
5809
  */
5030
5810
  vulnerabilities: Vulnerability[] | undefined;
5031
5811
  /**
5812
+ * @public
5032
5813
  * <p>The pagination parameter to be used on the next list operation to retrieve more items.</p>
5033
5814
  */
5034
5815
  nextToken?: string;
@@ -5038,10 +5819,12 @@ export interface SearchVulnerabilitiesResponse {
5038
5819
  */
5039
5820
  export interface TagResourceRequest {
5040
5821
  /**
5822
+ * @public
5041
5823
  * <p>The Amazon Resource Name (ARN) of the resource to apply a tag to.</p>
5042
5824
  */
5043
5825
  resourceArn: string | undefined;
5044
5826
  /**
5827
+ * @public
5045
5828
  * <p>The tags to be added to a resource.</p>
5046
5829
  */
5047
5830
  tags: Record<string, string> | undefined;
@@ -5056,10 +5839,12 @@ export interface TagResourceResponse {
5056
5839
  */
5057
5840
  export interface UntagResourceRequest {
5058
5841
  /**
5842
+ * @public
5059
5843
  * <p>The Amazon Resource Name (ARN) for the resource to remove tags from.</p>
5060
5844
  */
5061
5845
  resourceArn: string | undefined;
5062
5846
  /**
5847
+ * @public
5063
5848
  * <p>The tag keys to remove from the resource.</p>
5064
5849
  */
5065
5850
  tagKeys: string[] | undefined;
@@ -5074,6 +5859,7 @@ export interface UntagResourceResponse {
5074
5859
  */
5075
5860
  export interface UpdateConfigurationRequest {
5076
5861
  /**
5862
+ * @public
5077
5863
  * <p>Specifies how the ECR automated re-scan will be updated for your environment.</p>
5078
5864
  */
5079
5865
  ecrConfiguration: EcrConfiguration | undefined;
@@ -5088,10 +5874,12 @@ export interface UpdateConfigurationResponse {
5088
5874
  */
5089
5875
  export interface UpdateEc2DeepInspectionConfigurationRequest {
5090
5876
  /**
5877
+ * @public
5091
5878
  * <p>Specify <code>TRUE</code> to activate Amazon Inspector deep inspection in your account, or <code>FALSE</code> to deactivate. Member accounts in an organization cannot deactivate deep inspection, instead the delegated administrator for the organization can deactivate a member account using <a href="https://docs.aws.amazon.com/inspector/v2/APIReference/API_BatchUpdateMemberEc2DeepInspectionStatus.html">BatchUpdateMemberEc2DeepInspectionStatus</a>.</p>
5092
5879
  */
5093
5880
  activateDeepInspection?: boolean;
5094
5881
  /**
5882
+ * @public
5095
5883
  * <p>The Amazon Inspector deep inspection custom paths you are adding for your account.</p>
5096
5884
  */
5097
5885
  packagePaths?: string[];
@@ -5101,18 +5889,22 @@ export interface UpdateEc2DeepInspectionConfigurationRequest {
5101
5889
  */
5102
5890
  export interface UpdateEc2DeepInspectionConfigurationResponse {
5103
5891
  /**
5892
+ * @public
5104
5893
  * <p>The current Amazon Inspector deep inspection custom paths for your account.</p>
5105
5894
  */
5106
5895
  packagePaths?: string[];
5107
5896
  /**
5897
+ * @public
5108
5898
  * <p>The current Amazon Inspector deep inspection custom paths for the organization.</p>
5109
5899
  */
5110
5900
  orgPackagePaths?: string[];
5111
5901
  /**
5902
+ * @public
5112
5903
  * <p>The status of Amazon Inspector deep inspection in your account.</p>
5113
5904
  */
5114
5905
  status?: Ec2DeepInspectionStatus | string;
5115
5906
  /**
5907
+ * @public
5116
5908
  * <p>An error message explaining why new Amazon Inspector deep inspection custom paths could not be added.</p>
5117
5909
  */
5118
5910
  errorMessage?: string;
@@ -5122,14 +5914,17 @@ export interface UpdateEc2DeepInspectionConfigurationResponse {
5122
5914
  */
5123
5915
  export interface UpdateEncryptionKeyRequest {
5124
5916
  /**
5917
+ * @public
5125
5918
  * <p>A KMS key ID for the encryption key.</p>
5126
5919
  */
5127
5920
  kmsKeyId: string | undefined;
5128
5921
  /**
5922
+ * @public
5129
5923
  * <p>The scan type for the encryption key.</p>
5130
5924
  */
5131
5925
  scanType: ScanType | string | undefined;
5132
5926
  /**
5927
+ * @public
5133
5928
  * <p>The resource type for the encryption key.</p>
5134
5929
  */
5135
5930
  resourceType: ResourceType | string | undefined;
@@ -5144,26 +5939,32 @@ export interface UpdateEncryptionKeyResponse {
5144
5939
  */
5145
5940
  export interface UpdateFilterRequest {
5146
5941
  /**
5942
+ * @public
5147
5943
  * <p>Specifies the action that is to be applied to the findings that match the filter.</p>
5148
5944
  */
5149
5945
  action?: FilterAction | string;
5150
5946
  /**
5947
+ * @public
5151
5948
  * <p>A description of the filter.</p>
5152
5949
  */
5153
5950
  description?: string;
5154
5951
  /**
5952
+ * @public
5155
5953
  * <p>Defines the criteria to be update in the filter.</p>
5156
5954
  */
5157
5955
  filterCriteria?: FilterCriteria;
5158
5956
  /**
5957
+ * @public
5159
5958
  * <p>The name of the filter.</p>
5160
5959
  */
5161
5960
  name?: string;
5162
5961
  /**
5962
+ * @public
5163
5963
  * <p>The Amazon Resource Number (ARN) of the filter to update.</p>
5164
5964
  */
5165
5965
  filterArn: string | undefined;
5166
5966
  /**
5967
+ * @public
5167
5968
  * <p>The reason the filter was updated.</p>
5168
5969
  */
5169
5970
  reason?: string;
@@ -5173,6 +5974,7 @@ export interface UpdateFilterRequest {
5173
5974
  */
5174
5975
  export interface UpdateFilterResponse {
5175
5976
  /**
5977
+ * @public
5176
5978
  * <p>The Amazon Resource Number (ARN) of the successfully updated filter.</p>
5177
5979
  */
5178
5980
  arn: string | undefined;
@@ -5182,6 +5984,7 @@ export interface UpdateFilterResponse {
5182
5984
  */
5183
5985
  export interface UpdateOrganizationConfigurationRequest {
5184
5986
  /**
5987
+ * @public
5185
5988
  * <p>Defines which scan types are enabled automatically for new members of your Amazon Inspector organization.</p>
5186
5989
  */
5187
5990
  autoEnable: AutoEnable | undefined;
@@ -5191,6 +5994,7 @@ export interface UpdateOrganizationConfigurationRequest {
5191
5994
  */
5192
5995
  export interface UpdateOrganizationConfigurationResponse {
5193
5996
  /**
5997
+ * @public
5194
5998
  * <p>The updated status of scan types automatically enabled for new members of your Amazon Inspector organization.</p>
5195
5999
  */
5196
6000
  autoEnable: AutoEnable | undefined;
@@ -5200,6 +6004,7 @@ export interface UpdateOrganizationConfigurationResponse {
5200
6004
  */
5201
6005
  export interface UpdateOrgEc2DeepInspectionConfigurationRequest {
5202
6006
  /**
6007
+ * @public
5203
6008
  * <p>The Amazon Inspector deep inspection custom paths you are adding for your organization.</p>
5204
6009
  */
5205
6010
  orgPackagePaths: string[] | undefined;