@aws-sdk/client-imagebuilder 3.378.0 → 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.
Files changed (5) hide show
  1. package/dist-types/endpoint/EndpointParameters.d.ts +3 -0
  2. package/dist-types/index.d.ts +1 -0
  3. package/dist-types/models/models_0.d.ts +763 -0
  4. package/dist-types/ts3.4/index.d.ts +1 -0
  5. package/package.json +7 -7
package/dist-types/models/models_0.d.ts CHANGED
@@ -7,18 +7,22 @@ import { ImagebuilderServiceException as __BaseException } from "./ImagebuilderS
7
7
  */
8
8
  export interface SeverityCounts {
9
9
  /**
10
+ * @public
10
11
  * <p>The total number of findings across all severity levels for the specified filter.</p>
11
12
  */
12
13
  all?: number;
13
14
  /**
15
+ * @public
14
16
  * <p>The number of critical severity findings for the specified filter.</p>
15
17
  */
16
18
  critical?: number;
17
19
  /**
20
+ * @public
18
21
  * <p>The number of high severity findings for the specified filter.</p>
19
22
  */
20
23
  high?: number;
21
24
  /**
25
+ * @public
22
26
  * <p>The number of medium severity findings for the specified filter.</p>
23
27
  */
24
28
  medium?: number;
@@ -32,10 +36,12 @@ export interface SeverityCounts {
32
36
  */
33
37
  export interface AccountAggregation {
34
38
  /**
39
+ * @public
35
40
  * <p>Identifies the account that owns the aggregated resource findings.</p>
36
41
  */
37
42
  accountId?: string;
38
43
  /**
44
+ * @public
39
45
  * <p>Counts by severity level for medium severity and higher level findings, plus a total
40
46
  * for all of the findings.</p>
41
47
  */
@@ -47,6 +53,7 @@ export interface AccountAggregation {
47
53
  */
48
54
  export interface SystemsManagerAgent {
49
55
  /**
56
+ * @public
50
57
  * <p>Controls whether the Systems Manager agent is removed from your final build image, prior to
51
58
  * creating the new AMI. If this is set to true, then the agent is removed from the final
52
59
  * image. If it's set to false, then the agent is left in, so that it is included in the
@@ -67,10 +74,12 @@ export interface SystemsManagerAgent {
67
74
  */
68
75
  export interface AdditionalInstanceConfiguration {
69
76
  /**
77
+ * @public
70
78
  * <p>Contains settings for the Systems Manager agent on your build instance.</p>
71
79
  */
72
80
  systemsManagerAgent?: SystemsManagerAgent;
73
81
  /**
82
+ * @public
74
83
  * <p>Use this property to provide commands or a command script to run when you launch your
75
84
  * build instance.</p>
76
85
  * <p>The userDataOverride property replaces any commands that Image Builder might have added to
@@ -117,10 +126,12 @@ export type ImageStatus = (typeof ImageStatus)[keyof typeof ImageStatus];
117
126
  */
118
127
  export interface ImageState {
119
128
  /**
129
+ * @public
120
130
  * <p>The status of the image.</p>
121
131
  */
122
132
  status?: ImageStatus | string;
123
133
  /**
134
+ * @public
124
135
  * <p>The reason for the status of the image.</p>
125
136
  */
126
137
  reason?: string;
@@ -131,26 +142,32 @@ export interface ImageState {
131
142
  */
132
143
  export interface Ami {
133
144
  /**
145
+ * @public
134
146
  * <p>The Amazon Web Services Region of the Amazon EC2 AMI.</p>
135
147
  */
136
148
  region?: string;
137
149
  /**
150
+ * @public
138
151
  * <p>The AMI ID of the Amazon EC2 AMI.</p>
139
152
  */
140
153
  image?: string;
141
154
  /**
155
+ * @public
142
156
  * <p>The name of the Amazon EC2 AMI.</p>
143
157
  */
144
158
  name?: string;
145
159
  /**
160
+ * @public
146
161
  * <p>The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.</p>
147
162
  */
148
163
  description?: string;
149
164
  /**
165
+ * @public
150
166
  * <p>Image status and the reason for that status.</p>
151
167
  */
152
168
  state?: ImageState;
153
169
  /**
170
+ * @public
154
171
  * <p>The account ID of the owner of the AMI.</p>
155
172
  */
156
173
  accountId?: string;
@@ -167,20 +184,24 @@ export interface Ami {
167
184
  */
168
185
  export interface LaunchPermissionConfiguration {
169
186
  /**
187
+ * @public
170
188
  * <p>The Amazon Web Services account ID.</p>
171
189
  */
172
190
  userIds?: string[];
173
191
  /**
192
+ * @public
174
193
  * <p>The name of the group.</p>
175
194
  */
176
195
  userGroups?: string[];
177
196
  /**
197
+ * @public
178
198
  * <p>The ARN for an Amazon Web Services Organization that you want to share your AMI with. For more
179
199
  * information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html">What is
180
200
  * Organizations?</a>.</p>
181
201
  */
182
202
  organizationArns?: string[];
183
203
  /**
204
+ * @public
184
205
  * <p>The ARN for an Organizations organizational unit (OU) that you want to share your AMI with.
185
206
  * For more information about key concepts for Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html">Organizations
186
207
  * terminology and concepts</a>.</p>
@@ -193,27 +214,33 @@ export interface LaunchPermissionConfiguration {
193
214
  */
194
215
  export interface AmiDistributionConfiguration {
195
216
  /**
217
+ * @public
196
218
  * <p>The name of the output AMI.</p>
197
219
  */
198
220
  name?: string;
199
221
  /**
222
+ * @public
200
223
  * <p>The description of the AMI distribution configuration. Minimum and maximum length are
201
224
  * in characters.</p>
202
225
  */
203
226
  description?: string;
204
227
  /**
228
+ * @public
205
229
  * <p>The ID of an account to which you want to distribute an image.</p>
206
230
  */
207
231
  targetAccountIds?: string[];
208
232
  /**
233
+ * @public
209
234
  * <p>The tags to apply to AMIs distributed to this Region.</p>
210
235
  */
211
236
  amiTags?: Record<string, string>;
212
237
  /**
238
+ * @public
213
239
  * <p>The KMS key identifier used to encrypt the distributed image.</p>
214
240
  */
215
241
  kmsKeyId?: string;
216
242
  /**
243
+ * @public
217
244
  * <p>Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to
218
245
  * launch instances.</p>
219
246
  */
@@ -249,11 +276,13 @@ export declare class CallRateLimitExceededException extends __BaseException {
249
276
  */
250
277
  export interface CancelImageCreationRequest {
251
278
  /**
279
+ * @public
252
280
  * <p>The Amazon Resource Name (ARN) of the image that you want to cancel creation
253
281
  * for.</p>
254
282
  */
255
283
  imageBuildVersionArn: string | undefined;
256
284
  /**
285
+ * @public
257
286
  * <p>Unique, case-sensitive identifier you provide to ensure
258
287
  * idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>
259
288
  * in the <i>Amazon EC2 API Reference</i>.</p>
@@ -265,14 +294,17 @@ export interface CancelImageCreationRequest {
265
294
  */
266
295
  export interface CancelImageCreationResponse {
267
296
  /**
297
+ * @public
268
298
  * <p>The request ID that uniquely identifies this request.</p>
269
299
  */
270
300
  requestId?: string;
271
301
  /**
302
+ * @public
272
303
  * <p>The idempotency token that was used for this request.</p>
273
304
  */
274
305
  clientToken?: string;
275
306
  /**
307
+ * @public
276
308
  * <p>The ARN of the image whose creation this request canceled.</p>
277
309
  */
278
310
  imageBuildVersionArn?: string;
@@ -373,19 +405,23 @@ export declare class ServiceUnavailableException extends __BaseException {
373
405
  */
374
406
  export interface ComponentParameterDetail {
375
407
  /**
408
+ * @public
376
409
  * <p>The name of this input parameter.</p>
377
410
  */
378
411
  name: string | undefined;
379
412
  /**
413
+ * @public
380
414
  * <p>The type of input this parameter provides. The currently supported value is
381
415
  * "string".</p>
382
416
  */
383
417
  type: string | undefined;
384
418
  /**
419
+ * @public
385
420
  * <p>The default value of this parameter if no input is provided.</p>
386
421
  */
387
422
  defaultValue?: string[];
388
423
  /**
424
+ * @public
389
425
  * <p>Describes this parameter.</p>
390
426
  */
391
427
  description?: string;
@@ -420,10 +456,12 @@ export type ComponentStatus = (typeof ComponentStatus)[keyof typeof ComponentSta
420
456
  */
421
457
  export interface ComponentState {
422
458
  /**
459
+ * @public
423
460
  * <p>The current state of the component.</p>
424
461
  */
425
462
  status?: ComponentStatus | string;
426
463
  /**
464
+ * @public
427
465
  * <p>Describes how or why the component changed state.</p>
428
466
  */
429
467
  reason?: string;
@@ -446,80 +484,98 @@ export type ComponentType = (typeof ComponentType)[keyof typeof ComponentType];
446
484
  */
447
485
  export interface Component {
448
486
  /**
487
+ * @public
449
488
  * <p>The Amazon Resource Name (ARN) of the component.</p>
450
489
  */
451
490
  arn?: string;
452
491
  /**
492
+ * @public
453
493
  * <p>The name of the component.</p>
454
494
  */
455
495
  name?: string;
456
496
  /**
497
+ * @public
457
498
  * <p>The version of the component.</p>
458
499
  */
459
500
  version?: string;
460
501
  /**
502
+ * @public
461
503
  * <p>The description of the component.</p>
462
504
  */
463
505
  description?: string;
464
506
  /**
507
+ * @public
465
508
  * <p>The change description of the component.</p>
466
509
  */
467
510
  changeDescription?: string;
468
511
  /**
512
+ * @public
469
513
  * <p>The component type specifies whether Image Builder uses the component to build the image or
470
514
  * only to test it.</p>
471
515
  */
472
516
  type?: ComponentType | string;
473
517
  /**
518
+ * @public
474
519
  * <p>The operating system platform of the component.</p>
475
520
  */
476
521
  platform?: Platform | string;
477
522
  /**
523
+ * @public
478
524
  * <p>The operating system (OS) version supported by the component. If the OS information is
479
525
  * available, Image Builder performs a prefix match against the base image OS version during image
480
526
  * recipe creation.</p>
481
527
  */
482
528
  supportedOsVersions?: string[];
483
529
  /**
530
+ * @public
484
531
  * <p>Describes the current status of the component. This is used for components that are no
485
532
  * longer active.</p>
486
533
  */
487
534
  state?: ComponentState;
488
535
  /**
536
+ * @public
489
537
  * <p>Contains parameter details for each of the parameters that the component document
490
538
  * defined for the component.</p>
491
539
  */
492
540
  parameters?: ComponentParameterDetail[];
493
541
  /**
542
+ * @public
494
543
  * <p>The owner of the component.</p>
495
544
  */
496
545
  owner?: string;
497
546
  /**
547
+ * @public
498
548
  * <p>Component data contains the YAML document content for the component.</p>
499
549
  */
500
550
  data?: string;
501
551
  /**
552
+ * @public
502
553
  * <p>The KMS key identifier used to encrypt the component.</p>
503
554
  */
504
555
  kmsKeyId?: string;
505
556
  /**
557
+ * @public
506
558
  * <p>The encryption status of the component.</p>
507
559
  */
508
560
  encrypted?: boolean;
509
561
  /**
562
+ * @public
510
563
  * <p>The date that Image Builder created the component.</p>
511
564
  */
512
565
  dateCreated?: string;
513
566
  /**
567
+ * @public
514
568
  * <p>The tags that apply to the component.</p>
515
569
  */
516
570
  tags?: Record<string, string>;
517
571
  /**
572
+ * @public
518
573
  * <p>Contains the name of the publisher if this is a third-party component. Otherwise,
519
574
  * this property is empty.</p>
520
575
  */
521
576
  publisher?: string;
522
577
  /**
578
+ * @public
523
579
  * <p>Indicates whether component source is hidden from view in the console, and from
524
580
  * component detail results for API, CLI, or SDK operations.</p>
525
581
  */
@@ -531,10 +587,12 @@ export interface Component {
531
587
  */
532
588
  export interface ComponentParameter {
533
589
  /**
590
+ * @public
534
591
  * <p>The name of the component parameter to set.</p>
535
592
  */
536
593
  name: string | undefined;
537
594
  /**
595
+ * @public
538
596
  * <p>Sets the value for the named component parameter.</p>
539
597
  */
540
598
  value: string[] | undefined;
@@ -545,10 +603,12 @@ export interface ComponentParameter {
545
603
  */
546
604
  export interface ComponentConfiguration {
547
605
  /**
606
+ * @public
548
607
  * <p>The Amazon Resource Name (ARN) of the component.</p>
549
608
  */
550
609
  componentArn: string | undefined;
551
610
  /**
611
+ * @public
552
612
  * <p>A group of parameter settings that Image Builder uses to configure the component for a specific
553
613
  * recipe.</p>
554
614
  */
@@ -571,62 +631,76 @@ export type ComponentFormat = (typeof ComponentFormat)[keyof typeof ComponentFor
571
631
  */
572
632
  export interface ComponentSummary {
573
633
  /**
634
+ * @public
574
635
  * <p>The Amazon Resource Name (ARN) of the component.</p>
575
636
  */
576
637
  arn?: string;
577
638
  /**
639
+ * @public
578
640
  * <p>The name of the component.</p>
579
641
  */
580
642
  name?: string;
581
643
  /**
644
+ * @public
582
645
  * <p>The version of the component.</p>
583
646
  */
584
647
  version?: string;
585
648
  /**
649
+ * @public
586
650
  * <p>The operating system platform of the component.</p>
587
651
  */
588
652
  platform?: Platform | string;
589
653
  /**
654
+ * @public
590
655
  * <p>The operating system (OS) version that the component supports. If the OS information
591
656
  * is available, Image Builder performs a prefix match against the base image OS version during
592
657
  * image recipe creation.</p>
593
658
  */
594
659
  supportedOsVersions?: string[];
595
660
  /**
661
+ * @public
596
662
  * <p>Describes the current status of the component.</p>
597
663
  */
598
664
  state?: ComponentState;
599
665
  /**
666
+ * @public
600
667
  * <p>The component type specifies whether Image Builder uses the component to build the image or
601
668
  * only to test it.</p>
602
669
  */
603
670
  type?: ComponentType | string;
604
671
  /**
672
+ * @public
605
673
  * <p>The owner of the component.</p>
606
674
  */
607
675
  owner?: string;
608
676
  /**
677
+ * @public
609
678
  * <p>The description of the component.</p>
610
679
  */
611
680
  description?: string;
612
681
  /**
682
+ * @public
613
683
  * <p>The change description for the current version of the component.</p>
614
684
  */
615
685
  changeDescription?: string;
616
686
  /**
687
+ * @public
617
688
  * <p>The original creation date of the component.</p>
618
689
  */
619
690
  dateCreated?: string;
620
691
  /**
692
+ * @public
621
693
  * <p>The tags that apply to the component.</p>
622
694
  */
623
695
  tags?: Record<string, string>;
624
696
  /**
697
+ * @public
625
698
  * <p>Contains the name of the publisher if this is a third-party component. Otherwise,
626
699
  * this property is empty.</p>
627
700
  */
628
701
  publisher?: string;
629
702
  /**
703
+ * @public
630
704
  * <p>Indicates whether component source is hidden from view in the console,
631
705
  * and from component detail results for API, CLI, or SDK operations.</p>
632
706
  */
@@ -638,6 +712,7 @@ export interface ComponentSummary {
638
712
  */
639
713
  export interface ComponentVersion {
640
714
  /**
715
+ * @public
641
716
  * <p>The Amazon Resource Name (ARN) of the component.</p>
642
717
  * <note>
643
718
  * <p>Semantic versioning is included in each object's Amazon Resource Name (ARN),
@@ -658,10 +733,12 @@ export interface ComponentVersion {
658
733
  */
659
734
  arn?: string;
660
735
  /**
736
+ * @public
661
737
  * <p>The name of the component.</p>
662
738
  */
663
739
  name?: string;
664
740
  /**
741
+ * @public
665
742
  * <p>The semantic version of the component.</p>
666
743
  * <note>
667
744
  * <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
@@ -683,29 +760,35 @@ export interface ComponentVersion {
683
760
  */
684
761
  version?: string;
685
762
  /**
763
+ * @public
686
764
  * <p>The description of the component.</p>
687
765
  */
688
766
  description?: string;
689
767
  /**
768
+ * @public
690
769
  * <p>The platform of the component.</p>
691
770
  */
692
771
  platform?: Platform | string;
693
772
  /**
773
+ * @public
694
774
  * <p>he operating system (OS) version supported by the component. If the OS information is
695
775
  * available, a prefix match is performed against the base image OS version during image
696
776
  * recipe creation.</p>
697
777
  */
698
778
  supportedOsVersions?: string[];
699
779
  /**
780
+ * @public
700
781
  * <p>The type of the component denotes whether the component is used to build the image or
701
782
  * only to test it.</p>
702
783
  */
703
784
  type?: ComponentType | string;
704
785
  /**
786
+ * @public
705
787
  * <p>The owner of the component.</p>
706
788
  */
707
789
  owner?: string;
708
790
  /**
791
+ * @public
709
792
  * <p>The date that the component was created.</p>
710
793
  */
711
794
  dateCreated?: string;
@@ -716,11 +799,13 @@ export interface ComponentVersion {
716
799
  */
717
800
  export interface Container {
718
801
  /**
802
+ * @public
719
803
  * <p>Containers and container images are Region-specific. This is the Region context for
720
804
  * the container.</p>
721
805
  */
722
806
  region?: string;
723
807
  /**
808
+ * @public
724
809
  * <p>A list of URIs for containers created in the context Region.</p>
725
810
  */
726
811
  imageUris?: string[];
@@ -742,10 +827,12 @@ export type ContainerRepositoryService = (typeof ContainerRepositoryService)[key
742
827
  */
743
828
  export interface TargetContainerRepository {
744
829
  /**
830
+ * @public
745
831
  * <p>Specifies the service in which this image was registered.</p>
746
832
  */
747
833
  service: ContainerRepositoryService | string | undefined;
748
834
  /**
835
+ * @public
749
836
  * <p>The name of the container repository where the output container image is stored. This
750
837
  * name is prefixed by the repository location.</p>
751
838
  */
@@ -758,14 +845,17 @@ export interface TargetContainerRepository {
758
845
  */
759
846
  export interface ContainerDistributionConfiguration {
760
847
  /**
848
+ * @public
761
849
  * <p>The description of the container distribution configuration.</p>
762
850
  */
763
851
  description?: string;
764
852
  /**
853
+ * @public
765
854
  * <p>Tags that are attached to the container distribution configuration.</p>
766
855
  */
767
856
  containerTags?: string[];
768
857
  /**
858
+ * @public
769
859
  * <p>The destination repository for the container distribution configuration.</p>
770
860
  */
771
861
  targetRepository: TargetContainerRepository | undefined;
@@ -804,34 +894,42 @@ export type EbsVolumeType = (typeof EbsVolumeType)[keyof typeof EbsVolumeType];
804
894
  */
805
895
  export interface EbsInstanceBlockDeviceSpecification {
806
896
  /**
897
+ * @public
807
898
  * <p>Use to configure device encryption.</p>
808
899
  */
809
900
  encrypted?: boolean;
810
901
  /**
902
+ * @public
811
903
  * <p>Use to configure delete on termination of the associated device.</p>
812
904
  */
813
905
  deleteOnTermination?: boolean;
814
906
  /**
907
+ * @public
815
908
  * <p>Use to configure device IOPS.</p>
816
909
  */
817
910
  iops?: number;
818
911
  /**
912
+ * @public
819
913
  * <p>Use to configure the KMS key to use when encrypting the device.</p>
820
914
  */
821
915
  kmsKeyId?: string;
822
916
  /**
917
+ * @public
823
918
  * <p>The snapshot that defines the device contents.</p>
824
919
  */
825
920
  snapshotId?: string;
826
921
  /**
922
+ * @public
827
923
  * <p>Use to override the device's volume size.</p>
828
924
  */
829
925
  volumeSize?: number;
830
926
  /**
927
+ * @public
831
928
  * <p>Use to override the device's volume type.</p>
832
929
  */
833
930
  volumeType?: EbsVolumeType | string;
834
931
  /**
932
+ * @public
835
933
  * <p>
836
934
  * <b>For GP3 volumes only</b> – The throughput in MiB/s
837
935
  * that the volume supports.</p>
@@ -844,18 +942,22 @@ export interface EbsInstanceBlockDeviceSpecification {
844
942
  */
845
943
  export interface InstanceBlockDeviceMapping {
846
944
  /**
945
+ * @public
847
946
  * <p>The device to which these mappings apply.</p>
848
947
  */
849
948
  deviceName?: string;
850
949
  /**
950
+ * @public
851
951
  * <p>Use to manage Amazon EBS-specific configuration for this mapping.</p>
852
952
  */
853
953
  ebs?: EbsInstanceBlockDeviceSpecification;
854
954
  /**
955
+ * @public
855
956
  * <p>Use to manage instance ephemeral devices.</p>
856
957
  */
857
958
  virtualName?: string;
858
959
  /**
960
+ * @public
859
961
  * <p>Use to remove a mapping from the base image.</p>
860
962
  */
861
963
  noDevice?: string;
@@ -867,11 +969,13 @@ export interface InstanceBlockDeviceMapping {
867
969
  */
868
970
  export interface InstanceConfiguration {
869
971
  /**
972
+ * @public
870
973
  * <p>The AMI ID to use as the base image for a container build and test instance. If not
871
974
  * specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.</p>
872
975
  */
873
976
  image?: string;
874
977
  /**
978
+ * @public
875
979
  * <p>Defines the block devices to attach for building an instance from this Image Builder
876
980
  * AMI.</p>
877
981
  */
@@ -883,6 +987,7 @@ export interface InstanceConfiguration {
883
987
  */
884
988
  export interface ContainerRecipe {
885
989
  /**
990
+ * @public
886
991
  * <p>The Amazon Resource Name (ARN) of the container recipe.</p>
887
992
  * <note>
888
993
  * <p>Semantic versioning is included in each object's Amazon Resource Name (ARN),
@@ -903,26 +1008,32 @@ export interface ContainerRecipe {
903
1008
  */
904
1009
  arn?: string;
905
1010
  /**
1011
+ * @public
906
1012
  * <p>Specifies the type of container, such as Docker.</p>
907
1013
  */
908
1014
  containerType?: ContainerType | string;
909
1015
  /**
1016
+ * @public
910
1017
  * <p>The name of the container recipe.</p>
911
1018
  */
912
1019
  name?: string;
913
1020
  /**
1021
+ * @public
914
1022
  * <p>The description of the container recipe.</p>
915
1023
  */
916
1024
  description?: string;
917
1025
  /**
1026
+ * @public
918
1027
  * <p>The system platform for the container, such as Windows or Linux.</p>
919
1028
  */
920
1029
  platform?: Platform | string;
921
1030
  /**
1031
+ * @public
922
1032
  * <p>The owner of the container recipe.</p>
923
1033
  */
924
1034
  owner?: string;
925
1035
  /**
1036
+ * @public
926
1037
  * <p>The semantic version of the container recipe.</p>
927
1038
  * <note>
928
1039
  * <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
@@ -944,17 +1055,20 @@ export interface ContainerRecipe {
944
1055
  */
945
1056
  version?: string;
946
1057
  /**
1058
+ * @public
947
1059
  * <p>Build and test components that are included in the container recipe.
948
1060
  * Recipes require a minimum of one build component, and can
949
1061
  * have a maximum of 20 build and test components in any combination.</p>
950
1062
  */
951
1063
  components?: ComponentConfiguration[];
952
1064
  /**
1065
+ * @public
953
1066
  * <p>A group of options that can be used to configure an instance for building and testing
954
1067
  * container images.</p>
955
1068
  */
956
1069
  instanceConfiguration?: InstanceConfiguration;
957
1070
  /**
1071
+ * @public
958
1072
  * <p>Dockerfiles are text documents that are used to build Docker containers, and ensure
959
1073
  * that they contain all of the elements required by the application running inside. The
960
1074
  * template data consists of contextual variables where Image Builder places build information or
@@ -962,31 +1076,38 @@ export interface ContainerRecipe {
962
1076
  */
963
1077
  dockerfileTemplateData?: string;
964
1078
  /**
1079
+ * @public
965
1080
  * <p>Identifies which KMS key is used to encrypt the container image for distribution to
966
1081
  * the target Region.</p>
967
1082
  */
968
1083
  kmsKeyId?: string;
969
1084
  /**
1085
+ * @public
970
1086
  * <p>A flag that indicates if the target container is encrypted.</p>
971
1087
  */
972
1088
  encrypted?: boolean;
973
1089
  /**
1090
+ * @public
974
1091
  * <p>The base image for the container recipe.</p>
975
1092
  */
976
1093
  parentImage?: string;
977
1094
  /**
1095
+ * @public
978
1096
  * <p>The date when this container recipe was created.</p>
979
1097
  */
980
1098
  dateCreated?: string;
981
1099
  /**
1100
+ * @public
982
1101
  * <p>Tags that are attached to the container recipe.</p>
983
1102
  */
984
1103
  tags?: Record<string, string>;
985
1104
  /**
1105
+ * @public
986
1106
  * <p>The working directory for use during build and test workflows.</p>
987
1107
  */
988
1108
  workingDirectory?: string;
989
1109
  /**
1110
+ * @public
990
1111
  * <p>The destination repository for the container image.</p>
991
1112
  */
992
1113
  targetRepository?: TargetContainerRepository;
@@ -997,34 +1118,42 @@ export interface ContainerRecipe {
997
1118
  */
998
1119
  export interface ContainerRecipeSummary {
999
1120
  /**
1121
+ * @public
1000
1122
  * <p>The Amazon Resource Name (ARN) of the container recipe.</p>
1001
1123
  */
1002
1124
  arn?: string;
1003
1125
  /**
1126
+ * @public
1004
1127
  * <p>Specifies the type of container, such as "Docker".</p>
1005
1128
  */
1006
1129
  containerType?: ContainerType | string;
1007
1130
  /**
1131
+ * @public
1008
1132
  * <p>The name of the container recipe.</p>
1009
1133
  */
1010
1134
  name?: string;
1011
1135
  /**
1136
+ * @public
1012
1137
  * <p>The system platform for the container, such as Windows or Linux.</p>
1013
1138
  */
1014
1139
  platform?: Platform | string;
1015
1140
  /**
1141
+ * @public
1016
1142
  * <p>The owner of the container recipe.</p>
1017
1143
  */
1018
1144
  owner?: string;
1019
1145
  /**
1146
+ * @public
1020
1147
  * <p>The base image for the container recipe.</p>
1021
1148
  */
1022
1149
  parentImage?: string;
1023
1150
  /**
1151
+ * @public
1024
1152
  * <p>The date when this container recipe was created.</p>
1025
1153
  */
1026
1154
  dateCreated?: string;
1027
1155
  /**
1156
+ * @public
1028
1157
  * <p>Tags that are attached to the container recipe.</p>
1029
1158
  */
1030
1159
  tags?: Record<string, string>;
@@ -1034,10 +1163,12 @@ export interface ContainerRecipeSummary {
1034
1163
  */
1035
1164
  export interface CreateComponentRequest {
1036
1165
  /**
1166
+ * @public
1037
1167
  * <p>The name of the component.</p>
1038
1168
  */
1039
1169
  name: string | undefined;
1040
1170
  /**
1171
+ * @public
1041
1172
  * <p>The semantic version of the component. This version follows the semantic version
1042
1173
  * syntax.</p>
1043
1174
  * <note>
@@ -1055,32 +1186,38 @@ export interface CreateComponentRequest {
1055
1186
  */
1056
1187
  semanticVersion: string | undefined;
1057
1188
  /**
1189
+ * @public
1058
1190
  * <p>Describes the contents of the component.</p>
1059
1191
  */
1060
1192
  description?: string;
1061
1193
  /**
1194
+ * @public
1062
1195
  * <p>The change description of the component. Describes what change has been made in this
1063
1196
  * version, or what makes this version different from other versions of this
1064
1197
  * component.</p>
1065
1198
  */
1066
1199
  changeDescription?: string;
1067
1200
  /**
1201
+ * @public
1068
1202
  * <p>The operating system platform of the component.</p>
1069
1203
  */
1070
1204
  platform: Platform | string | undefined;
1071
1205
  /**
1206
+ * @public
1072
1207
  * <p>The operating system (OS) version supported by the component. If the OS information is
1073
1208
  * available, a prefix match is performed against the base image OS version during image
1074
1209
  * recipe creation.</p>
1075
1210
  */
1076
1211
  supportedOsVersions?: string[];
1077
1212
  /**
1213
+ * @public
1078
1214
  * <p>Component <code>data</code> contains inline YAML document content for the component.
1079
1215
  * Alternatively, you can specify the <code>uri</code> of a YAML document file stored in
1080
1216
  * Amazon S3. However, you cannot specify both properties.</p>
1081
1217
  */
1082
1218
  data?: string;
1083
1219
  /**
1220
+ * @public
1084
1221
  * <p>The <code>uri</code> of a YAML component document file. This must be an S3 URL
1085
1222
  * (<code>s3://bucket/key</code>), and the requester must have permission to access the
1086
1223
  * S3 bucket it points to. If you use Amazon S3, you can specify component content up to your
@@ -1090,14 +1227,17 @@ export interface CreateComponentRequest {
1090
1227
  */
1091
1228
  uri?: string;
1092
1229
  /**
1230
+ * @public
1093
1231
  * <p>The ID of the KMS key that is used to encrypt this component.</p>
1094
1232
  */
1095
1233
  kmsKeyId?: string;
1096
1234
  /**
1235
+ * @public
1097
1236
  * <p>The tags that apply to the component.</p>
1098
1237
  */
1099
1238
  tags?: Record<string, string>;
1100
1239
  /**
1240
+ * @public
1101
1241
  * <p>The idempotency token of the component.</p>
1102
1242
  */
1103
1243
  clientToken?: string;
@@ -1107,14 +1247,17 @@ export interface CreateComponentRequest {
1107
1247
  */
1108
1248
  export interface CreateComponentResponse {
1109
1249
  /**
1250
+ * @public
1110
1251
  * <p>The request ID that uniquely identifies this request.</p>
1111
1252
  */
1112
1253
  requestId?: string;
1113
1254
  /**
1255
+ * @public
1114
1256
  * <p>The idempotency token used to make this request idempotent.</p>
1115
1257
  */
1116
1258
  clientToken?: string;
1117
1259
  /**
1260
+ * @public
1118
1261
  * <p>The Amazon Resource Name (ARN) of the component that this request created.</p>
1119
1262
  */
1120
1263
  componentBuildVersionArn?: string;
@@ -1163,18 +1306,22 @@ export declare class ServiceQuotaExceededException extends __BaseException {
1163
1306
  */
1164
1307
  export interface CreateContainerRecipeRequest {
1165
1308
  /**
1309
+ * @public
1166
1310
  * <p>The type of container to create.</p>
1167
1311
  */
1168
1312
  containerType: ContainerType | string | undefined;
1169
1313
  /**
1314
+ * @public
1170
1315
  * <p>The name of the container recipe.</p>
1171
1316
  */
1172
1317
  name: string | undefined;
1173
1318
  /**
1319
+ * @public
1174
1320
  * <p>The description of the container recipe.</p>
1175
1321
  */
1176
1322
  description?: string;
1177
1323
  /**
1324
+ * @public
1178
1325
  * <p>The semantic version of the container recipe. This version follows the semantic
1179
1326
  * version syntax.</p>
1180
1327
  * <note>
@@ -1192,54 +1339,66 @@ export interface CreateContainerRecipeRequest {
1192
1339
  */
1193
1340
  semanticVersion: string | undefined;
1194
1341
  /**
1342
+ * @public
1195
1343
  * <p>Components for build and test that are included in the container recipe.
1196
1344
  * Recipes require a minimum of one build component, and can
1197
1345
  * have a maximum of 20 build and test components in any combination.</p>
1198
1346
  */
1199
1347
  components: ComponentConfiguration[] | undefined;
1200
1348
  /**
1349
+ * @public
1201
1350
  * <p>A group of options that can be used to configure an instance for building and testing
1202
1351
  * container images.</p>
1203
1352
  */
1204
1353
  instanceConfiguration?: InstanceConfiguration;
1205
1354
  /**
1355
+ * @public
1206
1356
  * <p>The Dockerfile template used to build your image as an inline data blob.</p>
1207
1357
  */
1208
1358
  dockerfileTemplateData?: string;
1209
1359
  /**
1360
+ * @public
1210
1361
  * <p>The Amazon S3 URI for the Dockerfile that will be used to build your container
1211
1362
  * image.</p>
1212
1363
  */
1213
1364
  dockerfileTemplateUri?: string;
1214
1365
  /**
1366
+ * @public
1215
1367
  * <p>Specifies the operating system platform when you use a custom base image.</p>
1216
1368
  */
1217
1369
  platformOverride?: Platform | string;
1218
1370
  /**
1371
+ * @public
1219
1372
  * <p>Specifies the operating system version for the base image.</p>
1220
1373
  */
1221
1374
  imageOsVersionOverride?: string;
1222
1375
  /**
1376
+ * @public
1223
1377
  * <p>The base image for the container recipe.</p>
1224
1378
  */
1225
1379
  parentImage: string | undefined;
1226
1380
  /**
1381
+ * @public
1227
1382
  * <p>Tags that are attached to the container recipe.</p>
1228
1383
  */
1229
1384
  tags?: Record<string, string>;
1230
1385
  /**
1386
+ * @public
1231
1387
  * <p>The working directory for use during build and test workflows.</p>
1232
1388
  */
1233
1389
  workingDirectory?: string;
1234
1390
  /**
1391
+ * @public
1235
1392
  * <p>The destination repository for the container image.</p>
1236
1393
  */
1237
1394
  targetRepository: TargetContainerRepository | undefined;
1238
1395
  /**
1396
+ * @public
1239
1397
  * <p>Identifies which KMS key is used to encrypt the container image.</p>
1240
1398
  */
1241
1399
  kmsKeyId?: string;
1242
1400
  /**
1401
+ * @public
1243
1402
  * <p>The client token used to make this request idempotent.</p>
1244
1403
  */
1245
1404
  clientToken?: string;
@@ -1249,14 +1408,17 @@ export interface CreateContainerRecipeRequest {
1249
1408
  */
1250
1409
  export interface CreateContainerRecipeResponse {
1251
1410
  /**
1411
+ * @public
1252
1412
  * <p>The request ID that uniquely identifies this request.</p>
1253
1413
  */
1254
1414
  requestId?: string;
1255
1415
  /**
1416
+ * @public
1256
1417
  * <p>The client token used to make this request idempotent.</p>
1257
1418
  */
1258
1419
  clientToken?: string;
1259
1420
  /**
1421
+ * @public
1260
1422
  * <p>Returns the Amazon Resource Name (ARN) of the container recipe that the request
1261
1423
  * created.</p>
1262
1424
  */
@@ -1285,14 +1447,17 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
1285
1447
  */
1286
1448
  export interface FastLaunchLaunchTemplateSpecification {
1287
1449
  /**
1450
+ * @public
1288
1451
  * <p>The ID of the launch template to use for faster launching for a Windows AMI.</p>
1289
1452
  */
1290
1453
  launchTemplateId?: string;
1291
1454
  /**
1455
+ * @public
1292
1456
  * <p>The name of the launch template to use for faster launching for a Windows AMI.</p>
1293
1457
  */
1294
1458
  launchTemplateName?: string;
1295
1459
  /**
1460
+ * @public
1296
1461
  * <p>The version of the launch template to use for faster launching for a Windows
1297
1462
  * AMI.</p>
1298
1463
  */
@@ -1305,6 +1470,7 @@ export interface FastLaunchLaunchTemplateSpecification {
1305
1470
  */
1306
1471
  export interface FastLaunchSnapshotConfiguration {
1307
1472
  /**
1473
+ * @public
1308
1474
  * <p>The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled
1309
1475
  * Windows AMI.</p>
1310
1476
  */
@@ -1316,27 +1482,32 @@ export interface FastLaunchSnapshotConfiguration {
1316
1482
  */
1317
1483
  export interface FastLaunchConfiguration {
1318
1484
  /**
1485
+ * @public
1319
1486
  * <p>A Boolean that represents the current state of faster launching for the Windows AMI.
1320
1487
  * Set to <code>true</code> to start using Windows faster launching, or <code>false</code>
1321
1488
  * to stop using it.</p>
1322
1489
  */
1323
1490
  enabled: boolean | undefined;
1324
1491
  /**
1492
+ * @public
1325
1493
  * <p>Configuration settings for managing the number of snapshots that are created from
1326
1494
  * pre-provisioned instances for the Windows AMI when faster launching is enabled.</p>
1327
1495
  */
1328
1496
  snapshotConfiguration?: FastLaunchSnapshotConfiguration;
1329
1497
  /**
1498
+ * @public
1330
1499
  * <p>The maximum number of parallel instances that are launched for creating
1331
1500
  * resources.</p>
1332
1501
  */
1333
1502
  maxParallelLaunches?: number;
1334
1503
  /**
1504
+ * @public
1335
1505
  * <p>The launch template that the fast-launch enabled Windows AMI uses when it launches
1336
1506
  * Windows instances to create pre-provisioned snapshots.</p>
1337
1507
  */
1338
1508
  launchTemplate?: FastLaunchLaunchTemplateSpecification;
1339
1509
  /**
1510
+ * @public
1340
1511
  * <p>The owner account ID for the fast-launch enabled Windows AMI.</p>
1341
1512
  */
1342
1513
  accountId?: string;
@@ -1347,14 +1518,17 @@ export interface FastLaunchConfiguration {
1347
1518
  */
1348
1519
  export interface LaunchTemplateConfiguration {
1349
1520
  /**
1521
+ * @public
1350
1522
  * <p>Identifies the Amazon EC2 launch template to use.</p>
1351
1523
  */
1352
1524
  launchTemplateId: string | undefined;
1353
1525
  /**
1526
+ * @public
1354
1527
  * <p>The account ID that this configuration applies to.</p>
1355
1528
  */
1356
1529
  accountId?: string;
1357
1530
  /**
1531
+ * @public
1358
1532
  * <p>Set the specified Amazon EC2 launch template as the default launch template for the
1359
1533
  * specified account.</p>
1360
1534
  */
@@ -1380,11 +1554,13 @@ export type DiskImageFormat = (typeof DiskImageFormat)[keyof typeof DiskImageFor
1380
1554
  */
1381
1555
  export interface S3ExportConfiguration {
1382
1556
  /**
1557
+ * @public
1383
1558
  * <p>The name of the role that grants VM Import/Export permission to export images to your
1384
1559
  * S3 bucket.</p>
1385
1560
  */
1386
1561
  roleName: string | undefined;
1387
1562
  /**
1563
+ * @public
1388
1564
  * <p>Export the updated image to one of the following supported disk image formats:</p>
1389
1565
  * <ul>
1390
1566
  * <li>
@@ -1406,10 +1582,12 @@ export interface S3ExportConfiguration {
1406
1582
  */
1407
1583
  diskImageFormat: DiskImageFormat | string | undefined;
1408
1584
  /**
1585
+ * @public
1409
1586
  * <p>The S3 bucket in which to store the output disk images for your VM.</p>
1410
1587
  */
1411
1588
  s3Bucket: string | undefined;
1412
1589
  /**
1590
+ * @public
1413
1591
  * <p>The Amazon S3 path for the bucket where the output disk images for your VM are
1414
1592
  * stored.</p>
1415
1593
  */
@@ -1421,34 +1599,41 @@ export interface S3ExportConfiguration {
1421
1599
  */
1422
1600
  export interface Distribution {
1423
1601
  /**
1602
+ * @public
1424
1603
  * <p>The target Region.</p>
1425
1604
  */
1426
1605
  region: string | undefined;
1427
1606
  /**
1607
+ * @public
1428
1608
  * <p>The specific AMI settings; for example, launch permissions or AMI tags.</p>
1429
1609
  */
1430
1610
  amiDistributionConfiguration?: AmiDistributionConfiguration;
1431
1611
  /**
1612
+ * @public
1432
1613
  * <p>Container distribution settings for encryption, licensing, and sharing in a specific
1433
1614
  * Region.</p>
1434
1615
  */
1435
1616
  containerDistributionConfiguration?: ContainerDistributionConfiguration;
1436
1617
  /**
1618
+ * @public
1437
1619
  * <p>The License Manager Configuration to associate with the AMI in the specified
1438
1620
  * Region.</p>
1439
1621
  */
1440
1622
  licenseConfigurationArns?: string[];
1441
1623
  /**
1624
+ * @public
1442
1625
  * <p>A group of launchTemplateConfiguration settings that apply to image distribution for
1443
1626
  * specified accounts.</p>
1444
1627
  */
1445
1628
  launchTemplateConfigurations?: LaunchTemplateConfiguration[];
1446
1629
  /**
1630
+ * @public
1447
1631
  * <p>Configure export settings to deliver disk images created from your image build, using
1448
1632
  * a file format that is compatible with your VMs in that Region.</p>
1449
1633
  */
1450
1634
  s3ExportConfiguration?: S3ExportConfiguration;
1451
1635
  /**
1636
+ * @public
1452
1637
  * <p>The Windows faster-launching configurations to use for AMI distribution.</p>
1453
1638
  */
1454
1639
  fastLaunchConfigurations?: FastLaunchConfiguration[];
@@ -1458,22 +1643,27 @@ export interface Distribution {
1458
1643
  */
1459
1644
  export interface CreateDistributionConfigurationRequest {
1460
1645
  /**
1646
+ * @public
1461
1647
  * <p>The name of the distribution configuration.</p>
1462
1648
  */
1463
1649
  name: string | undefined;
1464
1650
  /**
1651
+ * @public
1465
1652
  * <p>The description of the distribution configuration.</p>
1466
1653
  */
1467
1654
  description?: string;
1468
1655
  /**
1656
+ * @public
1469
1657
  * <p>The distributions of the distribution configuration.</p>
1470
1658
  */
1471
1659
  distributions: Distribution[] | undefined;
1472
1660
  /**
1661
+ * @public
1473
1662
  * <p>The tags of the distribution configuration.</p>
1474
1663
  */
1475
1664
  tags?: Record<string, string>;
1476
1665
  /**
1666
+ * @public
1477
1667
  * <p>The idempotency token of the distribution configuration.</p>
1478
1668
  */
1479
1669
  clientToken?: string;
@@ -1483,14 +1673,17 @@ export interface CreateDistributionConfigurationRequest {
1483
1673
  */
1484
1674
  export interface CreateDistributionConfigurationResponse {
1485
1675
  /**
1676
+ * @public
1486
1677
  * <p>The request ID that uniquely identifies this request.</p>
1487
1678
  */
1488
1679
  requestId?: string;
1489
1680
  /**
1681
+ * @public
1490
1682
  * <p>The idempotency token used to make this request idempotent.</p>
1491
1683
  */
1492
1684
  clientToken?: string;
1493
1685
  /**
1686
+ * @public
1494
1687
  * <p>The Amazon Resource Name (ARN) of the distribution configuration that was created by
1495
1688
  * this request.</p>
1496
1689
  */
@@ -1503,6 +1696,7 @@ export interface CreateDistributionConfigurationResponse {
1503
1696
  */
1504
1697
  export interface EcrConfiguration {
1505
1698
  /**
1699
+ * @public
1506
1700
  * <p>The name of the container repository that Amazon Inspector scans to identify findings for your
1507
1701
  * container images. The name includes the path for the repository location. If you don’t
1508
1702
  * provide this information, Image Builder creates a repository in your account named
@@ -1511,6 +1705,7 @@ export interface EcrConfiguration {
1511
1705
  */
1512
1706
  repositoryName?: string;
1513
1707
  /**
1708
+ * @public
1514
1709
  * <p>Tags for Image Builder to apply to the output container image that &INS; scans. Tags can
1515
1710
  * help you identify and manage your scanned images.</p>
1516
1711
  */
@@ -1522,11 +1717,13 @@ export interface EcrConfiguration {
1522
1717
  */
1523
1718
  export interface ImageScanningConfiguration {
1524
1719
  /**
1720
+ * @public
1525
1721
  * <p>A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that
1526
1722
  * Amazon Inspector runs against the build instance when you create a new image.</p>
1527
1723
  */
1528
1724
  imageScanningEnabled?: boolean;
1529
1725
  /**
1726
+ * @public
1530
1727
  * <p>Contains Amazon ECR settings for vulnerability scans.</p>
1531
1728
  */
1532
1729
  ecrConfiguration?: EcrConfiguration;
@@ -1538,11 +1735,13 @@ export interface ImageScanningConfiguration {
1538
1735
  */
1539
1736
  export interface ImageTestsConfiguration {
1540
1737
  /**
1738
+ * @public
1541
1739
  * <p>Determines if tests should run after building the image. Image Builder defaults to enable tests
1542
1740
  * to run following the image build, before image distribution.</p>
1543
1741
  */
1544
1742
  imageTestsEnabled?: boolean;
1545
1743
  /**
1744
+ * @public
1546
1745
  * <p>The maximum time in minutes that tests are permitted to run.</p>
1547
1746
  * <note>
1548
1747
  * <p>The timeoutMinutes attribute is not currently active. This value is
@@ -1556,44 +1755,53 @@ export interface ImageTestsConfiguration {
1556
1755
  */
1557
1756
  export interface CreateImageRequest {
1558
1757
  /**
1758
+ * @public
1559
1759
  * <p>The Amazon Resource Name (ARN) of the image recipe that defines how images are
1560
1760
  * configured, tested, and assessed.</p>
1561
1761
  */
1562
1762
  imageRecipeArn?: string;
1563
1763
  /**
1764
+ * @public
1564
1765
  * <p>The Amazon Resource Name (ARN) of the container recipe that defines how images are
1565
1766
  * configured and tested.</p>
1566
1767
  */
1567
1768
  containerRecipeArn?: string;
1568
1769
  /**
1770
+ * @public
1569
1771
  * <p>The Amazon Resource Name (ARN) of the distribution configuration that defines and
1570
1772
  * configures the outputs of your pipeline.</p>
1571
1773
  */
1572
1774
  distributionConfigurationArn?: string;
1573
1775
  /**
1776
+ * @public
1574
1777
  * <p>The Amazon Resource Name (ARN) of the infrastructure configuration that defines the
1575
1778
  * environment in which your image will be built and tested.</p>
1576
1779
  */
1577
1780
  infrastructureConfigurationArn: string | undefined;
1578
1781
  /**
1782
+ * @public
1579
1783
  * <p>The image tests configuration of the image.</p>
1580
1784
  */
1581
1785
  imageTestsConfiguration?: ImageTestsConfiguration;
1582
1786
  /**
1787
+ * @public
1583
1788
  * <p>Collects additional information about the image being created, including the operating
1584
1789
  * system (OS) version and package list. This information is used to enhance the overall
1585
1790
  * experience of using EC2 Image Builder. Enabled by default.</p>
1586
1791
  */
1587
1792
  enhancedImageMetadataEnabled?: boolean;
1588
1793
  /**
1794
+ * @public
1589
1795
  * <p>The tags of the image.</p>
1590
1796
  */
1591
1797
  tags?: Record<string, string>;
1592
1798
  /**
1799
+ * @public
1593
1800
  * <p>The idempotency token used to make this request idempotent.</p>
1594
1801
  */
1595
1802
  clientToken?: string;
1596
1803
  /**
1804
+ * @public
1597
1805
  * <p>Contains settings for vulnerability scans.</p>
1598
1806
  */
1599
1807
  imageScanningConfiguration?: ImageScanningConfiguration;
@@ -1603,14 +1811,17 @@ export interface CreateImageRequest {
1603
1811
  */
1604
1812
  export interface CreateImageResponse {
1605
1813
  /**
1814
+ * @public
1606
1815
  * <p>The request ID that uniquely identifies this request.</p>
1607
1816
  */
1608
1817
  requestId?: string;
1609
1818
  /**
1819
+ * @public
1610
1820
  * <p>The idempotency token used to make this request idempotent.</p>
1611
1821
  */
1612
1822
  clientToken?: string;
1613
1823
  /**
1824
+ * @public
1614
1825
  * <p>The Amazon Resource Name (ARN) of the image that this request created.</p>
1615
1826
  */
1616
1827
  imageBuildVersionArn?: string;
@@ -1634,6 +1845,7 @@ export type PipelineExecutionStartCondition = (typeof PipelineExecutionStartCond
1634
1845
  */
1635
1846
  export interface Schedule {
1636
1847
  /**
1848
+ * @public
1637
1849
  * <p>The cron expression determines how often EC2 Image Builder evaluates your
1638
1850
  * <code>pipelineExecutionStartCondition</code>.</p>
1639
1851
  * <p>For information on how to format a cron expression in Image Builder, see <a href="https://docs.aws.amazon.com/imagebuilder/latest/userguide/image-builder-cron.html">Use
@@ -1641,11 +1853,13 @@ export interface Schedule {
1641
1853
  */
1642
1854
  scheduleExpression?: string;
1643
1855
  /**
1856
+ * @public
1644
1857
  * <p>The timezone that applies to the scheduling expression. For example, "Etc/UTC",
1645
1858
  * "America/Los_Angeles" in the <a href="https://www.joda.org/joda-time/timezones.html">IANA timezone format</a>. If not specified this defaults to UTC.</p>
1646
1859
  */
1647
1860
  timezone?: string;
1648
1861
  /**
1862
+ * @public
1649
1863
  * <p>The condition configures when the pipeline should trigger a new image build. When the
1650
1864
  * <code>pipelineExecutionStartCondition</code> is set to
1651
1865
  * <code>EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE</code>, and you use semantic
@@ -1674,60 +1888,73 @@ export type PipelineStatus = (typeof PipelineStatus)[keyof typeof PipelineStatus
1674
1888
  */
1675
1889
  export interface CreateImagePipelineRequest {
1676
1890
  /**
1891
+ * @public
1677
1892
  * <p>The name of the image pipeline.</p>
1678
1893
  */
1679
1894
  name: string | undefined;
1680
1895
  /**
1896
+ * @public
1681
1897
  * <p>The description of the image pipeline.</p>
1682
1898
  */
1683
1899
  description?: string;
1684
1900
  /**
1901
+ * @public
1685
1902
  * <p>The Amazon Resource Name (ARN) of the image recipe that will be used to configure
1686
1903
  * images created by this image pipeline.</p>
1687
1904
  */
1688
1905
  imageRecipeArn?: string;
1689
1906
  /**
1907
+ * @public
1690
1908
  * <p>The Amazon Resource Name (ARN) of the container recipe that is used to configure
1691
1909
  * images created by this container pipeline.</p>
1692
1910
  */
1693
1911
  containerRecipeArn?: string;
1694
1912
  /**
1913
+ * @public
1695
1914
  * <p>The Amazon Resource Name (ARN) of the infrastructure configuration that will be used
1696
1915
  * to build images created by this image pipeline.</p>
1697
1916
  */
1698
1917
  infrastructureConfigurationArn: string | undefined;
1699
1918
  /**
1919
+ * @public
1700
1920
  * <p>The Amazon Resource Name (ARN) of the distribution configuration that will be used to
1701
1921
  * configure and distribute images created by this image pipeline.</p>
1702
1922
  */
1703
1923
  distributionConfigurationArn?: string;
1704
1924
  /**
1925
+ * @public
1705
1926
  * <p>The image test configuration of the image pipeline.</p>
1706
1927
  */
1707
1928
  imageTestsConfiguration?: ImageTestsConfiguration;
1708
1929
  /**
1930
+ * @public
1709
1931
  * <p>Collects additional information about the image being created, including the operating
1710
1932
  * system (OS) version and package list. This information is used to enhance the overall
1711
1933
  * experience of using EC2 Image Builder. Enabled by default.</p>
1712
1934
  */
1713
1935
  enhancedImageMetadataEnabled?: boolean;
1714
1936
  /**
1937
+ * @public
1715
1938
  * <p>The schedule of the image pipeline.</p>
1716
1939
  */
1717
1940
  schedule?: Schedule;
1718
1941
  /**
1942
+ * @public
1719
1943
  * <p>The status of the image pipeline.</p>
1720
1944
  */
1721
1945
  status?: PipelineStatus | string;
1722
1946
  /**
1947
+ * @public
1723
1948
  * <p>The tags of the image pipeline.</p>
1724
1949
  */
1725
1950
  tags?: Record<string, string>;
1726
1951
  /**
1952
+ * @public
1727
1953
  * <p>The idempotency token used to make this request idempotent.</p>
1728
1954
  */
1729
1955
  clientToken?: string;
1730
1956
  /**
1957
+ * @public
1731
1958
  * <p>Contains settings for vulnerability scans.</p>
1732
1959
  */
1733
1960
  imageScanningConfiguration?: ImageScanningConfiguration;
@@ -1737,14 +1964,17 @@ export interface CreateImagePipelineRequest {
1737
1964
  */
1738
1965
  export interface CreateImagePipelineResponse {
1739
1966
  /**
1967
+ * @public
1740
1968
  * <p>The request ID that uniquely identifies this request.</p>
1741
1969
  */
1742
1970
  requestId?: string;
1743
1971
  /**
1972
+ * @public
1744
1973
  * <p>The idempotency token used to make this request idempotent.</p>
1745
1974
  */
1746
1975
  clientToken?: string;
1747
1976
  /**
1977
+ * @public
1748
1978
  * <p>The Amazon Resource Name (ARN) of the image pipeline that was created by this
1749
1979
  * request.</p>
1750
1980
  */
@@ -1755,14 +1985,17 @@ export interface CreateImagePipelineResponse {
1755
1985
  */
1756
1986
  export interface CreateImageRecipeRequest {
1757
1987
  /**
1988
+ * @public
1758
1989
  * <p>The name of the image recipe.</p>
1759
1990
  */
1760
1991
  name: string | undefined;
1761
1992
  /**
1993
+ * @public
1762
1994
  * <p>The description of the image recipe.</p>
1763
1995
  */
1764
1996
  description?: string;
1765
1997
  /**
1998
+ * @public
1766
1999
  * <p>The semantic version of the image recipe. This version follows the semantic version
1767
2000
  * syntax.</p>
1768
2001
  * <note>
@@ -1780,10 +2013,12 @@ export interface CreateImageRecipeRequest {
1780
2013
  */
1781
2014
  semanticVersion: string | undefined;
1782
2015
  /**
2016
+ * @public
1783
2017
  * <p>The components included in the image recipe.</p>
1784
2018
  */
1785
2019
  components: ComponentConfiguration[] | undefined;
1786
2020
  /**
2021
+ * @public
1787
2022
  * <p>The base image of the image recipe. The value of the string can be the ARN of the base
1788
2023
  * image or an AMI ID. The format for the ARN follows this example:
1789
2024
  * <code>arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x</code>.
@@ -1793,22 +2028,27 @@ export interface CreateImageRecipeRequest {
1793
2028
  */
1794
2029
  parentImage: string | undefined;
1795
2030
  /**
2031
+ * @public
1796
2032
  * <p>The block device mappings of the image recipe.</p>
1797
2033
  */
1798
2034
  blockDeviceMappings?: InstanceBlockDeviceMapping[];
1799
2035
  /**
2036
+ * @public
1800
2037
  * <p>The tags of the image recipe.</p>
1801
2038
  */
1802
2039
  tags?: Record<string, string>;
1803
2040
  /**
2041
+ * @public
1804
2042
  * <p>The working directory used during build and test workflows.</p>
1805
2043
  */
1806
2044
  workingDirectory?: string;
1807
2045
  /**
2046
+ * @public
1808
2047
  * <p>Specify additional settings and launch scripts for your build instances.</p>
1809
2048
  */
1810
2049
  additionalInstanceConfiguration?: AdditionalInstanceConfiguration;
1811
2050
  /**
2051
+ * @public
1812
2052
  * <p>The idempotency token used to make this request idempotent.</p>
1813
2053
  */
1814
2054
  clientToken?: string;
@@ -1818,14 +2058,17 @@ export interface CreateImageRecipeRequest {
1818
2058
  */
1819
2059
  export interface CreateImageRecipeResponse {
1820
2060
  /**
2061
+ * @public
1821
2062
  * <p>The request ID that uniquely identifies this request.</p>
1822
2063
  */
1823
2064
  requestId?: string;
1824
2065
  /**
2066
+ * @public
1825
2067
  * <p>The idempotency token used to make this request idempotent.</p>
1826
2068
  */
1827
2069
  clientToken?: string;
1828
2070
  /**
2071
+ * @public
1829
2072
  * <p>The Amazon Resource Name (ARN) of the image recipe that was created by this
1830
2073
  * request.</p>
1831
2074
  */
@@ -1845,6 +2088,7 @@ export interface CreateImageRecipeResponse {
1845
2088
  */
1846
2089
  export interface InstanceMetadataOptions {
1847
2090
  /**
2091
+ * @public
1848
2092
  * <p>Indicates whether a signed token header is required for instance metadata retrieval
1849
2093
  * requests. The values affect the response as follows:</p>
1850
2094
  * <ul>
@@ -1865,6 +2109,7 @@ export interface InstanceMetadataOptions {
1865
2109
  */
1866
2110
  httpTokens?: string;
1867
2111
  /**
2112
+ * @public
1868
2113
  * <p>Limit the number of hops that an instance metadata request can traverse to reach its
1869
2114
  * destination. The default is one hop. However, if HTTP tokens are required, container
1870
2115
  * image builds need a minimum of two hops.</p>
@@ -1877,10 +2122,12 @@ export interface InstanceMetadataOptions {
1877
2122
  */
1878
2123
  export interface S3Logs {
1879
2124
  /**
2125
+ * @public
1880
2126
  * <p>The S3 bucket in which to store the logs.</p>
1881
2127
  */
1882
2128
  s3BucketName?: string;
1883
2129
  /**
2130
+ * @public
1884
2131
  * <p>The Amazon S3 path to the bucket where the logs are stored.</p>
1885
2132
  */
1886
2133
  s3KeyPrefix?: string;
@@ -1891,6 +2138,7 @@ export interface S3Logs {
1891
2138
  */
1892
2139
  export interface Logging {
1893
2140
  /**
2141
+ * @public
1894
2142
  * <p>The Amazon S3 logging configuration.</p>
1895
2143
  */
1896
2144
  s3Logs?: S3Logs;
@@ -1900,49 +2148,59 @@ export interface Logging {
1900
2148
  */
1901
2149
  export interface CreateInfrastructureConfigurationRequest {
1902
2150
  /**
2151
+ * @public
1903
2152
  * <p>The name of the infrastructure configuration.</p>
1904
2153
  */
1905
2154
  name: string | undefined;
1906
2155
  /**
2156
+ * @public
1907
2157
  * <p>The description of the infrastructure configuration.</p>
1908
2158
  */
1909
2159
  description?: string;
1910
2160
  /**
2161
+ * @public
1911
2162
  * <p>The instance types of the infrastructure configuration. You can specify one or more
1912
2163
  * instance types to use for this build. The service will pick one of these instance types
1913
2164
  * based on availability.</p>
1914
2165
  */
1915
2166
  instanceTypes?: string[];
1916
2167
  /**
2168
+ * @public
1917
2169
  * <p>The instance profile to associate with the instance used to customize your Amazon EC2
1918
2170
  * AMI.</p>
1919
2171
  */
1920
2172
  instanceProfileName: string | undefined;
1921
2173
  /**
2174
+ * @public
1922
2175
  * <p>The security group IDs to associate with the instance used to customize your Amazon EC2
1923
2176
  * AMI.</p>
1924
2177
  */
1925
2178
  securityGroupIds?: string[];
1926
2179
  /**
2180
+ * @public
1927
2181
  * <p>The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.</p>
1928
2182
  */
1929
2183
  subnetId?: string;
1930
2184
  /**
2185
+ * @public
1931
2186
  * <p>The logging configuration of the infrastructure configuration.</p>
1932
2187
  */
1933
2188
  logging?: Logging;
1934
2189
  /**
2190
+ * @public
1935
2191
  * <p>The key pair of the infrastructure configuration. You can use this to log on to and
1936
2192
  * debug the instance used to create your image.</p>
1937
2193
  */
1938
2194
  keyPair?: string;
1939
2195
  /**
2196
+ * @public
1940
2197
  * <p>The terminate instance on failure setting of the infrastructure configuration. Set to
1941
2198
  * false if you want Image Builder to retain the instance used to configure your AMI if the build or
1942
2199
  * test phase of your workflow fails.</p>
1943
2200
  */
1944
2201
  terminateInstanceOnFailure?: boolean;
1945
2202
  /**
2203
+ * @public
1946
2204
  * <p>The Amazon Resource Name (ARN) for the SNS topic to which we send image build event
1947
2205
  * notifications.</p>
1948
2206
  * <note>
@@ -1953,19 +2211,23 @@ export interface CreateInfrastructureConfigurationRequest {
1953
2211
  */
1954
2212
  snsTopicArn?: string;
1955
2213
  /**
2214
+ * @public
1956
2215
  * <p>The tags attached to the resource created by Image Builder.</p>
1957
2216
  */
1958
2217
  resourceTags?: Record<string, string>;
1959
2218
  /**
2219
+ * @public
1960
2220
  * <p>The instance metadata options that you can set for the HTTP requests that pipeline
1961
2221
  * builds use to launch EC2 build and test instances.</p>
1962
2222
  */
1963
2223
  instanceMetadataOptions?: InstanceMetadataOptions;
1964
2224
  /**
2225
+ * @public
1965
2226
  * <p>The tags of the infrastructure configuration.</p>
1966
2227
  */
1967
2228
  tags?: Record<string, string>;
1968
2229
  /**
2230
+ * @public
1969
2231
  * <p>The idempotency token used to make this request idempotent.</p>
1970
2232
  */
1971
2233
  clientToken?: string;
@@ -1975,14 +2237,17 @@ export interface CreateInfrastructureConfigurationRequest {
1975
2237
  */
1976
2238
  export interface CreateInfrastructureConfigurationResponse {
1977
2239
  /**
2240
+ * @public
1978
2241
  * <p>The request ID that uniquely identifies this request.</p>
1979
2242
  */
1980
2243
  requestId?: string;
1981
2244
  /**
2245
+ * @public
1982
2246
  * <p>The idempotency token used to make this request idempotent.</p>
1983
2247
  */
1984
2248
  clientToken?: string;
1985
2249
  /**
2250
+ * @public
1986
2251
  * <p>The Amazon Resource Name (ARN) of the infrastructure configuration that was created by
1987
2252
  * this request.</p>
1988
2253
  */
@@ -1999,18 +2264,22 @@ export interface CreateInfrastructureConfigurationResponse {
1999
2264
  */
2000
2265
  export interface CvssScore {
2001
2266
  /**
2267
+ * @public
2002
2268
  * <p>The CVSS base score.</p>
2003
2269
  */
2004
2270
  baseScore?: number;
2005
2271
  /**
2272
+ * @public
2006
2273
  * <p>The vector string of the CVSS score.</p>
2007
2274
  */
2008
2275
  scoringVector?: string;
2009
2276
  /**
2277
+ * @public
2010
2278
  * <p>The CVSS version that generated the score.</p>
2011
2279
  */
2012
2280
  version?: string;
2013
2281
  /**
2282
+ * @public
2014
2283
  * <p>The source of the CVSS score.</p>
2015
2284
  */
2016
2285
  source?: string;
@@ -2021,10 +2290,12 @@ export interface CvssScore {
2021
2290
  */
2022
2291
  export interface CvssScoreAdjustment {
2023
2292
  /**
2293
+ * @public
2024
2294
  * <p>The metric that Amazon Inspector used to adjust the CVSS score.</p>
2025
2295
  */
2026
2296
  metric?: string;
2027
2297
  /**
2298
+ * @public
2028
2299
  * <p>The reason for the CVSS score adjustment.</p>
2029
2300
  */
2030
2301
  reason?: string;
@@ -2036,26 +2307,32 @@ export interface CvssScoreAdjustment {
2036
2307
  */
2037
2308
  export interface CvssScoreDetails {
2038
2309
  /**
2310
+ * @public
2039
2311
  * <p>The source for the CVSS score.</p>
2040
2312
  */
2041
2313
  scoreSource?: string;
2042
2314
  /**
2315
+ * @public
2043
2316
  * <p>The source of the finding.</p>
2044
2317
  */
2045
2318
  cvssSource?: string;
2046
2319
  /**
2320
+ * @public
2047
2321
  * <p>The CVSS version that generated the score.</p>
2048
2322
  */
2049
2323
  version?: string;
2050
2324
  /**
2325
+ * @public
2051
2326
  * <p>The CVSS score.</p>
2052
2327
  */
2053
2328
  score?: number;
2054
2329
  /**
2330
+ * @public
2055
2331
  * <p>A vector that measures the severity of the vulnerability.</p>
2056
2332
  */
2057
2333
  scoringVector?: string;
2058
2334
  /**
2335
+ * @public
2059
2336
  * <p>An object that contains details about an adjustment that Amazon Inspector made to the CVSS score
2060
2337
  * for the finding.</p>
2061
2338
  */
@@ -2066,6 +2343,7 @@ export interface CvssScoreDetails {
2066
2343
  */
2067
2344
  export interface DeleteComponentRequest {
2068
2345
  /**
2346
+ * @public
2069
2347
  * <p>The Amazon Resource Name (ARN) of the component build version to delete.</p>
2070
2348
  */
2071
2349
  componentBuildVersionArn: string | undefined;
@@ -2075,10 +2353,12 @@ export interface DeleteComponentRequest {
2075
2353
  */
2076
2354
  export interface DeleteComponentResponse {
2077
2355
  /**
2356
+ * @public
2078
2357
  * <p>The request ID that uniquely identifies this request.</p>
2079
2358
  */
2080
2359
  requestId?: string;
2081
2360
  /**
2361
+ * @public
2082
2362
  * <p>The ARN of the component build version that this request deleted.</p>
2083
2363
  */
2084
2364
  componentBuildVersionArn?: string;
@@ -2101,6 +2381,7 @@ export declare class ResourceDependencyException extends __BaseException {
2101
2381
  */
2102
2382
  export interface DeleteContainerRecipeRequest {
2103
2383
  /**
2384
+ * @public
2104
2385
  * <p>The Amazon Resource Name (ARN) of the container recipe to delete.</p>
2105
2386
  */
2106
2387
  containerRecipeArn: string | undefined;
@@ -2110,10 +2391,12 @@ export interface DeleteContainerRecipeRequest {
2110
2391
  */
2111
2392
  export interface DeleteContainerRecipeResponse {
2112
2393
  /**
2394
+ * @public
2113
2395
  * <p>The request ID that uniquely identifies this request.</p>
2114
2396
  */
2115
2397
  requestId?: string;
2116
2398
  /**
2399
+ * @public
2117
2400
  * <p>The Amazon Resource Name (ARN) of the container recipe that was deleted.</p>
2118
2401
  */
2119
2402
  containerRecipeArn?: string;
@@ -2123,6 +2406,7 @@ export interface DeleteContainerRecipeResponse {
2123
2406
  */
2124
2407
  export interface DeleteDistributionConfigurationRequest {
2125
2408
  /**
2409
+ * @public
2126
2410
  * <p>The Amazon Resource Name (ARN) of the distribution configuration to delete.</p>
2127
2411
  */
2128
2412
  distributionConfigurationArn: string | undefined;
@@ -2132,10 +2416,12 @@ export interface DeleteDistributionConfigurationRequest {
2132
2416
  */
2133
2417
  export interface DeleteDistributionConfigurationResponse {
2134
2418
  /**
2419
+ * @public
2135
2420
  * <p>The request ID that uniquely identifies this request.</p>
2136
2421
  */
2137
2422
  requestId?: string;
2138
2423
  /**
2424
+ * @public
2139
2425
  * <p>The Amazon Resource Name (ARN) of the distribution configuration that was
2140
2426
  * deleted.</p>
2141
2427
  */
@@ -2146,6 +2432,7 @@ export interface DeleteDistributionConfigurationResponse {
2146
2432
  */
2147
2433
  export interface DeleteImageRequest {
2148
2434
  /**
2435
+ * @public
2149
2436
  * <p>The Amazon Resource Name (ARN) of the Image Builder image resource to delete.</p>
2150
2437
  */
2151
2438
  imageBuildVersionArn: string | undefined;
@@ -2155,10 +2442,12 @@ export interface DeleteImageRequest {
2155
2442
  */
2156
2443
  export interface DeleteImageResponse {
2157
2444
  /**
2445
+ * @public
2158
2446
  * <p>The request ID that uniquely identifies this request.</p>
2159
2447
  */
2160
2448
  requestId?: string;
2161
2449
  /**
2450
+ * @public
2162
2451
  * <p>The ARN of the Image Builder image resource that this request deleted.</p>
2163
2452
  */
2164
2453
  imageBuildVersionArn?: string;
@@ -2168,6 +2457,7 @@ export interface DeleteImageResponse {
2168
2457
  */
2169
2458
  export interface DeleteImagePipelineRequest {
2170
2459
  /**
2460
+ * @public
2171
2461
  * <p>The Amazon Resource Name (ARN) of the image pipeline to delete.</p>
2172
2462
  */
2173
2463
  imagePipelineArn: string | undefined;
@@ -2177,10 +2467,12 @@ export interface DeleteImagePipelineRequest {
2177
2467
  */
2178
2468
  export interface DeleteImagePipelineResponse {
2179
2469
  /**
2470
+ * @public
2180
2471
  * <p>The request ID that uniquely identifies this request.</p>
2181
2472
  */
2182
2473
  requestId?: string;
2183
2474
  /**
2475
+ * @public
2184
2476
  * <p>The Amazon Resource Name (ARN) of the image pipeline that was deleted.</p>
2185
2477
  */
2186
2478
  imagePipelineArn?: string;
@@ -2190,6 +2482,7 @@ export interface DeleteImagePipelineResponse {
2190
2482
  */
2191
2483
  export interface DeleteImageRecipeRequest {
2192
2484
  /**
2485
+ * @public
2193
2486
  * <p>The Amazon Resource Name (ARN) of the image recipe to delete.</p>
2194
2487
  */
2195
2488
  imageRecipeArn: string | undefined;
@@ -2199,10 +2492,12 @@ export interface DeleteImageRecipeRequest {
2199
2492
  */
2200
2493
  export interface DeleteImageRecipeResponse {
2201
2494
  /**
2495
+ * @public
2202
2496
  * <p>The request ID that uniquely identifies this request.</p>
2203
2497
  */
2204
2498
  requestId?: string;
2205
2499
  /**
2500
+ * @public
2206
2501
  * <p>The Amazon Resource Name (ARN) of the image recipe that was deleted.</p>
2207
2502
  */
2208
2503
  imageRecipeArn?: string;
@@ -2212,6 +2507,7 @@ export interface DeleteImageRecipeResponse {
2212
2507
  */
2213
2508
  export interface DeleteInfrastructureConfigurationRequest {
2214
2509
  /**
2510
+ * @public
2215
2511
  * <p>The Amazon Resource Name (ARN) of the infrastructure configuration to delete.</p>
2216
2512
  */
2217
2513
  infrastructureConfigurationArn: string | undefined;
@@ -2221,10 +2517,12 @@ export interface DeleteInfrastructureConfigurationRequest {
2221
2517
  */
2222
2518
  export interface DeleteInfrastructureConfigurationResponse {
2223
2519
  /**
2520
+ * @public
2224
2521
  * <p>The request ID that uniquely identifies this request.</p>
2225
2522
  */
2226
2523
  requestId?: string;
2227
2524
  /**
2525
+ * @public
2228
2526
  * <p>The Amazon Resource Name (ARN) of the infrastructure configuration that was
2229
2527
  * deleted.</p>
2230
2528
  */
@@ -2236,35 +2534,43 @@ export interface DeleteInfrastructureConfigurationResponse {
2236
2534
  */
2237
2535
  export interface DistributionConfiguration {
2238
2536
  /**
2537
+ * @public
2239
2538
  * <p>The Amazon Resource Name (ARN) of the distribution configuration.</p>
2240
2539
  */
2241
2540
  arn?: string;
2242
2541
  /**
2542
+ * @public
2243
2543
  * <p>The name of the distribution configuration.</p>
2244
2544
  */
2245
2545
  name?: string;
2246
2546
  /**
2547
+ * @public
2247
2548
  * <p>The description of the distribution configuration.</p>
2248
2549
  */
2249
2550
  description?: string;
2250
2551
  /**
2552
+ * @public
2251
2553
  * <p>The distribution objects that apply Region-specific settings for the deployment of the
2252
2554
  * image to targeted Regions.</p>
2253
2555
  */
2254
2556
  distributions?: Distribution[];
2255
2557
  /**
2558
+ * @public
2256
2559
  * <p>The maximum duration in minutes for this distribution configuration.</p>
2257
2560
  */
2258
2561
  timeoutMinutes: number | undefined;
2259
2562
  /**
2563
+ * @public
2260
2564
  * <p>The date on which this distribution configuration was created.</p>
2261
2565
  */
2262
2566
  dateCreated?: string;
2263
2567
  /**
2568
+ * @public
2264
2569
  * <p>The date on which this distribution configuration was last updated.</p>
2265
2570
  */
2266
2571
  dateUpdated?: string;
2267
2572
  /**
2573
+ * @public
2268
2574
  * <p>The tags of the distribution configuration.</p>
2269
2575
  */
2270
2576
  tags?: Record<string, string>;
@@ -2275,30 +2581,37 @@ export interface DistributionConfiguration {
2275
2581
  */
2276
2582
  export interface DistributionConfigurationSummary {
2277
2583
  /**
2584
+ * @public
2278
2585
  * <p>The Amazon Resource Name (ARN) of the distribution configuration.</p>
2279
2586
  */
2280
2587
  arn?: string;
2281
2588
  /**
2589
+ * @public
2282
2590
  * <p>The name of the distribution configuration.</p>
2283
2591
  */
2284
2592
  name?: string;
2285
2593
  /**
2594
+ * @public
2286
2595
  * <p>The description of the distribution configuration.</p>
2287
2596
  */
2288
2597
  description?: string;
2289
2598
  /**
2599
+ * @public
2290
2600
  * <p>The date on which the distribution configuration was created.</p>
2291
2601
  */
2292
2602
  dateCreated?: string;
2293
2603
  /**
2604
+ * @public
2294
2605
  * <p>The date on which the distribution configuration was updated.</p>
2295
2606
  */
2296
2607
  dateUpdated?: string;
2297
2608
  /**
2609
+ * @public
2298
2610
  * <p>The tags associated with the distribution configuration.</p>
2299
2611
  */
2300
2612
  tags?: Record<string, string>;
2301
2613
  /**
2614
+ * @public
2302
2615
  * <p>A list of Regions where the container image is distributed to.</p>
2303
2616
  */
2304
2617
  regions?: string[];
@@ -2311,10 +2624,12 @@ export interface DistributionConfigurationSummary {
2311
2624
  */
2312
2625
  export interface Filter {
2313
2626
  /**
2627
+ * @public
2314
2628
  * <p>The name of the filter. Filter names are case-sensitive.</p>
2315
2629
  */
2316
2630
  name?: string;
2317
2631
  /**
2632
+ * @public
2318
2633
  * <p>The filter values. Filter values are case-sensitive.</p>
2319
2634
  */
2320
2635
  values?: string[];
@@ -2324,6 +2639,7 @@ export interface Filter {
2324
2639
  */
2325
2640
  export interface GetComponentRequest {
2326
2641
  /**
2642
+ * @public
2327
2643
  * <p>The Amazon Resource Name (ARN) of the component that you want to get. Regex requires
2328
2644
  * the suffix <code>/\d+$</code>.</p>
2329
2645
  */
@@ -2334,10 +2650,12 @@ export interface GetComponentRequest {
2334
2650
  */
2335
2651
  export interface GetComponentResponse {
2336
2652
  /**
2653
+ * @public
2337
2654
  * <p>The request ID that uniquely identifies this request.</p>
2338
2655
  */
2339
2656
  requestId?: string;
2340
2657
  /**
2658
+ * @public
2341
2659
  * <p>The component object associated with the specified ARN.</p>
2342
2660
  */
2343
2661
  component?: Component;
@@ -2347,6 +2665,7 @@ export interface GetComponentResponse {
2347
2665
  */
2348
2666
  export interface GetComponentPolicyRequest {
2349
2667
  /**
2668
+ * @public
2350
2669
  * <p>The Amazon Resource Name (ARN) of the component whose policy you want to
2351
2670
  * retrieve.</p>
2352
2671
  */
@@ -2357,10 +2676,12 @@ export interface GetComponentPolicyRequest {
2357
2676
  */
2358
2677
  export interface GetComponentPolicyResponse {
2359
2678
  /**
2679
+ * @public
2360
2680
  * <p>The request ID that uniquely identifies this request.</p>
2361
2681
  */
2362
2682
  requestId?: string;
2363
2683
  /**
2684
+ * @public
2364
2685
  * <p>The component policy.</p>
2365
2686
  */
2366
2687
  policy?: string;
@@ -2382,6 +2703,7 @@ export declare class ResourceNotFoundException extends __BaseException {
2382
2703
  */
2383
2704
  export interface GetContainerRecipeRequest {
2384
2705
  /**
2706
+ * @public
2385
2707
  * <p>The Amazon Resource Name (ARN) of the container recipe to retrieve.</p>
2386
2708
  */
2387
2709
  containerRecipeArn: string | undefined;
@@ -2391,10 +2713,12 @@ export interface GetContainerRecipeRequest {
2391
2713
  */
2392
2714
  export interface GetContainerRecipeResponse {
2393
2715
  /**
2716
+ * @public
2394
2717
  * <p>The request ID that uniquely identifies this request.</p>
2395
2718
  */
2396
2719
  requestId?: string;
2397
2720
  /**
2721
+ * @public
2398
2722
  * <p>The container recipe object that is returned.</p>
2399
2723
  */
2400
2724
  containerRecipe?: ContainerRecipe;
@@ -2404,6 +2728,7 @@ export interface GetContainerRecipeResponse {
2404
2728
  */
2405
2729
  export interface GetContainerRecipePolicyRequest {
2406
2730
  /**
2731
+ * @public
2407
2732
  * <p>The Amazon Resource Name (ARN) of the container recipe for the policy being
2408
2733
  * requested.</p>
2409
2734
  */
@@ -2414,10 +2739,12 @@ export interface GetContainerRecipePolicyRequest {
2414
2739
  */
2415
2740
  export interface GetContainerRecipePolicyResponse {
2416
2741
  /**
2742
+ * @public
2417
2743
  * <p>The request ID that uniquely identifies this request.</p>
2418
2744
  */
2419
2745
  requestId?: string;
2420
2746
  /**
2747
+ * @public
2421
2748
  * <p>The container recipe policy object that is returned.</p>
2422
2749
  */
2423
2750
  policy?: string;
@@ -2427,6 +2754,7 @@ export interface GetContainerRecipePolicyResponse {
2427
2754
  */
2428
2755
  export interface GetDistributionConfigurationRequest {
2429
2756
  /**
2757
+ * @public
2430
2758
  * <p>The Amazon Resource Name (ARN) of the distribution configuration that you want to
2431
2759
  * retrieve.</p>
2432
2760
  */
@@ -2437,10 +2765,12 @@ export interface GetDistributionConfigurationRequest {
2437
2765
  */
2438
2766
  export interface GetDistributionConfigurationResponse {
2439
2767
  /**
2768
+ * @public
2440
2769
  * <p>The request ID that uniquely identifies this request.</p>
2441
2770
  */
2442
2771
  requestId?: string;
2443
2772
  /**
2773
+ * @public
2444
2774
  * <p>The distribution configuration object.</p>
2445
2775
  */
2446
2776
  distributionConfiguration?: DistributionConfiguration;
@@ -2450,6 +2780,7 @@ export interface GetDistributionConfigurationResponse {
2450
2780
  */
2451
2781
  export interface GetImageRequest {
2452
2782
  /**
2783
+ * @public
2453
2784
  * <p>The Amazon Resource Name (ARN) of the image that you want to get.</p>
2454
2785
  */
2455
2786
  imageBuildVersionArn: string | undefined;
@@ -2472,60 +2803,74 @@ export type ImageType = (typeof ImageType)[keyof typeof ImageType];
2472
2803
  */
2473
2804
  export interface ImageRecipe {
2474
2805
  /**
2806
+ * @public
2475
2807
  * <p>The Amazon Resource Name (ARN) of the image recipe.</p>
2476
2808
  */
2477
2809
  arn?: string;
2478
2810
  /**
2811
+ * @public
2479
2812
  * <p>Specifies which type of image is created by the recipe - an AMI or a container
2480
2813
  * image.</p>
2481
2814
  */
2482
2815
  type?: ImageType | string;
2483
2816
  /**
2817
+ * @public
2484
2818
  * <p>The name of the image recipe.</p>
2485
2819
  */
2486
2820
  name?: string;
2487
2821
  /**
2822
+ * @public
2488
2823
  * <p>The description of the image recipe.</p>
2489
2824
  */
2490
2825
  description?: string;
2491
2826
  /**
2827
+ * @public
2492
2828
  * <p>The platform of the image recipe.</p>
2493
2829
  */
2494
2830
  platform?: Platform | string;
2495
2831
  /**
2832
+ * @public
2496
2833
  * <p>The owner of the image recipe.</p>
2497
2834
  */
2498
2835
  owner?: string;
2499
2836
  /**
2837
+ * @public
2500
2838
  * <p>The version of the image recipe.</p>
2501
2839
  */
2502
2840
  version?: string;
2503
2841
  /**
2842
+ * @public
2504
2843
  * <p>The components that are included in the image recipe. Recipes require a minimum of one build component, and can
2505
2844
  * have a maximum of 20 build and test components in any combination.</p>
2506
2845
  */
2507
2846
  components?: ComponentConfiguration[];
2508
2847
  /**
2848
+ * @public
2509
2849
  * <p>The base image of the image recipe.</p>
2510
2850
  */
2511
2851
  parentImage?: string;
2512
2852
  /**
2853
+ * @public
2513
2854
  * <p>The block device mappings to apply when creating images from this recipe.</p>
2514
2855
  */
2515
2856
  blockDeviceMappings?: InstanceBlockDeviceMapping[];
2516
2857
  /**
2858
+ * @public
2517
2859
  * <p>The date on which this image recipe was created.</p>
2518
2860
  */
2519
2861
  dateCreated?: string;
2520
2862
  /**
2863
+ * @public
2521
2864
  * <p>The tags of the image recipe.</p>
2522
2865
  */
2523
2866
  tags?: Record<string, string>;
2524
2867
  /**
2868
+ * @public
2525
2869
  * <p>The working directory to be used during build and test workflows.</p>
2526
2870
  */
2527
2871
  workingDirectory?: string;
2528
2872
  /**
2873
+ * @public
2529
2874
  * <p>Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test
2530
2875
  * your image configuration. Instance configuration adds a layer of control over those
2531
2876
  * instances. You can define settings and add scripts to run when an instance is launched
@@ -2553,47 +2898,58 @@ export type ImageSource = (typeof ImageSource)[keyof typeof ImageSource];
2553
2898
  */
2554
2899
  export interface InfrastructureConfiguration {
2555
2900
  /**
2901
+ * @public
2556
2902
  * <p>The Amazon Resource Name (ARN) of the infrastructure configuration.</p>
2557
2903
  */
2558
2904
  arn?: string;
2559
2905
  /**
2906
+ * @public
2560
2907
  * <p>The name of the infrastructure configuration.</p>
2561
2908
  */
2562
2909
  name?: string;
2563
2910
  /**
2911
+ * @public
2564
2912
  * <p>The description of the infrastructure configuration.</p>
2565
2913
  */
2566
2914
  description?: string;
2567
2915
  /**
2916
+ * @public
2568
2917
  * <p>The instance types of the infrastructure configuration.</p>
2569
2918
  */
2570
2919
  instanceTypes?: string[];
2571
2920
  /**
2921
+ * @public
2572
2922
  * <p>The instance profile of the infrastructure configuration.</p>
2573
2923
  */
2574
2924
  instanceProfileName?: string;
2575
2925
  /**
2926
+ * @public
2576
2927
  * <p>The security group IDs of the infrastructure configuration.</p>
2577
2928
  */
2578
2929
  securityGroupIds?: string[];
2579
2930
  /**
2931
+ * @public
2580
2932
  * <p>The subnet ID of the infrastructure configuration.</p>
2581
2933
  */
2582
2934
  subnetId?: string;
2583
2935
  /**
2936
+ * @public
2584
2937
  * <p>The logging configuration of the infrastructure configuration.</p>
2585
2938
  */
2586
2939
  logging?: Logging;
2587
2940
  /**
2941
+ * @public
2588
2942
  * <p>The Amazon EC2 key pair of the infrastructure configuration.</p>
2589
2943
  */
2590
2944
  keyPair?: string;
2591
2945
  /**
2946
+ * @public
2592
2947
  * <p>The terminate instance on failure configuration of the infrastructure
2593
2948
  * configuration.</p>
2594
2949
  */
2595
2950
  terminateInstanceOnFailure?: boolean;
2596
2951
  /**
2952
+ * @public
2597
2953
  * <p>The Amazon Resource Name (ARN) for the SNS topic to which we send image build event
2598
2954
  * notifications.</p>
2599
2955
  * <note>
@@ -2604,22 +2960,27 @@ export interface InfrastructureConfiguration {
2604
2960
  */
2605
2961
  snsTopicArn?: string;
2606
2962
  /**
2963
+ * @public
2607
2964
  * <p>The date on which the infrastructure configuration was created.</p>
2608
2965
  */
2609
2966
  dateCreated?: string;
2610
2967
  /**
2968
+ * @public
2611
2969
  * <p>The date on which the infrastructure configuration was last updated.</p>
2612
2970
  */
2613
2971
  dateUpdated?: string;
2614
2972
  /**
2973
+ * @public
2615
2974
  * <p>The tags attached to the resource created by Image Builder.</p>
2616
2975
  */
2617
2976
  resourceTags?: Record<string, string>;
2618
2977
  /**
2978
+ * @public
2619
2979
  * <p>The instance metadata option settings for the infrastructure configuration.</p>
2620
2980
  */
2621
2981
  instanceMetadataOptions?: InstanceMetadataOptions;
2622
2982
  /**
2983
+ * @public
2623
2984
  * <p>The tags of the infrastructure configuration.</p>
2624
2985
  */
2625
2986
  tags?: Record<string, string>;
@@ -2630,10 +2991,12 @@ export interface InfrastructureConfiguration {
2630
2991
  */
2631
2992
  export interface OutputResources {
2632
2993
  /**
2994
+ * @public
2633
2995
  * <p>The Amazon EC2 AMIs created by this image.</p>
2634
2996
  */
2635
2997
  amis?: Ami[];
2636
2998
  /**
2999
+ * @public
2637
3000
  * <p>Container images that the pipeline has generated and stored in the output
2638
3001
  * repository.</p>
2639
3002
  */
@@ -2663,10 +3026,12 @@ export type ImageScanStatus = (typeof ImageScanStatus)[keyof typeof ImageScanSta
2663
3026
  */
2664
3027
  export interface ImageScanState {
2665
3028
  /**
3029
+ * @public
2666
3030
  * <p>The current state of vulnerability scans for the image.</p>
2667
3031
  */
2668
3032
  status?: ImageScanStatus | string;
2669
3033
  /**
3034
+ * @public
2670
3035
  * <p>The reason for the scan status for the image.</p>
2671
3036
  */
2672
3037
  reason?: string;
@@ -2679,6 +3044,7 @@ export interface ImageScanState {
2679
3044
  */
2680
3045
  export interface Image {
2681
3046
  /**
3047
+ * @public
2682
3048
  * <p>The Amazon Resource Name (ARN) of the image.</p>
2683
3049
  * <note>
2684
3050
  * <p>Semantic versioning is included in each object's Amazon Resource Name (ARN),
@@ -2699,14 +3065,17 @@ export interface Image {
2699
3065
  */
2700
3066
  arn?: string;
2701
3067
  /**
3068
+ * @public
2702
3069
  * <p>Specifies whether this image produces an AMI or a container image.</p>
2703
3070
  */
2704
3071
  type?: ImageType | string;
2705
3072
  /**
3073
+ * @public
2706
3074
  * <p>The name of the image.</p>
2707
3075
  */
2708
3076
  name?: string;
2709
3077
  /**
3078
+ * @public
2710
3079
  * <p>The semantic version of the image.</p>
2711
3080
  * <note>
2712
3081
  * <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
@@ -2728,66 +3097,81 @@ export interface Image {
2728
3097
  */
2729
3098
  version?: string;
2730
3099
  /**
3100
+ * @public
2731
3101
  * <p>The image operating system platform, such as Linux or Windows.</p>
2732
3102
  */
2733
3103
  platform?: Platform | string;
2734
3104
  /**
3105
+ * @public
2735
3106
  * <p>Indicates whether Image Builder collects additional information about the image, such as
2736
3107
  * the operating system (OS) version and package list.</p>
2737
3108
  */
2738
3109
  enhancedImageMetadataEnabled?: boolean;
2739
3110
  /**
3111
+ * @public
2740
3112
  * <p>The operating system version for instances that launch from this image. For example,
2741
3113
  * Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.</p>
2742
3114
  */
2743
3115
  osVersion?: string;
2744
3116
  /**
3117
+ * @public
2745
3118
  * <p>The state of the image.</p>
2746
3119
  */
2747
3120
  state?: ImageState;
2748
3121
  /**
3122
+ * @public
2749
3123
  * <p>For images that distribute an AMI, this is the image recipe that Image Builder used to
2750
3124
  * create the image. For container images, this is empty.</p>
2751
3125
  */
2752
3126
  imageRecipe?: ImageRecipe;
2753
3127
  /**
3128
+ * @public
2754
3129
  * <p>For container images, this is the container recipe that Image Builder used to create the
2755
3130
  * image. For images that distribute an AMI, this is empty.</p>
2756
3131
  */
2757
3132
  containerRecipe?: ContainerRecipe;
2758
3133
  /**
3134
+ * @public
2759
3135
  * <p>The name of the image pipeline that created this image.</p>
2760
3136
  */
2761
3137
  sourcePipelineName?: string;
2762
3138
  /**
3139
+ * @public
2763
3140
  * <p>The Amazon Resource Name (ARN) of the image pipeline that created this image.</p>
2764
3141
  */
2765
3142
  sourcePipelineArn?: string;
2766
3143
  /**
3144
+ * @public
2767
3145
  * <p>The infrastructure that Image Builder used to create this image.</p>
2768
3146
  */
2769
3147
  infrastructureConfiguration?: InfrastructureConfiguration;
2770
3148
  /**
3149
+ * @public
2771
3150
  * <p>The distribution configuration that Image Builder used to create this image.</p>
2772
3151
  */
2773
3152
  distributionConfiguration?: DistributionConfiguration;
2774
3153
  /**
3154
+ * @public
2775
3155
  * <p>The image tests that ran when that Image Builder created this image.</p>
2776
3156
  */
2777
3157
  imageTestsConfiguration?: ImageTestsConfiguration;
2778
3158
  /**
3159
+ * @public
2779
3160
  * <p>The date on which Image Builder created this image.</p>
2780
3161
  */
2781
3162
  dateCreated?: string;
2782
3163
  /**
3164
+ * @public
2783
3165
  * <p>The output resources that Image Builder produces for this image.</p>
2784
3166
  */
2785
3167
  outputResources?: OutputResources;
2786
3168
  /**
3169
+ * @public
2787
3170
  * <p>The tags that apply to this image.</p>
2788
3171
  */
2789
3172
  tags?: Record<string, string>;
2790
3173
  /**
3174
+ * @public
2791
3175
  * <p>Indicates the type of build that created this image. The build can be initiated in the
2792
3176
  * following ways:</p>
2793
3177
  * <ul>
@@ -2810,14 +3194,17 @@ export interface Image {
2810
3194
  */
2811
3195
  buildType?: BuildType | string;
2812
3196
  /**
3197
+ * @public
2813
3198
  * <p>The origin of the base image that Image Builder used to build this image.</p>
2814
3199
  */
2815
3200
  imageSource?: ImageSource | string;
2816
3201
  /**
3202
+ * @public
2817
3203
  * <p>Contains information about the current state of scans for this image.</p>
2818
3204
  */
2819
3205
  scanState?: ImageScanState;
2820
3206
  /**
3207
+ * @public
2821
3208
  * <p>Contains settings for vulnerability scans.</p>
2822
3209
  */
2823
3210
  imageScanningConfiguration?: ImageScanningConfiguration;
@@ -2827,10 +3214,12 @@ export interface Image {
2827
3214
  */
2828
3215
  export interface GetImageResponse {
2829
3216
  /**
3217
+ * @public
2830
3218
  * <p>The request ID that uniquely identifies this request.</p>
2831
3219
  */
2832
3220
  requestId?: string;
2833
3221
  /**
3222
+ * @public
2834
3223
  * <p>The image object.</p>
2835
3224
  */
2836
3225
  image?: Image;
@@ -2840,6 +3229,7 @@ export interface GetImageResponse {
2840
3229
  */
2841
3230
  export interface GetImagePipelineRequest {
2842
3231
  /**
3232
+ * @public
2843
3233
  * <p>The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve.</p>
2844
3234
  */
2845
3235
  imagePipelineArn: string | undefined;
@@ -2850,80 +3240,98 @@ export interface GetImagePipelineRequest {
2850
3240
  */
2851
3241
  export interface ImagePipeline {
2852
3242
  /**
3243
+ * @public
2853
3244
  * <p>The Amazon Resource Name (ARN) of the image pipeline.</p>
2854
3245
  */
2855
3246
  arn?: string;
2856
3247
  /**
3248
+ * @public
2857
3249
  * <p>The name of the image pipeline.</p>
2858
3250
  */
2859
3251
  name?: string;
2860
3252
  /**
3253
+ * @public
2861
3254
  * <p>The description of the image pipeline.</p>
2862
3255
  */
2863
3256
  description?: string;
2864
3257
  /**
3258
+ * @public
2865
3259
  * <p>The platform of the image pipeline.</p>
2866
3260
  */
2867
3261
  platform?: Platform | string;
2868
3262
  /**
3263
+ * @public
2869
3264
  * <p>Collects additional information about the image being created, including the operating
2870
3265
  * system (OS) version and package list. This information is used to enhance the overall
2871
3266
  * experience of using EC2 Image Builder. Enabled by default.</p>
2872
3267
  */
2873
3268
  enhancedImageMetadataEnabled?: boolean;
2874
3269
  /**
3270
+ * @public
2875
3271
  * <p>The Amazon Resource Name (ARN) of the image recipe associated with this image
2876
3272
  * pipeline.</p>
2877
3273
  */
2878
3274
  imageRecipeArn?: string;
2879
3275
  /**
3276
+ * @public
2880
3277
  * <p>The Amazon Resource Name (ARN) of the container recipe that is used for this
2881
3278
  * pipeline.</p>
2882
3279
  */
2883
3280
  containerRecipeArn?: string;
2884
3281
  /**
3282
+ * @public
2885
3283
  * <p>The Amazon Resource Name (ARN) of the infrastructure configuration associated with
2886
3284
  * this image pipeline.</p>
2887
3285
  */
2888
3286
  infrastructureConfigurationArn?: string;
2889
3287
  /**
3288
+ * @public
2890
3289
  * <p>The Amazon Resource Name (ARN) of the distribution configuration associated with this
2891
3290
  * image pipeline.</p>
2892
3291
  */
2893
3292
  distributionConfigurationArn?: string;
2894
3293
  /**
3294
+ * @public
2895
3295
  * <p>The image tests configuration of the image pipeline.</p>
2896
3296
  */
2897
3297
  imageTestsConfiguration?: ImageTestsConfiguration;
2898
3298
  /**
3299
+ * @public
2899
3300
  * <p>The schedule of the image pipeline.</p>
2900
3301
  */
2901
3302
  schedule?: Schedule;
2902
3303
  /**
3304
+ * @public
2903
3305
  * <p>The status of the image pipeline.</p>
2904
3306
  */
2905
3307
  status?: PipelineStatus | string;
2906
3308
  /**
3309
+ * @public
2907
3310
  * <p>The date on which this image pipeline was created.</p>
2908
3311
  */
2909
3312
  dateCreated?: string;
2910
3313
  /**
3314
+ * @public
2911
3315
  * <p>The date on which this image pipeline was last updated.</p>
2912
3316
  */
2913
3317
  dateUpdated?: string;
2914
3318
  /**
3319
+ * @public
2915
3320
  * <p>This is no longer supported, and does not return a value.</p>
2916
3321
  */
2917
3322
  dateLastRun?: string;
2918
3323
  /**
3324
+ * @public
2919
3325
  * <p>The next date when the pipeline is scheduled to run.</p>
2920
3326
  */
2921
3327
  dateNextRun?: string;
2922
3328
  /**
3329
+ * @public
2923
3330
  * <p>The tags of this image pipeline.</p>
2924
3331
  */
2925
3332
  tags?: Record<string, string>;
2926
3333
  /**
3334
+ * @public
2927
3335
  * <p>Contains settings for vulnerability scans.</p>
2928
3336
  */
2929
3337
  imageScanningConfiguration?: ImageScanningConfiguration;
@@ -2933,10 +3341,12 @@ export interface ImagePipeline {
2933
3341
  */
2934
3342
  export interface GetImagePipelineResponse {
2935
3343
  /**
3344
+ * @public
2936
3345
  * <p>The request ID that uniquely identifies this request.</p>
2937
3346
  */
2938
3347
  requestId?: string;
2939
3348
  /**
3349
+ * @public
2940
3350
  * <p>The image pipeline object.</p>
2941
3351
  */
2942
3352
  imagePipeline?: ImagePipeline;
@@ -2946,6 +3356,7 @@ export interface GetImagePipelineResponse {
2946
3356
  */
2947
3357
  export interface GetImagePolicyRequest {
2948
3358
  /**
3359
+ * @public
2949
3360
  * <p>The Amazon Resource Name (ARN) of the image whose policy you want to retrieve.</p>
2950
3361
  */
2951
3362
  imageArn: string | undefined;
@@ -2955,10 +3366,12 @@ export interface GetImagePolicyRequest {
2955
3366
  */
2956
3367
  export interface GetImagePolicyResponse {
2957
3368
  /**
3369
+ * @public
2958
3370
  * <p>The request ID that uniquely identifies this request.</p>
2959
3371
  */
2960
3372
  requestId?: string;
2961
3373
  /**
3374
+ * @public
2962
3375
  * <p>The image policy object.</p>
2963
3376
  */
2964
3377
  policy?: string;
@@ -2968,6 +3381,7 @@ export interface GetImagePolicyResponse {
2968
3381
  */
2969
3382
  export interface GetImageRecipeRequest {
2970
3383
  /**
3384
+ * @public
2971
3385
  * <p>The Amazon Resource Name (ARN) of the image recipe that you want to retrieve.</p>
2972
3386
  */
2973
3387
  imageRecipeArn: string | undefined;
@@ -2977,10 +3391,12 @@ export interface GetImageRecipeRequest {
2977
3391
  */
2978
3392
  export interface GetImageRecipeResponse {
2979
3393
  /**
3394
+ * @public
2980
3395
  * <p>The request ID that uniquely identifies this request.</p>
2981
3396
  */
2982
3397
  requestId?: string;
2983
3398
  /**
3399
+ * @public
2984
3400
  * <p>The image recipe object.</p>
2985
3401
  */
2986
3402
  imageRecipe?: ImageRecipe;
@@ -2990,6 +3406,7 @@ export interface GetImageRecipeResponse {
2990
3406
  */
2991
3407
  export interface GetImageRecipePolicyRequest {
2992
3408
  /**
3409
+ * @public
2993
3410
  * <p>The Amazon Resource Name (ARN) of the image recipe whose policy you want to
2994
3411
  * retrieve.</p>
2995
3412
  */
@@ -3000,10 +3417,12 @@ export interface GetImageRecipePolicyRequest {
3000
3417
  */
3001
3418
  export interface GetImageRecipePolicyResponse {
3002
3419
  /**
3420
+ * @public
3003
3421
  * <p>The request ID that uniquely identifies this request.</p>
3004
3422
  */
3005
3423
  requestId?: string;
3006
3424
  /**
3425
+ * @public
3007
3426
  * <p>The image recipe policy object.</p>
3008
3427
  */
3009
3428
  policy?: string;
@@ -3014,6 +3433,7 @@ export interface GetImageRecipePolicyResponse {
3014
3433
  */
3015
3434
  export interface GetInfrastructureConfigurationRequest {
3016
3435
  /**
3436
+ * @public
3017
3437
  * <p>The Amazon Resource Name (ARN) of the infrastructure configuration that you want to
3018
3438
  * retrieve.</p>
3019
3439
  */
@@ -3025,10 +3445,12 @@ export interface GetInfrastructureConfigurationRequest {
3025
3445
  */
3026
3446
  export interface GetInfrastructureConfigurationResponse {
3027
3447
  /**
3448
+ * @public
3028
3449
  * <p>The request ID that uniquely identifies this request.</p>
3029
3450
  */
3030
3451
  requestId?: string;
3031
3452
  /**
3453
+ * @public
3032
3454
  * <p>The infrastructure configuration object.</p>
3033
3455
  */
3034
3456
  infrastructureConfiguration?: InfrastructureConfiguration;
@@ -3038,6 +3460,7 @@ export interface GetInfrastructureConfigurationResponse {
3038
3460
  */
3039
3461
  export interface GetWorkflowExecutionRequest {
3040
3462
  /**
3463
+ * @public
3041
3464
  * <p>Use the unique identifier for a runtime instance of the workflow to get
3042
3465
  * runtime details.</p>
3043
3466
  */
@@ -3078,62 +3501,75 @@ export type WorkflowType = (typeof WorkflowType)[keyof typeof WorkflowType];
3078
3501
  */
3079
3502
  export interface GetWorkflowExecutionResponse {
3080
3503
  /**
3504
+ * @public
3081
3505
  * <p>The request ID that uniquely identifies this request.</p>
3082
3506
  */
3083
3507
  requestId?: string;
3084
3508
  /**
3509
+ * @public
3085
3510
  * <p>The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource
3086
3511
  * that defines the specified runtime instance of the workflow.</p>
3087
3512
  */
3088
3513
  workflowBuildVersionArn?: string;
3089
3514
  /**
3515
+ * @public
3090
3516
  * <p>The unique identifier that Image Builder assigned to keep track of runtime details
3091
3517
  * when it ran the workflow.</p>
3092
3518
  */
3093
3519
  workflowExecutionId?: string;
3094
3520
  /**
3521
+ * @public
3095
3522
  * <p>The Amazon Resource Name (ARN) of the image resource build version that the specified
3096
3523
  * runtime instance of the workflow created.</p>
3097
3524
  */
3098
3525
  imageBuildVersionArn?: string;
3099
3526
  /**
3527
+ * @public
3100
3528
  * <p>The type of workflow that Image Builder ran for the specified runtime instance of the workflow.</p>
3101
3529
  */
3102
3530
  type?: WorkflowType | string;
3103
3531
  /**
3532
+ * @public
3104
3533
  * <p>The current runtime status for the specified runtime instance of the workflow.</p>
3105
3534
  */
3106
3535
  status?: WorkflowExecutionStatus | string;
3107
3536
  /**
3537
+ * @public
3108
3538
  * <p>The output message from the specified runtime instance of the workflow, if applicable.</p>
3109
3539
  */
3110
3540
  message?: string;
3111
3541
  /**
3542
+ * @public
3112
3543
  * <p>The total number of steps in the specified runtime instance of the workflow that ran.
3113
3544
  * This number should equal the sum of the step counts for steps that succeeded, were skipped,
3114
3545
  * and failed.</p>
3115
3546
  */
3116
3547
  totalStepCount?: number;
3117
3548
  /**
3549
+ * @public
3118
3550
  * <p>A runtime count for the number of steps that ran successfully in the specified runtime
3119
3551
  * instance of the workflow.</p>
3120
3552
  */
3121
3553
  totalStepsSucceeded?: number;
3122
3554
  /**
3555
+ * @public
3123
3556
  * <p>A runtime count for the number of steps that failed in the specified runtime instance
3124
3557
  * of the workflow.</p>
3125
3558
  */
3126
3559
  totalStepsFailed?: number;
3127
3560
  /**
3561
+ * @public
3128
3562
  * <p>A runtime count for the number of steps that were skipped in the specified runtime
3129
3563
  * instance of the workflow.</p>
3130
3564
  */
3131
3565
  totalStepsSkipped?: number;
3132
3566
  /**
3567
+ * @public
3133
3568
  * <p>The timestamp when the specified runtime instance of the workflow started.</p>
3134
3569
  */
3135
3570
  startTime?: string;
3136
3571
  /**
3572
+ * @public
3137
3573
  * <p>The timestamp when the specified runtime instance of the workflow finished.</p>
3138
3574
  */
3139
3575
  endTime?: string;
@@ -3143,6 +3579,7 @@ export interface GetWorkflowExecutionResponse {
3143
3579
  */
3144
3580
  export interface GetWorkflowStepExecutionRequest {
3145
3581
  /**
3582
+ * @public
3146
3583
  * <p>Use the unique identifier for a specific runtime instance of the workflow step to
3147
3584
  * get runtime details for that step.</p>
3148
3585
  */
@@ -3182,76 +3619,93 @@ export type WorkflowStepExecutionStatus = (typeof WorkflowStepExecutionStatus)[k
3182
3619
  */
3183
3620
  export interface GetWorkflowStepExecutionResponse {
3184
3621
  /**
3622
+ * @public
3185
3623
  * <p>The request ID that uniquely identifies this request.</p>
3186
3624
  */
3187
3625
  requestId?: string;
3188
3626
  /**
3627
+ * @public
3189
3628
  * <p>The unique identifier for the runtime version of the workflow step that you specified
3190
3629
  * in the request.</p>
3191
3630
  */
3192
3631
  stepExecutionId?: string;
3193
3632
  /**
3633
+ * @public
3194
3634
  * <p>The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource
3195
3635
  * that defines this workflow step.</p>
3196
3636
  */
3197
3637
  workflowBuildVersionArn?: string;
3198
3638
  /**
3639
+ * @public
3199
3640
  * <p>The unique identifier that Image Builder assigned to keep track of runtime details
3200
3641
  * when it ran the workflow.</p>
3201
3642
  */
3202
3643
  workflowExecutionId?: string;
3203
3644
  /**
3645
+ * @public
3204
3646
  * <p>The Amazon Resource Name (ARN) of the image resource build version that the specified
3205
3647
  * runtime instance of the workflow step creates.</p>
3206
3648
  */
3207
3649
  imageBuildVersionArn?: string;
3208
3650
  /**
3651
+ * @public
3209
3652
  * <p>The name of the specified runtime instance of the workflow step.</p>
3210
3653
  */
3211
3654
  name?: string;
3212
3655
  /**
3656
+ * @public
3213
3657
  * <p>Describes the specified workflow step.</p>
3214
3658
  */
3215
3659
  description?: string;
3216
3660
  /**
3661
+ * @public
3217
3662
  * <p>The name of the action that the specified step performs.</p>
3218
3663
  */
3219
3664
  action?: string;
3220
3665
  /**
3666
+ * @public
3221
3667
  * <p>The current status for the specified runtime version of the workflow step.</p>
3222
3668
  */
3223
3669
  status?: WorkflowStepExecutionStatus | string;
3224
3670
  /**
3671
+ * @public
3225
3672
  * <p>Reports on the rollback status of the specified runtime version of the workflow step,
3226
3673
  * if applicable.</p>
3227
3674
  */
3228
3675
  rollbackStatus?: WorkflowStepExecutionRollbackStatus | string;
3229
3676
  /**
3677
+ * @public
3230
3678
  * <p>The output message from the specified runtime instance of the workflow step, if applicable.</p>
3231
3679
  */
3232
3680
  message?: string;
3233
3681
  /**
3682
+ * @public
3234
3683
  * <p>Input parameters that Image Builder provided for the specified runtime instance of
3235
3684
  * the workflow step.</p>
3236
3685
  */
3237
3686
  inputs?: string;
3238
3687
  /**
3688
+ * @public
3239
3689
  * <p>The file names that the specified runtime version of the workflow step created as output.</p>
3240
3690
  */
3241
3691
  outputs?: string;
3242
3692
  /**
3693
+ * @public
3243
3694
  * <p>The timestamp when the specified runtime version of the workflow step started.</p>
3244
3695
  */
3245
3696
  startTime?: string;
3246
3697
  /**
3698
+ * @public
3247
3699
  * <p>The timestamp when the specified runtime instance of the workflow step finished.</p>
3248
3700
  */
3249
3701
  endTime?: string;
3250
3702
  /**
3703
+ * @public
3251
3704
  * <p>The action to perform if the workflow step fails.</p>
3252
3705
  */
3253
3706
  onFailure?: string;
3254
3707
  /**
3708
+ * @public
3255
3709
  * <p>The maximum duration in seconds for this step to complete its action.</p>
3256
3710
  */
3257
3711
  timeoutSeconds?: number;
@@ -3262,10 +3716,12 @@ export interface GetWorkflowStepExecutionResponse {
3262
3716
  */
3263
3717
  export interface ImageAggregation {
3264
3718
  /**
3719
+ * @public
3265
3720
  * <p>The Amazon Resource Name (ARN) that identifies the image for this aggregation.</p>
3266
3721
  */
3267
3722
  imageBuildVersionArn?: string;
3268
3723
  /**
3724
+ * @public
3269
3725
  * <p>Counts by severity level for medium severity and higher level findings, plus a total
3270
3726
  * for all of the findings for the specified image.</p>
3271
3727
  */
@@ -3276,10 +3732,12 @@ export interface ImageAggregation {
3276
3732
  */
3277
3733
  export interface ImportComponentRequest {
3278
3734
  /**
3735
+ * @public
3279
3736
  * <p>The name of the component.</p>
3280
3737
  */
3281
3738
  name: string | undefined;
3282
3739
  /**
3740
+ * @public
3283
3741
  * <p>The semantic version of the component. This version follows the semantic version
3284
3742
  * syntax.</p>
3285
3743
  * <note>
@@ -3294,34 +3752,41 @@ export interface ImportComponentRequest {
3294
3752
  */
3295
3753
  semanticVersion: string | undefined;
3296
3754
  /**
3755
+ * @public
3297
3756
  * <p>The description of the component. Describes the contents of the component.</p>
3298
3757
  */
3299
3758
  description?: string;
3300
3759
  /**
3760
+ * @public
3301
3761
  * <p>The change description of the component. This description indicates the change that
3302
3762
  * has been made in this version, or what makes this version different from other versions
3303
3763
  * of this component.</p>
3304
3764
  */
3305
3765
  changeDescription?: string;
3306
3766
  /**
3767
+ * @public
3307
3768
  * <p>The type of the component denotes whether the component is used to build the image, or
3308
3769
  * only to test it.</p>
3309
3770
  */
3310
3771
  type: ComponentType | string | undefined;
3311
3772
  /**
3773
+ * @public
3312
3774
  * <p>The format of the resource that you want to import as a component.</p>
3313
3775
  */
3314
3776
  format: ComponentFormat | string | undefined;
3315
3777
  /**
3778
+ * @public
3316
3779
  * <p>The platform of the component.</p>
3317
3780
  */
3318
3781
  platform: Platform | string | undefined;
3319
3782
  /**
3783
+ * @public
3320
3784
  * <p>The data of the component. Used to specify the data inline. Either <code>data</code>
3321
3785
  * or <code>uri</code> can be used to specify the data within the component.</p>
3322
3786
  */
3323
3787
  data?: string;
3324
3788
  /**
3789
+ * @public
3325
3790
  * <p>The uri of the component. Must be an Amazon S3 URL and the requester must have permission
3326
3791
  * to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your
3327
3792
  * service quota. Either <code>data</code> or <code>uri</code> can be used to specify the
@@ -3329,14 +3794,17 @@ export interface ImportComponentRequest {
3329
3794
  */
3330
3795
  uri?: string;
3331
3796
  /**
3797
+ * @public
3332
3798
  * <p>The ID of the KMS key that should be used to encrypt this component.</p>
3333
3799
  */
3334
3800
  kmsKeyId?: string;
3335
3801
  /**
3802
+ * @public
3336
3803
  * <p>The tags of the component.</p>
3337
3804
  */
3338
3805
  tags?: Record<string, string>;
3339
3806
  /**
3807
+ * @public
3340
3808
  * <p>The idempotency token of the component.</p>
3341
3809
  */
3342
3810
  clientToken?: string;
@@ -3346,14 +3814,17 @@ export interface ImportComponentRequest {
3346
3814
  */
3347
3815
  export interface ImportComponentResponse {
3348
3816
  /**
3817
+ * @public
3349
3818
  * <p>The request ID that uniquely identifies this request.</p>
3350
3819
  */
3351
3820
  requestId?: string;
3352
3821
  /**
3822
+ * @public
3353
3823
  * <p>The idempotency token used to make this request idempotent.</p>
3354
3824
  */
3355
3825
  clientToken?: string;
3356
3826
  /**
3827
+ * @public
3357
3828
  * <p>The Amazon Resource Name (ARN) of the imported component.</p>
3358
3829
  */
3359
3830
  componentBuildVersionArn?: string;
@@ -3363,10 +3834,12 @@ export interface ImportComponentResponse {
3363
3834
  */
3364
3835
  export interface ImportVmImageRequest {
3365
3836
  /**
3837
+ * @public
3366
3838
  * <p>The name of the base image that is created by the import process.</p>
3367
3839
  */
3368
3840
  name: string | undefined;
3369
3841
  /**
3842
+ * @public
3370
3843
  * <p>The semantic version to attach to the base image that was created during the import
3371
3844
  * process. This version follows the semantic version syntax.</p>
3372
3845
  * <note>
@@ -3384,28 +3857,34 @@ export interface ImportVmImageRequest {
3384
3857
  */
3385
3858
  semanticVersion: string | undefined;
3386
3859
  /**
3860
+ * @public
3387
3861
  * <p>The description for the base image that is created by the import process.</p>
3388
3862
  */
3389
3863
  description?: string;
3390
3864
  /**
3865
+ * @public
3391
3866
  * <p>The operating system platform for the imported VM.</p>
3392
3867
  */
3393
3868
  platform: Platform | string | undefined;
3394
3869
  /**
3870
+ * @public
3395
3871
  * <p>The operating system version for the imported VM.</p>
3396
3872
  */
3397
3873
  osVersion?: string;
3398
3874
  /**
3875
+ * @public
3399
3876
  * <p>The <code>importTaskId</code> (API) or <code>ImportTaskId</code> (CLI) from the
3400
3877
  * Amazon EC2 VM import process. Image Builder retrieves information from the import process to pull in
3401
3878
  * the AMI that is created from the VM source as the base image for your recipe.</p>
3402
3879
  */
3403
3880
  vmImportTaskId: string | undefined;
3404
3881
  /**
3882
+ * @public
3405
3883
  * <p>Tags that are attached to the import resources.</p>
3406
3884
  */
3407
3885
  tags?: Record<string, string>;
3408
3886
  /**
3887
+ * @public
3409
3888
  * <p>Unique, case-sensitive identifier you provide to ensure
3410
3889
  * idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>
3411
3890
  * in the <i>Amazon EC2 API Reference</i>.</p>
@@ -3417,15 +3896,18 @@ export interface ImportVmImageRequest {
3417
3896
  */
3418
3897
  export interface ImportVmImageResponse {
3419
3898
  /**
3899
+ * @public
3420
3900
  * <p>The request ID that uniquely identifies this request.</p>
3421
3901
  */
3422
3902
  requestId?: string;
3423
3903
  /**
3904
+ * @public
3424
3905
  * <p>The Amazon Resource Name (ARN) of the AMI that was created during the VM import
3425
3906
  * process. This AMI is used as the base image for the recipe that imported the VM.</p>
3426
3907
  */
3427
3908
  imageArn?: string;
3428
3909
  /**
3910
+ * @public
3429
3911
  * <p>The idempotency token that was used for this request.</p>
3430
3912
  */
3431
3913
  clientToken?: string;
@@ -3447,15 +3929,18 @@ export declare class InvalidPaginationTokenException extends __BaseException {
3447
3929
  */
3448
3930
  export interface ListComponentBuildVersionsRequest {
3449
3931
  /**
3932
+ * @public
3450
3933
  * <p>The component version Amazon Resource Name (ARN) whose versions you want to
3451
3934
  * list.</p>
3452
3935
  */
3453
3936
  componentVersionArn: string | undefined;
3454
3937
  /**
3938
+ * @public
3455
3939
  * <p>The maximum items to return in a request.</p>
3456
3940
  */
3457
3941
  maxResults?: number;
3458
3942
  /**
3943
+ * @public
3459
3944
  * <p>A token to specify where to start paginating. This is the NextToken
3460
3945
  * from a previously truncated response.</p>
3461
3946
  */
@@ -3466,14 +3951,17 @@ export interface ListComponentBuildVersionsRequest {
3466
3951
  */
3467
3952
  export interface ListComponentBuildVersionsResponse {
3468
3953
  /**
3954
+ * @public
3469
3955
  * <p>The request ID that uniquely identifies this request.</p>
3470
3956
  */
3471
3957
  requestId?: string;
3472
3958
  /**
3959
+ * @public
3473
3960
  * <p>The list of component summaries for the specified semantic version.</p>
3474
3961
  */
3475
3962
  componentSummaryList?: ComponentSummary[];
3476
3963
  /**
3964
+ * @public
3477
3965
  * <p>The next token used for paginated responses. When this field isn't empty,
3478
3966
  * there are additional elements that the service has'ot included in this request. Use this token
3479
3967
  * with the next request to retrieve additional objects.</p>
@@ -3499,6 +3987,7 @@ export type Ownership = (typeof Ownership)[keyof typeof Ownership];
3499
3987
  */
3500
3988
  export interface ListComponentsRequest {
3501
3989
  /**
3990
+ * @public
3502
3991
  * <p>Filters results based on the type of owner for the component. By default, this request
3503
3992
  * returns a list of components that your account owns. To see results for other types of
3504
3993
  * owners, you can specify components that Amazon manages, third party components, or
@@ -3506,6 +3995,7 @@ export interface ListComponentsRequest {
3506
3995
  */
3507
3996
  owner?: Ownership | string;
3508
3997
  /**
3998
+ * @public
3509
3999
  * <p>Use the following filters to streamline results:</p>
3510
4000
  * <ul>
3511
4001
  * <li>
@@ -3542,14 +4032,17 @@ export interface ListComponentsRequest {
3542
4032
  */
3543
4033
  filters?: Filter[];
3544
4034
  /**
4035
+ * @public
3545
4036
  * <p>Returns the list of components for the specified name.</p>
3546
4037
  */
3547
4038
  byName?: boolean;
3548
4039
  /**
4040
+ * @public
3549
4041
  * <p>The maximum items to return in a request.</p>
3550
4042
  */
3551
4043
  maxResults?: number;
3552
4044
  /**
4045
+ * @public
3553
4046
  * <p>A token to specify where to start paginating. This is the NextToken
3554
4047
  * from a previously truncated response.</p>
3555
4048
  */
@@ -3560,10 +4053,12 @@ export interface ListComponentsRequest {
3560
4053
  */
3561
4054
  export interface ListComponentsResponse {
3562
4055
  /**
4056
+ * @public
3563
4057
  * <p>The request ID that uniquely identifies this request.</p>
3564
4058
  */
3565
4059
  requestId?: string;
3566
4060
  /**
4061
+ * @public
3567
4062
  * <p>The list of component semantic versions.</p>
3568
4063
  * <note>
3569
4064
  * <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
@@ -3572,6 +4067,7 @@ export interface ListComponentsResponse {
3572
4067
  */
3573
4068
  componentVersionList?: ComponentVersion[];
3574
4069
  /**
4070
+ * @public
3575
4071
  * <p>The next token used for paginated responses. When this field isn't empty,
3576
4072
  * there are additional elements that the service has'ot included in this request. Use this token
3577
4073
  * with the next request to retrieve additional objects.</p>
@@ -3583,12 +4079,14 @@ export interface ListComponentsResponse {
3583
4079
  */
3584
4080
  export interface ListContainerRecipesRequest {
3585
4081
  /**
4082
+ * @public
3586
4083
  * <p>Returns container recipes belonging to the specified owner, that have been shared with
3587
4084
  * you. You can omit this field to return container recipes belonging to your
3588
4085
  * account.</p>
3589
4086
  */
3590
4087
  owner?: Ownership | string;
3591
4088
  /**
4089
+ * @public
3592
4090
  * <p>Use the following filters to streamline results:</p>
3593
4091
  * <ul>
3594
4092
  * <li>
@@ -3615,10 +4113,12 @@ export interface ListContainerRecipesRequest {
3615
4113
  */
3616
4114
  filters?: Filter[];
3617
4115
  /**
4116
+ * @public
3618
4117
  * <p>The maximum items to return in a request.</p>
3619
4118
  */
3620
4119
  maxResults?: number;
3621
4120
  /**
4121
+ * @public
3622
4122
  * <p>A token to specify where to start paginating. This is the NextToken
3623
4123
  * from a previously truncated response.</p>
3624
4124
  */
@@ -3629,14 +4129,17 @@ export interface ListContainerRecipesRequest {
3629
4129
  */
3630
4130
  export interface ListContainerRecipesResponse {
3631
4131
  /**
4132
+ * @public
3632
4133
  * <p>The request ID that uniquely identifies this request.</p>
3633
4134
  */
3634
4135
  requestId?: string;
3635
4136
  /**
4137
+ * @public
3636
4138
  * <p>The list of container recipes returned for the request.</p>
3637
4139
  */
3638
4140
  containerRecipeSummaryList?: ContainerRecipeSummary[];
3639
4141
  /**
4142
+ * @public
3640
4143
  * <p>The next token used for paginated responses. When this field isn't empty,
3641
4144
  * there are additional elements that the service has'ot included in this request. Use this token
3642
4145
  * with the next request to retrieve additional objects.</p>
@@ -3648,14 +4151,17 @@ export interface ListContainerRecipesResponse {
3648
4151
  */
3649
4152
  export interface ListDistributionConfigurationsRequest {
3650
4153
  /**
4154
+ * @public
3651
4155
  * <p>You can filter on <code>name</code> to streamline results.</p>
3652
4156
  */
3653
4157
  filters?: Filter[];
3654
4158
  /**
4159
+ * @public
3655
4160
  * <p>The maximum items to return in a request.</p>
3656
4161
  */
3657
4162
  maxResults?: number;
3658
4163
  /**
4164
+ * @public
3659
4165
  * <p>A token to specify where to start paginating. This is the NextToken
3660
4166
  * from a previously truncated response.</p>
3661
4167
  */
@@ -3666,14 +4172,17 @@ export interface ListDistributionConfigurationsRequest {
3666
4172
  */
3667
4173
  export interface ListDistributionConfigurationsResponse {
3668
4174
  /**
4175
+ * @public
3669
4176
  * <p>The request ID that uniquely identifies this request.</p>
3670
4177
  */
3671
4178
  requestId?: string;
3672
4179
  /**
4180
+ * @public
3673
4181
  * <p>The list of distributions.</p>
3674
4182
  */
3675
4183
  distributionConfigurationSummaryList?: DistributionConfigurationSummary[];
3676
4184
  /**
4185
+ * @public
3677
4186
  * <p>The next token used for paginated responses. When this field isn't empty,
3678
4187
  * there are additional elements that the service has'ot included in this request. Use this token
3679
4188
  * with the next request to retrieve additional objects.</p>
@@ -3685,11 +4194,13 @@ export interface ListDistributionConfigurationsResponse {
3685
4194
  */
3686
4195
  export interface ListImageBuildVersionsRequest {
3687
4196
  /**
4197
+ * @public
3688
4198
  * <p>The Amazon Resource Name (ARN) of the image whose build versions you want to
3689
4199
  * retrieve.</p>
3690
4200
  */
3691
4201
  imageVersionArn: string | undefined;
3692
4202
  /**
4203
+ * @public
3693
4204
  * <p>Use the following filters to streamline results:</p>
3694
4205
  * <ul>
3695
4206
  * <li>
@@ -3721,10 +4232,12 @@ export interface ListImageBuildVersionsRequest {
3721
4232
  */
3722
4233
  filters?: Filter[];
3723
4234
  /**
4235
+ * @public
3724
4236
  * <p>The maximum items to return in a request.</p>
3725
4237
  */
3726
4238
  maxResults?: number;
3727
4239
  /**
4240
+ * @public
3728
4241
  * <p>A token to specify where to start paginating. This is the NextToken
3729
4242
  * from a previously truncated response.</p>
3730
4243
  */
@@ -3736,51 +4249,63 @@ export interface ListImageBuildVersionsRequest {
3736
4249
  */
3737
4250
  export interface ImageSummary {
3738
4251
  /**
4252
+ * @public
3739
4253
  * <p>The Amazon Resource Name (ARN) of the image.</p>
3740
4254
  */
3741
4255
  arn?: string;
3742
4256
  /**
4257
+ * @public
3743
4258
  * <p>The name of the image.</p>
3744
4259
  */
3745
4260
  name?: string;
3746
4261
  /**
4262
+ * @public
3747
4263
  * <p>Specifies whether this image produces an AMI or a container image.</p>
3748
4264
  */
3749
4265
  type?: ImageType | string;
3750
4266
  /**
4267
+ * @public
3751
4268
  * <p>The version of the image.</p>
3752
4269
  */
3753
4270
  version?: string;
3754
4271
  /**
4272
+ * @public
3755
4273
  * <p>The image operating system platform, such as Linux or Windows.</p>
3756
4274
  */
3757
4275
  platform?: Platform | string;
3758
4276
  /**
4277
+ * @public
3759
4278
  * <p>The operating system version of the instances that launch from this image. For
3760
4279
  * example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.</p>
3761
4280
  */
3762
4281
  osVersion?: string;
3763
4282
  /**
4283
+ * @public
3764
4284
  * <p>The state of the image.</p>
3765
4285
  */
3766
4286
  state?: ImageState;
3767
4287
  /**
4288
+ * @public
3768
4289
  * <p>The owner of the image.</p>
3769
4290
  */
3770
4291
  owner?: string;
3771
4292
  /**
4293
+ * @public
3772
4294
  * <p>The date on which Image Builder created this image.</p>
3773
4295
  */
3774
4296
  dateCreated?: string;
3775
4297
  /**
4298
+ * @public
3776
4299
  * <p>The output resources that Image Builder produced when it created this image.</p>
3777
4300
  */
3778
4301
  outputResources?: OutputResources;
3779
4302
  /**
4303
+ * @public
3780
4304
  * <p>The tags that apply to this image.</p>
3781
4305
  */
3782
4306
  tags?: Record<string, string>;
3783
4307
  /**
4308
+ * @public
3784
4309
  * <p>Indicates the type of build that created this image. The build can be initiated in the
3785
4310
  * following ways:</p>
3786
4311
  * <ul>
@@ -3803,6 +4328,7 @@ export interface ImageSummary {
3803
4328
  */
3804
4329
  buildType?: BuildType | string;
3805
4330
  /**
4331
+ * @public
3806
4332
  * <p>The origin of the base image that Image Builder used to build this image.</p>
3807
4333
  */
3808
4334
  imageSource?: ImageSource | string;
@@ -3812,14 +4338,17 @@ export interface ImageSummary {
3812
4338
  */
3813
4339
  export interface ListImageBuildVersionsResponse {
3814
4340
  /**
4341
+ * @public
3815
4342
  * <p>The request ID that uniquely identifies this request.</p>
3816
4343
  */
3817
4344
  requestId?: string;
3818
4345
  /**
4346
+ * @public
3819
4347
  * <p>The list of image build versions.</p>
3820
4348
  */
3821
4349
  imageSummaryList?: ImageSummary[];
3822
4350
  /**
4351
+ * @public
3823
4352
  * <p>The next token used for paginated responses. When this field isn't empty,
3824
4353
  * there are additional elements that the service has'ot included in this request. Use this token
3825
4354
  * with the next request to retrieve additional objects.</p>
@@ -3831,14 +4360,17 @@ export interface ListImageBuildVersionsResponse {
3831
4360
  */
3832
4361
  export interface ListImagePackagesRequest {
3833
4362
  /**
4363
+ * @public
3834
4364
  * <p>Filter results for the ListImagePackages request by the Image Build Version ARN</p>
3835
4365
  */
3836
4366
  imageBuildVersionArn: string | undefined;
3837
4367
  /**
4368
+ * @public
3838
4369
  * <p>The maximum items to return in a request.</p>
3839
4370
  */
3840
4371
  maxResults?: number;
3841
4372
  /**
4373
+ * @public
3842
4374
  * <p>A token to specify where to start paginating. This is the NextToken
3843
4375
  * from a previously truncated response.</p>
3844
4376
  */
@@ -3850,10 +4382,12 @@ export interface ListImagePackagesRequest {
3850
4382
  */
3851
4383
  export interface ImagePackage {
3852
4384
  /**
4385
+ * @public
3853
4386
  * <p>The name of the package as reported to the operating system package manager.</p>
3854
4387
  */
3855
4388
  packageName?: string;
3856
4389
  /**
4390
+ * @public
3857
4391
  * <p>The version of the package as reported to the operating system package manager.</p>
3858
4392
  */
3859
4393
  packageVersion?: string;
@@ -3863,14 +4397,17 @@ export interface ImagePackage {
3863
4397
  */
3864
4398
  export interface ListImagePackagesResponse {
3865
4399
  /**
4400
+ * @public
3866
4401
  * <p>The request ID that uniquely identifies this request.</p>
3867
4402
  */
3868
4403
  requestId?: string;
3869
4404
  /**
4405
+ * @public
3870
4406
  * <p>The list of Image Packages returned in the response.</p>
3871
4407
  */
3872
4408
  imagePackageList?: ImagePackage[];
3873
4409
  /**
4410
+ * @public
3874
4411
  * <p>The next token used for paginated responses. When this field isn't empty,
3875
4412
  * there are additional elements that the service has'ot included in this request. Use this token
3876
4413
  * with the next request to retrieve additional objects.</p>
@@ -3882,11 +4419,13 @@ export interface ListImagePackagesResponse {
3882
4419
  */
3883
4420
  export interface ListImagePipelineImagesRequest {
3884
4421
  /**
4422
+ * @public
3885
4423
  * <p>The Amazon Resource Name (ARN) of the image pipeline whose images you want to
3886
4424
  * view.</p>
3887
4425
  */
3888
4426
  imagePipelineArn: string | undefined;
3889
4427
  /**
4428
+ * @public
3890
4429
  * <p>Use the following filters to streamline results:</p>
3891
4430
  * <ul>
3892
4431
  * <li>
@@ -3903,10 +4442,12 @@ export interface ListImagePipelineImagesRequest {
3903
4442
  */
3904
4443
  filters?: Filter[];
3905
4444
  /**
4445
+ * @public
3906
4446
  * <p>The maximum items to return in a request.</p>
3907
4447
  */
3908
4448
  maxResults?: number;
3909
4449
  /**
4450
+ * @public
3910
4451
  * <p>A token to specify where to start paginating. This is the NextToken
3911
4452
  * from a previously truncated response.</p>
3912
4453
  */
@@ -3917,14 +4458,17 @@ export interface ListImagePipelineImagesRequest {
3917
4458
  */
3918
4459
  export interface ListImagePipelineImagesResponse {
3919
4460
  /**
4461
+ * @public
3920
4462
  * <p>The request ID that uniquely identifies this request.</p>
3921
4463
  */
3922
4464
  requestId?: string;
3923
4465
  /**
4466
+ * @public
3924
4467
  * <p>The list of images built by this pipeline.</p>
3925
4468
  */
3926
4469
  imageSummaryList?: ImageSummary[];
3927
4470
  /**
4471
+ * @public
3928
4472
  * <p>The next token used for paginated responses. When this field isn't empty,
3929
4473
  * there are additional elements that the service has'ot included in this request. Use this token
3930
4474
  * with the next request to retrieve additional objects.</p>
@@ -3936,6 +4480,7 @@ export interface ListImagePipelineImagesResponse {
3936
4480
  */
3937
4481
  export interface ListImagePipelinesRequest {
3938
4482
  /**
4483
+ * @public
3939
4484
  * <p>Use the following filters to streamline results:</p>
3940
4485
  * <ul>
3941
4486
  * <li>
@@ -3972,10 +4517,12 @@ export interface ListImagePipelinesRequest {
3972
4517
  */
3973
4518
  filters?: Filter[];
3974
4519
  /**
4520
+ * @public
3975
4521
  * <p>The maximum items to return in a request.</p>
3976
4522
  */
3977
4523
  maxResults?: number;
3978
4524
  /**
4525
+ * @public
3979
4526
  * <p>A token to specify where to start paginating. This is the NextToken
3980
4527
  * from a previously truncated response.</p>
3981
4528
  */
@@ -3986,14 +4533,17 @@ export interface ListImagePipelinesRequest {
3986
4533
  */
3987
4534
  export interface ListImagePipelinesResponse {
3988
4535
  /**
4536
+ * @public
3989
4537
  * <p>The request ID that uniquely identifies this request.</p>
3990
4538
  */
3991
4539
  requestId?: string;
3992
4540
  /**
4541
+ * @public
3993
4542
  * <p>The list of image pipelines.</p>
3994
4543
  */
3995
4544
  imagePipelineList?: ImagePipeline[];
3996
4545
  /**
4546
+ * @public
3997
4547
  * <p>The next token used for paginated responses. When this field isn't empty,
3998
4548
  * there are additional elements that the service has'ot included in this request. Use this token
3999
4549
  * with the next request to retrieve additional objects.</p>
@@ -4005,6 +4555,7 @@ export interface ListImagePipelinesResponse {
4005
4555
  */
4006
4556
  export interface ListImageRecipesRequest {
4007
4557
  /**
4558
+ * @public
4008
4559
  * <p>The owner defines which image recipes you want to list. By default, this request will
4009
4560
  * only show image recipes owned by your account. You can use this field to specify if you
4010
4561
  * want to view image recipes owned by yourself, by Amazon, or those image recipes that
@@ -4012,6 +4563,7 @@ export interface ListImageRecipesRequest {
4012
4563
  */
4013
4564
  owner?: Ownership | string;
4014
4565
  /**
4566
+ * @public
4015
4567
  * <p>Use the following filters to streamline results:</p>
4016
4568
  * <ul>
4017
4569
  * <li>
@@ -4033,10 +4585,12 @@ export interface ListImageRecipesRequest {
4033
4585
  */
4034
4586
  filters?: Filter[];
4035
4587
  /**
4588
+ * @public
4036
4589
  * <p>The maximum items to return in a request.</p>
4037
4590
  */
4038
4591
  maxResults?: number;
4039
4592
  /**
4593
+ * @public
4040
4594
  * <p>A token to specify where to start paginating. This is the NextToken
4041
4595
  * from a previously truncated response.</p>
4042
4596
  */
@@ -4048,30 +4602,37 @@ export interface ListImageRecipesRequest {
4048
4602
  */
4049
4603
  export interface ImageRecipeSummary {
4050
4604
  /**
4605
+ * @public
4051
4606
  * <p>The Amazon Resource Name (ARN) of the image recipe.</p>
4052
4607
  */
4053
4608
  arn?: string;
4054
4609
  /**
4610
+ * @public
4055
4611
  * <p>The name of the image recipe.</p>
4056
4612
  */
4057
4613
  name?: string;
4058
4614
  /**
4615
+ * @public
4059
4616
  * <p>The platform of the image recipe.</p>
4060
4617
  */
4061
4618
  platform?: Platform | string;
4062
4619
  /**
4620
+ * @public
4063
4621
  * <p>The owner of the image recipe.</p>
4064
4622
  */
4065
4623
  owner?: string;
4066
4624
  /**
4625
+ * @public
4067
4626
  * <p>The base image of the image recipe.</p>
4068
4627
  */
4069
4628
  parentImage?: string;
4070
4629
  /**
4630
+ * @public
4071
4631
  * <p>The date on which this image recipe was created.</p>
4072
4632
  */
4073
4633
  dateCreated?: string;
4074
4634
  /**
4635
+ * @public
4075
4636
  * <p>The tags of the image recipe.</p>
4076
4637
  */
4077
4638
  tags?: Record<string, string>;
@@ -4081,14 +4642,17 @@ export interface ImageRecipeSummary {
4081
4642
  */
4082
4643
  export interface ListImageRecipesResponse {
4083
4644
  /**
4645
+ * @public
4084
4646
  * <p>The request ID that uniquely identifies this request.</p>
4085
4647
  */
4086
4648
  requestId?: string;
4087
4649
  /**
4650
+ * @public
4088
4651
  * <p>The list of image pipelines.</p>
4089
4652
  */
4090
4653
  imageRecipeSummaryList?: ImageRecipeSummary[];
4091
4654
  /**
4655
+ * @public
4092
4656
  * <p>The next token used for paginated responses. When this field isn't empty,
4093
4657
  * there are additional elements that the service has'ot included in this request. Use this token
4094
4658
  * with the next request to retrieve additional objects.</p>
@@ -4100,6 +4664,7 @@ export interface ListImageRecipesResponse {
4100
4664
  */
4101
4665
  export interface ListImagesRequest {
4102
4666
  /**
4667
+ * @public
4103
4668
  * <p>The owner defines which images you want to list. By default, this request will only
4104
4669
  * show images owned by your account. You can use this field to specify if you want to view
4105
4670
  * images owned by yourself, by Amazon, or those images that have been shared with you by
@@ -4107,6 +4672,7 @@ export interface ListImagesRequest {
4107
4672
  */
4108
4673
  owner?: Ownership | string;
4109
4674
  /**
4675
+ * @public
4110
4676
  * <p>Use the following filters to streamline results:</p>
4111
4677
  * <ul>
4112
4678
  * <li>
@@ -4138,19 +4704,23 @@ export interface ListImagesRequest {
4138
4704
  */
4139
4705
  filters?: Filter[];
4140
4706
  /**
4707
+ * @public
4141
4708
  * <p>Requests a list of images with a specific recipe name.</p>
4142
4709
  */
4143
4710
  byName?: boolean;
4144
4711
  /**
4712
+ * @public
4145
4713
  * <p>The maximum items to return in a request.</p>
4146
4714
  */
4147
4715
  maxResults?: number;
4148
4716
  /**
4717
+ * @public
4149
4718
  * <p>A token to specify where to start paginating. This is the NextToken
4150
4719
  * from a previously truncated response.</p>
4151
4720
  */
4152
4721
  nextToken?: string;
4153
4722
  /**
4723
+ * @public
4154
4724
  * <p>Includes deprecated images in the response list.</p>
4155
4725
  */
4156
4726
  includeDeprecated?: boolean;
@@ -4161,6 +4731,7 @@ export interface ListImagesRequest {
4161
4731
  */
4162
4732
  export interface ImageVersion {
4163
4733
  /**
4734
+ * @public
4164
4735
  * <p>The Amazon Resource Name (ARN) of a specific version of an Image Builder image.</p>
4165
4736
  * <note>
4166
4737
  * <p>Semantic versioning is included in each object's Amazon Resource Name (ARN),
@@ -4181,14 +4752,17 @@ export interface ImageVersion {
4181
4752
  */
4182
4753
  arn?: string;
4183
4754
  /**
4755
+ * @public
4184
4756
  * <p>The name of this specific version of an Image Builder image.</p>
4185
4757
  */
4186
4758
  name?: string;
4187
4759
  /**
4760
+ * @public
4188
4761
  * <p>Specifies whether this image produces an AMI or a container image.</p>
4189
4762
  */
4190
4763
  type?: ImageType | string;
4191
4764
  /**
4765
+ * @public
4192
4766
  * <p>Details for a specific version of an Image Builder image. This version follows the semantic
4193
4767
  * version syntax.</p>
4194
4768
  * <note>
@@ -4211,24 +4785,29 @@ export interface ImageVersion {
4211
4785
  */
4212
4786
  version?: string;
4213
4787
  /**
4788
+ * @public
4214
4789
  * <p>The operating system platform of the image version, for example "Windows" or
4215
4790
  * "Linux".</p>
4216
4791
  */
4217
4792
  platform?: Platform | string;
4218
4793
  /**
4794
+ * @public
4219
4795
  * <p>The operating system version of the Amazon EC2 build instance. For example, Amazon Linux 2,
4220
4796
  * Ubuntu 18, or Microsoft Windows Server 2019.</p>
4221
4797
  */
4222
4798
  osVersion?: string;
4223
4799
  /**
4800
+ * @public
4224
4801
  * <p>The owner of the image version.</p>
4225
4802
  */
4226
4803
  owner?: string;
4227
4804
  /**
4805
+ * @public
4228
4806
  * <p>The date on which this specific version of the Image Builder image was created.</p>
4229
4807
  */
4230
4808
  dateCreated?: string;
4231
4809
  /**
4810
+ * @public
4232
4811
  * <p>Indicates the type of build that created this image. The build can be initiated in the
4233
4812
  * following ways:</p>
4234
4813
  * <ul>
@@ -4251,6 +4830,7 @@ export interface ImageVersion {
4251
4830
  */
4252
4831
  buildType?: BuildType | string;
4253
4832
  /**
4833
+ * @public
4254
4834
  * <p>The origin of the base image that Image Builder used to build this image.</p>
4255
4835
  */
4256
4836
  imageSource?: ImageSource | string;
@@ -4260,10 +4840,12 @@ export interface ImageVersion {
4260
4840
  */
4261
4841
  export interface ListImagesResponse {
4262
4842
  /**
4843
+ * @public
4263
4844
  * <p>The request ID that uniquely identifies this request.</p>
4264
4845
  */
4265
4846
  requestId?: string;
4266
4847
  /**
4848
+ * @public
4267
4849
  * <p>The list of image semantic versions.</p>
4268
4850
  * <note>
4269
4851
  * <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
@@ -4277,6 +4859,7 @@ export interface ListImagesResponse {
4277
4859
  */
4278
4860
  imageVersionList?: ImageVersion[];
4279
4861
  /**
4862
+ * @public
4280
4863
  * <p>The next token used for paginated responses. When this field isn't empty,
4281
4864
  * there are additional elements that the service has'ot included in this request. Use this token
4282
4865
  * with the next request to retrieve additional objects.</p>
@@ -4288,12 +4871,14 @@ export interface ListImagesResponse {
4288
4871
  */
4289
4872
  export interface ListImageScanFindingAggregationsRequest {
4290
4873
  /**
4874
+ * @public
4291
4875
  * <p>A filter name and value pair that is used to return a more specific list of results
4292
4876
  * from a list operation. Filters can be used to match a set of resources by specific
4293
4877
  * criteria, such as tags, attributes, or IDs.</p>
4294
4878
  */
4295
4879
  filter?: Filter;
4296
4880
  /**
4881
+ * @public
4297
4882
  * <p>A token to specify where to start paginating. This is the NextToken
4298
4883
  * from a previously truncated response.</p>
4299
4884
  */
@@ -4305,11 +4890,13 @@ export interface ListImageScanFindingAggregationsRequest {
4305
4890
  */
4306
4891
  export interface ImagePipelineAggregation {
4307
4892
  /**
4893
+ * @public
4308
4894
  * <p>The Amazon Resource Name (ARN) that identifies the image pipeline for this
4309
4895
  * aggregation.</p>
4310
4896
  */
4311
4897
  imagePipelineArn?: string;
4312
4898
  /**
4899
+ * @public
4313
4900
  * <p>Counts by severity level for medium severity and higher level findings, plus a total
4314
4901
  * for all of the findings for the specified image pipeline.</p>
4315
4902
  */
@@ -4321,10 +4908,12 @@ export interface ImagePipelineAggregation {
4321
4908
  */
4322
4909
  export interface VulnerabilityIdAggregation {
4323
4910
  /**
4911
+ * @public
4324
4912
  * <p>The vulnerability Id for this set of counts.</p>
4325
4913
  */
4326
4914
  vulnerabilityId?: string;
4327
4915
  /**
4916
+ * @public
4328
4917
  * <p>Counts by severity level for medium severity and higher level findings, plus a total
4329
4918
  * for all of the findings for the specified vulnerability.</p>
4330
4919
  */
@@ -4337,19 +4926,23 @@ export interface VulnerabilityIdAggregation {
4337
4926
  */
4338
4927
  export interface ImageScanFindingAggregation {
4339
4928
  /**
4929
+ * @public
4340
4930
  * <p>Returns an object that contains severity counts based on an account ID.</p>
4341
4931
  */
4342
4932
  accountAggregation?: AccountAggregation;
4343
4933
  /**
4934
+ * @public
4344
4935
  * <p>Returns an object that contains severity counts based on the Amazon Resource Name
4345
4936
  * (ARN) for a specific image.</p>
4346
4937
  */
4347
4938
  imageAggregation?: ImageAggregation;
4348
4939
  /**
4940
+ * @public
4349
4941
  * <p>Returns an object that contains severity counts based on an image pipeline ARN.</p>
4350
4942
  */
4351
4943
  imagePipelineAggregation?: ImagePipelineAggregation;
4352
4944
  /**
4945
+ * @public
4353
4946
  * <p>Returns an object that contains severity counts based on vulnerability ID.</p>
4354
4947
  */
4355
4948
  vulnerabilityIdAggregation?: VulnerabilityIdAggregation;
@@ -4359,10 +4952,12 @@ export interface ImageScanFindingAggregation {
4359
4952
  */
4360
4953
  export interface ListImageScanFindingAggregationsResponse {
4361
4954
  /**
4955
+ * @public
4362
4956
  * <p>The request ID that uniquely identifies this request.</p>
4363
4957
  */
4364
4958
  requestId?: string;
4365
4959
  /**
4960
+ * @public
4366
4961
  * <p>The aggregation type specifies what type of key is used to group the image scan
4367
4962
  * findings. Image Builder returns results based on the request filter. If you didn't specify a
4368
4963
  * filter in the request, the type defaults to <code>accountId</code>.</p>
@@ -4388,10 +4983,12 @@ export interface ListImageScanFindingAggregationsResponse {
4388
4983
  */
4389
4984
  aggregationType?: string;
4390
4985
  /**
4986
+ * @public
4391
4987
  * <p>An array of image scan finding aggregations that match the filter criteria.</p>
4392
4988
  */
4393
4989
  responses?: ImageScanFindingAggregation[];
4394
4990
  /**
4991
+ * @public
4395
4992
  * <p>The next token used for paginated responses. When this field isn't empty,
4396
4993
  * there are additional elements that the service has'ot included in this request. Use this token
4397
4994
  * with the next request to retrieve additional objects.</p>
@@ -4405,10 +5002,12 @@ export interface ListImageScanFindingAggregationsResponse {
4405
5002
  */
4406
5003
  export interface ImageScanFindingsFilter {
4407
5004
  /**
5005
+ * @public
4408
5006
  * <p>The name of the image scan finding filter. Filter names are case-sensitive.</p>
4409
5007
  */
4410
5008
  name?: string;
4411
5009
  /**
5010
+ * @public
4412
5011
  * <p>The filter values. Filter values are case-sensitive.</p>
4413
5012
  */
4414
5013
  values?: string[];
@@ -4418,6 +5017,7 @@ export interface ImageScanFindingsFilter {
4418
5017
  */
4419
5018
  export interface ListImageScanFindingsRequest {
4420
5019
  /**
5020
+ * @public
4421
5021
  * <p>An array of name value pairs that you can use to filter your results. You can use the
4422
5022
  * following filters to streamline results:</p>
4423
5023
  * <ul>
@@ -4446,10 +5046,12 @@ export interface ListImageScanFindingsRequest {
4446
5046
  */
4447
5047
  filters?: ImageScanFindingsFilter[];
4448
5048
  /**
5049
+ * @public
4449
5050
  * <p>The maximum items to return in a request.</p>
4450
5051
  */
4451
5052
  maxResults?: number;
4452
5053
  /**
5054
+ * @public
4453
5055
  * <p>A token to specify where to start paginating. This is the NextToken
4454
5056
  * from a previously truncated response.</p>
4455
5057
  */
@@ -4462,6 +5064,7 @@ export interface ListImageScanFindingsRequest {
4462
5064
  */
4463
5065
  export interface InspectorScoreDetails {
4464
5066
  /**
5067
+ * @public
4465
5068
  * <p>An object that contains details about an adjustment that Amazon Inspector made to the CVSS score
4466
5069
  * for the finding.</p>
4467
5070
  */
@@ -4473,42 +5076,52 @@ export interface InspectorScoreDetails {
4473
5076
  */
4474
5077
  export interface VulnerablePackage {
4475
5078
  /**
5079
+ * @public
4476
5080
  * <p>The name of the vulnerable package.</p>
4477
5081
  */
4478
5082
  name?: string;
4479
5083
  /**
5084
+ * @public
4480
5085
  * <p>The version of the vulnerable package.</p>
4481
5086
  */
4482
5087
  version?: string;
4483
5088
  /**
5089
+ * @public
4484
5090
  * <p>The source layer hash of the vulnerable package.</p>
4485
5091
  */
4486
5092
  sourceLayerHash?: string;
4487
5093
  /**
5094
+ * @public
4488
5095
  * <p>The epoch of the vulnerable package.</p>
4489
5096
  */
4490
5097
  epoch?: number;
4491
5098
  /**
5099
+ * @public
4492
5100
  * <p>The release of the vulnerable package.</p>
4493
5101
  */
4494
5102
  release?: string;
4495
5103
  /**
5104
+ * @public
4496
5105
  * <p>The architecture of the vulnerable package.</p>
4497
5106
  */
4498
5107
  arch?: string;
4499
5108
  /**
5109
+ * @public
4500
5110
  * <p>The package manager of the vulnerable package.</p>
4501
5111
  */
4502
5112
  packageManager?: string;
4503
5113
  /**
5114
+ * @public
4504
5115
  * <p>The file path of the vulnerable package.</p>
4505
5116
  */
4506
5117
  filePath?: string;
4507
5118
  /**
5119
+ * @public
4508
5120
  * <p>The version of the package that contains the vulnerability fix.</p>
4509
5121
  */
4510
5122
  fixedInVersion?: string;
4511
5123
  /**
5124
+ * @public
4512
5125
  * <p>The code to run in your environment to update packages with a fix available.</p>
4513
5126
  */
4514
5127
  remediation?: string;
@@ -4519,45 +5132,55 @@ export interface VulnerablePackage {
4519
5132
  */
4520
5133
  export interface PackageVulnerabilityDetails {
4521
5134
  /**
5135
+ * @public
4522
5136
  * <p>A unique identifier for this vulnerability.</p>
4523
5137
  */
4524
5138
  vulnerabilityId: string | undefined;
4525
5139
  /**
5140
+ * @public
4526
5141
  * <p>The packages that this vulnerability impacts.</p>
4527
5142
  */
4528
5143
  vulnerablePackages?: VulnerablePackage[];
4529
5144
  /**
5145
+ * @public
4530
5146
  * <p>The source of the vulnerability information.</p>
4531
5147
  */
4532
5148
  source?: string;
4533
5149
  /**
5150
+ * @public
4534
5151
  * <p>CVSS scores for one or more vulnerabilities that Amazon Inspector identified for a
4535
5152
  * package.</p>
4536
5153
  */
4537
5154
  cvss?: CvssScore[];
4538
5155
  /**
5156
+ * @public
4539
5157
  * <p>Vulnerabilities that are often related to the findings for the package.</p>
4540
5158
  */
4541
5159
  relatedVulnerabilities?: string[];
4542
5160
  /**
5161
+ * @public
4543
5162
  * <p>A link to the source of the vulnerability information.</p>
4544
5163
  */
4545
5164
  sourceUrl?: string;
4546
5165
  /**
5166
+ * @public
4547
5167
  * <p>The severity that the vendor assigned to this vulnerability type.</p>
4548
5168
  */
4549
5169
  vendorSeverity?: string;
4550
5170
  /**
5171
+ * @public
4551
5172
  * <p>The date and time when this vulnerability was first added to the vendor's
4552
5173
  * database.</p>
4553
5174
  */
4554
5175
  vendorCreatedAt?: Date;
4555
5176
  /**
5177
+ * @public
4556
5178
  * <p>The date and time when the vendor last updated this vulnerability in their
4557
5179
  * database.</p>
4558
5180
  */
4559
5181
  vendorUpdatedAt?: Date;
4560
5182
  /**
5183
+ * @public
4561
5184
  * <p>Links to web pages that contain details about the vulnerabilities that Amazon Inspector
4562
5185
  * identified for the package.</p>
4563
5186
  */
@@ -4569,10 +5192,12 @@ export interface PackageVulnerabilityDetails {
4569
5192
  */
4570
5193
  export interface RemediationRecommendation {
4571
5194
  /**
5195
+ * @public
4572
5196
  * <p>The recommended course of action to remediate the finding.</p>
4573
5197
  */
4574
5198
  text?: string;
4575
5199
  /**
5200
+ * @public
4576
5201
  * <p>A link to more information about the recommended remediation for this
4577
5202
  * vulnerability.</p>
4578
5203
  */
@@ -4584,6 +5209,7 @@ export interface RemediationRecommendation {
4584
5209
  */
4585
5210
  export interface Remediation {
4586
5211
  /**
5212
+ * @public
4587
5213
  * <p>An object that contains information about the recommended course of action to
4588
5214
  * remediate the finding.</p>
4589
5215
  */
@@ -4595,62 +5221,76 @@ export interface Remediation {
4595
5221
  */
4596
5222
  export interface ImageScanFinding {
4597
5223
  /**
5224
+ * @public
4598
5225
  * <p>The Amazon Web Services account ID that's associated with the finding.</p>
4599
5226
  */
4600
5227
  awsAccountId?: string;
4601
5228
  /**
5229
+ * @public
4602
5230
  * <p>The Amazon Resource Name (ARN) of the image build version that's associated with the
4603
5231
  * finding.</p>
4604
5232
  */
4605
5233
  imageBuildVersionArn?: string;
4606
5234
  /**
5235
+ * @public
4607
5236
  * <p>The Amazon Resource Name (ARN) of the image pipeline that's associated with the
4608
5237
  * finding.</p>
4609
5238
  */
4610
5239
  imagePipelineArn?: string;
4611
5240
  /**
5241
+ * @public
4612
5242
  * <p>The type of the finding. Image Builder looks for findings of the type
4613
5243
  * <code>PACKAGE_VULNERABILITY</code> that apply to output images, and excludes other
4614
5244
  * types.</p>
4615
5245
  */
4616
5246
  type?: string;
4617
5247
  /**
5248
+ * @public
4618
5249
  * <p>The description of the finding.</p>
4619
5250
  */
4620
5251
  description?: string;
4621
5252
  /**
5253
+ * @public
4622
5254
  * <p>The title of the finding.</p>
4623
5255
  */
4624
5256
  title?: string;
4625
5257
  /**
5258
+ * @public
4626
5259
  * <p>An object that contains the details about how to remediate the finding.</p>
4627
5260
  */
4628
5261
  remediation?: Remediation;
4629
5262
  /**
5263
+ * @public
4630
5264
  * <p>The severity of the finding.</p>
4631
5265
  */
4632
5266
  severity?: string;
4633
5267
  /**
5268
+ * @public
4634
5269
  * <p>The date and time when the finding was first observed.</p>
4635
5270
  */
4636
5271
  firstObservedAt?: Date;
4637
5272
  /**
5273
+ * @public
4638
5274
  * <p>The timestamp when the finding was last updated.</p>
4639
5275
  */
4640
5276
  updatedAt?: Date;
4641
5277
  /**
5278
+ * @public
4642
5279
  * <p>The score that Amazon Inspector assigned for the finding.</p>
4643
5280
  */
4644
5281
  inspectorScore?: number;
4645
5282
  /**
5283
+ * @public
4646
5284
  * <p>An object that contains details of the Amazon Inspector score.</p>
4647
5285
  */
4648
5286
  inspectorScoreDetails?: InspectorScoreDetails;
4649
5287
  /**
5288
+ * @public
4650
5289
  * <p>An object that contains the details of a package vulnerability finding.</p>
4651
5290
  */
4652
5291
  packageVulnerabilityDetails?: PackageVulnerabilityDetails;
4653
5292
  /**
5293
+ * @public
4654
5294
  * <p>Details about whether a fix is available for any of the packages that are identified
4655
5295
  * in the finding through a version update.</p>
4656
5296
  */
@@ -4661,15 +5301,18 @@ export interface ImageScanFinding {
4661
5301
  */
4662
5302
  export interface ListImageScanFindingsResponse {
4663
5303
  /**
5304
+ * @public
4664
5305
  * <p>The request ID that uniquely identifies this request.</p>
4665
5306
  */
4666
5307
  requestId?: string;
4667
5308
  /**
5309
+ * @public
4668
5310
  * <p>The image scan findings for your account that meet your request filter
4669
5311
  * criteria.</p>
4670
5312
  */
4671
5313
  findings?: ImageScanFinding[];
4672
5314
  /**
5315
+ * @public
4673
5316
  * <p>The next token used for paginated responses. When this field isn't empty,
4674
5317
  * there are additional elements that the service has'ot included in this request. Use this token
4675
5318
  * with the next request to retrieve additional objects.</p>
@@ -4681,14 +5324,17 @@ export interface ListImageScanFindingsResponse {
4681
5324
  */
4682
5325
  export interface ListInfrastructureConfigurationsRequest {
4683
5326
  /**
5327
+ * @public
4684
5328
  * <p>You can filter on <code>name</code> to streamline results.</p>
4685
5329
  */
4686
5330
  filters?: Filter[];
4687
5331
  /**
5332
+ * @public
4688
5333
  * <p>The maximum items to return in a request.</p>
4689
5334
  */
4690
5335
  maxResults?: number;
4691
5336
  /**
5337
+ * @public
4692
5338
  * <p>A token to specify where to start paginating. This is the NextToken
4693
5339
  * from a previously truncated response.</p>
4694
5340
  */
@@ -4700,38 +5346,47 @@ export interface ListInfrastructureConfigurationsRequest {
4700
5346
  */
4701
5347
  export interface InfrastructureConfigurationSummary {
4702
5348
  /**
5349
+ * @public
4703
5350
  * <p>The Amazon Resource Name (ARN) of the infrastructure configuration.</p>
4704
5351
  */
4705
5352
  arn?: string;
4706
5353
  /**
5354
+ * @public
4707
5355
  * <p>The name of the infrastructure configuration.</p>
4708
5356
  */
4709
5357
  name?: string;
4710
5358
  /**
5359
+ * @public
4711
5360
  * <p>The description of the infrastructure configuration.</p>
4712
5361
  */
4713
5362
  description?: string;
4714
5363
  /**
5364
+ * @public
4715
5365
  * <p>The date on which the infrastructure configuration was created.</p>
4716
5366
  */
4717
5367
  dateCreated?: string;
4718
5368
  /**
5369
+ * @public
4719
5370
  * <p>The date on which the infrastructure configuration was last updated.</p>
4720
5371
  */
4721
5372
  dateUpdated?: string;
4722
5373
  /**
5374
+ * @public
4723
5375
  * <p>The tags attached to the image created by Image Builder.</p>
4724
5376
  */
4725
5377
  resourceTags?: Record<string, string>;
4726
5378
  /**
5379
+ * @public
4727
5380
  * <p>The tags of the infrastructure configuration.</p>
4728
5381
  */
4729
5382
  tags?: Record<string, string>;
4730
5383
  /**
5384
+ * @public
4731
5385
  * <p>The instance types of the infrastructure configuration.</p>
4732
5386
  */
4733
5387
  instanceTypes?: string[];
4734
5388
  /**
5389
+ * @public
4735
5390
  * <p>The instance profile of the infrastructure configuration.</p>
4736
5391
  */
4737
5392
  instanceProfileName?: string;
@@ -4741,14 +5396,17 @@ export interface InfrastructureConfigurationSummary {
4741
5396
  */
4742
5397
  export interface ListInfrastructureConfigurationsResponse {
4743
5398
  /**
5399
+ * @public
4744
5400
  * <p>The request ID that uniquely identifies this request.</p>
4745
5401
  */
4746
5402
  requestId?: string;
4747
5403
  /**
5404
+ * @public
4748
5405
  * <p>The list of infrastructure configurations.</p>
4749
5406
  */
4750
5407
  infrastructureConfigurationSummaryList?: InfrastructureConfigurationSummary[];
4751
5408
  /**
5409
+ * @public
4752
5410
  * <p>The next token used for paginated responses. When this field isn't empty,
4753
5411
  * there are additional elements that the service has'ot included in this request. Use this token
4754
5412
  * with the next request to retrieve additional objects.</p>
@@ -4773,6 +5431,7 @@ export declare class InvalidParameterException extends __BaseException {
4773
5431
  */
4774
5432
  export interface ListTagsForResourceRequest {
4775
5433
  /**
5434
+ * @public
4776
5435
  * <p>The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.</p>
4777
5436
  */
4778
5437
  resourceArn: string | undefined;
@@ -4782,6 +5441,7 @@ export interface ListTagsForResourceRequest {
4782
5441
  */
4783
5442
  export interface ListTagsForResourceResponse {
4784
5443
  /**
5444
+ * @public
4785
5445
  * <p>The tags for the specified resource.</p>
4786
5446
  */
4787
5447
  tags?: Record<string, string>;
@@ -4791,15 +5451,18 @@ export interface ListTagsForResourceResponse {
4791
5451
  */
4792
5452
  export interface ListWorkflowExecutionsRequest {
4793
5453
  /**
5454
+ * @public
4794
5455
  * <p>The maximum items to return in a request.</p>
4795
5456
  */
4796
5457
  maxResults?: number;
4797
5458
  /**
5459
+ * @public
4798
5460
  * <p>A token to specify where to start paginating. This is the NextToken
4799
5461
  * from a previously truncated response.</p>
4800
5462
  */
4801
5463
  nextToken?: string;
4802
5464
  /**
5465
+ * @public
4803
5466
  * <p>List all workflow runtime instances for the specified image build version
4804
5467
  * resource ARN.</p>
4805
5468
  */
@@ -4811,48 +5474,59 @@ export interface ListWorkflowExecutionsRequest {
4811
5474
  */
4812
5475
  export interface WorkflowExecutionMetadata {
4813
5476
  /**
5477
+ * @public
4814
5478
  * <p>The Amazon Resource Name (ARN) of the workflow resource build version that ran.</p>
4815
5479
  */
4816
5480
  workflowBuildVersionArn?: string;
4817
5481
  /**
5482
+ * @public
4818
5483
  * <p>Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a
4819
5484
  * workflow.</p>
4820
5485
  */
4821
5486
  workflowExecutionId?: string;
4822
5487
  /**
5488
+ * @public
4823
5489
  * <p>Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.</p>
4824
5490
  */
4825
5491
  type?: WorkflowType | string;
4826
5492
  /**
5493
+ * @public
4827
5494
  * <p>The current runtime status for this workflow.</p>
4828
5495
  */
4829
5496
  status?: WorkflowExecutionStatus | string;
4830
5497
  /**
5498
+ * @public
4831
5499
  * <p>The runtime output message from the workflow, if applicable.</p>
4832
5500
  */
4833
5501
  message?: string;
4834
5502
  /**
5503
+ * @public
4835
5504
  * <p>The total number of steps in the workflow. This should equal the sum of the step
4836
5505
  * counts for steps that succeeded, were skipped, and failed.</p>
4837
5506
  */
4838
5507
  totalStepCount?: number;
4839
5508
  /**
5509
+ * @public
4840
5510
  * <p>A runtime count for the number of steps in the workflow that ran successfully.</p>
4841
5511
  */
4842
5512
  totalStepsSucceeded?: number;
4843
5513
  /**
5514
+ * @public
4844
5515
  * <p>A runtime count for the number of steps in the workflow that failed.</p>
4845
5516
  */
4846
5517
  totalStepsFailed?: number;
4847
5518
  /**
5519
+ * @public
4848
5520
  * <p>A runtime count for the number of steps in the workflow that were skipped.</p>
4849
5521
  */
4850
5522
  totalStepsSkipped?: number;
4851
5523
  /**
5524
+ * @public
4852
5525
  * <p>The timestamp when the runtime instance of this workflow started.</p>
4853
5526
  */
4854
5527
  startTime?: string;
4855
5528
  /**
5529
+ * @public
4856
5530
  * <p>The timestamp when this runtime instance of the workflow finished.</p>
4857
5531
  */
4858
5532
  endTime?: string;
@@ -4862,24 +5536,29 @@ export interface WorkflowExecutionMetadata {
4862
5536
  */
4863
5537
  export interface ListWorkflowExecutionsResponse {
4864
5538
  /**
5539
+ * @public
4865
5540
  * <p>The request ID that uniquely identifies this request.</p>
4866
5541
  */
4867
5542
  requestId?: string;
4868
5543
  /**
5544
+ * @public
4869
5545
  * <p>Contains an array of runtime details that represents each time a workflow ran for
4870
5546
  * the requested image build version.</p>
4871
5547
  */
4872
5548
  workflowExecutions?: WorkflowExecutionMetadata[];
4873
5549
  /**
5550
+ * @public
4874
5551
  * <p>The resource ARN of the image build version for which you requested a list of
4875
5552
  * workflow runtime details.</p>
4876
5553
  */
4877
5554
  imageBuildVersionArn?: string;
4878
5555
  /**
5556
+ * @public
4879
5557
  * <p>The output message from the list action, if applicable.</p>
4880
5558
  */
4881
5559
  message?: string;
4882
5560
  /**
5561
+ * @public
4883
5562
  * <p>The next token used for paginated responses. When this field isn't empty,
4884
5563
  * there are additional elements that the service has'ot included in this request. Use this token
4885
5564
  * with the next request to retrieve additional objects.</p>
@@ -4891,15 +5570,18 @@ export interface ListWorkflowExecutionsResponse {
4891
5570
  */
4892
5571
  export interface ListWorkflowStepExecutionsRequest {
4893
5572
  /**
5573
+ * @public
4894
5574
  * <p>The maximum items to return in a request.</p>
4895
5575
  */
4896
5576
  maxResults?: number;
4897
5577
  /**
5578
+ * @public
4898
5579
  * <p>A token to specify where to start paginating. This is the NextToken
4899
5580
  * from a previously truncated response.</p>
4900
5581
  */
4901
5582
  nextToken?: string;
4902
5583
  /**
5584
+ * @public
4903
5585
  * <p>The unique identifier that Image Builder assigned to keep track of runtime details
4904
5586
  * when it ran the workflow.</p>
4905
5587
  */
@@ -4911,46 +5593,57 @@ export interface ListWorkflowStepExecutionsRequest {
4911
5593
  */
4912
5594
  export interface WorkflowStepMetadata {
4913
5595
  /**
5596
+ * @public
4914
5597
  * <p>A unique identifier for the workflow step, assigned at runtime.</p>
4915
5598
  */
4916
5599
  stepExecutionId?: string;
4917
5600
  /**
5601
+ * @public
4918
5602
  * <p>The name of the workflow step.</p>
4919
5603
  */
4920
5604
  name?: string;
4921
5605
  /**
5606
+ * @public
4922
5607
  * <p>Description of the workflow step.</p>
4923
5608
  */
4924
5609
  description?: string;
4925
5610
  /**
5611
+ * @public
4926
5612
  * <p>The step action name.</p>
4927
5613
  */
4928
5614
  action?: string;
4929
5615
  /**
5616
+ * @public
4930
5617
  * <p>Runtime status for the workflow step.</p>
4931
5618
  */
4932
5619
  status?: WorkflowStepExecutionStatus | string;
4933
5620
  /**
5621
+ * @public
4934
5622
  * <p>Reports on the rollback status of the step, if applicable.</p>
4935
5623
  */
4936
5624
  rollbackStatus?: WorkflowStepExecutionRollbackStatus | string;
4937
5625
  /**
5626
+ * @public
4938
5627
  * <p>Detailed output message that the workflow step provides at runtime.</p>
4939
5628
  */
4940
5629
  message?: string;
4941
5630
  /**
5631
+ * @public
4942
5632
  * <p>Input parameters that Image Builder provides for the workflow step.</p>
4943
5633
  */
4944
5634
  inputs?: string;
4945
5635
  /**
5636
+ * @public
4946
5637
  * <p>The file names that the workflow step created as output for this runtime instance of the workflow.</p>
4947
5638
  */
4948
5639
  outputs?: string;
4949
5640
  /**
5641
+ * @public
4950
5642
  * <p>The timestamp when the workflow step started.</p>
4951
5643
  */
4952
5644
  startTime?: string;
4953
5645
  /**
5646
+ * @public
4954
5647
  * <p>The timestamp when the workflow step finished.</p>
4955
5648
  */
4956
5649
  endTime?: string;
@@ -4960,34 +5653,41 @@ export interface WorkflowStepMetadata {
4960
5653
  */
4961
5654
  export interface ListWorkflowStepExecutionsResponse {
4962
5655
  /**
5656
+ * @public
4963
5657
  * <p>The request ID that uniquely identifies this request.</p>
4964
5658
  */
4965
5659
  requestId?: string;
4966
5660
  /**
5661
+ * @public
4967
5662
  * <p>Contains an array of runtime details that represents each step in this runtime
4968
5663
  * instance of the workflow.</p>
4969
5664
  */
4970
5665
  steps?: WorkflowStepMetadata[];
4971
5666
  /**
5667
+ * @public
4972
5668
  * <p>The build version ARN for the Image Builder workflow resource that defines the steps for
4973
5669
  * this runtime instance of the workflow.</p>
4974
5670
  */
4975
5671
  workflowBuildVersionArn?: string;
4976
5672
  /**
5673
+ * @public
4977
5674
  * <p>The unique identifier that Image Builder assigned to keep track of runtime details
4978
5675
  * when it ran the workflow.</p>
4979
5676
  */
4980
5677
  workflowExecutionId?: string;
4981
5678
  /**
5679
+ * @public
4982
5680
  * <p>The image build version resource ARN that's associated with the specified runtime
4983
5681
  * instance of the workflow.</p>
4984
5682
  */
4985
5683
  imageBuildVersionArn?: string;
4986
5684
  /**
5685
+ * @public
4987
5686
  * <p>The output message from the list action, if applicable.</p>
4988
5687
  */
4989
5688
  message?: string;
4990
5689
  /**
5690
+ * @public
4991
5691
  * <p>The next token used for paginated responses. When this field isn't empty,
4992
5692
  * there are additional elements that the service has'ot included in this request. Use this token
4993
5693
  * with the next request to retrieve additional objects.</p>
@@ -5011,11 +5711,13 @@ export declare class InvalidParameterValueException extends __BaseException {
5011
5711
  */
5012
5712
  export interface PutComponentPolicyRequest {
5013
5713
  /**
5714
+ * @public
5014
5715
  * <p>The Amazon Resource Name (ARN) of the component that this policy should be applied
5015
5716
  * to.</p>
5016
5717
  */
5017
5718
  componentArn: string | undefined;
5018
5719
  /**
5720
+ * @public
5019
5721
  * <p>The policy to apply.</p>
5020
5722
  */
5021
5723
  policy: string | undefined;
@@ -5025,10 +5727,12 @@ export interface PutComponentPolicyRequest {
5025
5727
  */
5026
5728
  export interface PutComponentPolicyResponse {
5027
5729
  /**
5730
+ * @public
5028
5731
  * <p>The request ID that uniquely identifies this request.</p>
5029
5732
  */
5030
5733
  requestId?: string;
5031
5734
  /**
5735
+ * @public
5032
5736
  * <p>The Amazon Resource Name (ARN) of the component that this policy was applied
5033
5737
  * to.</p>
5034
5738
  */
@@ -5039,11 +5743,13 @@ export interface PutComponentPolicyResponse {
5039
5743
  */
5040
5744
  export interface PutContainerRecipePolicyRequest {
5041
5745
  /**
5746
+ * @public
5042
5747
  * <p>The Amazon Resource Name (ARN) of the container recipe that this policy should be
5043
5748
  * applied to.</p>
5044
5749
  */
5045
5750
  containerRecipeArn: string | undefined;
5046
5751
  /**
5752
+ * @public
5047
5753
  * <p>The policy to apply to the container recipe.</p>
5048
5754
  */
5049
5755
  policy: string | undefined;
@@ -5053,10 +5759,12 @@ export interface PutContainerRecipePolicyRequest {
5053
5759
  */
5054
5760
  export interface PutContainerRecipePolicyResponse {
5055
5761
  /**
5762
+ * @public
5056
5763
  * <p>The request ID that uniquely identifies this request.</p>
5057
5764
  */
5058
5765
  requestId?: string;
5059
5766
  /**
5767
+ * @public
5060
5768
  * <p>The Amazon Resource Name (ARN) of the container recipe that this policy was applied
5061
5769
  * to.</p>
5062
5770
  */
@@ -5067,11 +5775,13 @@ export interface PutContainerRecipePolicyResponse {
5067
5775
  */
5068
5776
  export interface PutImagePolicyRequest {
5069
5777
  /**
5778
+ * @public
5070
5779
  * <p>The Amazon Resource Name (ARN) of the image that this policy should be applied
5071
5780
  * to.</p>
5072
5781
  */
5073
5782
  imageArn: string | undefined;
5074
5783
  /**
5784
+ * @public
5075
5785
  * <p>The policy to apply.</p>
5076
5786
  */
5077
5787
  policy: string | undefined;
@@ -5081,10 +5791,12 @@ export interface PutImagePolicyRequest {
5081
5791
  */
5082
5792
  export interface PutImagePolicyResponse {
5083
5793
  /**
5794
+ * @public
5084
5795
  * <p>The request ID that uniquely identifies this request.</p>
5085
5796
  */
5086
5797
  requestId?: string;
5087
5798
  /**
5799
+ * @public
5088
5800
  * <p>The Amazon Resource Name (ARN) of the image that this policy was applied to.</p>
5089
5801
  */
5090
5802
  imageArn?: string;
@@ -5094,11 +5806,13 @@ export interface PutImagePolicyResponse {
5094
5806
  */
5095
5807
  export interface PutImageRecipePolicyRequest {
5096
5808
  /**
5809
+ * @public
5097
5810
  * <p>The Amazon Resource Name (ARN) of the image recipe that this policy should be applied
5098
5811
  * to.</p>
5099
5812
  */
5100
5813
  imageRecipeArn: string | undefined;
5101
5814
  /**
5815
+ * @public
5102
5816
  * <p>The policy to apply.</p>
5103
5817
  */
5104
5818
  policy: string | undefined;
@@ -5108,10 +5822,12 @@ export interface PutImageRecipePolicyRequest {
5108
5822
  */
5109
5823
  export interface PutImageRecipePolicyResponse {
5110
5824
  /**
5825
+ * @public
5111
5826
  * <p>The request ID that uniquely identifies this request.</p>
5112
5827
  */
5113
5828
  requestId?: string;
5114
5829
  /**
5830
+ * @public
5115
5831
  * <p>The Amazon Resource Name (ARN) of the image recipe that this policy was applied
5116
5832
  * to.</p>
5117
5833
  */
@@ -5122,11 +5838,13 @@ export interface PutImageRecipePolicyResponse {
5122
5838
  */
5123
5839
  export interface StartImagePipelineExecutionRequest {
5124
5840
  /**
5841
+ * @public
5125
5842
  * <p>The Amazon Resource Name (ARN) of the image pipeline that you want to manually
5126
5843
  * invoke.</p>
5127
5844
  */
5128
5845
  imagePipelineArn: string | undefined;
5129
5846
  /**
5847
+ * @public
5130
5848
  * <p>The idempotency token used to make this request idempotent.</p>
5131
5849
  */
5132
5850
  clientToken?: string;
@@ -5136,14 +5854,17 @@ export interface StartImagePipelineExecutionRequest {
5136
5854
  */
5137
5855
  export interface StartImagePipelineExecutionResponse {
5138
5856
  /**
5857
+ * @public
5139
5858
  * <p>The request ID that uniquely identifies this request.</p>
5140
5859
  */
5141
5860
  requestId?: string;
5142
5861
  /**
5862
+ * @public
5143
5863
  * <p>The idempotency token used to make this request idempotent.</p>
5144
5864
  */
5145
5865
  clientToken?: string;
5146
5866
  /**
5867
+ * @public
5147
5868
  * <p>The Amazon Resource Name (ARN) of the image that was created by this request.</p>
5148
5869
  */
5149
5870
  imageBuildVersionArn?: string;
@@ -5153,10 +5874,12 @@ export interface StartImagePipelineExecutionResponse {
5153
5874
  */
5154
5875
  export interface TagResourceRequest {
5155
5876
  /**
5877
+ * @public
5156
5878
  * <p>The Amazon Resource Name (ARN) of the resource that you want to tag.</p>
5157
5879
  */
5158
5880
  resourceArn: string | undefined;
5159
5881
  /**
5882
+ * @public
5160
5883
  * <p>The tags to apply to the resource.</p>
5161
5884
  */
5162
5885
  tags: Record<string, string> | undefined;
@@ -5171,10 +5894,12 @@ export interface TagResourceResponse {
5171
5894
  */
5172
5895
  export interface UntagResourceRequest {
5173
5896
  /**
5897
+ * @public
5174
5898
  * <p>The Amazon Resource Name (ARN) of the resource that you want to untag.</p>
5175
5899
  */
5176
5900
  resourceArn: string | undefined;
5177
5901
  /**
5902
+ * @public
5178
5903
  * <p>The tag keys to remove from the resource.</p>
5179
5904
  */
5180
5905
  tagKeys: string[] | undefined;
@@ -5189,19 +5914,23 @@ export interface UntagResourceResponse {
5189
5914
  */
5190
5915
  export interface UpdateDistributionConfigurationRequest {
5191
5916
  /**
5917
+ * @public
5192
5918
  * <p>The Amazon Resource Name (ARN) of the distribution configuration that you want to
5193
5919
  * update.</p>
5194
5920
  */
5195
5921
  distributionConfigurationArn: string | undefined;
5196
5922
  /**
5923
+ * @public
5197
5924
  * <p>The description of the distribution configuration.</p>
5198
5925
  */
5199
5926
  description?: string;
5200
5927
  /**
5928
+ * @public
5201
5929
  * <p>The distributions of the distribution configuration.</p>
5202
5930
  */
5203
5931
  distributions: Distribution[] | undefined;
5204
5932
  /**
5933
+ * @public
5205
5934
  * <p>The idempotency token of the distribution configuration.</p>
5206
5935
  */
5207
5936
  clientToken?: string;
@@ -5211,14 +5940,17 @@ export interface UpdateDistributionConfigurationRequest {
5211
5940
  */
5212
5941
  export interface UpdateDistributionConfigurationResponse {
5213
5942
  /**
5943
+ * @public
5214
5944
  * <p>The request ID that uniquely identifies this request.</p>
5215
5945
  */
5216
5946
  requestId?: string;
5217
5947
  /**
5948
+ * @public
5218
5949
  * <p>The idempotency token used to make this request idempotent.</p>
5219
5950
  */
5220
5951
  clientToken?: string;
5221
5952
  /**
5953
+ * @public
5222
5954
  * <p>The Amazon Resource Name (ARN) of the distribution configuration that was updated by
5223
5955
  * this request.</p>
5224
5956
  */
@@ -5229,55 +5961,67 @@ export interface UpdateDistributionConfigurationResponse {
5229
5961
  */
5230
5962
  export interface UpdateImagePipelineRequest {
5231
5963
  /**
5964
+ * @public
5232
5965
  * <p>The Amazon Resource Name (ARN) of the image pipeline that you want to update.</p>
5233
5966
  */
5234
5967
  imagePipelineArn: string | undefined;
5235
5968
  /**
5969
+ * @public
5236
5970
  * <p>The description of the image pipeline.</p>
5237
5971
  */
5238
5972
  description?: string;
5239
5973
  /**
5974
+ * @public
5240
5975
  * <p>The Amazon Resource Name (ARN) of the image recipe that will be used to configure
5241
5976
  * images updated by this image pipeline.</p>
5242
5977
  */
5243
5978
  imageRecipeArn?: string;
5244
5979
  /**
5980
+ * @public
5245
5981
  * <p>The Amazon Resource Name (ARN) of the container pipeline to update.</p>
5246
5982
  */
5247
5983
  containerRecipeArn?: string;
5248
5984
  /**
5985
+ * @public
5249
5986
  * <p>The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to
5250
5987
  * build images that this image pipeline has updated.</p>
5251
5988
  */
5252
5989
  infrastructureConfigurationArn: string | undefined;
5253
5990
  /**
5991
+ * @public
5254
5992
  * <p>The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to
5255
5993
  * configure and distribute images that this image pipeline has updated.</p>
5256
5994
  */
5257
5995
  distributionConfigurationArn?: string;
5258
5996
  /**
5997
+ * @public
5259
5998
  * <p>The image test configuration of the image pipeline.</p>
5260
5999
  */
5261
6000
  imageTestsConfiguration?: ImageTestsConfiguration;
5262
6001
  /**
6002
+ * @public
5263
6003
  * <p>Collects additional information about the image being created, including the operating
5264
6004
  * system (OS) version and package list. This information is used to enhance the overall
5265
6005
  * experience of using EC2 Image Builder. Enabled by default.</p>
5266
6006
  */
5267
6007
  enhancedImageMetadataEnabled?: boolean;
5268
6008
  /**
6009
+ * @public
5269
6010
  * <p>The schedule of the image pipeline.</p>
5270
6011
  */
5271
6012
  schedule?: Schedule;
5272
6013
  /**
6014
+ * @public
5273
6015
  * <p>The status of the image pipeline.</p>
5274
6016
  */
5275
6017
  status?: PipelineStatus | string;
5276
6018
  /**
6019
+ * @public
5277
6020
  * <p>The idempotency token used to make this request idempotent.</p>
5278
6021
  */
5279
6022
  clientToken?: string;
5280
6023
  /**
6024
+ * @public
5281
6025
  * <p>Contains settings for vulnerability scans.</p>
5282
6026
  */
5283
6027
  imageScanningConfiguration?: ImageScanningConfiguration;
@@ -5287,14 +6031,17 @@ export interface UpdateImagePipelineRequest {
5287
6031
  */
5288
6032
  export interface UpdateImagePipelineResponse {
5289
6033
  /**
6034
+ * @public
5290
6035
  * <p>The request ID that uniquely identifies this request.</p>
5291
6036
  */
5292
6037
  requestId?: string;
5293
6038
  /**
6039
+ * @public
5294
6040
  * <p>The idempotency token used to make this request idempotent.</p>
5295
6041
  */
5296
6042
  clientToken?: string;
5297
6043
  /**
6044
+ * @public
5298
6045
  * <p>The Amazon Resource Name (ARN) of the image pipeline that was updated by this
5299
6046
  * request.</p>
5300
6047
  */
@@ -5305,50 +6052,60 @@ export interface UpdateImagePipelineResponse {
5305
6052
  */
5306
6053
  export interface UpdateInfrastructureConfigurationRequest {
5307
6054
  /**
6055
+ * @public
5308
6056
  * <p>The Amazon Resource Name (ARN) of the infrastructure configuration that you want to
5309
6057
  * update.</p>
5310
6058
  */
5311
6059
  infrastructureConfigurationArn: string | undefined;
5312
6060
  /**
6061
+ * @public
5313
6062
  * <p>The description of the infrastructure configuration.</p>
5314
6063
  */
5315
6064
  description?: string;
5316
6065
  /**
6066
+ * @public
5317
6067
  * <p>The instance types of the infrastructure configuration. You can specify one or more
5318
6068
  * instance types to use for this build. The service will pick one of these instance types
5319
6069
  * based on availability.</p>
5320
6070
  */
5321
6071
  instanceTypes?: string[];
5322
6072
  /**
6073
+ * @public
5323
6074
  * <p>The instance profile to associate with the instance used to customize your Amazon EC2
5324
6075
  * AMI.</p>
5325
6076
  */
5326
6077
  instanceProfileName: string | undefined;
5327
6078
  /**
6079
+ * @public
5328
6080
  * <p>The security group IDs to associate with the instance used to customize your Amazon EC2
5329
6081
  * AMI.</p>
5330
6082
  */
5331
6083
  securityGroupIds?: string[];
5332
6084
  /**
6085
+ * @public
5333
6086
  * <p>The subnet ID to place the instance used to customize your Amazon EC2 AMI in.</p>
5334
6087
  */
5335
6088
  subnetId?: string;
5336
6089
  /**
6090
+ * @public
5337
6091
  * <p>The logging configuration of the infrastructure configuration.</p>
5338
6092
  */
5339
6093
  logging?: Logging;
5340
6094
  /**
6095
+ * @public
5341
6096
  * <p>The key pair of the infrastructure configuration. You can use this to log on to and
5342
6097
  * debug the instance used to create your image.</p>
5343
6098
  */
5344
6099
  keyPair?: string;
5345
6100
  /**
6101
+ * @public
5346
6102
  * <p>The terminate instance on failure setting of the infrastructure configuration. Set to
5347
6103
  * false if you want Image Builder to retain the instance used to configure your AMI if the build or
5348
6104
  * test phase of your workflow fails.</p>
5349
6105
  */
5350
6106
  terminateInstanceOnFailure?: boolean;
5351
6107
  /**
6108
+ * @public
5352
6109
  * <p>The Amazon Resource Name (ARN) for the SNS topic to which we send image build event
5353
6110
  * notifications.</p>
5354
6111
  * <note>
@@ -5359,14 +6116,17 @@ export interface UpdateInfrastructureConfigurationRequest {
5359
6116
  */
5360
6117
  snsTopicArn?: string;
5361
6118
  /**
6119
+ * @public
5362
6120
  * <p>The idempotency token used to make this request idempotent.</p>
5363
6121
  */
5364
6122
  clientToken?: string;
5365
6123
  /**
6124
+ * @public
5366
6125
  * <p>The tags attached to the resource created by Image Builder.</p>
5367
6126
  */
5368
6127
  resourceTags?: Record<string, string>;
5369
6128
  /**
6129
+ * @public
5370
6130
  * <p>The instance metadata options that you can set for the HTTP requests that pipeline
5371
6131
  * builds use to launch EC2 build and test instances. For more information about instance
5372
6132
  * metadata options, see one of the following links:</p>
@@ -5394,14 +6154,17 @@ export interface UpdateInfrastructureConfigurationRequest {
5394
6154
  */
5395
6155
  export interface UpdateInfrastructureConfigurationResponse {
5396
6156
  /**
6157
+ * @public
5397
6158
  * <p>The request ID that uniquely identifies this request.</p>
5398
6159
  */
5399
6160
  requestId?: string;
5400
6161
  /**
6162
+ * @public
5401
6163
  * <p>The idempotency token used to make this request idempotent.</p>
5402
6164
  */
5403
6165
  clientToken?: string;
5404
6166
  /**
6167
+ * @public
5405
6168
  * <p>The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by
5406
6169
  * this request.</p>
5407
6170
  */