-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
docs-2.json
3378 lines (3378 loc) · 221 KB
/
docs-2.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
{
"version": "2.0",
"service": "<p>EC2 Image Builder is a fully managed Amazon Web Services service that makes it easier to automate the creation, management, and deployment of customized, secure, and up-to-date \"golden\" server images that are pre-installed and pre-configured with software and settings to meet specific IT standards.</p>",
"operations": {
"CancelImageCreation": "<p>CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.</p>",
"CancelLifecycleExecution": "<p>Cancel a specific image lifecycle policy runtime instance.</p>",
"CreateComponent": "<p>Creates a new component that can be used to build, validate, test, and assess your image. The component is based on a YAML document that you specify using exactly one of the following methods:</p> <ul> <li> <p>Inline, using the <code>data</code> property in the request body.</p> </li> <li> <p>A URL that points to a YAML document file stored in Amazon S3, using the <code>uri</code> property in the request body.</p> </li> </ul>",
"CreateContainerRecipe": "<p>Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.</p>",
"CreateDistributionConfiguration": "<p>Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.</p>",
"CreateImage": "<p>Creates a new image. This request will create a new image along with all of the configured output resources defined in the distribution configuration. You must specify exactly one recipe for your image, using either a ContainerRecipeArn or an ImageRecipeArn.</p>",
"CreateImagePipeline": "<p>Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.</p>",
"CreateImageRecipe": "<p>Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.</p>",
"CreateInfrastructureConfiguration": "<p>Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.</p>",
"CreateLifecyclePolicy": "<p>Create a lifecycle policy resource.</p>",
"CreateWorkflow": "<p>Create a new workflow or a new version of an existing workflow.</p>",
"DeleteComponent": "<p>Deletes a component build version.</p>",
"DeleteContainerRecipe": "<p>Deletes a container recipe.</p>",
"DeleteDistributionConfiguration": "<p>Deletes a distribution configuration.</p>",
"DeleteImage": "<p>Deletes an Image Builder image resource. This does not delete any EC2 AMIs or ECR container images that are created during the image build process. You must clean those up separately, using the appropriate Amazon EC2 or Amazon ECR console actions, or API or CLI commands.</p> <ul> <li> <p>To deregister an EC2 Linux AMI, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/deregister-ami.html\">Deregister your Linux AMI</a> in the <i> <i>Amazon EC2 User Guide</i> </i>.</p> </li> <li> <p>To deregister an EC2 Windows AMI, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/deregister-ami.html\">Deregister your Windows AMI</a> in the <i> <i>Amazon EC2 Windows Guide</i> </i>.</p> </li> <li> <p>To delete a container image from Amazon ECR, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/delete_image.html\">Deleting an image</a> in the <i>Amazon ECR User Guide</i>.</p> </li> </ul>",
"DeleteImagePipeline": "<p>Deletes an image pipeline.</p>",
"DeleteImageRecipe": "<p>Deletes an image recipe.</p>",
"DeleteInfrastructureConfiguration": "<p>Deletes an infrastructure configuration.</p>",
"DeleteLifecyclePolicy": "<p>Delete the specified lifecycle policy resource.</p>",
"DeleteWorkflow": "<p>Deletes a specific workflow resource.</p>",
"GetComponent": "<p>Gets a component object.</p>",
"GetComponentPolicy": "<p>Gets a component policy.</p>",
"GetContainerRecipe": "<p>Retrieves a container recipe.</p>",
"GetContainerRecipePolicy": "<p>Retrieves the policy for a container recipe.</p>",
"GetDistributionConfiguration": "<p>Gets a distribution configuration.</p>",
"GetImage": "<p>Gets an image.</p>",
"GetImagePipeline": "<p>Gets an image pipeline.</p>",
"GetImagePolicy": "<p>Gets an image policy.</p>",
"GetImageRecipe": "<p>Gets an image recipe.</p>",
"GetImageRecipePolicy": "<p>Gets an image recipe policy.</p>",
"GetInfrastructureConfiguration": "<p>Gets an infrastructure configuration.</p>",
"GetLifecycleExecution": "<p>Get the runtime information that was logged for a specific runtime instance of the lifecycle policy.</p>",
"GetLifecyclePolicy": "<p>Get details for the specified image lifecycle policy.</p>",
"GetWorkflow": "<p>Get a workflow resource object.</p>",
"GetWorkflowExecution": "<p>Get the runtime information that was logged for a specific runtime instance of the workflow.</p>",
"GetWorkflowStepExecution": "<p>Get the runtime information that was logged for a specific runtime instance of the workflow step.</p>",
"ImportComponent": "<p>Imports a component and transforms its data into a component document.</p>",
"ImportVmImage": "<p>When you export your virtual machine (VM) from its virtualization environment, that process creates a set of one or more disk container files that act as snapshots of your VM’s environment, settings, and data. The Amazon EC2 API <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportImage.html\">ImportImage</a> action uses those files to import your VM and create an AMI. To import using the CLI command, see <a href=\"https://docs.aws.amazon.com/cli/latest/reference/ec2/import-image.html\">import-image</a> </p> <p>You can reference the task ID from the VM import to pull in the AMI that the import created as the base image for your Image Builder recipe.</p>",
"ListComponentBuildVersions": "<p>Returns the list of component build versions for the specified semantic version.</p> <note> <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.</p> <p> <b>Filtering:</b> With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.</p> </note>",
"ListComponents": "<p>Returns the list of components that can be filtered by name, or by using the listed <code>filters</code> to streamline results. Newly created components can take up to two minutes to appear in the ListComponents API Results.</p> <note> <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.</p> <p> <b>Filtering:</b> With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.</p> </note>",
"ListContainerRecipes": "<p>Returns a list of container recipes.</p>",
"ListDistributionConfigurations": "<p>Returns a list of distribution configurations.</p>",
"ListImageBuildVersions": "<p>Returns a list of image build versions.</p>",
"ListImagePackages": "<p>List the Packages that are associated with an Image Build Version, as determined by Amazon Web Services Systems Manager Inventory at build time.</p>",
"ListImagePipelineImages": "<p>Returns a list of images created by the specified pipeline.</p>",
"ListImagePipelines": "<p>Returns a list of image pipelines.</p>",
"ListImageRecipes": "<p>Returns a list of image recipes.</p>",
"ListImageScanFindingAggregations": "<p>Returns a list of image scan aggregations for your account. You can filter by the type of key that Image Builder uses to group results. For example, if you want to get a list of findings by severity level for one of your pipelines, you might specify your pipeline with the <code>imagePipelineArn</code> filter. If you don't specify a filter, Image Builder returns an aggregation for your account.</p> <p>To streamline results, you can use the following filters in your request:</p> <ul> <li> <p> <code>accountId</code> </p> </li> <li> <p> <code>imageBuildVersionArn</code> </p> </li> <li> <p> <code>imagePipelineArn</code> </p> </li> <li> <p> <code>vulnerabilityId</code> </p> </li> </ul>",
"ListImageScanFindings": "<p>Returns a list of image scan findings for your account.</p>",
"ListImages": "<p>Returns the list of images that you have access to. Newly created images can take up to two minutes to appear in the ListImages API Results.</p>",
"ListInfrastructureConfigurations": "<p>Returns a list of infrastructure configurations.</p>",
"ListLifecycleExecutionResources": "<p>List resources that the runtime instance of the image lifecycle identified for lifecycle actions.</p>",
"ListLifecycleExecutions": "<p>Get the lifecycle runtime history for the specified resource.</p>",
"ListLifecyclePolicies": "<p>Get a list of lifecycle policies in your Amazon Web Services account.</p>",
"ListTagsForResource": "<p>Returns the list of tags for the specified resource.</p>",
"ListWaitingWorkflowSteps": "<p>Get a list of workflow steps that are waiting for action for workflows in your Amazon Web Services account.</p>",
"ListWorkflowBuildVersions": "<p>Returns a list of build versions for a specific workflow resource.</p>",
"ListWorkflowExecutions": "<p>Returns a list of workflow runtime instance metadata objects for a specific image build version.</p>",
"ListWorkflowStepExecutions": "<p>Returns runtime data for each step in a runtime instance of the workflow that you specify in the request.</p>",
"ListWorkflows": "<p>Lists workflow build versions based on filtering parameters.</p>",
"PutComponentPolicy": "<p>Applies a policy to a component. We recommend that you call the RAM API <a href=\"https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html\">CreateResourceShare</a> to share resources. If you call the Image Builder API <code>PutComponentPolicy</code>, you must also call the RAM API <a href=\"https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html\">PromoteResourceShareCreatedFromPolicy</a> in order for the resource to be visible to all principals with whom the resource is shared.</p>",
"PutContainerRecipePolicy": "<p>Applies a policy to a container image. We recommend that you call the RAM API CreateResourceShare (https://docs.aws.amazon.com//ram/latest/APIReference/API_CreateResourceShare.html) to share resources. If you call the Image Builder API <code>PutContainerImagePolicy</code>, you must also call the RAM API PromoteResourceShareCreatedFromPolicy (https://docs.aws.amazon.com//ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) in order for the resource to be visible to all principals with whom the resource is shared.</p>",
"PutImagePolicy": "<p>Applies a policy to an image. We recommend that you call the RAM API <a href=\"https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html\">CreateResourceShare</a> to share resources. If you call the Image Builder API <code>PutImagePolicy</code>, you must also call the RAM API <a href=\"https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html\">PromoteResourceShareCreatedFromPolicy</a> in order for the resource to be visible to all principals with whom the resource is shared.</p>",
"PutImageRecipePolicy": "<p>Applies a policy to an image recipe. We recommend that you call the RAM API <a href=\"https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html\">CreateResourceShare</a> to share resources. If you call the Image Builder API <code>PutImageRecipePolicy</code>, you must also call the RAM API <a href=\"https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html\">PromoteResourceShareCreatedFromPolicy</a> in order for the resource to be visible to all principals with whom the resource is shared.</p>",
"SendWorkflowStepAction": "<p>Pauses or resumes image creation when the associated workflow runs a <code>WaitForAction</code> step.</p>",
"StartImagePipelineExecution": "<p>Manually triggers a pipeline to create an image.</p>",
"StartResourceStateUpdate": "<p>Begin asynchronous resource state update for lifecycle changes to the specified image resources.</p>",
"TagResource": "<p>Adds a tag to a resource.</p>",
"UntagResource": "<p>Removes a tag from a resource.</p>",
"UpdateDistributionConfiguration": "<p>Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.</p>",
"UpdateImagePipeline": "<p>Updates an image pipeline. Image pipelines enable you to automate the creation and distribution of images. You must specify exactly one recipe for your image, using either a <code>containerRecipeArn</code> or an <code>imageRecipeArn</code>.</p> <note> <p>UpdateImagePipeline does not support selective updates for the pipeline. You must specify all of the required properties in the update request, not just the properties that have changed.</p> </note>",
"UpdateInfrastructureConfiguration": "<p>Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.</p>",
"UpdateLifecyclePolicy": "<p>Update the specified lifecycle policy.</p>"
},
"shapes": {
"AccountAggregation": {
"base": "<p>Contains counts of vulnerability findings from image scans that run when you create new Image Builder images, or build new versions of existing images. The vulnerability counts are grouped by severity level. The counts are aggregated across resources to create the final tally for the account that owns them.</p>",
"refs": {
"ImageScanFindingAggregation$accountAggregation": "<p>Returns an object that contains severity counts based on an account ID.</p>"
}
},
"AccountId": {
"base": null,
"refs": {
"AccountList$member": null,
"FastLaunchConfiguration$accountId": "<p>The owner account ID for the fast-launch enabled Windows AMI.</p>",
"LaunchTemplateConfiguration$accountId": "<p>The account ID that this configuration applies to.</p>"
}
},
"AccountList": {
"base": null,
"refs": {
"AmiDistributionConfiguration$targetAccountIds": "<p>The ID of an account to which you want to distribute an image.</p>",
"LaunchPermissionConfiguration$userIds": "<p>The Amazon Web Services account ID.</p>",
"LifecyclePolicyDetailExclusionRulesAmis$sharedAccounts": "<p>Specifies Amazon Web Services accounts whose resources are excluded from the lifecycle action.</p>"
}
},
"AdditionalInstanceConfiguration": {
"base": "<p>In addition to your infrastructure configuration, these settings provide an extra layer of control over your build instances. You can also specify commands to run on launch for all of your build instances.</p> <p>Image Builder does not automatically install the Systems Manager agent on Windows instances. If your base image includes the Systems Manager agent, then the AMI that you create will also include the agent. For Linux instances, if the base image does not already include the Systems Manager agent, Image Builder installs it. For Linux instances where Image Builder installs the Systems Manager agent, you can choose whether to keep it for the AMI that you create.</p>",
"refs": {
"CreateImageRecipeRequest$additionalInstanceConfiguration": "<p>Specify additional settings and launch scripts for your build instances.</p>",
"ImageRecipe$additionalInstanceConfiguration": "<p>Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration. Instance configuration adds a layer of control over those instances. You can define settings and add scripts to run when an instance is launched from your AMI.</p>"
}
},
"Ami": {
"base": "<p>Details of an Amazon EC2 AMI.</p>",
"refs": {
"AmiList$member": null
}
},
"AmiDistributionConfiguration": {
"base": "<p>Define and configure the output AMIs of the pipeline.</p>",
"refs": {
"Distribution$amiDistributionConfiguration": "<p>The specific AMI settings; for example, launch permissions or AMI tags.</p>"
}
},
"AmiList": {
"base": null,
"refs": {
"OutputResources$amis": "<p>The Amazon EC2 AMIs created by this image.</p>"
}
},
"AmiNameString": {
"base": null,
"refs": {
"AmiDistributionConfiguration$name": "<p>The name of the output AMI.</p>"
}
},
"Arn": {
"base": null,
"refs": {
"Image$sourcePipelineArn": "<p>The Amazon Resource Name (ARN) of the image pipeline that created this image.</p>",
"ImagePipeline$imageRecipeArn": "<p>The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.</p>",
"ImagePipeline$containerRecipeArn": "<p>The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.</p>",
"ImagePipeline$infrastructureConfigurationArn": "<p>The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.</p>",
"ImagePipeline$distributionConfigurationArn": "<p>The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.</p>",
"ImportVmImageResponse$imageArn": "<p>The Amazon Resource Name (ARN) of the AMI that was created during the VM import process. This AMI is used as the base image for the recipe that imported the VM.</p>"
}
},
"Boolean": {
"base": null,
"refs": {
"Component$obfuscate": "<p>Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.</p>",
"ComponentSummary$obfuscate": "<p>Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.</p>",
"FastLaunchConfiguration$enabled": "<p>A Boolean that represents the current state of faster launching for the Windows AMI. Set to <code>true</code> to start using Windows faster launching, or <code>false</code> to stop using it.</p>",
"LaunchTemplateConfiguration$setDefaultVersion": "<p>Set the specified Amazon EC2 launch template as the default launch template for the specified account.</p>",
"LifecycleExecutionResourcesImpactedSummary$hasImpactedResources": "<p>Indicates whether an image resource that was identified for a lifecycle action has associated resources that are also impacted.</p>",
"LifecyclePolicyDetailActionIncludeResources$amis": "<p>Specifies whether the lifecycle action should apply to distributed AMIs.</p>",
"LifecyclePolicyDetailActionIncludeResources$snapshots": "<p>Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs.</p>",
"LifecyclePolicyDetailActionIncludeResources$containers": "<p>Specifies whether the lifecycle action should apply to distributed containers.</p>",
"LifecyclePolicyDetailExclusionRulesAmis$isPublic": "<p>Configures whether public AMIs are excluded from the lifecycle action.</p>",
"ListComponentsRequest$byName": "<p>Returns the list of components for the specified name.</p>",
"ListImagesRequest$byName": "<p>Requests a list of images with a specific recipe name.</p>",
"ListWorkflowsRequest$byName": "<p>Specify all or part of the workflow name to streamline results.</p>",
"ResourceStateUpdateIncludeResources$amis": "<p>Specifies whether the lifecycle action should apply to distributed AMIs</p>",
"ResourceStateUpdateIncludeResources$snapshots": "<p>Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs.</p>",
"ResourceStateUpdateIncludeResources$containers": "<p>Specifies whether the lifecycle action should apply to distributed containers.</p>"
}
},
"BuildType": {
"base": null,
"refs": {
"Image$buildType": "<p>Indicates the type of build that created this image. The build can be initiated in the following ways:</p> <ul> <li> <p> <b>USER_INITIATED</b> – A manual pipeline build request.</p> </li> <li> <p> <b>SCHEDULED</b> – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.</p> </li> <li> <p> <b>IMPORT</b> – A VM import created the image to use as the base image for the recipe.</p> </li> </ul>",
"ImageSummary$buildType": "<p>Indicates the type of build that created this image. The build can be initiated in the following ways:</p> <ul> <li> <p> <b>USER_INITIATED</b> – A manual pipeline build request.</p> </li> <li> <p> <b>SCHEDULED</b> – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.</p> </li> <li> <p> <b>IMPORT</b> – A VM import created the image to use as the base image for the recipe.</p> </li> </ul>",
"ImageVersion$buildType": "<p>Indicates the type of build that created this image. The build can be initiated in the following ways:</p> <ul> <li> <p> <b>USER_INITIATED</b> – A manual pipeline build request.</p> </li> <li> <p> <b>SCHEDULED</b> – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.</p> </li> <li> <p> <b>IMPORT</b> – A VM import created the image to use as the base image for the recipe.</p> </li> </ul>"
}
},
"CallRateLimitExceededException": {
"base": "<p>You have exceeded the permitted request rate for the specific operation.</p>",
"refs": {
}
},
"CancelImageCreationRequest": {
"base": null,
"refs": {
}
},
"CancelImageCreationResponse": {
"base": null,
"refs": {
}
},
"CancelLifecycleExecutionRequest": {
"base": null,
"refs": {
}
},
"CancelLifecycleExecutionResponse": {
"base": null,
"refs": {
}
},
"ClientException": {
"base": "<p>These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.</p>",
"refs": {
}
},
"ClientToken": {
"base": null,
"refs": {
"CancelImageCreationRequest$clientToken": "<p>Unique, case-sensitive identifier you provide to ensure 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> in the <i>Amazon EC2 API Reference</i>.</p>",
"CancelImageCreationResponse$clientToken": "<p>The client token that uniquely identifies the request.</p>",
"CancelLifecycleExecutionRequest$clientToken": "<p>Unique, case-sensitive identifier you provide to ensure 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> in the <i>Amazon EC2 API Reference</i>.</p>",
"CreateComponentRequest$clientToken": "<p>Unique, case-sensitive identifier you provide to ensure 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> in the <i>Amazon EC2 API Reference</i>.</p>",
"CreateComponentResponse$clientToken": "<p>The client token that uniquely identifies the request.</p>",
"CreateContainerRecipeRequest$clientToken": "<p>Unique, case-sensitive identifier you provide to ensure 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> in the <i>Amazon EC2 API Reference</i>.</p>",
"CreateContainerRecipeResponse$clientToken": "<p>The client token that uniquely identifies the request.</p>",
"CreateDistributionConfigurationRequest$clientToken": "<p>Unique, case-sensitive identifier you provide to ensure 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> in the <i>Amazon EC2 API Reference</i>.</p>",
"CreateDistributionConfigurationResponse$clientToken": "<p>The client token that uniquely identifies the request.</p>",
"CreateImagePipelineRequest$clientToken": "<p>Unique, case-sensitive identifier you provide to ensure 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> in the <i>Amazon EC2 API Reference</i>.</p>",
"CreateImagePipelineResponse$clientToken": "<p>The client token that uniquely identifies the request.</p>",
"CreateImageRecipeRequest$clientToken": "<p>Unique, case-sensitive identifier you provide to ensure 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> in the <i>Amazon EC2 API Reference</i>.</p>",
"CreateImageRecipeResponse$clientToken": "<p>The client token that uniquely identifies the request.</p>",
"CreateImageRequest$clientToken": "<p>Unique, case-sensitive identifier you provide to ensure 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> in the <i>Amazon EC2 API Reference</i>.</p>",
"CreateImageResponse$clientToken": "<p>The client token that uniquely identifies the request.</p>",
"CreateInfrastructureConfigurationRequest$clientToken": "<p>Unique, case-sensitive identifier you provide to ensure 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> in the <i>Amazon EC2 API Reference</i>.</p>",
"CreateInfrastructureConfigurationResponse$clientToken": "<p>The client token that uniquely identifies the request.</p>",
"CreateLifecyclePolicyRequest$clientToken": "<p>Unique, case-sensitive identifier you provide to ensure 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> in the <i>Amazon EC2 API Reference</i>.</p>",
"CreateLifecyclePolicyResponse$clientToken": "<p>The client token that uniquely identifies the request.</p>",
"CreateWorkflowRequest$clientToken": "<p>Unique, case-sensitive identifier you provide to ensure 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> in the <i>Amazon EC2 API Reference</i>.</p>",
"CreateWorkflowResponse$clientToken": "<p>The client token that uniquely identifies the request.</p>",
"ImportComponentRequest$clientToken": "<p>Unique, case-sensitive identifier you provide to ensure 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> in the <i>Amazon EC2 API Reference</i>.</p>",
"ImportComponentResponse$clientToken": "<p>The client token that uniquely identifies the request.</p>",
"ImportVmImageRequest$clientToken": "<p>Unique, case-sensitive identifier you provide to ensure 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> in the <i>Amazon EC2 API Reference</i>.</p>",
"ImportVmImageResponse$clientToken": "<p>The client token that uniquely identifies the request.</p>",
"SendWorkflowStepActionRequest$clientToken": "<p>Unique, case-sensitive identifier you provide to ensure 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> in the <i>Amazon EC2 API Reference</i>.</p>",
"SendWorkflowStepActionResponse$clientToken": "<p>The client token that uniquely identifies the request.</p>",
"StartImagePipelineExecutionRequest$clientToken": "<p>Unique, case-sensitive identifier you provide to ensure 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> in the <i>Amazon EC2 API Reference</i>.</p>",
"StartImagePipelineExecutionResponse$clientToken": "<p>The client token that uniquely identifies the request.</p>",
"StartResourceStateUpdateRequest$clientToken": "<p>Unique, case-sensitive identifier you provide to ensure 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> in the <i>Amazon EC2 API Reference</i>.</p>",
"UpdateDistributionConfigurationRequest$clientToken": "<p>Unique, case-sensitive identifier you provide to ensure 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> in the <i>Amazon EC2 API Reference</i>.</p>",
"UpdateDistributionConfigurationResponse$clientToken": "<p>The client token that uniquely identifies the request.</p>",
"UpdateImagePipelineRequest$clientToken": "<p>Unique, case-sensitive identifier you provide to ensure 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> in the <i>Amazon EC2 API Reference</i>.</p>",
"UpdateImagePipelineResponse$clientToken": "<p>The client token that uniquely identifies the request.</p>",
"UpdateInfrastructureConfigurationRequest$clientToken": "<p>Unique, case-sensitive identifier you provide to ensure 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> in the <i>Amazon EC2 API Reference</i>.</p>",
"UpdateInfrastructureConfigurationResponse$clientToken": "<p>The client token that uniquely identifies the request.</p>",
"UpdateLifecyclePolicyRequest$clientToken": "<p>Unique, case-sensitive identifier you provide to ensure 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> in the <i>Amazon EC2 API Reference</i>.</p>"
}
},
"Component": {
"base": "<p>A detailed view of a component.</p>",
"refs": {
"GetComponentResponse$component": "<p>The component object specified in the request.</p>"
}
},
"ComponentBuildVersionArn": {
"base": null,
"refs": {
"CreateComponentResponse$componentBuildVersionArn": "<p>The Amazon Resource Name (ARN) of the component that the request created.</p>",
"DeleteComponentRequest$componentBuildVersionArn": "<p>The Amazon Resource Name (ARN) of the component build version to delete.</p>",
"DeleteComponentResponse$componentBuildVersionArn": "<p>The ARN of the component build version that this request deleted.</p>",
"GetComponentPolicyRequest$componentArn": "<p>The Amazon Resource Name (ARN) of the component whose policy you want to retrieve.</p>",
"ImportComponentResponse$componentBuildVersionArn": "<p>The Amazon Resource Name (ARN) of the imported component.</p>",
"PutComponentPolicyRequest$componentArn": "<p>The Amazon Resource Name (ARN) of the component that this policy should be applied to.</p>",
"PutComponentPolicyResponse$componentArn": "<p>The Amazon Resource Name (ARN) of the component that this policy was applied to.</p>"
}
},
"ComponentConfiguration": {
"base": "<p>Configuration details of the component.</p>",
"refs": {
"ComponentConfigurationList$member": null
}
},
"ComponentConfigurationList": {
"base": null,
"refs": {
"ContainerRecipe$components": "<p>Build and test components that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.</p>",
"CreateContainerRecipeRequest$components": "<p>Components for build and test that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.</p>",
"CreateImageRecipeRequest$components": "<p>The components included in the image recipe.</p>",
"ImageRecipe$components": "<p>The components that are included in the image recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.</p>"
}
},
"ComponentData": {
"base": null,
"refs": {
"Component$data": "<p>Component data contains the YAML document content for the component.</p>"
}
},
"ComponentFormat": {
"base": null,
"refs": {
"ImportComponentRequest$format": "<p>The format of the resource that you want to import as a component.</p>"
}
},
"ComponentParameter": {
"base": "<p>Contains a key/value pair that sets the named component parameter.</p>",
"refs": {
"ComponentParameterList$member": null
}
},
"ComponentParameterDescription": {
"base": null,
"refs": {
"ComponentParameterDetail$description": "<p>Describes this parameter.</p>"
}
},
"ComponentParameterDetail": {
"base": "<p>Defines a parameter that is used to provide configuration details for the component.</p>",
"refs": {
"ComponentParameterDetailList$member": null
}
},
"ComponentParameterDetailList": {
"base": null,
"refs": {
"Component$parameters": "<p>Contains parameter details for each of the parameters that the component document defined for the component.</p>"
}
},
"ComponentParameterList": {
"base": null,
"refs": {
"ComponentConfiguration$parameters": "<p>A group of parameter settings that Image Builder uses to configure the component for a specific recipe.</p>"
}
},
"ComponentParameterName": {
"base": null,
"refs": {
"ComponentParameter$name": "<p>The name of the component parameter to set.</p>",
"ComponentParameterDetail$name": "<p>The name of this input parameter.</p>"
}
},
"ComponentParameterType": {
"base": null,
"refs": {
"ComponentParameterDetail$type": "<p>The type of input this parameter provides. The currently supported value is \"string\".</p>"
}
},
"ComponentParameterValue": {
"base": null,
"refs": {
"ComponentParameterValueList$member": null
}
},
"ComponentParameterValueList": {
"base": null,
"refs": {
"ComponentParameter$value": "<p>Sets the value for the named component parameter.</p>",
"ComponentParameterDetail$defaultValue": "<p>The default value of this parameter if no input is provided.</p>"
}
},
"ComponentState": {
"base": "<p>A group of fields that describe the current status of components.</p>",
"refs": {
"Component$state": "<p>Describes the current status of the component. This is used for components that are no longer active.</p>",
"ComponentSummary$state": "<p>Describes the current status of the component.</p>"
}
},
"ComponentStatus": {
"base": null,
"refs": {
"ComponentState$status": "<p>The current state of the component.</p>"
}
},
"ComponentSummary": {
"base": "<p>A high-level summary of a component.</p>",
"refs": {
"ComponentSummaryList$member": null
}
},
"ComponentSummaryList": {
"base": null,
"refs": {
"ListComponentBuildVersionsResponse$componentSummaryList": "<p>The list of component summaries for the specified semantic version.</p>"
}
},
"ComponentType": {
"base": null,
"refs": {
"Component$type": "<p>The component type specifies whether Image Builder uses the component to build the image or only to test it.</p>",
"ComponentSummary$type": "<p>The component type specifies whether Image Builder uses the component to build the image or only to test it.</p>",
"ComponentVersion$type": "<p>The type of the component denotes whether the component is used to build the image or only to test it.</p>",
"ImportComponentRequest$type": "<p>The type of the component denotes whether the component is used to build the image, or only to test it.</p>"
}
},
"ComponentVersion": {
"base": "<p>The defining characteristics of a specific version of an Amazon Web Services TOE component.</p>",
"refs": {
"ComponentVersionList$member": null
}
},
"ComponentVersionArn": {
"base": null,
"refs": {
"ListComponentBuildVersionsRequest$componentVersionArn": "<p>The component version Amazon Resource Name (ARN) whose versions you want to list.</p>"
}
},
"ComponentVersionArnOrBuildVersionArn": {
"base": null,
"refs": {
"ComponentConfiguration$componentArn": "<p>The Amazon Resource Name (ARN) of the component.</p>",
"GetComponentRequest$componentBuildVersionArn": "<p>The Amazon Resource Name (ARN) of the component that you want to get. Regex requires the suffix <code>/\\d+$</code>.</p>"
}
},
"ComponentVersionList": {
"base": null,
"refs": {
"ListComponentsResponse$componentVersionList": "<p>The list of component semantic versions.</p> <note> <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.</p> </note>"
}
},
"Container": {
"base": "<p>A container encapsulates the runtime environment for an application.</p>",
"refs": {
"ContainerList$member": null
}
},
"ContainerDistributionConfiguration": {
"base": "<p>Container distribution settings for encryption, licensing, and sharing in a specific Region.</p>",
"refs": {
"Distribution$containerDistributionConfiguration": "<p>Container distribution settings for encryption, licensing, and sharing in a specific Region.</p>"
}
},
"ContainerList": {
"base": null,
"refs": {
"OutputResources$containers": "<p>Container images that the pipeline has generated and stored in the output repository.</p>"
}
},
"ContainerRecipe": {
"base": "<p>A container recipe.</p>",
"refs": {
"GetContainerRecipeResponse$containerRecipe": "<p>The container recipe object that is returned.</p>",
"Image$containerRecipe": "<p>For container images, this is the container recipe that Image Builder used to create the image. For images that distribute an AMI, this is empty.</p>"
}
},
"ContainerRecipeArn": {
"base": null,
"refs": {
"CreateContainerRecipeResponse$containerRecipeArn": "<p>Returns the Amazon Resource Name (ARN) of the container recipe that the request created.</p>",
"CreateImagePipelineRequest$containerRecipeArn": "<p>The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline.</p>",
"CreateImageRequest$containerRecipeArn": "<p>The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.</p>",
"DeleteContainerRecipeRequest$containerRecipeArn": "<p>The Amazon Resource Name (ARN) of the container recipe to delete.</p>",
"DeleteContainerRecipeResponse$containerRecipeArn": "<p>The Amazon Resource Name (ARN) of the container recipe that was deleted.</p>",
"GetContainerRecipePolicyRequest$containerRecipeArn": "<p>The Amazon Resource Name (ARN) of the container recipe for the policy being requested.</p>",
"GetContainerRecipeRequest$containerRecipeArn": "<p>The Amazon Resource Name (ARN) of the container recipe to retrieve.</p>",
"PutContainerRecipePolicyRequest$containerRecipeArn": "<p>The Amazon Resource Name (ARN) of the container recipe that this policy should be applied to.</p>",
"PutContainerRecipePolicyResponse$containerRecipeArn": "<p>The Amazon Resource Name (ARN) of the container recipe that this policy was applied to.</p>",
"UpdateImagePipelineRequest$containerRecipeArn": "<p>The Amazon Resource Name (ARN) of the container pipeline to update.</p>"
}
},
"ContainerRecipeSummary": {
"base": "<p>A summary of a container recipe</p>",
"refs": {
"ContainerRecipeSummaryList$member": null
}
},
"ContainerRecipeSummaryList": {
"base": null,
"refs": {
"ListContainerRecipesResponse$containerRecipeSummaryList": "<p>The list of container recipes returned for the request.</p>"
}
},
"ContainerRepositoryService": {
"base": null,
"refs": {
"TargetContainerRepository$service": "<p>Specifies the service in which this image was registered.</p>"
}
},
"ContainerType": {
"base": null,
"refs": {
"ContainerRecipe$containerType": "<p>Specifies the type of container, such as Docker.</p>",
"ContainerRecipeSummary$containerType": "<p>Specifies the type of container, such as \"Docker\".</p>",
"CreateContainerRecipeRequest$containerType": "<p>The type of container to create.</p>"
}
},
"CreateComponentRequest": {
"base": null,
"refs": {
}
},
"CreateComponentResponse": {
"base": null,
"refs": {
}
},
"CreateContainerRecipeRequest": {
"base": null,
"refs": {
}
},
"CreateContainerRecipeResponse": {
"base": null,
"refs": {
}
},
"CreateDistributionConfigurationRequest": {
"base": null,
"refs": {
}
},
"CreateDistributionConfigurationResponse": {
"base": null,
"refs": {
}
},
"CreateImagePipelineRequest": {
"base": null,
"refs": {
}
},
"CreateImagePipelineResponse": {
"base": null,
"refs": {
}
},
"CreateImageRecipeRequest": {
"base": null,
"refs": {
}
},
"CreateImageRecipeResponse": {
"base": null,
"refs": {
}
},
"CreateImageRequest": {
"base": null,
"refs": {
}
},
"CreateImageResponse": {
"base": null,
"refs": {
}
},
"CreateInfrastructureConfigurationRequest": {
"base": null,
"refs": {
}
},
"CreateInfrastructureConfigurationResponse": {
"base": null,
"refs": {
}
},
"CreateLifecyclePolicyRequest": {
"base": null,
"refs": {
}
},
"CreateLifecyclePolicyResponse": {
"base": null,
"refs": {
}
},
"CreateWorkflowRequest": {
"base": null,
"refs": {
}
},
"CreateWorkflowResponse": {
"base": null,
"refs": {
}
},
"CvssScore": {
"base": "<p>Amazon Inspector generates a risk score for each finding. This score helps you to prioritize findings, to focus on the most critical findings and the most vulnerable resources. The score uses the Common Vulnerability Scoring System (CVSS) format. This format is a modification of the base CVSS score that the National Vulnerability Database (NVD) provides. For more information about severity levels, see <a href=\"https://docs.aws.amazon.com/inspector/latest/user/findings-understanding-severity.html\">Severity levels for Amazon Inspector findings</a> in the <i>Amazon Inspector User Guide</i>.</p>",
"refs": {
"CvssScoreList$member": null
}
},
"CvssScoreAdjustment": {
"base": "<p>Details about an adjustment that Amazon Inspector made to the CVSS score for a finding.</p>",
"refs": {
"CvssScoreAdjustmentList$member": null
}
},
"CvssScoreAdjustmentList": {
"base": null,
"refs": {
"CvssScoreDetails$adjustments": "<p>An object that contains details about an adjustment that Amazon Inspector made to the CVSS score for the finding.</p>"
}
},
"CvssScoreDetails": {
"base": "<p>Details about the source of the score, and the factors that determined the adjustments to create the final score.</p>",
"refs": {
"InspectorScoreDetails$adjustedCvss": "<p>An object that contains details about an adjustment that Amazon Inspector made to the CVSS score for the finding.</p>"
}
},
"CvssScoreList": {
"base": null,
"refs": {
"PackageVulnerabilityDetails$cvss": "<p>CVSS scores for one or more vulnerabilities that Amazon Inspector identified for a package.</p>"
}
},
"DateTime": {
"base": null,
"refs": {
"Component$dateCreated": "<p>The date that Image Builder created the component.</p>",
"ComponentSummary$dateCreated": "<p>The original creation date of the component.</p>",
"ComponentVersion$dateCreated": "<p>The date that the component was created.</p>",
"ContainerRecipe$dateCreated": "<p>The date when this container recipe was created.</p>",
"ContainerRecipeSummary$dateCreated": "<p>The date when this container recipe was created.</p>",
"DistributionConfiguration$dateCreated": "<p>The date on which this distribution configuration was created.</p>",
"DistributionConfiguration$dateUpdated": "<p>The date on which this distribution configuration was last updated.</p>",
"DistributionConfigurationSummary$dateCreated": "<p>The date on which the distribution configuration was created.</p>",
"DistributionConfigurationSummary$dateUpdated": "<p>The date on which the distribution configuration was updated.</p>",
"GetWorkflowExecutionResponse$startTime": "<p>The timestamp when the specified runtime instance of the workflow started.</p>",
"GetWorkflowExecutionResponse$endTime": "<p>The timestamp when the specified runtime instance of the workflow finished.</p>",
"GetWorkflowStepExecutionResponse$startTime": "<p>The timestamp when the specified runtime version of the workflow step started.</p>",
"GetWorkflowStepExecutionResponse$endTime": "<p>The timestamp when the specified runtime instance of the workflow step finished.</p>",
"Image$dateCreated": "<p>The date on which Image Builder created this image.</p>",
"ImagePipeline$dateCreated": "<p>The date on which this image pipeline was created.</p>",
"ImagePipeline$dateUpdated": "<p>The date on which this image pipeline was last updated.</p>",
"ImagePipeline$dateLastRun": "<p>This is no longer supported, and does not return a value.</p>",
"ImagePipeline$dateNextRun": "<p>The next date when the pipeline is scheduled to run.</p>",
"ImageRecipe$dateCreated": "<p>The date on which this image recipe was created.</p>",
"ImageRecipeSummary$dateCreated": "<p>The date on which this image recipe was created.</p>",
"ImageSummary$dateCreated": "<p>The date on which Image Builder created this image.</p>",
"ImageVersion$dateCreated": "<p>The date on which this specific version of the Image Builder image was created.</p>",
"InfrastructureConfiguration$dateCreated": "<p>The date on which the infrastructure configuration was created.</p>",
"InfrastructureConfiguration$dateUpdated": "<p>The date on which the infrastructure configuration was last updated.</p>",
"InfrastructureConfigurationSummary$dateCreated": "<p>The date on which the infrastructure configuration was created.</p>",
"InfrastructureConfigurationSummary$dateUpdated": "<p>The date on which the infrastructure configuration was last updated.</p>",
"Workflow$dateCreated": "<p>The timestamp when Image Builder created the workflow resource.</p>",
"WorkflowExecutionMetadata$startTime": "<p>The timestamp when the runtime instance of this workflow started.</p>",
"WorkflowExecutionMetadata$endTime": "<p>The timestamp when this runtime instance of the workflow finished.</p>",
"WorkflowStepExecution$startTime": "<p>The timestamp when the workflow step started.</p>",
"WorkflowStepMetadata$startTime": "<p>The timestamp when the workflow step started.</p>",
"WorkflowStepMetadata$endTime": "<p>The timestamp when the workflow step finished.</p>",
"WorkflowSummary$dateCreated": "<p>The original creation date of the workflow resource.</p>",
"WorkflowVersion$dateCreated": "<p>The timestamp when Image Builder created the workflow version.</p>"
}
},
"DateTimeTimestamp": {
"base": null,
"refs": {
"Image$deprecationTime": "<p>The time when deprecation occurs for an image resource. This can be a past or future date.</p>",
"ImageScanFinding$firstObservedAt": "<p>The date and time when the finding was first observed.</p>",
"ImageScanFinding$updatedAt": "<p>The timestamp when the finding was last updated.</p>",
"ImageSummary$deprecationTime": "<p>The time when deprecation occurs for an image resource. This can be a past or future date.</p>",
"LifecycleExecution$startTime": "<p>The timestamp when the lifecycle runtime instance started.</p>",
"LifecycleExecution$endTime": "<p>The timestamp when the lifecycle runtime instance completed.</p>",
"LifecycleExecutionResource$startTime": "<p>The starting timestamp from the lifecycle action that was applied to the resource.</p>",
"LifecycleExecutionResource$endTime": "<p>The ending timestamp from the lifecycle action that was applied to the resource.</p>",
"LifecyclePolicy$dateCreated": "<p>The timestamp when Image Builder created the lifecycle policy resource.</p>",
"LifecyclePolicy$dateUpdated": "<p>The timestamp when Image Builder updated the lifecycle policy resource.</p>",
"LifecyclePolicy$dateLastRun": "<p>The timestamp for the last time Image Builder ran the lifecycle policy.</p>",
"LifecyclePolicySummary$dateCreated": "<p>The timestamp when Image Builder created the lifecycle policy resource.</p>",
"LifecyclePolicySummary$dateUpdated": "<p>The timestamp when Image Builder updated the lifecycle policy resource.</p>",
"LifecyclePolicySummary$dateLastRun": "<p>The timestamp for the last time Image Builder ran the lifecycle policy.</p>",
"PackageVulnerabilityDetails$vendorCreatedAt": "<p>The date and time when this vulnerability was first added to the vendor's database.</p>",
"PackageVulnerabilityDetails$vendorUpdatedAt": "<p>The date and time when the vendor last updated this vulnerability in their database.</p>",
"StartResourceStateUpdateRequest$updateAt": "<p>The timestamp that indicates when resources are updated by a lifecycle action.</p>"
}
},
"DeleteComponentRequest": {
"base": null,
"refs": {
}
},
"DeleteComponentResponse": {
"base": null,
"refs": {
}
},
"DeleteContainerRecipeRequest": {
"base": null,
"refs": {
}
},
"DeleteContainerRecipeResponse": {
"base": null,
"refs": {
}
},
"DeleteDistributionConfigurationRequest": {
"base": null,
"refs": {
}
},
"DeleteDistributionConfigurationResponse": {
"base": null,
"refs": {
}
},
"DeleteImagePipelineRequest": {
"base": null,
"refs": {
}
},
"DeleteImagePipelineResponse": {
"base": null,
"refs": {
}
},
"DeleteImageRecipeRequest": {
"base": null,
"refs": {
}
},
"DeleteImageRecipeResponse": {
"base": null,
"refs": {
}
},
"DeleteImageRequest": {
"base": null,
"refs": {
}
},
"DeleteImageResponse": {
"base": null,
"refs": {
}
},
"DeleteInfrastructureConfigurationRequest": {
"base": null,
"refs": {
}
},
"DeleteInfrastructureConfigurationResponse": {
"base": null,
"refs": {
}
},
"DeleteLifecyclePolicyRequest": {
"base": null,
"refs": {
}
},
"DeleteLifecyclePolicyResponse": {
"base": null,
"refs": {
}
},
"DeleteWorkflowRequest": {
"base": null,
"refs": {
}
},
"DeleteWorkflowResponse": {
"base": null,
"refs": {
}
},
"DiskImageFormat": {
"base": null,
"refs": {
"S3ExportConfiguration$diskImageFormat": "<p>Export the updated image to one of the following supported disk image formats:</p> <ul> <li> <p> <b>Virtual Hard Disk (VHD)</b> – Compatible with Citrix Xen and Microsoft Hyper-V virtualization products.</p> </li> <li> <p> <b>Stream-optimized ESX Virtual Machine Disk (VMDK)</b> – Compatible with VMware ESX and VMware vSphere versions 4, 5, and 6.</p> </li> <li> <p> <b>Raw</b> – Raw format.</p> </li> </ul>"
}
},
"Distribution": {
"base": "<p>Defines the settings for a specific Region.</p>",
"refs": {
"DistributionList$member": null
}
},
"DistributionConfiguration": {
"base": "<p>A distribution configuration.</p>",
"refs": {
"GetDistributionConfigurationResponse$distributionConfiguration": "<p>The distribution configuration object.</p>",
"Image$distributionConfiguration": "<p>The distribution configuration that Image Builder used to create this image.</p>"
}
},
"DistributionConfigurationArn": {
"base": null,
"refs": {
"CreateDistributionConfigurationResponse$distributionConfigurationArn": "<p>The Amazon Resource Name (ARN) of the distribution configuration that was created by this request.</p>",
"CreateImagePipelineRequest$distributionConfigurationArn": "<p>The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline.</p>",
"CreateImageRequest$distributionConfigurationArn": "<p>The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.</p>",
"DeleteDistributionConfigurationRequest$distributionConfigurationArn": "<p>The Amazon Resource Name (ARN) of the distribution configuration to delete.</p>",
"DeleteDistributionConfigurationResponse$distributionConfigurationArn": "<p>The Amazon Resource Name (ARN) of the distribution configuration that was deleted.</p>",
"GetDistributionConfigurationRequest$distributionConfigurationArn": "<p>The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve.</p>",
"UpdateDistributionConfigurationRequest$distributionConfigurationArn": "<p>The Amazon Resource Name (ARN) of the distribution configuration that you want to update.</p>",
"UpdateDistributionConfigurationResponse$distributionConfigurationArn": "<p>The Amazon Resource Name (ARN) of the distribution configuration that was updated by this request.</p>",
"UpdateImagePipelineRequest$distributionConfigurationArn": "<p>The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated.</p>"
}
},
"DistributionConfigurationSummary": {
"base": "<p>A high-level overview of a distribution configuration.</p>",
"refs": {
"DistributionConfigurationSummaryList$member": null
}
},
"DistributionConfigurationSummaryList": {
"base": null,
"refs": {
"ListDistributionConfigurationsResponse$distributionConfigurationSummaryList": "<p>The list of distributions.</p>"
}
},
"DistributionList": {
"base": null,
"refs": {
"CreateDistributionConfigurationRequest$distributions": "<p>The distributions of the distribution configuration.</p>",
"DistributionConfiguration$distributions": "<p>The distribution objects that apply Region-specific settings for the deployment of the image to targeted Regions.</p>",
"UpdateDistributionConfigurationRequest$distributions": "<p>The distributions of the distribution configuration.</p>"
}
},
"DistributionTimeoutMinutes": {
"base": null,
"refs": {
"DistributionConfiguration$timeoutMinutes": "<p>The maximum duration in minutes for this distribution configuration.</p>"
}
},
"DockerFileTemplate": {
"base": null,
"refs": {
"ContainerRecipe$dockerfileTemplateData": "<p>Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.</p>"
}
},
"EbsInstanceBlockDeviceSpecification": {
"base": "<p>Amazon EBS-specific block device mapping specifications.</p>",
"refs": {
"InstanceBlockDeviceMapping$ebs": "<p>Use to manage Amazon EBS-specific configuration for this mapping.</p>"
}
},
"EbsIopsInteger": {
"base": null,
"refs": {
"EbsInstanceBlockDeviceSpecification$iops": "<p>Use to configure device IOPS.</p>"
}
},
"EbsVolumeSizeInteger": {
"base": null,
"refs": {
"EbsInstanceBlockDeviceSpecification$volumeSize": "<p>Use to override the device's volume size.</p>"
}
},
"EbsVolumeThroughput": {
"base": null,
"refs": {
"EbsInstanceBlockDeviceSpecification$throughput": "<p> <b>For GP3 volumes only</b> – The throughput in MiB/s that the volume supports.</p>"
}
},
"EbsVolumeType": {
"base": null,
"refs": {
"EbsInstanceBlockDeviceSpecification$volumeType": "<p>Use to override the device's volume type.</p>"
}
},
"EcrConfiguration": {
"base": "<p>Settings that Image Builder uses to configure the ECR repository and the output container images that Amazon Inspector scans.</p>",
"refs": {
"ImageScanningConfiguration$ecrConfiguration": "<p>Contains Amazon ECR settings for vulnerability scans.</p>"
}
},
"EmptyString": {
"base": null,
"refs": {
"InstanceBlockDeviceMapping$noDevice": "<p>Use to remove a mapping from the base image.</p>"
}
},
"ErrorMessage": {
"base": null,
"refs": {
"CallRateLimitExceededException$message": null,
"ClientException$message": null,
"ForbiddenException$message": null,
"IdempotentParameterMismatchException$message": null,
"InvalidPaginationTokenException$message": null,
"InvalidParameterCombinationException$message": null,
"InvalidParameterException$message": null,
"InvalidParameterValueException$message": null,
"InvalidRequestException$message": null,
"InvalidVersionNumberException$message": null,
"ResourceAlreadyExistsException$message": null,
"ResourceDependencyException$message": null,
"ResourceInUseException$message": null,
"ResourceNotFoundException$message": null,
"ServiceException$message": null,
"ServiceQuotaExceededException$message": null,
"ServiceUnavailableException$message": null
}
},
"FastLaunchConfiguration": {
"base": "<p>Define and configure faster launching for output Windows AMIs.</p>",
"refs": {
"FastLaunchConfigurationList$member": null
}
},
"FastLaunchConfigurationList": {
"base": null,
"refs": {
"Distribution$fastLaunchConfigurations": "<p>The Windows faster-launching configurations to use for AMI distribution.</p>"
}
},
"FastLaunchLaunchTemplateSpecification": {
"base": "<p>Identifies the launch template that the associated Windows AMI uses for launching an instance when faster launching is enabled.</p> <note> <p>You can specify either the <code>launchTemplateName</code> or the <code>launchTemplateId</code>, but not both.</p> </note>",
"refs": {
"FastLaunchConfiguration$launchTemplate": "<p>The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.</p>"
}
},
"FastLaunchSnapshotConfiguration": {
"base": "<p>Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.</p>",
"refs": {
"FastLaunchConfiguration$snapshotConfiguration": "<p>Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.</p>"
}
},
"Filter": {
"base": "<p>A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.</p>",
"refs": {
"FilterList$member": null,
"ListImageScanFindingAggregationsRequest$filter": null
}
},
"FilterList": {
"base": null,
"refs": {
"ListComponentsRequest$filters": "<p>Use the following filters to streamline results:</p> <ul> <li> <p> <code>description</code> </p> </li> <li> <p> <code>name</code> </p> </li> <li> <p> <code>platform</code> </p> </li> <li> <p> <code>supportedOsVersion</code> </p> </li> <li> <p> <code>type</code> </p> </li> <li> <p> <code>version</code> </p> </li> </ul>",
"ListContainerRecipesRequest$filters": "<p>Use the following filters to streamline results:</p> <ul> <li> <p> <code>containerType</code> </p> </li> <li> <p> <code>name</code> </p> </li> <li> <p> <code>parentImage</code> </p> </li> <li> <p> <code>platform</code> </p> </li> </ul>",
"ListDistributionConfigurationsRequest$filters": "<p>You can filter on <code>name</code> to streamline results.</p>",
"ListImageBuildVersionsRequest$filters": "<p>Use the following filters to streamline results:</p> <ul> <li> <p> <code>name</code> </p> </li> <li> <p> <code>osVersion</code> </p> </li> <li> <p> <code>platform</code> </p> </li> <li> <p> <code>type</code> </p> </li> <li> <p> <code>version</code> </p> </li> </ul>",
"ListImagePipelineImagesRequest$filters": "<p>Use the following filters to streamline results:</p> <ul> <li> <p> <code>name</code> </p> </li> <li> <p> <code>version</code> </p> </li> </ul>",
"ListImagePipelinesRequest$filters": "<p>Use the following filters to streamline results:</p> <ul> <li> <p> <code>description</code> </p> </li> <li> <p> <code>distributionConfigurationArn</code> </p> </li> <li> <p> <code>imageRecipeArn</code> </p> </li> <li> <p> <code>infrastructureConfigurationArn</code> </p> </li> <li> <p> <code>name</code> </p> </li> <li> <p> <code>status</code> </p> </li> </ul>",
"ListImageRecipesRequest$filters": "<p>Use the following filters to streamline results:</p> <ul> <li> <p> <code>name</code> </p> </li> <li> <p> <code>parentImage</code> </p> </li> <li> <p> <code>platform</code> </p> </li> </ul>",
"ListImagesRequest$filters": "<p>Use the following filters to streamline results:</p> <ul> <li> <p> <code>name</code> </p> </li> <li> <p> <code>osVersion</code> </p> </li> <li> <p> <code>platform</code> </p> </li> <li> <p> <code>type</code> </p> </li> <li> <p> <code>version</code> </p> </li> </ul>",
"ListInfrastructureConfigurationsRequest$filters": "<p>You can filter on <code>name</code> to streamline results.</p>",
"ListLifecyclePoliciesRequest$filters": "<p>Streamline results based on one of the following values: <code>Name</code>, <code>Status</code>.</p>",
"ListWorkflowsRequest$filters": "<p>Used to streamline search results.</p>"
}
},
"FilterName": {
"base": null,
"refs": {
"Filter$name": "<p>The name of the filter. Filter names are case-sensitive.</p>",
"ImageScanFindingsFilter$name": "<p>The name of the image scan finding filter. Filter names are case-sensitive.</p>"
}
},
"FilterValue": {
"base": null,
"refs": {
"FilterValues$member": null,
"ImageScanFindingsFilterValues$member": null
}
},
"FilterValues": {
"base": null,
"refs": {
"Filter$values": "<p>The filter values. Filter values are case-sensitive.</p>"
}
},
"ForbiddenException": {
"base": "<p>You are not authorized to perform the requested operation.</p>",
"refs": {
}
},
"GetComponentPolicyRequest": {
"base": null,
"refs": {
}
},
"GetComponentPolicyResponse": {
"base": null,
"refs": {
}
},
"GetComponentRequest": {
"base": null,
"refs": {
}
},
"GetComponentResponse": {
"base": null,
"refs": {
}
},
"GetContainerRecipePolicyRequest": {
"base": null,
"refs": {
}
},
"GetContainerRecipePolicyResponse": {
"base": null,
"refs": {
}
},
"GetContainerRecipeRequest": {
"base": null,
"refs": {
}
},
"GetContainerRecipeResponse": {
"base": null,
"refs": {
}
},
"GetDistributionConfigurationRequest": {
"base": null,
"refs": {
}
},
"GetDistributionConfigurationResponse": {
"base": null,
"refs": {
}
},
"GetImagePipelineRequest": {
"base": null,
"refs": {
}
},
"GetImagePipelineResponse": {
"base": null,
"refs": {
}