@aws-sdk/client-inspector 3.379.1 → 3.385.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.
@@ -26,10 +26,12 @@ export declare class AccessDeniedException extends __BaseException {
26
26
  readonly name: "AccessDeniedException";
27
27
  readonly $fault: "client";
28
28
  /**
29
+ * @public
29
30
  * <p>Code that indicates the type of error that is generated.</p>
30
31
  */
31
32
  errorCode: AccessDeniedErrorCode | string | undefined;
32
33
  /**
34
+ * @public
33
35
  * <p>You can immediately retry your request.</p>
34
36
  */
35
37
  canRetry: boolean | undefined;
@@ -45,10 +47,12 @@ export declare class AccessDeniedException extends __BaseException {
45
47
  */
46
48
  export interface Attribute {
47
49
  /**
50
+ * @public
48
51
  * <p>The attribute key.</p>
49
52
  */
50
53
  key: string | undefined;
51
54
  /**
55
+ * @public
52
56
  * <p>The value assigned to the attribute key.</p>
53
57
  */
54
58
  value?: string;
@@ -58,10 +62,12 @@ export interface Attribute {
58
62
  */
59
63
  export interface AddAttributesToFindingsRequest {
60
64
  /**
65
+ * @public
61
66
  * <p>The ARNs that specify the findings that you want to assign attributes to.</p>
62
67
  */
63
68
  findingArns: string[] | undefined;
64
69
  /**
70
+ * @public
65
71
  * <p>The array of attributes that you want to assign to specified findings.</p>
66
72
  */
67
73
  attributes: Attribute[] | undefined;
@@ -88,10 +94,12 @@ export type FailedItemErrorCode = (typeof FailedItemErrorCode)[keyof typeof Fail
88
94
  */
89
95
  export interface FailedItemDetails {
90
96
  /**
97
+ * @public
91
98
  * <p>The status code of a failed item.</p>
92
99
  */
93
100
  failureCode: FailedItemErrorCode | string | undefined;
94
101
  /**
102
+ * @public
95
103
  * <p>Indicates whether you can immediately retry a request for this item for a specified
96
104
  * resource.</p>
97
105
  */
@@ -102,6 +110,7 @@ export interface FailedItemDetails {
102
110
  */
103
111
  export interface AddAttributesToFindingsResponse {
104
112
  /**
113
+ * @public
105
114
  * <p>Attribute details that cannot be described. An error code is provided for each failed
106
115
  * item.</p>
107
116
  */
@@ -115,6 +124,7 @@ export declare class InternalException extends __BaseException {
115
124
  readonly name: "InternalException";
116
125
  readonly $fault: "server";
117
126
  /**
127
+ * @public
118
128
  * <p>You can immediately retry your request.</p>
119
129
  */
120
130
  canRetry: boolean | undefined;
@@ -196,10 +206,12 @@ export declare class InvalidInputException extends __BaseException {
196
206
  readonly name: "InvalidInputException";
197
207
  readonly $fault: "client";
198
208
  /**
209
+ * @public
199
210
  * <p>Code that indicates the type of error that is generated.</p>
200
211
  */
201
212
  errorCode: InvalidInputErrorCode | string | undefined;
202
213
  /**
214
+ * @public
203
215
  * <p>You can immediately retry your request.</p>
204
216
  */
205
217
  canRetry: boolean | undefined;
@@ -235,10 +247,12 @@ export declare class NoSuchEntityException extends __BaseException {
235
247
  readonly name: "NoSuchEntityException";
236
248
  readonly $fault: "client";
237
249
  /**
250
+ * @public
238
251
  * <p>Code that indicates the type of error that is generated.</p>
239
252
  */
240
253
  errorCode: NoSuchEntityErrorCode | string | undefined;
241
254
  /**
255
+ * @public
242
256
  * <p>You can immediately retry your request.</p>
243
257
  */
244
258
  canRetry: boolean | undefined;
@@ -255,6 +269,7 @@ export declare class ServiceTemporarilyUnavailableException extends __BaseExcept
255
269
  readonly name: "ServiceTemporarilyUnavailableException";
256
270
  readonly $fault: "server";
257
271
  /**
272
+ * @public
258
273
  * <p>You can wait and then retry your request.</p>
259
274
  */
260
275
  canRetry: boolean | undefined;
@@ -271,11 +286,13 @@ export declare class ServiceTemporarilyUnavailableException extends __BaseExcept
271
286
  */
272
287
  export interface AgentAlreadyRunningAssessment {
273
288
  /**
289
+ * @public
274
290
  * <p>ID of the agent that is running on an EC2 instance that is already participating in
275
291
  * another started assessment run.</p>
276
292
  */
277
293
  agentId: string | undefined;
278
294
  /**
295
+ * @public
279
296
  * <p>The ARN of the assessment run that has already been started.</p>
280
297
  */
281
298
  assessmentRunArn: string | undefined;
@@ -316,10 +333,12 @@ export type AgentHealth = (typeof AgentHealth)[keyof typeof AgentHealth];
316
333
  */
317
334
  export interface AgentFilter {
318
335
  /**
336
+ * @public
319
337
  * <p>The current health state of the agent. Values can be set to <b>HEALTHY</b> or <b>UNHEALTHY</b>.</p>
320
338
  */
321
339
  agentHealths: (AgentHealth | string)[] | undefined;
322
340
  /**
341
+ * @public
323
342
  * <p>The detailed health state of the agent. Values can be set to <b>IDLE</b>, <b>RUNNING</b>, <b>SHUTDOWN</b>, <b>UNHEALTHY</b>, <b>THROTTLED</b>, and <b>UNKNOWN</b>. </p>
324
343
  */
325
344
  agentHealthCodes: (AgentHealthCode | string)[] | undefined;
@@ -330,37 +349,45 @@ export interface AgentFilter {
330
349
  */
331
350
  export interface AgentPreview {
332
351
  /**
352
+ * @public
333
353
  * <p>The hostname of the EC2 instance on which the Amazon Inspector Agent is
334
354
  * installed.</p>
335
355
  */
336
356
  hostname?: string;
337
357
  /**
358
+ * @public
338
359
  * <p>The ID of the EC2 instance where the agent is installed.</p>
339
360
  */
340
361
  agentId: string | undefined;
341
362
  /**
363
+ * @public
342
364
  * <p>The Auto Scaling group for the EC2 instance where the agent is installed.</p>
343
365
  */
344
366
  autoScalingGroup?: string;
345
367
  /**
368
+ * @public
346
369
  * <p>The health status of the Amazon Inspector Agent.</p>
347
370
  */
348
371
  agentHealth?: AgentHealth | string;
349
372
  /**
373
+ * @public
350
374
  * <p>The version of the Amazon Inspector Agent.</p>
351
375
  */
352
376
  agentVersion?: string;
353
377
  /**
378
+ * @public
354
379
  * <p>The operating system running on the EC2 instance on which the Amazon Inspector Agent
355
380
  * is installed.</p>
356
381
  */
357
382
  operatingSystem?: string;
358
383
  /**
384
+ * @public
359
385
  * <p>The kernel version of the operating system running on the EC2 instance on which the
360
386
  * Amazon Inspector Agent is installed.</p>
361
387
  */
362
388
  kernelVersion?: string;
363
389
  /**
390
+ * @public
364
391
  * <p>The IP address of the EC2 instance on which the Amazon Inspector Agent is
365
392
  * installed.</p>
366
393
  */
@@ -375,14 +402,17 @@ export declare class AgentsAlreadyRunningAssessmentException extends __BaseExcep
375
402
  readonly name: "AgentsAlreadyRunningAssessmentException";
376
403
  readonly $fault: "client";
377
404
  /**
405
+ * @public
378
406
  * <p></p>
379
407
  */
380
408
  agents: AgentAlreadyRunningAssessment[] | undefined;
381
409
  /**
410
+ * @public
382
411
  * <p></p>
383
412
  */
384
413
  agentsTruncated: boolean | undefined;
385
414
  /**
415
+ * @public
386
416
  * <p>You can immediately retry your request.</p>
387
417
  */
388
418
  canRetry: boolean | undefined;
@@ -442,27 +472,33 @@ export type AssessmentRunNotificationSnsStatusCode = (typeof AssessmentRunNotifi
442
472
  */
443
473
  export interface AssessmentRunNotification {
444
474
  /**
475
+ * @public
445
476
  * <p>The date of the notification.</p>
446
477
  */
447
478
  date: Date | undefined;
448
479
  /**
480
+ * @public
449
481
  * <p>The event for which a notification is sent.</p>
450
482
  */
451
483
  event: InspectorEvent | string | undefined;
452
484
  /**
485
+ * @public
453
486
  * <p>The message included in the notification.</p>
454
487
  */
455
488
  message?: string;
456
489
  /**
490
+ * @public
457
491
  * <p>The Boolean value that specifies whether the notification represents an
458
492
  * error.</p>
459
493
  */
460
494
  error: boolean | undefined;
461
495
  /**
496
+ * @public
462
497
  * <p>The SNS topic to which the SNS notification is sent.</p>
463
498
  */
464
499
  snsTopicArn?: string;
465
500
  /**
501
+ * @public
466
502
  * <p>The status code of the SNS notification.</p>
467
503
  */
468
504
  snsPublishStatusCode?: AssessmentRunNotificationSnsStatusCode | string;
@@ -497,10 +533,12 @@ export type AssessmentRunState = (typeof AssessmentRunState)[keyof typeof Assess
497
533
  */
498
534
  export interface AssessmentRunStateChange {
499
535
  /**
536
+ * @public
500
537
  * <p>The last time the assessment run state changed.</p>
501
538
  */
502
539
  stateChangedAt: Date | undefined;
503
540
  /**
541
+ * @public
504
542
  * <p>The assessment run state.</p>
505
543
  */
506
544
  state: AssessmentRunState | string | undefined;
@@ -514,66 +552,81 @@ export interface AssessmentRunStateChange {
514
552
  */
515
553
  export interface AssessmentRun {
516
554
  /**
555
+ * @public
517
556
  * <p>The ARN of the assessment run.</p>
518
557
  */
519
558
  arn: string | undefined;
520
559
  /**
560
+ * @public
521
561
  * <p>The auto-generated name for the assessment run.</p>
522
562
  */
523
563
  name: string | undefined;
524
564
  /**
565
+ * @public
525
566
  * <p>The ARN of the assessment template that is associated with the assessment
526
567
  * run.</p>
527
568
  */
528
569
  assessmentTemplateArn: string | undefined;
529
570
  /**
571
+ * @public
530
572
  * <p>The state of the assessment run.</p>
531
573
  */
532
574
  state: AssessmentRunState | string | undefined;
533
575
  /**
576
+ * @public
534
577
  * <p>The duration of the assessment run.</p>
535
578
  */
536
579
  durationInSeconds: number | undefined;
537
580
  /**
581
+ * @public
538
582
  * <p>The rules packages selected for the assessment run.</p>
539
583
  */
540
584
  rulesPackageArns: string[] | undefined;
541
585
  /**
586
+ * @public
542
587
  * <p>The user-defined attributes that are assigned to every generated finding.</p>
543
588
  */
544
589
  userAttributesForFindings: Attribute[] | undefined;
545
590
  /**
591
+ * @public
546
592
  * <p>The time when <a>StartAssessmentRun</a> was called.</p>
547
593
  */
548
594
  createdAt: Date | undefined;
549
595
  /**
596
+ * @public
550
597
  * <p>The time when <a>StartAssessmentRun</a> was called.</p>
551
598
  */
552
599
  startedAt?: Date;
553
600
  /**
601
+ * @public
554
602
  * <p>The assessment run completion time that corresponds to the rules packages evaluation
555
603
  * completion time or failure.</p>
556
604
  */
557
605
  completedAt?: Date;
558
606
  /**
607
+ * @public
559
608
  * <p>The last time when the assessment run's state changed.</p>
560
609
  */
561
610
  stateChangedAt: Date | undefined;
562
611
  /**
612
+ * @public
563
613
  * <p>A Boolean value (true or false) that specifies whether the process of collecting data
564
614
  * from the agents is completed.</p>
565
615
  */
566
616
  dataCollected: boolean | undefined;
567
617
  /**
618
+ * @public
568
619
  * <p>A list of the assessment run state changes.</p>
569
620
  */
570
621
  stateChanges: AssessmentRunStateChange[] | undefined;
571
622
  /**
623
+ * @public
572
624
  * <p>A list of notifications for the event subscriptions. A notification about a
573
625
  * particular generated finding is added to this list only once.</p>
574
626
  */
575
627
  notifications: AssessmentRunNotification[] | undefined;
576
628
  /**
629
+ * @public
577
630
  * <p>Provides a total count of generated findings per severity.</p>
578
631
  */
579
632
  findingCounts: Record<string, number> | undefined;
@@ -585,14 +638,17 @@ export interface AssessmentRun {
585
638
  */
586
639
  export interface TelemetryMetadata {
587
640
  /**
641
+ * @public
588
642
  * <p>A specific type of behavioral data that is collected by the agent.</p>
589
643
  */
590
644
  messageType: string | undefined;
591
645
  /**
646
+ * @public
592
647
  * <p>The count of messages that the agent sends to the Amazon Inspector service.</p>
593
648
  */
594
649
  count: number | undefined;
595
650
  /**
651
+ * @public
596
652
  * <p>The data size of messages that the agent sends to the Amazon Inspector
597
653
  * service.</p>
598
654
  */
@@ -605,31 +661,38 @@ export interface TelemetryMetadata {
605
661
  */
606
662
  export interface AssessmentRunAgent {
607
663
  /**
664
+ * @public
608
665
  * <p>The AWS account of the EC2 instance where the agent is installed.</p>
609
666
  */
610
667
  agentId: string | undefined;
611
668
  /**
669
+ * @public
612
670
  * <p>The ARN of the assessment run that is associated with the agent.</p>
613
671
  */
614
672
  assessmentRunArn: string | undefined;
615
673
  /**
674
+ * @public
616
675
  * <p>The current health state of the agent.</p>
617
676
  */
618
677
  agentHealth: AgentHealth | string | undefined;
619
678
  /**
679
+ * @public
620
680
  * <p>The detailed health state of the agent.</p>
621
681
  */
622
682
  agentHealthCode: AgentHealthCode | string | undefined;
623
683
  /**
684
+ * @public
624
685
  * <p>The description for the agent health code.</p>
625
686
  */
626
687
  agentHealthDetails?: string;
627
688
  /**
689
+ * @public
628
690
  * <p>The Auto Scaling group of the EC2 instance that is specified by the agent
629
691
  * ID.</p>
630
692
  */
631
693
  autoScalingGroup?: string;
632
694
  /**
695
+ * @public
633
696
  * <p>The Amazon Inspector application data metrics that are collected by the
634
697
  * agent.</p>
635
698
  */
@@ -642,10 +705,12 @@ export interface AssessmentRunAgent {
642
705
  */
643
706
  export interface TimestampRange {
644
707
  /**
708
+ * @public
645
709
  * <p>The minimum value of the timestamp range.</p>
646
710
  */
647
711
  beginDate?: Date;
648
712
  /**
713
+ * @public
649
714
  * <p>The maximum value of the timestamp range.</p>
650
715
  */
651
716
  endDate?: Date;
@@ -657,10 +722,12 @@ export interface TimestampRange {
657
722
  */
658
723
  export interface DurationRange {
659
724
  /**
725
+ * @public
660
726
  * <p>The minimum value of the duration range. Must be greater than zero.</p>
661
727
  */
662
728
  minSeconds?: number;
663
729
  /**
730
+ * @public
664
731
  * <p>The maximum value of the duration range. Must be less than or equal to 604800 seconds
665
732
  * (1 week).</p>
666
733
  */
@@ -673,42 +740,49 @@ export interface DurationRange {
673
740
  */
674
741
  export interface AssessmentRunFilter {
675
742
  /**
743
+ * @public
676
744
  * <p>For a record to match a filter, an explicit value or a string containing a wildcard
677
745
  * that is specified for this data type property must match the value of the <b>assessmentRunName</b> property of the <a>AssessmentRun</a>
678
746
  * data type.</p>
679
747
  */
680
748
  namePattern?: string;
681
749
  /**
750
+ * @public
682
751
  * <p>For a record to match a filter, one of the values specified for this data type
683
752
  * property must be the exact match of the value of the <b>assessmentRunState</b> property of the <a>AssessmentRun</a> data
684
753
  * type.</p>
685
754
  */
686
755
  states?: (AssessmentRunState | string)[];
687
756
  /**
757
+ * @public
688
758
  * <p>For a record to match a filter, the value that is specified for this data type
689
759
  * property must inclusively match any value between the specified minimum and maximum values
690
760
  * of the <b>durationInSeconds</b> property of the <a>AssessmentRun</a> data type.</p>
691
761
  */
692
762
  durationRange?: DurationRange;
693
763
  /**
764
+ * @public
694
765
  * <p>For a record to match a filter, the value that is specified for this data type
695
766
  * property must be contained in the list of values of the <b>rulesPackages</b> property of the <a>AssessmentRun</a> data
696
767
  * type.</p>
697
768
  */
698
769
  rulesPackageArns?: string[];
699
770
  /**
771
+ * @public
700
772
  * <p>For a record to match a filter, the value that is specified for this data type
701
773
  * property must inclusively match any value between the specified minimum and maximum values
702
774
  * of the <b>startTime</b> property of the <a>AssessmentRun</a> data type.</p>
703
775
  */
704
776
  startTimeRange?: TimestampRange;
705
777
  /**
778
+ * @public
706
779
  * <p>For a record to match a filter, the value that is specified for this data type
707
780
  * property must inclusively match any value between the specified minimum and maximum values
708
781
  * of the <b>completedAt</b> property of the <a>AssessmentRun</a> data type.</p>
709
782
  */
710
783
  completionTimeRange?: TimestampRange;
711
784
  /**
785
+ * @public
712
786
  * <p>For a record to match a filter, the value that is specified for this data type
713
787
  * property must match the <b>stateChangedAt</b> property of the
714
788
  * <a>AssessmentRun</a> data type.</p>
@@ -724,15 +798,18 @@ export declare class AssessmentRunInProgressException extends __BaseException {
724
798
  readonly name: "AssessmentRunInProgressException";
725
799
  readonly $fault: "client";
726
800
  /**
801
+ * @public
727
802
  * <p>The ARNs of the assessment runs that are currently in progress.</p>
728
803
  */
729
804
  assessmentRunArns: string[] | undefined;
730
805
  /**
806
+ * @public
731
807
  * <p>Boolean value that indicates whether the ARN list of the assessment runs is
732
808
  * truncated.</p>
733
809
  */
734
810
  assessmentRunArnsTruncated: boolean | undefined;
735
811
  /**
812
+ * @public
736
813
  * <p>You can immediately retry your request.</p>
737
814
  */
738
815
  canRetry: boolean | undefined;
@@ -748,23 +825,28 @@ export declare class AssessmentRunInProgressException extends __BaseException {
748
825
  */
749
826
  export interface AssessmentTarget {
750
827
  /**
828
+ * @public
751
829
  * <p>The ARN that specifies the Amazon Inspector assessment target.</p>
752
830
  */
753
831
  arn: string | undefined;
754
832
  /**
833
+ * @public
755
834
  * <p>The name of the Amazon Inspector assessment target.</p>
756
835
  */
757
836
  name: string | undefined;
758
837
  /**
838
+ * @public
759
839
  * <p>The ARN that specifies the resource group that is associated with the assessment
760
840
  * target.</p>
761
841
  */
762
842
  resourceGroupArn?: string;
763
843
  /**
844
+ * @public
764
845
  * <p>The time at which the assessment target is created.</p>
765
846
  */
766
847
  createdAt: Date | undefined;
767
848
  /**
849
+ * @public
768
850
  * <p>The time at which <a>UpdateAssessmentTarget</a> is called.</p>
769
851
  */
770
852
  updatedAt: Date | undefined;
@@ -776,6 +858,7 @@ export interface AssessmentTarget {
776
858
  */
777
859
  export interface AssessmentTargetFilter {
778
860
  /**
861
+ * @public
779
862
  * <p>For a record to match a filter, an explicit value or a string that contains a
780
863
  * wildcard that is specified for this data type property must match the value of the
781
864
  * <b>assessmentTargetName</b> property of the <a>AssessmentTarget</a> data type.</p>
@@ -790,44 +873,53 @@ export interface AssessmentTargetFilter {
790
873
  */
791
874
  export interface AssessmentTemplate {
792
875
  /**
876
+ * @public
793
877
  * <p>The ARN of the assessment template.</p>
794
878
  */
795
879
  arn: string | undefined;
796
880
  /**
881
+ * @public
797
882
  * <p>The name of the assessment template.</p>
798
883
  */
799
884
  name: string | undefined;
800
885
  /**
886
+ * @public
801
887
  * <p>The ARN of the assessment target that corresponds to this assessment
802
888
  * template.</p>
803
889
  */
804
890
  assessmentTargetArn: string | undefined;
805
891
  /**
892
+ * @public
806
893
  * <p>The duration in seconds specified for this assessment template. The default value is
807
894
  * 3600 seconds (one hour). The maximum value is 86400 seconds (one day).</p>
808
895
  */
809
896
  durationInSeconds: number | undefined;
810
897
  /**
898
+ * @public
811
899
  * <p>The rules packages that are specified for this assessment template.</p>
812
900
  */
813
901
  rulesPackageArns: string[] | undefined;
814
902
  /**
903
+ * @public
815
904
  * <p>The user-defined attributes that are assigned to every generated finding from the
816
905
  * assessment run that uses this assessment template.</p>
817
906
  */
818
907
  userAttributesForFindings: Attribute[] | undefined;
819
908
  /**
909
+ * @public
820
910
  * <p>The Amazon Resource Name (ARN) of the most recent assessment run associated with this
821
911
  * assessment template. This value exists only when the value of assessmentRunCount is
822
912
  * greaterpa than zero.</p>
823
913
  */
824
914
  lastAssessmentRunArn?: string;
825
915
  /**
916
+ * @public
826
917
  * <p>The number of existing assessment runs associated with this assessment template. This
827
918
  * value can be zero or a positive integer.</p>
828
919
  */
829
920
  assessmentRunCount: number | undefined;
830
921
  /**
922
+ * @public
831
923
  * <p>The time at which the assessment template is created.</p>
832
924
  */
833
925
  createdAt: Date | undefined;
@@ -839,18 +931,21 @@ export interface AssessmentTemplate {
839
931
  */
840
932
  export interface AssessmentTemplateFilter {
841
933
  /**
934
+ * @public
842
935
  * <p>For a record to match a filter, an explicit value or a string that contains a
843
936
  * wildcard that is specified for this data type property must match the value of the
844
937
  * <b>assessmentTemplateName</b> property of the <a>AssessmentTemplate</a> data type.</p>
845
938
  */
846
939
  namePattern?: string;
847
940
  /**
941
+ * @public
848
942
  * <p>For a record to match a filter, the value specified for this data type property must
849
943
  * inclusively match any value between the specified minimum and maximum values of the
850
944
  * <b>durationInSeconds</b> property of the <a>AssessmentTemplate</a> data type.</p>
851
945
  */
852
946
  durationRange?: DurationRange;
853
947
  /**
948
+ * @public
854
949
  * <p>For a record to match a filter, the values that are specified for this data type
855
950
  * property must be contained in the list of values of the <b>rulesPackageArns</b> property of the <a>AssessmentTemplate</a> data
856
951
  * type.</p>
@@ -865,10 +960,12 @@ export interface AssessmentTemplateFilter {
865
960
  */
866
961
  export interface PrivateIp {
867
962
  /**
963
+ * @public
868
964
  * <p>The DNS name of the private IP address.</p>
869
965
  */
870
966
  privateDnsName?: string;
871
967
  /**
968
+ * @public
872
969
  * <p>The full IP address of the network inteface.</p>
873
970
  */
874
971
  privateIpAddress?: string;
@@ -881,10 +978,12 @@ export interface PrivateIp {
881
978
  */
882
979
  export interface SecurityGroup {
883
980
  /**
981
+ * @public
884
982
  * <p>The name of the security group.</p>
885
983
  */
886
984
  groupName?: string;
887
985
  /**
986
+ * @public
888
987
  * <p>The ID of the security group.</p>
889
988
  */
890
989
  groupId?: string;
@@ -897,43 +996,53 @@ export interface SecurityGroup {
897
996
  */
898
997
  export interface NetworkInterface {
899
998
  /**
999
+ * @public
900
1000
  * <p>The ID of the network interface.</p>
901
1001
  */
902
1002
  networkInterfaceId?: string;
903
1003
  /**
1004
+ * @public
904
1005
  * <p>The ID of a subnet associated with the network interface.</p>
905
1006
  */
906
1007
  subnetId?: string;
907
1008
  /**
1009
+ * @public
908
1010
  * <p>The ID of a VPC associated with the network interface.</p>
909
1011
  */
910
1012
  vpcId?: string;
911
1013
  /**
1014
+ * @public
912
1015
  * <p>The name of a private DNS associated with the network interface.</p>
913
1016
  */
914
1017
  privateDnsName?: string;
915
1018
  /**
1019
+ * @public
916
1020
  * <p>The private IP address associated with the network interface.</p>
917
1021
  */
918
1022
  privateIpAddress?: string;
919
1023
  /**
1024
+ * @public
920
1025
  * <p>A list of the private IP addresses associated with the network interface. Includes
921
1026
  * the privateDnsName and privateIpAddress.</p>
922
1027
  */
923
1028
  privateIpAddresses?: PrivateIp[];
924
1029
  /**
1030
+ * @public
925
1031
  * <p>The name of a public DNS associated with the network interface.</p>
926
1032
  */
927
1033
  publicDnsName?: string;
928
1034
  /**
1035
+ * @public
929
1036
  * <p>The public IP address from which the network interface is reachable.</p>
930
1037
  */
931
1038
  publicIp?: string;
932
1039
  /**
1040
+ * @public
933
1041
  * <p>The IP addresses associated with the network interface.</p>
934
1042
  */
935
1043
  ipv6Addresses?: string[];
936
1044
  /**
1045
+ * @public
937
1046
  * <p>A list of the security groups associated with the network interface. Includes the
938
1047
  * groupId and groupName.</p>
939
1048
  */
@@ -945,10 +1054,12 @@ export interface NetworkInterface {
945
1054
  */
946
1055
  export interface Tag {
947
1056
  /**
1057
+ * @public
948
1058
  * <p>A tag key.</p>
949
1059
  */
950
1060
  key: string | undefined;
951
1061
  /**
1062
+ * @public
952
1063
  * <p>A value assigned to a tag key.</p>
953
1064
  */
954
1065
  value?: string;
@@ -959,37 +1070,45 @@ export interface Tag {
959
1070
  */
960
1071
  export interface AssetAttributes {
961
1072
  /**
1073
+ * @public
962
1074
  * <p>The schema version of this data type.</p>
963
1075
  */
964
1076
  schemaVersion: number | undefined;
965
1077
  /**
1078
+ * @public
966
1079
  * <p>The ID of the agent that is installed on the EC2 instance where the finding is
967
1080
  * generated.</p>
968
1081
  */
969
1082
  agentId?: string;
970
1083
  /**
1084
+ * @public
971
1085
  * <p>The Auto Scaling group of the EC2 instance where the finding is generated.</p>
972
1086
  */
973
1087
  autoScalingGroup?: string;
974
1088
  /**
1089
+ * @public
975
1090
  * <p>The ID of the Amazon Machine Image (AMI) that is installed on the EC2 instance where
976
1091
  * the finding is generated.</p>
977
1092
  */
978
1093
  amiId?: string;
979
1094
  /**
1095
+ * @public
980
1096
  * <p>The hostname of the EC2 instance where the finding is generated.</p>
981
1097
  */
982
1098
  hostname?: string;
983
1099
  /**
1100
+ * @public
984
1101
  * <p>The list of IP v4 addresses of the EC2 instance where the finding is
985
1102
  * generated.</p>
986
1103
  */
987
1104
  ipv4Addresses?: string[];
988
1105
  /**
1106
+ * @public
989
1107
  * <p>The tags related to the EC2 instance where the finding is generated.</p>
990
1108
  */
991
1109
  tags?: Tag[];
992
1110
  /**
1111
+ * @public
993
1112
  * <p>An array of the network interfaces interacting with the EC2 instance where the
994
1113
  * finding is generated.</p>
995
1114
  */
@@ -1011,11 +1130,13 @@ export type AssetType = (typeof AssetType)[keyof typeof AssetType];
1011
1130
  */
1012
1131
  export interface CreateAssessmentTargetRequest {
1013
1132
  /**
1133
+ * @public
1014
1134
  * <p>The user-defined name that identifies the assessment target that you want to create.
1015
1135
  * The name must be unique within the AWS account.</p>
1016
1136
  */
1017
1137
  assessmentTargetName: string | undefined;
1018
1138
  /**
1139
+ * @public
1019
1140
  * <p>The ARN that specifies the resource group that is used to create the assessment
1020
1141
  * target. If resourceGroupArn is not specified, all EC2 instances in the current AWS account
1021
1142
  * and region are included in the assessment target.</p>
@@ -1027,6 +1148,7 @@ export interface CreateAssessmentTargetRequest {
1027
1148
  */
1028
1149
  export interface CreateAssessmentTargetResponse {
1029
1150
  /**
1151
+ * @public
1030
1152
  * <p>The ARN that specifies the assessment target that is created.</p>
1031
1153
  */
1032
1154
  assessmentTargetArn: string | undefined;
@@ -1052,10 +1174,12 @@ export declare class InvalidCrossAccountRoleException extends __BaseException {
1052
1174
  readonly name: "InvalidCrossAccountRoleException";
1053
1175
  readonly $fault: "client";
1054
1176
  /**
1177
+ * @public
1055
1178
  * <p>Code that indicates the type of error that is generated.</p>
1056
1179
  */
1057
1180
  errorCode: InvalidCrossAccountRoleErrorCode | string | undefined;
1058
1181
  /**
1182
+ * @public
1059
1183
  * <p>You can immediately retry your request.</p>
1060
1184
  */
1061
1185
  canRetry: boolean | undefined;
@@ -1088,10 +1212,12 @@ export declare class LimitExceededException extends __BaseException {
1088
1212
  readonly name: "LimitExceededException";
1089
1213
  readonly $fault: "client";
1090
1214
  /**
1215
+ * @public
1091
1216
  * <p>Code that indicates the type of error that is generated.</p>
1092
1217
  */
1093
1218
  errorCode: LimitExceededErrorCode | string | undefined;
1094
1219
  /**
1220
+ * @public
1095
1221
  * <p>You can immediately retry your request.</p>
1096
1222
  */
1097
1223
  canRetry: boolean | undefined;
@@ -1105,11 +1231,13 @@ export declare class LimitExceededException extends __BaseException {
1105
1231
  */
1106
1232
  export interface CreateAssessmentTemplateRequest {
1107
1233
  /**
1234
+ * @public
1108
1235
  * <p>The ARN that specifies the assessment target for which you want to create the
1109
1236
  * assessment template.</p>
1110
1237
  */
1111
1238
  assessmentTargetArn: string | undefined;
1112
1239
  /**
1240
+ * @public
1113
1241
  * <p>The user-defined name that identifies the assessment template that you want to
1114
1242
  * create. You can create several assessment templates for an assessment target. The names of
1115
1243
  * the assessment templates that correspond to a particular assessment target must be
@@ -1117,15 +1245,18 @@ export interface CreateAssessmentTemplateRequest {
1117
1245
  */
1118
1246
  assessmentTemplateName: string | undefined;
1119
1247
  /**
1248
+ * @public
1120
1249
  * <p>The duration of the assessment run in seconds.</p>
1121
1250
  */
1122
1251
  durationInSeconds: number | undefined;
1123
1252
  /**
1253
+ * @public
1124
1254
  * <p>The ARNs that specify the rules packages that you want to attach to the assessment
1125
1255
  * template.</p>
1126
1256
  */
1127
1257
  rulesPackageArns: string[] | undefined;
1128
1258
  /**
1259
+ * @public
1129
1260
  * <p>The user-defined attributes that are assigned to every finding that is generated by
1130
1261
  * the assessment run that uses this assessment template. An attribute is a key and value pair
1131
1262
  * (an <a>Attribute</a> object). Within an assessment template, each key must be
@@ -1138,6 +1269,7 @@ export interface CreateAssessmentTemplateRequest {
1138
1269
  */
1139
1270
  export interface CreateAssessmentTemplateResponse {
1140
1271
  /**
1272
+ * @public
1141
1273
  * <p>The ARN that specifies the assessment template that is created.</p>
1142
1274
  */
1143
1275
  assessmentTemplateArn: string | undefined;
@@ -1147,6 +1279,7 @@ export interface CreateAssessmentTemplateResponse {
1147
1279
  */
1148
1280
  export interface CreateExclusionsPreviewRequest {
1149
1281
  /**
1282
+ * @public
1150
1283
  * <p>The ARN that specifies the assessment template for which you want to create an
1151
1284
  * exclusions preview.</p>
1152
1285
  */
@@ -1157,6 +1290,7 @@ export interface CreateExclusionsPreviewRequest {
1157
1290
  */
1158
1291
  export interface CreateExclusionsPreviewResponse {
1159
1292
  /**
1293
+ * @public
1160
1294
  * <p>Specifies the unique identifier of the requested exclusions preview. You can use the
1161
1295
  * unique identifier to retrieve the exclusions preview when running the GetExclusionsPreview
1162
1296
  * API.</p>
@@ -1183,10 +1317,12 @@ export declare class PreviewGenerationInProgressException extends __BaseExceptio
1183
1317
  */
1184
1318
  export interface ResourceGroupTag {
1185
1319
  /**
1320
+ * @public
1186
1321
  * <p>A tag key.</p>
1187
1322
  */
1188
1323
  key: string | undefined;
1189
1324
  /**
1325
+ * @public
1190
1326
  * <p>The value assigned to a tag key.</p>
1191
1327
  */
1192
1328
  value?: string;
@@ -1196,6 +1332,7 @@ export interface ResourceGroupTag {
1196
1332
  */
1197
1333
  export interface CreateResourceGroupRequest {
1198
1334
  /**
1335
+ * @public
1199
1336
  * <p>A collection of keys and an array of possible values,
1200
1337
  * '[\{"key":"key1","values":["Value1","Value2"]\},\{"key":"Key2","values":["Value3"]\}]'.</p>
1201
1338
  * <p>For example,'[\{"key":"Name","values":["TestEC2Instance"]\}]'.</p>
@@ -1207,6 +1344,7 @@ export interface CreateResourceGroupRequest {
1207
1344
  */
1208
1345
  export interface CreateResourceGroupResponse {
1209
1346
  /**
1347
+ * @public
1210
1348
  * <p>The ARN that specifies the resource group that is created.</p>
1211
1349
  */
1212
1350
  resourceGroupArn: string | undefined;
@@ -1216,6 +1354,7 @@ export interface CreateResourceGroupResponse {
1216
1354
  */
1217
1355
  export interface DeleteAssessmentRunRequest {
1218
1356
  /**
1357
+ * @public
1219
1358
  * <p>The ARN that specifies the assessment run that you want to delete.</p>
1220
1359
  */
1221
1360
  assessmentRunArn: string | undefined;
@@ -1225,6 +1364,7 @@ export interface DeleteAssessmentRunRequest {
1225
1364
  */
1226
1365
  export interface DeleteAssessmentTargetRequest {
1227
1366
  /**
1367
+ * @public
1228
1368
  * <p>The ARN that specifies the assessment target that you want to delete.</p>
1229
1369
  */
1230
1370
  assessmentTargetArn: string | undefined;
@@ -1234,6 +1374,7 @@ export interface DeleteAssessmentTargetRequest {
1234
1374
  */
1235
1375
  export interface DeleteAssessmentTemplateRequest {
1236
1376
  /**
1377
+ * @public
1237
1378
  * <p>The ARN that specifies the assessment template that you want to delete.</p>
1238
1379
  */
1239
1380
  assessmentTemplateArn: string | undefined;
@@ -1243,6 +1384,7 @@ export interface DeleteAssessmentTemplateRequest {
1243
1384
  */
1244
1385
  export interface DescribeAssessmentRunsRequest {
1245
1386
  /**
1387
+ * @public
1246
1388
  * <p>The ARN that specifies the assessment run that you want to describe.</p>
1247
1389
  */
1248
1390
  assessmentRunArns: string[] | undefined;
@@ -1252,10 +1394,12 @@ export interface DescribeAssessmentRunsRequest {
1252
1394
  */
1253
1395
  export interface DescribeAssessmentRunsResponse {
1254
1396
  /**
1397
+ * @public
1255
1398
  * <p>Information about the assessment run.</p>
1256
1399
  */
1257
1400
  assessmentRuns: AssessmentRun[] | undefined;
1258
1401
  /**
1402
+ * @public
1259
1403
  * <p>Assessment run details that cannot be described. An error code is provided for each
1260
1404
  * failed item.</p>
1261
1405
  */
@@ -1266,6 +1410,7 @@ export interface DescribeAssessmentRunsResponse {
1266
1410
  */
1267
1411
  export interface DescribeAssessmentTargetsRequest {
1268
1412
  /**
1413
+ * @public
1269
1414
  * <p>The ARNs that specifies the assessment targets that you want to describe.</p>
1270
1415
  */
1271
1416
  assessmentTargetArns: string[] | undefined;
@@ -1275,10 +1420,12 @@ export interface DescribeAssessmentTargetsRequest {
1275
1420
  */
1276
1421
  export interface DescribeAssessmentTargetsResponse {
1277
1422
  /**
1423
+ * @public
1278
1424
  * <p>Information about the assessment targets.</p>
1279
1425
  */
1280
1426
  assessmentTargets: AssessmentTarget[] | undefined;
1281
1427
  /**
1428
+ * @public
1282
1429
  * <p>Assessment target details that cannot be described. An error code is provided for
1283
1430
  * each failed item.</p>
1284
1431
  */
@@ -1295,10 +1442,12 @@ export interface DescribeAssessmentTemplatesRequest {
1295
1442
  */
1296
1443
  export interface DescribeAssessmentTemplatesResponse {
1297
1444
  /**
1445
+ * @public
1298
1446
  * <p>Information about the assessment templates.</p>
1299
1447
  */
1300
1448
  assessmentTemplates: AssessmentTemplate[] | undefined;
1301
1449
  /**
1450
+ * @public
1302
1451
  * <p>Assessment template details that cannot be described. An error code is provided for
1303
1452
  * each failed item.</p>
1304
1453
  */
@@ -1309,16 +1458,19 @@ export interface DescribeAssessmentTemplatesResponse {
1309
1458
  */
1310
1459
  export interface DescribeCrossAccountAccessRoleResponse {
1311
1460
  /**
1461
+ * @public
1312
1462
  * <p>The ARN that specifies the IAM role that Amazon Inspector uses to access your AWS
1313
1463
  * account.</p>
1314
1464
  */
1315
1465
  roleArn: string | undefined;
1316
1466
  /**
1467
+ * @public
1317
1468
  * <p>A Boolean value that specifies whether the IAM role has the necessary policies
1318
1469
  * attached to enable Amazon Inspector to access your AWS account.</p>
1319
1470
  */
1320
1471
  valid: boolean | undefined;
1321
1472
  /**
1473
+ * @public
1322
1474
  * <p>The date when the cross-account access role was registered.</p>
1323
1475
  */
1324
1476
  registeredAt: Date | undefined;
@@ -1339,10 +1491,12 @@ export type Locale = (typeof Locale)[keyof typeof Locale];
1339
1491
  */
1340
1492
  export interface DescribeExclusionsRequest {
1341
1493
  /**
1494
+ * @public
1342
1495
  * <p>The list of ARNs that specify the exclusions that you want to describe.</p>
1343
1496
  */
1344
1497
  exclusionArns: string[] | undefined;
1345
1498
  /**
1499
+ * @public
1346
1500
  * <p>The locale into which you want to translate the exclusion's title, description, and
1347
1501
  * recommendation.</p>
1348
1502
  */
@@ -1367,10 +1521,12 @@ export type ScopeType = (typeof ScopeType)[keyof typeof ScopeType];
1367
1521
  */
1368
1522
  export interface Scope {
1369
1523
  /**
1524
+ * @public
1370
1525
  * <p>The type of the scope.</p>
1371
1526
  */
1372
1527
  key?: ScopeType | string;
1373
1528
  /**
1529
+ * @public
1374
1530
  * <p>The resource identifier for the specified scope type.</p>
1375
1531
  */
1376
1532
  value?: string;
@@ -1381,26 +1537,32 @@ export interface Scope {
1381
1537
  */
1382
1538
  export interface Exclusion {
1383
1539
  /**
1540
+ * @public
1384
1541
  * <p>The ARN that specifies the exclusion.</p>
1385
1542
  */
1386
1543
  arn: string | undefined;
1387
1544
  /**
1545
+ * @public
1388
1546
  * <p>The name of the exclusion.</p>
1389
1547
  */
1390
1548
  title: string | undefined;
1391
1549
  /**
1550
+ * @public
1392
1551
  * <p>The description of the exclusion.</p>
1393
1552
  */
1394
1553
  description: string | undefined;
1395
1554
  /**
1555
+ * @public
1396
1556
  * <p>The recommendation for the exclusion.</p>
1397
1557
  */
1398
1558
  recommendation: string | undefined;
1399
1559
  /**
1560
+ * @public
1400
1561
  * <p>The AWS resources for which the exclusion pertains.</p>
1401
1562
  */
1402
1563
  scopes: Scope[] | undefined;
1403
1564
  /**
1565
+ * @public
1404
1566
  * <p>The system-defined attributes for the exclusion.</p>
1405
1567
  */
1406
1568
  attributes?: Attribute[];
@@ -1410,10 +1572,12 @@ export interface Exclusion {
1410
1572
  */
1411
1573
  export interface DescribeExclusionsResponse {
1412
1574
  /**
1575
+ * @public
1413
1576
  * <p>Information about the exclusions.</p>
1414
1577
  */
1415
1578
  exclusions: Record<string, Exclusion> | undefined;
1416
1579
  /**
1580
+ * @public
1417
1581
  * <p>Exclusion details that cannot be described. An error code is provided for each failed
1418
1582
  * item.</p>
1419
1583
  */
@@ -1424,10 +1588,12 @@ export interface DescribeExclusionsResponse {
1424
1588
  */
1425
1589
  export interface DescribeFindingsRequest {
1426
1590
  /**
1591
+ * @public
1427
1592
  * <p>The ARN that specifies the finding that you want to describe.</p>
1428
1593
  */
1429
1594
  findingArns: string[] | undefined;
1430
1595
  /**
1596
+ * @public
1431
1597
  * <p>The locale into which you want to translate a finding description, recommendation,
1432
1598
  * and the short description that identifies the finding.</p>
1433
1599
  */
@@ -1439,14 +1605,17 @@ export interface DescribeFindingsRequest {
1439
1605
  */
1440
1606
  export interface InspectorServiceAttributes {
1441
1607
  /**
1608
+ * @public
1442
1609
  * <p>The schema version of this data type.</p>
1443
1610
  */
1444
1611
  schemaVersion: number | undefined;
1445
1612
  /**
1613
+ * @public
1446
1614
  * <p>The ARN of the assessment run during which the finding is generated.</p>
1447
1615
  */
1448
1616
  assessmentRunArn?: string;
1449
1617
  /**
1618
+ * @public
1450
1619
  * <p>The ARN of the rules package that is used to generate the finding.</p>
1451
1620
  */
1452
1621
  rulesPackageArn?: string;
@@ -1458,75 +1627,93 @@ export interface InspectorServiceAttributes {
1458
1627
  */
1459
1628
  export interface Finding {
1460
1629
  /**
1630
+ * @public
1461
1631
  * <p>The ARN that specifies the finding.</p>
1462
1632
  */
1463
1633
  arn: string | undefined;
1464
1634
  /**
1635
+ * @public
1465
1636
  * <p>The schema version of this data type.</p>
1466
1637
  */
1467
1638
  schemaVersion?: number;
1468
1639
  /**
1640
+ * @public
1469
1641
  * <p>The data element is set to "Inspector".</p>
1470
1642
  */
1471
1643
  service?: string;
1472
1644
  /**
1645
+ * @public
1473
1646
  * <p>This data type is used in the <a>Finding</a> data type.</p>
1474
1647
  */
1475
1648
  serviceAttributes?: InspectorServiceAttributes;
1476
1649
  /**
1650
+ * @public
1477
1651
  * <p>The type of the host from which the finding is generated.</p>
1478
1652
  */
1479
1653
  assetType?: AssetType | string;
1480
1654
  /**
1655
+ * @public
1481
1656
  * <p>A collection of attributes of the host from which the finding is generated.</p>
1482
1657
  */
1483
1658
  assetAttributes?: AssetAttributes;
1484
1659
  /**
1660
+ * @public
1485
1661
  * <p>The ID of the finding.</p>
1486
1662
  */
1487
1663
  id?: string;
1488
1664
  /**
1665
+ * @public
1489
1666
  * <p>The name of the finding.</p>
1490
1667
  */
1491
1668
  title?: string;
1492
1669
  /**
1670
+ * @public
1493
1671
  * <p>The description of the finding.</p>
1494
1672
  */
1495
1673
  description?: string;
1496
1674
  /**
1675
+ * @public
1497
1676
  * <p>The recommendation for the finding.</p>
1498
1677
  */
1499
1678
  recommendation?: string;
1500
1679
  /**
1680
+ * @public
1501
1681
  * <p>The finding severity. Values can be set to High, Medium, Low, and
1502
1682
  * Informational.</p>
1503
1683
  */
1504
1684
  severity?: Severity | string;
1505
1685
  /**
1686
+ * @public
1506
1687
  * <p>The numeric value of the finding severity.</p>
1507
1688
  */
1508
1689
  numericSeverity?: number;
1509
1690
  /**
1691
+ * @public
1510
1692
  * <p>This data element is currently not used.</p>
1511
1693
  */
1512
1694
  confidence?: number;
1513
1695
  /**
1696
+ * @public
1514
1697
  * <p>This data element is currently not used.</p>
1515
1698
  */
1516
1699
  indicatorOfCompromise?: boolean;
1517
1700
  /**
1701
+ * @public
1518
1702
  * <p>The system-defined attributes for the finding.</p>
1519
1703
  */
1520
1704
  attributes: Attribute[] | undefined;
1521
1705
  /**
1706
+ * @public
1522
1707
  * <p>The user-defined attributes that are assigned to the finding.</p>
1523
1708
  */
1524
1709
  userAttributes: Attribute[] | undefined;
1525
1710
  /**
1711
+ * @public
1526
1712
  * <p>The time when the finding was generated.</p>
1527
1713
  */
1528
1714
  createdAt: Date | undefined;
1529
1715
  /**
1716
+ * @public
1530
1717
  * <p>The time when <a>AddAttributesToFindings</a> is called.</p>
1531
1718
  */
1532
1719
  updatedAt: Date | undefined;
@@ -1536,10 +1723,12 @@ export interface Finding {
1536
1723
  */
1537
1724
  export interface DescribeFindingsResponse {
1538
1725
  /**
1726
+ * @public
1539
1727
  * <p>Information about the finding.</p>
1540
1728
  */
1541
1729
  findings: Finding[] | undefined;
1542
1730
  /**
1731
+ * @public
1543
1732
  * <p>Finding details that cannot be described. An error code is provided for each failed
1544
1733
  * item.</p>
1545
1734
  */
@@ -1550,6 +1739,7 @@ export interface DescribeFindingsResponse {
1550
1739
  */
1551
1740
  export interface DescribeResourceGroupsRequest {
1552
1741
  /**
1742
+ * @public
1553
1743
  * <p>The ARN that specifies the resource group that you want to describe.</p>
1554
1744
  */
1555
1745
  resourceGroupArns: string[] | undefined;
@@ -1563,15 +1753,18 @@ export interface DescribeResourceGroupsRequest {
1563
1753
  */
1564
1754
  export interface ResourceGroup {
1565
1755
  /**
1756
+ * @public
1566
1757
  * <p>The ARN of the resource group.</p>
1567
1758
  */
1568
1759
  arn: string | undefined;
1569
1760
  /**
1761
+ * @public
1570
1762
  * <p>The tags (key and value pairs) of the resource group. This data type property is used
1571
1763
  * in the <a>CreateResourceGroup</a> action.</p>
1572
1764
  */
1573
1765
  tags: ResourceGroupTag[] | undefined;
1574
1766
  /**
1767
+ * @public
1575
1768
  * <p>The time at which resource group is created.</p>
1576
1769
  */
1577
1770
  createdAt: Date | undefined;
@@ -1581,10 +1774,12 @@ export interface ResourceGroup {
1581
1774
  */
1582
1775
  export interface DescribeResourceGroupsResponse {
1583
1776
  /**
1777
+ * @public
1584
1778
  * <p>Information about a resource group.</p>
1585
1779
  */
1586
1780
  resourceGroups: ResourceGroup[] | undefined;
1587
1781
  /**
1782
+ * @public
1588
1783
  * <p>Resource group details that cannot be described. An error code is provided for each
1589
1784
  * failed item.</p>
1590
1785
  */
@@ -1595,10 +1790,12 @@ export interface DescribeResourceGroupsResponse {
1595
1790
  */
1596
1791
  export interface DescribeRulesPackagesRequest {
1597
1792
  /**
1793
+ * @public
1598
1794
  * <p>The ARN that specifies the rules package that you want to describe.</p>
1599
1795
  */
1600
1796
  rulesPackageArns: string[] | undefined;
1601
1797
  /**
1798
+ * @public
1602
1799
  * <p>The locale that you want to translate a rules package description into.</p>
1603
1800
  */
1604
1801
  locale?: Locale | string;
@@ -1610,22 +1807,27 @@ export interface DescribeRulesPackagesRequest {
1610
1807
  */
1611
1808
  export interface RulesPackage {
1612
1809
  /**
1810
+ * @public
1613
1811
  * <p>The ARN of the rules package.</p>
1614
1812
  */
1615
1813
  arn: string | undefined;
1616
1814
  /**
1815
+ * @public
1617
1816
  * <p>The name of the rules package.</p>
1618
1817
  */
1619
1818
  name: string | undefined;
1620
1819
  /**
1820
+ * @public
1621
1821
  * <p>The version ID of the rules package.</p>
1622
1822
  */
1623
1823
  version: string | undefined;
1624
1824
  /**
1825
+ * @public
1625
1826
  * <p>The provider of the rules package.</p>
1626
1827
  */
1627
1828
  provider: string | undefined;
1628
1829
  /**
1830
+ * @public
1629
1831
  * <p>The description of the rules package.</p>
1630
1832
  */
1631
1833
  description?: string;
@@ -1635,10 +1837,12 @@ export interface RulesPackage {
1635
1837
  */
1636
1838
  export interface DescribeRulesPackagesResponse {
1637
1839
  /**
1840
+ * @public
1638
1841
  * <p>Information about the rules package.</p>
1639
1842
  */
1640
1843
  rulesPackages: RulesPackage[] | undefined;
1641
1844
  /**
1845
+ * @public
1642
1846
  * <p>Rules package details that cannot be described. An error code is provided for each
1643
1847
  * failed item.</p>
1644
1848
  */
@@ -1650,11 +1854,13 @@ export interface DescribeRulesPackagesResponse {
1650
1854
  */
1651
1855
  export interface EventSubscription {
1652
1856
  /**
1857
+ * @public
1653
1858
  * <p>The event for which Amazon Simple Notification Service (SNS) notifications are
1654
1859
  * sent.</p>
1655
1860
  */
1656
1861
  event: InspectorEvent | string | undefined;
1657
1862
  /**
1863
+ * @public
1658
1864
  * <p>The time at which <a>SubscribeToEvent</a> is called.</p>
1659
1865
  */
1660
1866
  subscribedAt: Date | undefined;
@@ -1666,22 +1872,27 @@ export interface EventSubscription {
1666
1872
  */
1667
1873
  export interface ExclusionPreview {
1668
1874
  /**
1875
+ * @public
1669
1876
  * <p>The name of the exclusion preview.</p>
1670
1877
  */
1671
1878
  title: string | undefined;
1672
1879
  /**
1880
+ * @public
1673
1881
  * <p>The description of the exclusion preview.</p>
1674
1882
  */
1675
1883
  description: string | undefined;
1676
1884
  /**
1885
+ * @public
1677
1886
  * <p>The recommendation for the exclusion preview.</p>
1678
1887
  */
1679
1888
  recommendation: string | undefined;
1680
1889
  /**
1890
+ * @public
1681
1891
  * <p>The AWS resources for which the exclusion preview pertains.</p>
1682
1892
  */
1683
1893
  scopes: Scope[] | undefined;
1684
1894
  /**
1895
+ * @public
1685
1896
  * <p>The system-defined attributes for the exclusion preview.</p>
1686
1897
  */
1687
1898
  attributes?: Attribute[];
@@ -1693,44 +1904,52 @@ export interface ExclusionPreview {
1693
1904
  */
1694
1905
  export interface FindingFilter {
1695
1906
  /**
1907
+ * @public
1696
1908
  * <p>For a record to match a filter, one of the values that is specified for this data
1697
1909
  * type property must be the exact match of the value of the <b>agentId</b> property of the <a>Finding</a> data type.</p>
1698
1910
  */
1699
1911
  agentIds?: string[];
1700
1912
  /**
1913
+ * @public
1701
1914
  * <p>For a record to match a filter, one of the values that is specified for this data
1702
1915
  * type property must be the exact match of the value of the <b>autoScalingGroup</b> property of the <a>Finding</a> data
1703
1916
  * type.</p>
1704
1917
  */
1705
1918
  autoScalingGroups?: string[];
1706
1919
  /**
1920
+ * @public
1707
1921
  * <p>For a record to match a filter, one of the values that is specified for this data
1708
1922
  * type property must be the exact match of the value of the <b>ruleName</b> property of the <a>Finding</a> data type.</p>
1709
1923
  */
1710
1924
  ruleNames?: string[];
1711
1925
  /**
1926
+ * @public
1712
1927
  * <p>For a record to match a filter, one of the values that is specified for this data
1713
1928
  * type property must be the exact match of the value of the <b>severity</b> property of the <a>Finding</a> data type.</p>
1714
1929
  */
1715
1930
  severities?: (Severity | string)[];
1716
1931
  /**
1932
+ * @public
1717
1933
  * <p>For a record to match a filter, one of the values that is specified for this data
1718
1934
  * type property must be the exact match of the value of the <b>rulesPackageArn</b> property of the <a>Finding</a> data
1719
1935
  * type.</p>
1720
1936
  */
1721
1937
  rulesPackageArns?: string[];
1722
1938
  /**
1939
+ * @public
1723
1940
  * <p>For a record to match a filter, the list of values that are specified for this data
1724
1941
  * type property must be contained in the list of values of the <b>attributes</b> property of the <a>Finding</a> data type.</p>
1725
1942
  */
1726
1943
  attributes?: Attribute[];
1727
1944
  /**
1945
+ * @public
1728
1946
  * <p>For a record to match a filter, the value that is specified for this data type
1729
1947
  * property must be contained in the list of values of the <b>userAttributes</b> property of the <a>Finding</a> data
1730
1948
  * type.</p>
1731
1949
  */
1732
1950
  userAttributes?: Attribute[];
1733
1951
  /**
1952
+ * @public
1734
1953
  * <p>The time range during which the finding is generated.</p>
1735
1954
  */
1736
1955
  creationTimeRange?: TimestampRange;
@@ -1764,16 +1983,19 @@ export type ReportType = (typeof ReportType)[keyof typeof ReportType];
1764
1983
  */
1765
1984
  export interface GetAssessmentReportRequest {
1766
1985
  /**
1986
+ * @public
1767
1987
  * <p>The ARN that specifies the assessment run for which you want to generate a
1768
1988
  * report.</p>
1769
1989
  */
1770
1990
  assessmentRunArn: string | undefined;
1771
1991
  /**
1992
+ * @public
1772
1993
  * <p>Specifies the file format (html or pdf) of the assessment report that you want to
1773
1994
  * generate.</p>
1774
1995
  */
1775
1996
  reportFileFormat: ReportFileFormat | string | undefined;
1776
1997
  /**
1998
+ * @public
1777
1999
  * <p>Specifies the type of the assessment report that you want to generate. There are two
1778
2000
  * types of assessment reports: a finding report and a full report. For more information, see
1779
2001
  * <a href="https://docs.aws.amazon.com/inspector/latest/userguide/inspector_reports.html">Assessment Reports</a>. </p>
@@ -1798,10 +2020,12 @@ export type ReportStatus = (typeof ReportStatus)[keyof typeof ReportStatus];
1798
2020
  */
1799
2021
  export interface GetAssessmentReportResponse {
1800
2022
  /**
2023
+ * @public
1801
2024
  * <p>Specifies the status of the request to generate an assessment report. </p>
1802
2025
  */
1803
2026
  status: ReportStatus | string | undefined;
1804
2027
  /**
2028
+ * @public
1805
2029
  * <p>Specifies the URL where you can find the generated assessment report. This parameter
1806
2030
  * is only returned if the report is successfully generated.</p>
1807
2031
  */
@@ -1829,15 +2053,18 @@ export declare class UnsupportedFeatureException extends __BaseException {
1829
2053
  */
1830
2054
  export interface GetExclusionsPreviewRequest {
1831
2055
  /**
2056
+ * @public
1832
2057
  * <p>The ARN that specifies the assessment template for which the exclusions preview was
1833
2058
  * requested.</p>
1834
2059
  */
1835
2060
  assessmentTemplateArn: string | undefined;
1836
2061
  /**
2062
+ * @public
1837
2063
  * <p>The unique identifier associated of the exclusions preview.</p>
1838
2064
  */
1839
2065
  previewToken: string | undefined;
1840
2066
  /**
2067
+ * @public
1841
2068
  * <p>You can use this parameter when paginating results. Set the value of this parameter
1842
2069
  * to null on your first call to the GetExclusionsPreviewRequest action. Subsequent calls to
1843
2070
  * the action fill nextToken in the request with the value of nextToken from the previous
@@ -1845,11 +2072,13 @@ export interface GetExclusionsPreviewRequest {
1845
2072
  */
1846
2073
  nextToken?: string;
1847
2074
  /**
2075
+ * @public
1848
2076
  * <p>You can use this parameter to indicate the maximum number of items you want in the
1849
2077
  * response. The default value is 100. The maximum value is 500.</p>
1850
2078
  */
1851
2079
  maxResults?: number;
1852
2080
  /**
2081
+ * @public
1853
2082
  * <p>The locale into which you want to translate the exclusion's title, description, and
1854
2083
  * recommendation.</p>
1855
2084
  */
@@ -1872,14 +2101,17 @@ export type PreviewStatus = (typeof PreviewStatus)[keyof typeof PreviewStatus];
1872
2101
  */
1873
2102
  export interface GetExclusionsPreviewResponse {
1874
2103
  /**
2104
+ * @public
1875
2105
  * <p>Specifies the status of the request to generate an exclusions preview.</p>
1876
2106
  */
1877
2107
  previewStatus: PreviewStatus | string | undefined;
1878
2108
  /**
2109
+ * @public
1879
2110
  * <p>Information about the exclusions included in the preview.</p>
1880
2111
  */
1881
2112
  exclusionPreviews?: ExclusionPreview[];
1882
2113
  /**
2114
+ * @public
1883
2115
  * <p>When a response is generated, if there is more data to be listed, this parameters is
1884
2116
  * present in the response and contains the value to use for the nextToken parameter in a
1885
2117
  * subsequent pagination request. If there is no more data to be listed, this parameter is set
@@ -1892,6 +2124,7 @@ export interface GetExclusionsPreviewResponse {
1892
2124
  */
1893
2125
  export interface GetTelemetryMetadataRequest {
1894
2126
  /**
2127
+ * @public
1895
2128
  * <p>The ARN that specifies the assessment run that has the telemetry data that you want
1896
2129
  * to obtain.</p>
1897
2130
  */
@@ -1902,6 +2135,7 @@ export interface GetTelemetryMetadataRequest {
1902
2135
  */
1903
2136
  export interface GetTelemetryMetadataResponse {
1904
2137
  /**
2138
+ * @public
1905
2139
  * <p>Telemetry details.</p>
1906
2140
  */
1907
2141
  telemetryMetadata: TelemetryMetadata[] | undefined;
@@ -1911,10 +2145,12 @@ export interface GetTelemetryMetadataResponse {
1911
2145
  */
1912
2146
  export interface ListAssessmentRunAgentsRequest {
1913
2147
  /**
2148
+ * @public
1914
2149
  * <p>The ARN that specifies the assessment run whose agents you want to list.</p>
1915
2150
  */
1916
2151
  assessmentRunArn: string | undefined;
1917
2152
  /**
2153
+ * @public
1918
2154
  * <p>You can use this parameter to specify a subset of data to be included in the action's
1919
2155
  * response.</p>
1920
2156
  * <p>For a record to match a filter, all specified filter attributes must match. When
@@ -1923,6 +2159,7 @@ export interface ListAssessmentRunAgentsRequest {
1923
2159
  */
1924
2160
  filter?: AgentFilter;
1925
2161
  /**
2162
+ * @public
1926
2163
  * <p>You can use this parameter when paginating results. Set the value of this parameter
1927
2164
  * to null on your first call to the <b>ListAssessmentRunAgents</b>
1928
2165
  * action. Subsequent calls to the action fill <b>nextToken</b> in
@@ -1931,6 +2168,7 @@ export interface ListAssessmentRunAgentsRequest {
1931
2168
  */
1932
2169
  nextToken?: string;
1933
2170
  /**
2171
+ * @public
1934
2172
  * <p>You can use this parameter to indicate the maximum number of items that you want in
1935
2173
  * the response. The default value is 10. The maximum value is 500.</p>
1936
2174
  */
@@ -1941,10 +2179,12 @@ export interface ListAssessmentRunAgentsRequest {
1941
2179
  */
1942
2180
  export interface ListAssessmentRunAgentsResponse {
1943
2181
  /**
2182
+ * @public
1944
2183
  * <p>A list of ARNs that specifies the agents returned by the action.</p>
1945
2184
  */
1946
2185
  assessmentRunAgents: AssessmentRunAgent[] | undefined;
1947
2186
  /**
2187
+ * @public
1948
2188
  * <p> When a response is generated, if there is more data to be listed, this parameter is
1949
2189
  * present in the response and contains the value to use for the <b>nextToken</b> parameter in a subsequent pagination request. If there is no more
1950
2190
  * data to be listed, this parameter is set to null.</p>
@@ -1956,11 +2196,13 @@ export interface ListAssessmentRunAgentsResponse {
1956
2196
  */
1957
2197
  export interface ListAssessmentRunsRequest {
1958
2198
  /**
2199
+ * @public
1959
2200
  * <p>The ARNs that specify the assessment templates whose assessment runs you want to
1960
2201
  * list.</p>
1961
2202
  */
1962
2203
  assessmentTemplateArns?: string[];
1963
2204
  /**
2205
+ * @public
1964
2206
  * <p>You can use this parameter to specify a subset of data to be included in the action's
1965
2207
  * response.</p>
1966
2208
  * <p>For a record to match a filter, all specified filter attributes must match. When
@@ -1969,6 +2211,7 @@ export interface ListAssessmentRunsRequest {
1969
2211
  */
1970
2212
  filter?: AssessmentRunFilter;
1971
2213
  /**
2214
+ * @public
1972
2215
  * <p>You can use this parameter when paginating results. Set the value of this parameter
1973
2216
  * to null on your first call to the <b>ListAssessmentRuns</b>
1974
2217
  * action. Subsequent calls to the action fill <b>nextToken</b> in
@@ -1977,6 +2220,7 @@ export interface ListAssessmentRunsRequest {
1977
2220
  */
1978
2221
  nextToken?: string;
1979
2222
  /**
2223
+ * @public
1980
2224
  * <p>You can use this parameter to indicate the maximum number of items that you want in
1981
2225
  * the response. The default value is 10. The maximum value is 500.</p>
1982
2226
  */
@@ -1987,11 +2231,13 @@ export interface ListAssessmentRunsRequest {
1987
2231
  */
1988
2232
  export interface ListAssessmentRunsResponse {
1989
2233
  /**
2234
+ * @public
1990
2235
  * <p>A list of ARNs that specifies the assessment runs that are returned by the
1991
2236
  * action.</p>
1992
2237
  */
1993
2238
  assessmentRunArns: string[] | undefined;
1994
2239
  /**
2240
+ * @public
1995
2241
  * <p> When a response is generated, if there is more data to be listed, this parameter is
1996
2242
  * present in the response and contains the value to use for the <b>nextToken</b> parameter in a subsequent pagination request. If there is no more
1997
2243
  * data to be listed, this parameter is set to null.</p>
@@ -2003,6 +2249,7 @@ export interface ListAssessmentRunsResponse {
2003
2249
  */
2004
2250
  export interface ListAssessmentTargetsRequest {
2005
2251
  /**
2252
+ * @public
2006
2253
  * <p>You can use this parameter to specify a subset of data to be included in the action's
2007
2254
  * response.</p>
2008
2255
  * <p>For a record to match a filter, all specified filter attributes must match. When
@@ -2011,6 +2258,7 @@ export interface ListAssessmentTargetsRequest {
2011
2258
  */
2012
2259
  filter?: AssessmentTargetFilter;
2013
2260
  /**
2261
+ * @public
2014
2262
  * <p>You can use this parameter when paginating results. Set the value of this parameter
2015
2263
  * to null on your first call to the <b>ListAssessmentTargets</b>
2016
2264
  * action. Subsequent calls to the action fill <b>nextToken</b> in
@@ -2019,6 +2267,7 @@ export interface ListAssessmentTargetsRequest {
2019
2267
  */
2020
2268
  nextToken?: string;
2021
2269
  /**
2270
+ * @public
2022
2271
  * <p>You can use this parameter to indicate the maximum number of items you want in the
2023
2272
  * response. The default value is 10. The maximum value is 500.</p>
2024
2273
  */
@@ -2029,11 +2278,13 @@ export interface ListAssessmentTargetsRequest {
2029
2278
  */
2030
2279
  export interface ListAssessmentTargetsResponse {
2031
2280
  /**
2281
+ * @public
2032
2282
  * <p>A list of ARNs that specifies the assessment targets that are returned by the
2033
2283
  * action.</p>
2034
2284
  */
2035
2285
  assessmentTargetArns: string[] | undefined;
2036
2286
  /**
2287
+ * @public
2037
2288
  * <p> When a response is generated, if there is more data to be listed, this parameter is
2038
2289
  * present in the response and contains the value to use for the <b>nextToken</b> parameter in a subsequent pagination request. If there is no more
2039
2290
  * data to be listed, this parameter is set to null.</p>
@@ -2045,11 +2296,13 @@ export interface ListAssessmentTargetsResponse {
2045
2296
  */
2046
2297
  export interface ListAssessmentTemplatesRequest {
2047
2298
  /**
2299
+ * @public
2048
2300
  * <p>A list of ARNs that specifies the assessment targets whose assessment templates you
2049
2301
  * want to list.</p>
2050
2302
  */
2051
2303
  assessmentTargetArns?: string[];
2052
2304
  /**
2305
+ * @public
2053
2306
  * <p>You can use this parameter to specify a subset of data to be included in the action's
2054
2307
  * response.</p>
2055
2308
  * <p>For a record to match a filter, all specified filter attributes must match. When
@@ -2058,6 +2311,7 @@ export interface ListAssessmentTemplatesRequest {
2058
2311
  */
2059
2312
  filter?: AssessmentTemplateFilter;
2060
2313
  /**
2314
+ * @public
2061
2315
  * <p>You can use this parameter when paginating results. Set the value of this parameter
2062
2316
  * to null on your first call to the <b>ListAssessmentTemplates</b>
2063
2317
  * action. Subsequent calls to the action fill <b>nextToken</b> in
@@ -2066,6 +2320,7 @@ export interface ListAssessmentTemplatesRequest {
2066
2320
  */
2067
2321
  nextToken?: string;
2068
2322
  /**
2323
+ * @public
2069
2324
  * <p>You can use this parameter to indicate the maximum number of items you want in the
2070
2325
  * response. The default value is 10. The maximum value is 500.</p>
2071
2326
  */
@@ -2076,11 +2331,13 @@ export interface ListAssessmentTemplatesRequest {
2076
2331
  */
2077
2332
  export interface ListAssessmentTemplatesResponse {
2078
2333
  /**
2334
+ * @public
2079
2335
  * <p>A list of ARNs that specifies the assessment templates returned by the
2080
2336
  * action.</p>
2081
2337
  */
2082
2338
  assessmentTemplateArns: string[] | undefined;
2083
2339
  /**
2340
+ * @public
2084
2341
  * <p> When a response is generated, if there is more data to be listed, this parameter is
2085
2342
  * present in the response and contains the value to use for the <b>nextToken</b> parameter in a subsequent pagination request. If there is no more
2086
2343
  * data to be listed, this parameter is set to null.</p>
@@ -2092,11 +2349,13 @@ export interface ListAssessmentTemplatesResponse {
2092
2349
  */
2093
2350
  export interface ListEventSubscriptionsRequest {
2094
2351
  /**
2352
+ * @public
2095
2353
  * <p>The ARN of the assessment template for which you want to list the existing event
2096
2354
  * subscriptions.</p>
2097
2355
  */
2098
2356
  resourceArn?: string;
2099
2357
  /**
2358
+ * @public
2100
2359
  * <p>You can use this parameter when paginating results. Set the value of this parameter
2101
2360
  * to null on your first call to the <b>ListEventSubscriptions</b>
2102
2361
  * action. Subsequent calls to the action fill <b>nextToken</b> in
@@ -2105,6 +2364,7 @@ export interface ListEventSubscriptionsRequest {
2105
2364
  */
2106
2365
  nextToken?: string;
2107
2366
  /**
2367
+ * @public
2108
2368
  * <p>You can use this parameter to indicate the maximum number of items you want in the
2109
2369
  * response. The default value is 10. The maximum value is 500.</p>
2110
2370
  */
@@ -2116,16 +2376,19 @@ export interface ListEventSubscriptionsRequest {
2116
2376
  */
2117
2377
  export interface Subscription {
2118
2378
  /**
2379
+ * @public
2119
2380
  * <p>The ARN of the assessment template that is used during the event for which the SNS
2120
2381
  * notification is sent.</p>
2121
2382
  */
2122
2383
  resourceArn: string | undefined;
2123
2384
  /**
2385
+ * @public
2124
2386
  * <p>The ARN of the Amazon Simple Notification Service (SNS) topic to which the SNS
2125
2387
  * notifications are sent.</p>
2126
2388
  */
2127
2389
  topicArn: string | undefined;
2128
2390
  /**
2391
+ * @public
2129
2392
  * <p>The list of existing event subscriptions.</p>
2130
2393
  */
2131
2394
  eventSubscriptions: EventSubscription[] | undefined;
@@ -2135,10 +2398,12 @@ export interface Subscription {
2135
2398
  */
2136
2399
  export interface ListEventSubscriptionsResponse {
2137
2400
  /**
2401
+ * @public
2138
2402
  * <p>Details of the returned event subscriptions.</p>
2139
2403
  */
2140
2404
  subscriptions: Subscription[] | undefined;
2141
2405
  /**
2406
+ * @public
2142
2407
  * <p> When a response is generated, if there is more data to be listed, this parameter is
2143
2408
  * present in the response and contains the value to use for the <b>nextToken</b> parameter in a subsequent pagination request. If there is no more
2144
2409
  * data to be listed, this parameter is set to null.</p>
@@ -2150,11 +2415,13 @@ export interface ListEventSubscriptionsResponse {
2150
2415
  */
2151
2416
  export interface ListExclusionsRequest {
2152
2417
  /**
2418
+ * @public
2153
2419
  * <p>The ARN of the assessment run that generated the exclusions that you want to
2154
2420
  * list.</p>
2155
2421
  */
2156
2422
  assessmentRunArn: string | undefined;
2157
2423
  /**
2424
+ * @public
2158
2425
  * <p>You can use this parameter when paginating results. Set the value of this parameter
2159
2426
  * to null on your first call to the ListExclusionsRequest action. Subsequent calls to the
2160
2427
  * action fill nextToken in the request with the value of nextToken from the previous response
@@ -2162,6 +2429,7 @@ export interface ListExclusionsRequest {
2162
2429
  */
2163
2430
  nextToken?: string;
2164
2431
  /**
2432
+ * @public
2165
2433
  * <p>You can use this parameter to indicate the maximum number of items you want in the
2166
2434
  * response. The default value is 100. The maximum value is 500.</p>
2167
2435
  */
@@ -2172,10 +2440,12 @@ export interface ListExclusionsRequest {
2172
2440
  */
2173
2441
  export interface ListExclusionsResponse {
2174
2442
  /**
2443
+ * @public
2175
2444
  * <p>A list of exclusions' ARNs returned by the action.</p>
2176
2445
  */
2177
2446
  exclusionArns: string[] | undefined;
2178
2447
  /**
2448
+ * @public
2179
2449
  * <p>When a response is generated, if there is more data to be listed, this parameters is
2180
2450
  * present in the response and contains the value to use for the nextToken parameter in a
2181
2451
  * subsequent pagination request. If there is no more data to be listed, this parameter is set
@@ -2188,11 +2458,13 @@ export interface ListExclusionsResponse {
2188
2458
  */
2189
2459
  export interface ListFindingsRequest {
2190
2460
  /**
2461
+ * @public
2191
2462
  * <p>The ARNs of the assessment runs that generate the findings that you want to
2192
2463
  * list.</p>
2193
2464
  */
2194
2465
  assessmentRunArns?: string[];
2195
2466
  /**
2467
+ * @public
2196
2468
  * <p>You can use this parameter to specify a subset of data to be included in the action's
2197
2469
  * response.</p>
2198
2470
  * <p>For a record to match a filter, all specified filter attributes must match. When
@@ -2201,6 +2473,7 @@ export interface ListFindingsRequest {
2201
2473
  */
2202
2474
  filter?: FindingFilter;
2203
2475
  /**
2476
+ * @public
2204
2477
  * <p>You can use this parameter when paginating results. Set the value of this parameter
2205
2478
  * to null on your first call to the <b>ListFindings</b> action.
2206
2479
  * Subsequent calls to the action fill <b>nextToken</b> in the
@@ -2209,6 +2482,7 @@ export interface ListFindingsRequest {
2209
2482
  */
2210
2483
  nextToken?: string;
2211
2484
  /**
2485
+ * @public
2212
2486
  * <p>You can use this parameter to indicate the maximum number of items you want in the
2213
2487
  * response. The default value is 10. The maximum value is 500.</p>
2214
2488
  */
@@ -2219,10 +2493,12 @@ export interface ListFindingsRequest {
2219
2493
  */
2220
2494
  export interface ListFindingsResponse {
2221
2495
  /**
2496
+ * @public
2222
2497
  * <p>A list of ARNs that specifies the findings returned by the action.</p>
2223
2498
  */
2224
2499
  findingArns: string[] | undefined;
2225
2500
  /**
2501
+ * @public
2226
2502
  * <p> When a response is generated, if there is more data to be listed, this parameter is
2227
2503
  * present in the response and contains the value to use for the <b>nextToken</b> parameter in a subsequent pagination request. If there is no more
2228
2504
  * data to be listed, this parameter is set to null.</p>
@@ -2234,6 +2510,7 @@ export interface ListFindingsResponse {
2234
2510
  */
2235
2511
  export interface ListRulesPackagesRequest {
2236
2512
  /**
2513
+ * @public
2237
2514
  * <p>You can use this parameter when paginating results. Set the value of this parameter
2238
2515
  * to null on your first call to the <b>ListRulesPackages</b>
2239
2516
  * action. Subsequent calls to the action fill <b>nextToken</b> in
@@ -2242,6 +2519,7 @@ export interface ListRulesPackagesRequest {
2242
2519
  */
2243
2520
  nextToken?: string;
2244
2521
  /**
2522
+ * @public
2245
2523
  * <p>You can use this parameter to indicate the maximum number of items you want in the
2246
2524
  * response. The default value is 10. The maximum value is 500.</p>
2247
2525
  */
@@ -2252,10 +2530,12 @@ export interface ListRulesPackagesRequest {
2252
2530
  */
2253
2531
  export interface ListRulesPackagesResponse {
2254
2532
  /**
2533
+ * @public
2255
2534
  * <p>The list of ARNs that specifies the rules packages returned by the action.</p>
2256
2535
  */
2257
2536
  rulesPackageArns: string[] | undefined;
2258
2537
  /**
2538
+ * @public
2259
2539
  * <p> When a response is generated, if there is more data to be listed, this parameter is
2260
2540
  * present in the response and contains the value to use for the <b>nextToken</b> parameter in a subsequent pagination request. If there is no more
2261
2541
  * data to be listed, this parameter is set to null.</p>
@@ -2267,6 +2547,7 @@ export interface ListRulesPackagesResponse {
2267
2547
  */
2268
2548
  export interface ListTagsForResourceRequest {
2269
2549
  /**
2550
+ * @public
2270
2551
  * <p>The ARN that specifies the assessment template whose tags you want to list.</p>
2271
2552
  */
2272
2553
  resourceArn: string | undefined;
@@ -2276,6 +2557,7 @@ export interface ListTagsForResourceRequest {
2276
2557
  */
2277
2558
  export interface ListTagsForResourceResponse {
2278
2559
  /**
2560
+ * @public
2279
2561
  * <p>A collection of key and value pairs.</p>
2280
2562
  */
2281
2563
  tags: Tag[] | undefined;
@@ -2285,10 +2567,12 @@ export interface ListTagsForResourceResponse {
2285
2567
  */
2286
2568
  export interface PreviewAgentsRequest {
2287
2569
  /**
2570
+ * @public
2288
2571
  * <p>The ARN of the assessment target whose agents you want to preview.</p>
2289
2572
  */
2290
2573
  previewAgentsArn: string | undefined;
2291
2574
  /**
2575
+ * @public
2292
2576
  * <p>You can use this parameter when paginating results. Set the value of this parameter
2293
2577
  * to null on your first call to the <b>PreviewAgents</b> action.
2294
2578
  * Subsequent calls to the action fill <b>nextToken</b> in the
@@ -2297,6 +2581,7 @@ export interface PreviewAgentsRequest {
2297
2581
  */
2298
2582
  nextToken?: string;
2299
2583
  /**
2584
+ * @public
2300
2585
  * <p>You can use this parameter to indicate the maximum number of items you want in the
2301
2586
  * response. The default value is 10. The maximum value is 500.</p>
2302
2587
  */
@@ -2307,10 +2592,12 @@ export interface PreviewAgentsRequest {
2307
2592
  */
2308
2593
  export interface PreviewAgentsResponse {
2309
2594
  /**
2595
+ * @public
2310
2596
  * <p>The resulting list of agents.</p>
2311
2597
  */
2312
2598
  agentPreviews: AgentPreview[] | undefined;
2313
2599
  /**
2600
+ * @public
2314
2601
  * <p> When a response is generated, if there is more data to be listed, this parameter is
2315
2602
  * present in the response and contains the value to use for the <b>nextToken</b> parameter in a subsequent pagination request. If there is no more
2316
2603
  * data to be listed, this parameter is set to null.</p>
@@ -2322,6 +2609,7 @@ export interface PreviewAgentsResponse {
2322
2609
  */
2323
2610
  export interface RegisterCrossAccountAccessRoleRequest {
2324
2611
  /**
2612
+ * @public
2325
2613
  * <p>The ARN of the IAM role that grants Amazon Inspector access to AWS Services needed to
2326
2614
  * perform security assessments. </p>
2327
2615
  */
@@ -2332,10 +2620,12 @@ export interface RegisterCrossAccountAccessRoleRequest {
2332
2620
  */
2333
2621
  export interface RemoveAttributesFromFindingsRequest {
2334
2622
  /**
2623
+ * @public
2335
2624
  * <p>The ARNs that specify the findings that you want to remove attributes from.</p>
2336
2625
  */
2337
2626
  findingArns: string[] | undefined;
2338
2627
  /**
2628
+ * @public
2339
2629
  * <p>The array of attribute keys that you want to remove from specified
2340
2630
  * findings.</p>
2341
2631
  */
@@ -2346,6 +2636,7 @@ export interface RemoveAttributesFromFindingsRequest {
2346
2636
  */
2347
2637
  export interface RemoveAttributesFromFindingsResponse {
2348
2638
  /**
2639
+ * @public
2349
2640
  * <p>Attributes details that cannot be described. An error code is provided for each
2350
2641
  * failed item.</p>
2351
2642
  */
@@ -2356,10 +2647,12 @@ export interface RemoveAttributesFromFindingsResponse {
2356
2647
  */
2357
2648
  export interface SetTagsForResourceRequest {
2358
2649
  /**
2650
+ * @public
2359
2651
  * <p>The ARN of the assessment template that you want to set tags to.</p>
2360
2652
  */
2361
2653
  resourceArn: string | undefined;
2362
2654
  /**
2655
+ * @public
2363
2656
  * <p>A collection of key and value pairs that you want to set to the assessment
2364
2657
  * template.</p>
2365
2658
  */
@@ -2370,11 +2663,13 @@ export interface SetTagsForResourceRequest {
2370
2663
  */
2371
2664
  export interface StartAssessmentRunRequest {
2372
2665
  /**
2666
+ * @public
2373
2667
  * <p>The ARN of the assessment template of the assessment run that you want to
2374
2668
  * start.</p>
2375
2669
  */
2376
2670
  assessmentTemplateArn: string | undefined;
2377
2671
  /**
2672
+ * @public
2378
2673
  * <p>You can specify the name for the assessment run. The name must be unique for the
2379
2674
  * assessment template whose ARN is used to start the assessment run.</p>
2380
2675
  */
@@ -2385,6 +2680,7 @@ export interface StartAssessmentRunRequest {
2385
2680
  */
2386
2681
  export interface StartAssessmentRunResponse {
2387
2682
  /**
2683
+ * @public
2388
2684
  * <p>The ARN of the assessment run that has been started.</p>
2389
2685
  */
2390
2686
  assessmentRunArn: string | undefined;
@@ -2406,10 +2702,12 @@ export type StopAction = (typeof StopAction)[keyof typeof StopAction];
2406
2702
  */
2407
2703
  export interface StopAssessmentRunRequest {
2408
2704
  /**
2705
+ * @public
2409
2706
  * <p>The ARN of the assessment run that you want to stop.</p>
2410
2707
  */
2411
2708
  assessmentRunArn: string | undefined;
2412
2709
  /**
2710
+ * @public
2413
2711
  * <p>An input option that can be set to either START_EVALUATION or SKIP_EVALUATION.
2414
2712
  * START_EVALUATION (the default value), stops the AWS agent from collecting data and begins
2415
2713
  * the results evaluation and the findings generation process. SKIP_EVALUATION cancels the
@@ -2422,15 +2720,18 @@ export interface StopAssessmentRunRequest {
2422
2720
  */
2423
2721
  export interface SubscribeToEventRequest {
2424
2722
  /**
2723
+ * @public
2425
2724
  * <p>The ARN of the assessment template that is used during the event for which you want
2426
2725
  * to receive SNS notifications.</p>
2427
2726
  */
2428
2727
  resourceArn: string | undefined;
2429
2728
  /**
2729
+ * @public
2430
2730
  * <p>The event for which you want to receive SNS notifications.</p>
2431
2731
  */
2432
2732
  event: InspectorEvent | string | undefined;
2433
2733
  /**
2734
+ * @public
2434
2735
  * <p>The ARN of the SNS topic to which the SNS notifications are sent.</p>
2435
2736
  */
2436
2737
  topicArn: string | undefined;
@@ -2440,15 +2741,18 @@ export interface SubscribeToEventRequest {
2440
2741
  */
2441
2742
  export interface UnsubscribeFromEventRequest {
2442
2743
  /**
2744
+ * @public
2443
2745
  * <p>The ARN of the assessment template that is used during the event for which you want
2444
2746
  * to stop receiving SNS notifications.</p>
2445
2747
  */
2446
2748
  resourceArn: string | undefined;
2447
2749
  /**
2750
+ * @public
2448
2751
  * <p>The event for which you want to stop receiving SNS notifications.</p>
2449
2752
  */
2450
2753
  event: InspectorEvent | string | undefined;
2451
2754
  /**
2755
+ * @public
2452
2756
  * <p>The ARN of the SNS topic to which SNS notifications are sent.</p>
2453
2757
  */
2454
2758
  topicArn: string | undefined;
@@ -2458,14 +2762,17 @@ export interface UnsubscribeFromEventRequest {
2458
2762
  */
2459
2763
  export interface UpdateAssessmentTargetRequest {
2460
2764
  /**
2765
+ * @public
2461
2766
  * <p>The ARN of the assessment target that you want to update.</p>
2462
2767
  */
2463
2768
  assessmentTargetArn: string | undefined;
2464
2769
  /**
2770
+ * @public
2465
2771
  * <p>The name of the assessment target that you want to update.</p>
2466
2772
  */
2467
2773
  assessmentTargetName: string | undefined;
2468
2774
  /**
2775
+ * @public
2469
2776
  * <p>The ARN of the resource group that is used to specify the new resource group to
2470
2777
  * associate with the assessment target.</p>
2471
2778
  */