-
Notifications
You must be signed in to change notification settings - Fork 670
/
Copy pathimagebuilder.json
14408 lines (14408 loc) · 673 KB
/
imagebuilder.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"smithy": "2.0",
"metadata": {
"suppressions": [
{
"id": "HttpMethodSemantics",
"namespace": "*"
},
{
"id": "HttpResponseCodeSemantics",
"namespace": "*"
},
{
"id": "PaginatedTrait",
"namespace": "*"
},
{
"id": "HttpHeaderTrait",
"namespace": "*"
},
{
"id": "HttpUriConflict",
"namespace": "*"
},
{
"id": "Service",
"namespace": "*"
}
]
},
"shapes": {
"com.amazonaws.imagebuilder#AccountAggregation": {
"type": "structure",
"members": {
"accountId": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>Identifies the account that owns the aggregated resource findings.</p>"
}
},
"severityCounts": {
"target": "com.amazonaws.imagebuilder#SeverityCounts",
"traits": {
"smithy.api#documentation": "<p>Counts by severity level for medium severity and higher level findings, plus a total\n\t\t\tfor all of the findings.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains counts of vulnerability findings from image scans that run when you create\n\t\t\tnew Image Builder images, or build new versions of existing images. The vulnerability counts are\n\t\t\tgrouped by severity level. The counts are aggregated across resources to create the\n\t\t\tfinal tally for the account that owns them.</p>"
}
},
"com.amazonaws.imagebuilder#AccountId": {
"type": "string",
"traits": {
"smithy.api#pattern": "^[0-9]{12}$"
}
},
"com.amazonaws.imagebuilder#AccountList": {
"type": "list",
"member": {
"target": "com.amazonaws.imagebuilder#AccountId"
},
"traits": {
"smithy.api#length": {
"min": 1,
"max": 1536
}
}
},
"com.amazonaws.imagebuilder#AdditionalInstanceConfiguration": {
"type": "structure",
"members": {
"systemsManagerAgent": {
"target": "com.amazonaws.imagebuilder#SystemsManagerAgent",
"traits": {
"smithy.api#documentation": "<p>Contains settings for the Systems Manager agent on your build instance.</p>"
}
},
"userDataOverride": {
"target": "com.amazonaws.imagebuilder#UserDataOverride",
"traits": {
"smithy.api#documentation": "<p>Use this property to provide commands or a command script to run when you launch your\n\t\t\tbuild instance.</p>\n <p>The userDataOverride property replaces any commands that Image Builder might have added to\n\t\t\tensure that Systems Manager is installed on your Linux build instance. If you override the user\n\t\t\tdata, make sure that you add commands to install Systems Manager, if it is not pre-installed on\n\t\t\tyour base image.</p>\n <note>\n <p>The user data is always base 64 encoded. For example, the following commands are\n\t\t\t\tencoded as\n\t\t\t\t<code>IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$</code>:</p>\n <p>\n <i>#!/bin/bash</i>\n </p>\n <p>mkdir -p /var/bb/</p>\n <p>touch /var</p>\n </note>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>In addition to your infrastructure configuration, these settings provide an extra\n\t\t\tlayer of control over your build instances. You can also specify commands to run on\n\t\t\tlaunch for all of your build instances.</p>\n <p>Image Builder does not automatically install the Systems Manager agent on Windows instances. If your base\n\t\t\timage includes the Systems Manager agent, then the AMI that you create will also include the\n\t\t\tagent. For Linux instances, if the base image does not already include the Systems Manager agent,\n\t\t\tImage Builder installs it. For Linux instances where Image Builder installs the Systems Manager agent, you can\n\t\t\tchoose whether to keep it for the AMI that you create.</p>"
}
},
"com.amazonaws.imagebuilder#Ami": {
"type": "structure",
"members": {
"region": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The Amazon Web Services Region of the Amazon EC2 AMI.</p>"
}
},
"image": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The AMI ID of the Amazon EC2 AMI.</p>"
}
},
"name": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The name of the Amazon EC2 AMI.</p>"
}
},
"description": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.</p>"
}
},
"state": {
"target": "com.amazonaws.imagebuilder#ImageState"
},
"accountId": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The account ID of the owner of the AMI.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Details of an Amazon EC2 AMI.</p>"
}
},
"com.amazonaws.imagebuilder#AmiDistributionConfiguration": {
"type": "structure",
"members": {
"name": {
"target": "com.amazonaws.imagebuilder#AmiNameString",
"traits": {
"smithy.api#documentation": "<p>The name of the output AMI.</p>"
}
},
"description": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The description of the AMI distribution configuration. Minimum and maximum length are\n\t\t\tin characters.</p>"
}
},
"targetAccountIds": {
"target": "com.amazonaws.imagebuilder#AccountList",
"traits": {
"smithy.api#documentation": "<p>The ID of an account to which you want to distribute an image.</p>"
}
},
"amiTags": {
"target": "com.amazonaws.imagebuilder#TagMap",
"traits": {
"smithy.api#documentation": "<p>The tags to apply to AMIs distributed to this Region.</p>"
}
},
"kmsKeyId": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The KMS key identifier used to encrypt the distributed image.</p>"
}
},
"launchPermission": {
"target": "com.amazonaws.imagebuilder#LaunchPermissionConfiguration",
"traits": {
"smithy.api#documentation": "<p>Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to\n\t\t\tlaunch instances.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Define and configure the output AMIs of the pipeline.</p>"
}
},
"com.amazonaws.imagebuilder#AmiList": {
"type": "list",
"member": {
"target": "com.amazonaws.imagebuilder#Ami"
}
},
"com.amazonaws.imagebuilder#AmiNameString": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 127
},
"smithy.api#pattern": "^[-_A-Za-z0-9{][-_A-Za-z0-9\\s:{}\\.]+[-_A-Za-z0-9}]$"
}
},
"com.amazonaws.imagebuilder#Arn": {
"type": "string"
},
"com.amazonaws.imagebuilder#Boolean": {
"type": "boolean",
"traits": {
"smithy.api#default": false
}
},
"com.amazonaws.imagebuilder#BuildType": {
"type": "enum",
"members": {
"USER_INITIATED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "USER_INITIATED"
}
},
"SCHEDULED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "SCHEDULED"
}
},
"IMPORT": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "IMPORT"
}
}
}
},
"com.amazonaws.imagebuilder#CallRateLimitExceededException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.imagebuilder#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>You have exceeded the permitted request rate for the specific operation.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 429
}
},
"com.amazonaws.imagebuilder#CancelImageCreation": {
"type": "operation",
"input": {
"target": "com.amazonaws.imagebuilder#CancelImageCreationRequest"
},
"output": {
"target": "com.amazonaws.imagebuilder#CancelImageCreationResponse"
},
"errors": [
{
"target": "com.amazonaws.imagebuilder#CallRateLimitExceededException"
},
{
"target": "com.amazonaws.imagebuilder#ClientException"
},
{
"target": "com.amazonaws.imagebuilder#ForbiddenException"
},
{
"target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException"
},
{
"target": "com.amazonaws.imagebuilder#InvalidRequestException"
},
{
"target": "com.amazonaws.imagebuilder#ResourceInUseException"
},
{
"target": "com.amazonaws.imagebuilder#ServiceException"
},
{
"target": "com.amazonaws.imagebuilder#ServiceUnavailableException"
}
],
"traits": {
"smithy.api#documentation": "<p>CancelImageCreation cancels the creation of Image. This operation can only be used on\n\t\t\timages in a non-terminal state.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/CancelImageCreation",
"code": 200
}
}
},
"com.amazonaws.imagebuilder#CancelImageCreationRequest": {
"type": "structure",
"members": {
"imageBuildVersionArn": {
"target": "com.amazonaws.imagebuilder#ImageBuildVersionArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the image that you want to cancel creation\n\t\t\tfor.</p>",
"smithy.api#required": {}
}
},
"clientToken": {
"target": "com.amazonaws.imagebuilder#ClientToken",
"traits": {
"smithy.api#documentation": "<p>Unique, case-sensitive identifier you provide to ensure\n 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> \n in the <i>Amazon EC2 API Reference</i>.</p>",
"smithy.api#idempotencyToken": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.imagebuilder#CancelImageCreationResponse": {
"type": "structure",
"members": {
"requestId": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The request ID that uniquely identifies this request.</p>"
}
},
"clientToken": {
"target": "com.amazonaws.imagebuilder#ClientToken",
"traits": {
"smithy.api#documentation": "<p>The client token that uniquely identifies the request.</p>"
}
},
"imageBuildVersionArn": {
"target": "com.amazonaws.imagebuilder#ImageBuildVersionArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the image whose creation this request canceled.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.imagebuilder#CancelLifecycleExecution": {
"type": "operation",
"input": {
"target": "com.amazonaws.imagebuilder#CancelLifecycleExecutionRequest"
},
"output": {
"target": "com.amazonaws.imagebuilder#CancelLifecycleExecutionResponse"
},
"errors": [
{
"target": "com.amazonaws.imagebuilder#CallRateLimitExceededException"
},
{
"target": "com.amazonaws.imagebuilder#ClientException"
},
{
"target": "com.amazonaws.imagebuilder#ForbiddenException"
},
{
"target": "com.amazonaws.imagebuilder#IdempotentParameterMismatchException"
},
{
"target": "com.amazonaws.imagebuilder#InvalidRequestException"
},
{
"target": "com.amazonaws.imagebuilder#ResourceInUseException"
},
{
"target": "com.amazonaws.imagebuilder#ServiceException"
},
{
"target": "com.amazonaws.imagebuilder#ServiceUnavailableException"
}
],
"traits": {
"smithy.api#documentation": "<p>Cancel a specific image lifecycle policy runtime instance.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/CancelLifecycleExecution",
"code": 200
}
}
},
"com.amazonaws.imagebuilder#CancelLifecycleExecutionRequest": {
"type": "structure",
"members": {
"lifecycleExecutionId": {
"target": "com.amazonaws.imagebuilder#LifecycleExecutionId",
"traits": {
"smithy.api#documentation": "<p>Identifies the specific runtime instance of the image lifecycle to cancel.</p>",
"smithy.api#required": {}
}
},
"clientToken": {
"target": "com.amazonaws.imagebuilder#ClientToken",
"traits": {
"smithy.api#documentation": "<p>Unique, case-sensitive identifier you provide to ensure\n 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> \n in the <i>Amazon EC2 API Reference</i>.</p>",
"smithy.api#idempotencyToken": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.imagebuilder#CancelLifecycleExecutionResponse": {
"type": "structure",
"members": {
"lifecycleExecutionId": {
"target": "com.amazonaws.imagebuilder#LifecycleExecutionId",
"traits": {
"smithy.api#documentation": "<p>The unique identifier for the image lifecycle runtime instance that was canceled.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.imagebuilder#ClientException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.imagebuilder#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>These errors are usually caused by a client action, such as using an action or\n\t\t\tresource on behalf of a user that doesn't have permissions to use the action or\n\t\t\tresource, or specifying an invalid resource identifier.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.imagebuilder#ClientToken": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 36
}
}
},
"com.amazonaws.imagebuilder#Component": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.imagebuilder#ImageBuilderArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the component.</p>"
}
},
"name": {
"target": "com.amazonaws.imagebuilder#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The name of the component.</p>"
}
},
"version": {
"target": "com.amazonaws.imagebuilder#VersionNumber",
"traits": {
"smithy.api#documentation": "<p>The version of the component.</p>"
}
},
"description": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The description of the component.</p>"
}
},
"changeDescription": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>Describes what change has been made in this version of the component, \n\t\t\tor what makes this version different from other versions of the component.</p>"
}
},
"type": {
"target": "com.amazonaws.imagebuilder#ComponentType",
"traits": {
"smithy.api#documentation": "<p>The component type specifies whether Image Builder uses the component to build the image or\n\t\t\tonly to test it.</p>"
}
},
"platform": {
"target": "com.amazonaws.imagebuilder#Platform",
"traits": {
"smithy.api#documentation": "<p>The operating system platform of the component.</p>"
}
},
"supportedOsVersions": {
"target": "com.amazonaws.imagebuilder#OsVersionList",
"traits": {
"smithy.api#documentation": "<p>The operating system (OS) version supported by the component. If the OS information is\n\t\t\tavailable, Image Builder performs a prefix match against the base image OS version during image\n\t\t\trecipe creation.</p>"
}
},
"state": {
"target": "com.amazonaws.imagebuilder#ComponentState",
"traits": {
"smithy.api#documentation": "<p>Describes the current status of the component. This is used for components that are no\n\t\t\tlonger active.</p>"
}
},
"parameters": {
"target": "com.amazonaws.imagebuilder#ComponentParameterDetailList",
"traits": {
"smithy.api#documentation": "<p>Contains parameter details for each of the parameters that the component document \n\t\t\tdefined for the component.</p>"
}
},
"owner": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The owner of the component.</p>"
}
},
"data": {
"target": "com.amazonaws.imagebuilder#ComponentData",
"traits": {
"smithy.api#documentation": "<p>Component data contains the YAML document content for the component.</p>"
}
},
"kmsKeyId": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The KMS key identifier used to encrypt the component.</p>"
}
},
"encrypted": {
"target": "com.amazonaws.imagebuilder#NullableBoolean",
"traits": {
"smithy.api#documentation": "<p>The encryption status of the component.</p>"
}
},
"dateCreated": {
"target": "com.amazonaws.imagebuilder#DateTime",
"traits": {
"smithy.api#documentation": "<p>The date that Image Builder created the component.</p>"
}
},
"tags": {
"target": "com.amazonaws.imagebuilder#TagMap",
"traits": {
"smithy.api#documentation": "<p>The tags that apply to the component.</p>"
}
},
"publisher": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>Contains the name of the publisher if this is a third-party component. Otherwise, \n\t\t\tthis property is empty.</p>"
}
},
"obfuscate": {
"target": "com.amazonaws.imagebuilder#Boolean",
"traits": {
"smithy.api#default": false,
"smithy.api#documentation": "<p>Indicates whether component source is hidden from view in the console, and from \n\t\t\tcomponent detail results for API, CLI, or SDK operations.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A detailed view of a component.</p>"
}
},
"com.amazonaws.imagebuilder#ComponentBuildVersionArn": {
"type": "string",
"traits": {
"smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):component/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+$"
}
},
"com.amazonaws.imagebuilder#ComponentConfiguration": {
"type": "structure",
"members": {
"componentArn": {
"target": "com.amazonaws.imagebuilder#ComponentVersionArnOrBuildVersionArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the component.</p>",
"smithy.api#required": {}
}
},
"parameters": {
"target": "com.amazonaws.imagebuilder#ComponentParameterList",
"traits": {
"smithy.api#documentation": "<p>A group of parameter settings that Image Builder uses to configure the component for a specific\n\t\t\trecipe.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Configuration details of the component.</p>"
}
},
"com.amazonaws.imagebuilder#ComponentConfigurationList": {
"type": "list",
"member": {
"target": "com.amazonaws.imagebuilder#ComponentConfiguration"
},
"traits": {
"smithy.api#length": {
"min": 1
}
}
},
"com.amazonaws.imagebuilder#ComponentData": {
"type": "string"
},
"com.amazonaws.imagebuilder#ComponentFormat": {
"type": "enum",
"members": {
"SHELL": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "SHELL"
}
}
}
},
"com.amazonaws.imagebuilder#ComponentParameter": {
"type": "structure",
"members": {
"name": {
"target": "com.amazonaws.imagebuilder#ComponentParameterName",
"traits": {
"smithy.api#documentation": "<p>The name of the component parameter to set.</p>",
"smithy.api#required": {}
}
},
"value": {
"target": "com.amazonaws.imagebuilder#ComponentParameterValueList",
"traits": {
"smithy.api#documentation": "<p>Sets the value for the named component parameter.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains a key/value pair that sets the named component parameter.</p>"
}
},
"com.amazonaws.imagebuilder#ComponentParameterDescription": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 1024
},
"smithy.api#pattern": "^[^\\x00]+$"
}
},
"com.amazonaws.imagebuilder#ComponentParameterDetail": {
"type": "structure",
"members": {
"name": {
"target": "com.amazonaws.imagebuilder#ComponentParameterName",
"traits": {
"smithy.api#documentation": "<p>The name of this input parameter.</p>",
"smithy.api#required": {}
}
},
"type": {
"target": "com.amazonaws.imagebuilder#ComponentParameterType",
"traits": {
"smithy.api#documentation": "<p>The type of input this parameter provides. The currently supported value is\n\t\t\t\"string\".</p>",
"smithy.api#required": {}
}
},
"defaultValue": {
"target": "com.amazonaws.imagebuilder#ComponentParameterValueList",
"traits": {
"smithy.api#documentation": "<p>The default value of this parameter if no input is provided.</p>"
}
},
"description": {
"target": "com.amazonaws.imagebuilder#ComponentParameterDescription",
"traits": {
"smithy.api#documentation": "<p>Describes this parameter.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Defines a parameter that is used to provide configuration details for the\n\t\t\tcomponent.</p>"
}
},
"com.amazonaws.imagebuilder#ComponentParameterDetailList": {
"type": "list",
"member": {
"target": "com.amazonaws.imagebuilder#ComponentParameterDetail"
}
},
"com.amazonaws.imagebuilder#ComponentParameterList": {
"type": "list",
"member": {
"target": "com.amazonaws.imagebuilder#ComponentParameter"
},
"traits": {
"smithy.api#length": {
"min": 1
}
}
},
"com.amazonaws.imagebuilder#ComponentParameterName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 256
},
"smithy.api#pattern": "^[^\\x00]+$"
}
},
"com.amazonaws.imagebuilder#ComponentParameterType": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 20
},
"smithy.api#pattern": "^String|Integer|Boolean|StringList$"
}
},
"com.amazonaws.imagebuilder#ComponentParameterValue": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0
},
"smithy.api#pattern": "^[^\\x00]*$"
}
},
"com.amazonaws.imagebuilder#ComponentParameterValueList": {
"type": "list",
"member": {
"target": "com.amazonaws.imagebuilder#ComponentParameterValue"
}
},
"com.amazonaws.imagebuilder#ComponentState": {
"type": "structure",
"members": {
"status": {
"target": "com.amazonaws.imagebuilder#ComponentStatus",
"traits": {
"smithy.api#documentation": "<p>The current state of the component.</p>"
}
},
"reason": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>Describes how or why the component changed state.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A group of fields that describe the current status of components.</p>"
}
},
"com.amazonaws.imagebuilder#ComponentStatus": {
"type": "enum",
"members": {
"DEPRECATED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "DEPRECATED"
}
}
}
},
"com.amazonaws.imagebuilder#ComponentSummary": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.imagebuilder#ImageBuilderArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the component.</p>"
}
},
"name": {
"target": "com.amazonaws.imagebuilder#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The name of the component.</p>"
}
},
"version": {
"target": "com.amazonaws.imagebuilder#VersionNumber",
"traits": {
"smithy.api#documentation": "<p>The version of the component.</p>"
}
},
"platform": {
"target": "com.amazonaws.imagebuilder#Platform",
"traits": {
"smithy.api#documentation": "<p>The operating system platform of the component.</p>"
}
},
"supportedOsVersions": {
"target": "com.amazonaws.imagebuilder#OsVersionList",
"traits": {
"smithy.api#documentation": "<p>The operating system (OS) version that the component supports. If the OS information\n\t\t\tis available, Image Builder performs a prefix match against the base image OS version during\n\t\t\timage recipe creation.</p>"
}
},
"state": {
"target": "com.amazonaws.imagebuilder#ComponentState",
"traits": {
"smithy.api#documentation": "<p>Describes the current status of the component.</p>"
}
},
"type": {
"target": "com.amazonaws.imagebuilder#ComponentType",
"traits": {
"smithy.api#documentation": "<p>The component type specifies whether Image Builder uses the component to build the image or\n\t\t\tonly to test it.</p>"
}
},
"owner": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The owner of the component.</p>"
}
},
"description": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The description of the component.</p>"
}
},
"changeDescription": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The change description for the current version of the component.</p>"
}
},
"dateCreated": {
"target": "com.amazonaws.imagebuilder#DateTime",
"traits": {
"smithy.api#documentation": "<p>The original creation date of the component.</p>"
}
},
"tags": {
"target": "com.amazonaws.imagebuilder#TagMap",
"traits": {
"smithy.api#documentation": "<p>The tags that apply to the component.</p>"
}
},
"publisher": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>Contains the name of the publisher if this is a third-party component. Otherwise, \n\t\t\tthis property is empty.</p>"
}
},
"obfuscate": {
"target": "com.amazonaws.imagebuilder#Boolean",
"traits": {
"smithy.api#default": false,
"smithy.api#documentation": "<p>Indicates whether component source is hidden from view in the console, \n\t\t\tand from component detail results for API, CLI, or SDK operations.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A high-level summary of a component.</p>"
}
},
"com.amazonaws.imagebuilder#ComponentSummaryList": {
"type": "list",
"member": {
"target": "com.amazonaws.imagebuilder#ComponentSummary"
}
},
"com.amazonaws.imagebuilder#ComponentType": {
"type": "enum",
"members": {
"BUILD": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "BUILD"
}
},
"TEST": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "TEST"
}
}
}
},
"com.amazonaws.imagebuilder#ComponentVersion": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.imagebuilder#ImageBuilderArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the component.</p>\n <note>\n <p>Semantic versioning is included in each object's Amazon Resource Name (ARN), \n\tat the level that applies to that object as follows:</p>\n <ol>\n <li>\n <p>Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are \n\t\t\t\teither left off entirely, or they are specified as wildcards, for example: x.x.x.</p>\n </li>\n <li>\n <p>Version ARNs have only the first three nodes: <major>.<minor>.<patch></p>\n </li>\n <li>\n <p>Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.</p>\n </li>\n </ol>\n </note>"
}
},
"name": {
"target": "com.amazonaws.imagebuilder#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The name of the component.</p>"
}
},
"version": {
"target": "com.amazonaws.imagebuilder#VersionNumber",
"traits": {
"smithy.api#documentation": "<p>The semantic version of the component.</p>\n <note>\n <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>. \n\tYou can assign values for the first three, and can filter on all of them.</p>\n <p>\n <b>Assignment:</b> For the first three nodes you can assign any positive integer value, including \n\tzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.</p>\n <p>\n <b>Patterns:</b> You can use any numeric pattern that adheres to the assignment requirements for \n\tthe nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or \n\ta date, such as 2021.01.01.</p>\n <p>\n <b>Filtering:</b> With semantic versioning, you have the flexibility to use wildcards (x) \n\tto specify the most recent versions or nodes when selecting the base image or components for your \n\trecipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be \n\twildcards.</p>\n </note>"
}
},
"description": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The description of the component.</p>"
}
},
"platform": {
"target": "com.amazonaws.imagebuilder#Platform",
"traits": {
"smithy.api#documentation": "<p>The platform of the component.</p>"
}
},
"supportedOsVersions": {
"target": "com.amazonaws.imagebuilder#OsVersionList",
"traits": {
"smithy.api#documentation": "<p>he operating system (OS) version supported by the component. If the OS information is\n\t\t\tavailable, a prefix match is performed against the base image OS version during image\n\t\t\trecipe creation.</p>"
}
},
"type": {
"target": "com.amazonaws.imagebuilder#ComponentType",
"traits": {
"smithy.api#documentation": "<p>The type of the component denotes whether the component is used to build the image or\n\t\t\tonly to test it.</p>"
}
},
"owner": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The owner of the component.</p>"
}
},
"dateCreated": {
"target": "com.amazonaws.imagebuilder#DateTime",
"traits": {
"smithy.api#documentation": "<p>The date that the component was created.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The defining characteristics of a specific version of an Amazon Web Services TOE component.</p>"
}
},
"com.amazonaws.imagebuilder#ComponentVersionArn": {
"type": "string",
"traits": {
"smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):component/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+$"
}
},
"com.amazonaws.imagebuilder#ComponentVersionArnOrBuildVersionArn": {
"type": "string",
"traits": {
"smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):component/[a-z0-9-_]+/(?:(?:([0-9]+|x)\\.([0-9]+|x)\\.([0-9]+|x))|(?:[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+))$"
}
},
"com.amazonaws.imagebuilder#ComponentVersionList": {
"type": "list",
"member": {
"target": "com.amazonaws.imagebuilder#ComponentVersion"
}
},
"com.amazonaws.imagebuilder#Container": {
"type": "structure",
"members": {
"region": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>Containers and container images are Region-specific. This is the Region context for\n\t\t\tthe container.</p>"
}
},
"imageUris": {
"target": "com.amazonaws.imagebuilder#StringList",
"traits": {
"smithy.api#documentation": "<p>A list of URIs for containers created in the context Region.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A container encapsulates the runtime environment for an application.</p>"
}
},
"com.amazonaws.imagebuilder#ContainerDistributionConfiguration": {
"type": "structure",
"members": {
"description": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The description of the container distribution configuration.</p>"
}
},
"containerTags": {
"target": "com.amazonaws.imagebuilder#StringList",
"traits": {
"smithy.api#documentation": "<p>Tags that are attached to the container distribution configuration.</p>"
}
},
"targetRepository": {
"target": "com.amazonaws.imagebuilder#TargetContainerRepository",
"traits": {
"smithy.api#documentation": "<p>The destination repository for the container distribution configuration.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Container distribution settings for encryption, licensing, and sharing in a specific\n\t\t\tRegion.</p>"
}
},
"com.amazonaws.imagebuilder#ContainerList": {
"type": "list",
"member": {
"target": "com.amazonaws.imagebuilder#Container"
}
},
"com.amazonaws.imagebuilder#ContainerRecipe": {
"type": "structure",
"members": {
"arn": {