EC2 Image Builder - docs.aws.amazon.com

EC2 Image BuilderAPI Reference

API Version 2019-12-02

EC2 Image Builder API Reference

EC2 Image Builder: API ReferenceCopyright © Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

Amazon's trademarks and trade dress may not be used in connection with any product or service that is notAmazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages ordiscredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who mayor may not be affiliated with, connected to, or sponsored by Amazon.


Table of ContentsWelcome .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Actions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

CancelImageCreation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

CreateComponent .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

CreateContainerRecipe .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

CreateDistributionConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

CreateImage .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

CreateImagePipeline .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

CreateImageRecipe .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

API Version 2019-12-02iii


Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

CreateInfrastructureConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

DeleteComponent .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

DeleteContainerRecipe .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

DeleteDistributionConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

DeleteImage .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

DeleteImagePipeline .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

DeleteImageRecipe .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

API Version 2019-12-02iv


Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

DeleteInfrastructureConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

GetComponent .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

GetComponentPolicy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

GetContainerRecipe .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

GetContainerRecipePolicy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

GetDistributionConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

GetImage .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

API Version 2019-12-02v


Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

GetImagePipeline .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

GetImagePolicy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

GetImageRecipe .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

GetImageRecipePolicy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

GetInfrastructureConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

ImportComponent .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

ImportVmImage .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

API Version 2019-12-02vi


See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106ListComponentBuildVersions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

ListComponents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

ListContainerRecipes .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

ListDistributionConfigurations .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

ListImageBuildVersions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

ListImagePackages .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

ListImagePipelineImages .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

API Version 2019-12-02vii


ListImagePipelines .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

ListImageRecipes .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

ListImages .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

ListInfrastructureConfigurations .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

ListTagsForResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

PutComponentPolicy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

PutContainerRecipePolicy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

PutImagePolicy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

API Version 2019-12-02viii


Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

PutImageRecipePolicy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

StartImagePipelineExecution .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

TagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

UntagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

UpdateDistributionConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

UpdateImagePipeline .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

UpdateInfrastructureConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

API Version 2019-12-02ix


URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

Data Types .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183AdditionalInstanceConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

Ami .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

AmiDistributionConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

Component .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

ComponentConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

ComponentParameter ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

ComponentParameterDetail .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

ComponentState .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

ComponentSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

ComponentVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

Container ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

ContainerDistributionConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

ContainerRecipe .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

ContainerRecipeSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

Distribution .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

DistributionConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

DistributionConfigurationSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

API Version 2019-12-02x


See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217EbsInstanceBlockDeviceSpecification .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218


FastLaunchConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

FastLaunchLaunchTemplateSpecification .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

FastLaunchSnapshotConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

Filter ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

Image .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228

ImagePackage .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

ImagePipeline .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

ImageRecipe .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

ImageRecipeSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

ImageState .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

ImageSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

ImageTestsConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

ImageVersion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

InfrastructureConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

InfrastructureConfigurationSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

InstanceBlockDeviceMapping .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

InstanceConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

InstanceMetadataOptions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

API Version 2019-12-02xi


See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253LaunchPermissionConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254


LaunchTemplateConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

Logging .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

OutputResources .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

S3ExportConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

S3Logs .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

Schedule .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

SystemsManagerAgent .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

TargetContainerRepository .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

Common Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266Common Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

API Version 2019-12-02xii


WelcomeEC2 Image Builder is a fully managed AWS service that makes it easier to automate the creation,management, and deployment of customized, secure, and up-to-date "golden" server images that arepre-installed and pre-configured with software and settings to meet specific IT standards.

This document was last published on April 7, 2022.



ActionsThe following actions are supported:

• CancelImageCreation (p. 4)• CreateComponent (p. 7)• CreateContainerRecipe (p. 12)• CreateDistributionConfiguration (p. 18)• CreateImage (p. 23)• CreateImagePipeline (p. 28)• CreateImageRecipe (p. 33)• CreateInfrastructureConfiguration (p. 39)• DeleteComponent (p. 45)• DeleteContainerRecipe (p. 48)• DeleteDistributionConfiguration (p. 51)• DeleteImage (p. 54)• DeleteImagePipeline (p. 57)• DeleteImageRecipe (p. 60)• DeleteInfrastructureConfiguration (p. 63)• GetComponent (p. 66)• GetComponentPolicy (p. 69)• GetContainerRecipe (p. 71)• GetContainerRecipePolicy (p. 74)• GetDistributionConfiguration (p. 76)• GetImage (p. 79)• GetImagePipeline (p. 85)• GetImagePolicy (p. 88)• GetImageRecipe (p. 90)• GetImageRecipePolicy (p. 93)• GetInfrastructureConfiguration (p. 95)• ImportComponent (p. 98)• ImportVmImage (p. 103)• ListComponentBuildVersions (p. 107)• ListComponents (p. 111)• ListContainerRecipes (p. 115)• ListDistributionConfigurations (p. 119)• ListImageBuildVersions (p. 122)• ListImagePackages (p. 126)• ListImagePipelineImages (p. 129)• ListImagePipelines (p. 133)• ListImageRecipes (p. 137)• ListImages (p. 141)• ListInfrastructureConfigurations (p. 145)• ListTagsForResource (p. 148)



• PutComponentPolicy (p. 150)• PutContainerRecipePolicy (p. 153)• PutImagePolicy (p. 156)• PutImageRecipePolicy (p. 159)• StartImagePipelineExecution (p. 162)• TagResource (p. 165)• UntagResource (p. 167)• UpdateDistributionConfiguration (p. 169)• UpdateImagePipeline (p. 173)• UpdateInfrastructureConfiguration (p. 178)


EC2 Image Builder API ReferenceCancelImageCreation

CancelImageCreationCancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.

Request SyntaxPUT /CancelImageCreation HTTP/1.1Content-type: application/json

{ "clientToken": "string", "imageBuildVersionArn": "string"}

URI Request ParametersThe request does not use any URI parameters.

Request BodyThe request accepts the following data in JSON format.

clientToken (p. 4)

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For moreinformation, see Ensuring idempotency in the Amazon EC2 API Reference.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Required: YesimageBuildVersionArn (p. 4)

The Amazon Resource Name (ARN) of the image whose creation you want to cancel.

Type: String

Pattern: ârn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+/[0-9]+$

Required: Yes

Response SyntaxHTTP/1.1 200Content-type: application/json

{ "clientToken": "string", "imageBuildVersionArn": "string", "requestId": "string"}


https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

EC2 Image Builder API ReferenceResponse Elements

Response ElementsIf the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

clientToken (p. 4)

The idempotency token that was used for this request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.imageBuildVersionArn (p. 4)

The Amazon Resource Name (ARN) of the image whose creation has been cancelled.

Type: String


requestId (p. 4)

The request ID that uniquely identifies this request.

Type: String


ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 268).

CallRateLimitExceededException

You have exceeded the permitted request rate for the specific operation.

HTTP Status Code: 429ClientException

These errors are usually caused by a client action, such as using an action or resource on behalf ofa user that doesn't have permissions to use the action or resource, or specifying an invalid resourceidentifier.

HTTP Status Code: 400ForbiddenException

You are not authorized to perform the requested operation.

HTTP Status Code: 403IdempotentParameterMismatchException

You have specified a client token for an operation using parameter values that differ from a previousrequest that used the same client token.

HTTP Status Code: 400


EC2 Image Builder API ReferenceSee Also

InvalidRequestException

You have made a request for an action that is not supported by the service.

HTTP Status Code: 400ResourceInUseException

The resource that you are trying to operate on is currently in use. Review the message details andretry later.

HTTP Status Code: 400ServiceException

This exception is thrown when the service encounters an unrecoverable exception.

HTTP Status Code: 500ServiceUnavailableException

The service is unable to process your request at this time.


See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/CancelImageCreation

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/CancelImageCreation

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/CancelImageCreation

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/CancelImageCreation

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/CancelImageCreation

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/CancelImageCreation

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/CancelImageCreation

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/CancelImageCreation

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/CancelImageCreation

EC2 Image Builder API ReferenceCreateComponent

CreateComponentCreates a new component that can be used to build, validate, test, and assess your image. Thecomponent is based on a YAML document that you specify using exactly one of the following methods:

• Inline, using the data property in the request body.

• A URL that points to a YAML document file stored in Amazon S3, using the uri property in the requestbody.

Request SyntaxPUT /CreateComponent HTTP/1.1Content-type: application/json

{ "changeDescription": "string", "clientToken": "string", "data": "string", "description": "string", "kmsKeyId": "string", "name": "string", "platform": "string", "semanticVersion": "string", "supportedOsVersions": [ "string" ], "tags": { "string" : "string" }, "uri": "string"}



changeDescription (p. 7)

The change description of the component. Describes what change has been made in this version, orwhat makes this version different from other versions of this component.

Type: String


Required: No

clientToken (p. 7)

The idempotency token of the component.

Type: String



EC2 Image Builder API ReferenceRequest Body

Required: Yesdata (p. 7)

Component data contains inline YAML document content for the component. Alternatively, you canspecify the uri of a YAML document file stored in Amazon S3. However, you cannot specify bothproperties.

Type: String


Pattern: [^\x00]+

Required: Nodescription (p. 7)

The description of the component. Describes the contents of the component.

Type: String


Required: NokmsKeyId (p. 7)

The ID of the KMS key that should be used to encrypt this component.

Type: String


Required: Noname (p. 7)

The name of the component.

Type: String

Pattern: ^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$

Required: Yesplatform (p. 7)

The platform of the component.

Type: String

Valid Values: Windows | Linux

Required: YessemanticVersion (p. 7)

The semantic version of the component. This version follows the semantic version syntax.

NoteThe semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assignvalues for the first three, and can filter on all of them.Assignment: For the first three nodes you can assign any positive integer value, includingzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builderautomatically assigns the build number to the fourth node.


EC2 Image Builder API ReferenceResponse Syntax

Patterns: You can use any numeric pattern that adheres to the assignment requirements forthe nodes that you can assign. For example, you might choose a software version pattern,such as 1.0.0, or a date, such as 2021.01.01.

Type: String

Pattern: ^[0-9]+\.[0-9]+\.[0-9]+$

Required: YessupportedOsVersions (p. 7)

The operating system (OS) version supported by the component. If the OS information is available, aprefix match is performed against the base image OS version during image recipe creation.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Length Constraints: Minimum length of 1.

Required: Notags (p. 7)

The tags of the component.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Required: Nouri (p. 7)

The uri of a YAML component document file. This must be an S3 URL (s3://bucket/key), and therequester must have permission to access the S3 bucket it points to. If you use Amazon S3, you canspecify component content up to your service quota.

Alternatively, you can specify the YAML document inline, using the component data property. Youcannot specify both properties.

Type: String

Required: No


{ "clientToken": "string", "componentBuildVersionArn": "string", "requestId": "string"



}



clientToken (p. 9)

The idempotency token used to make this request idempotent.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.componentBuildVersionArn (p. 9)

The Amazon Resource Name (ARN) of the component that was created by this request.

Type: String

Pattern: ârn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):component/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+/[0-9]+$

requestId (p. 9)


Type: String













HTTP Status Code: 400InvalidParameterCombinationException

You have specified two or more mutually exclusive parameters. Review the error message for details.

HTTP Status Code: 400InvalidRequestException


HTTP Status Code: 400InvalidVersionNumberException

Your version number is out of bounds or does not follow the required syntax.





HTTP Status Code: 500ServiceQuotaExceededException

You have exceeded the number of permitted resources or operations for this service. For servicequotas, see EC2 Image Builder endpoints and quotas.







https://docs.aws.amazon.com/general/latest/gr/imagebuilder.html#limits_imagebuilder

https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/CreateComponent

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/CreateComponent

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/CreateComponent

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/CreateComponent

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/CreateComponent

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/CreateComponent

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/CreateComponent

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/CreateComponent

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/CreateComponent

EC2 Image Builder API ReferenceCreateContainerRecipe

CreateContainerRecipeCreates a new container recipe. Container recipes define how images are configured, tested, andassessed.

Request SyntaxPUT /CreateContainerRecipe HTTP/1.1Content-type: application/json

{ "clientToken": "string", "components": [ { "componentArn": "string", "parameters": [ { "name": "string", "value": [ "string" ] } ] } ], "containerType": "string", "description": "string", "dockerfileTemplateData": "string", "dockerfileTemplateUri": "string", "imageOsVersionOverride": "string", "instanceConfiguration": { "blockDeviceMappings": [ { "deviceName": "string", "ebs": { "deleteOnTermination": boolean, "encrypted": boolean, "iops": number, "kmsKeyId": "string", "snapshotId": "string", "throughput": number, "volumeSize": number, "volumeType": "string" }, "noDevice": "string", "virtualName": "string" } ], "image": "string" }, "kmsKeyId": "string", "name": "string", "parentImage": "string", "platformOverride": "string", "semanticVersion": "string", "tags": { "string" : "string" }, "targetRepository": { "repositoryName": "string", "service": "string" }, "workingDirectory": "string"}


EC2 Image Builder API ReferenceURI Request Parameters



clientToken (p. 12)

The client token used to make this request idempotent.

Type: String


Required: Yes

components (p. 12)

Components for build and test that are included in the container recipe. Recipes require a minimumof one build component, and can have a maximum of 20 build and test components in anycombination.

Type: Array of ComponentConfiguration (p. 193) objects

Array Members: Minimum number of 1 item.

Required: Yes

containerType (p. 12)

The type of container to create.

Type: String

Valid Values: DOCKER

Required: Yes

description (p. 12)

The description of the container recipe.

Type: String


Required: No

dockerfileTemplateData (p. 12)

The Dockerfile template used to build your image as an inline data blob.

Type: String


Pattern: [^\x00]+

Required: No



dockerfileTemplateUri (p. 12)

The Amazon S3 URI for the Dockerfile that will be used to build your container image.

Type: String

Required: NoimageOsVersionOverride (p. 12)

Specifies the operating system version for the base image.

Type: String


Required: NoinstanceConfiguration (p. 12)

A group of options that can be used to configure an instance for building and testing containerimages.

Type: InstanceConfiguration (p. 252) object

Required: NokmsKeyId (p. 12)

Identifies which KMS key is used to encrypt the container image.

Type: String



The name of the container recipe.

Type: String


Required: YesparentImage (p. 12)

The base image for the container recipe.

Type: String


Required: YesplatformOverride (p. 12)

Specifies the operating system platform when you use a custom base image.

Type: String


Required: No



semanticVersion (p. 12)

The semantic version of the container recipe. This version follows the semantic version syntax.

NoteThe semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assignvalues for the first three, and can filter on all of them.Assignment: For the first three nodes you can assign any positive integer value, includingzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builderautomatically assigns the build number to the fourth node.Patterns: You can use any numeric pattern that adheres to the assignment requirements forthe nodes that you can assign. For example, you might choose a software version pattern,such as 1.0.0, or a date, such as 2021.01.01.

Type: String

Pattern: ^[0-9]+\.[0-9]+\.[0-9]+$

Required: Yestags (p. 12)

Tags that are attached to the container recipe.






Required: NotargetRepository (p. 12)

The destination repository for the container image.

Type: TargetContainerRepository (p. 265) object

Required: YesworkingDirectory (p. 12)

The working directory for use during build and test workflows.

Type: String


Required: No


{ "clientToken": "string", "containerRecipeArn": "string",



"requestId": "string"}



clientToken (p. 15)

The client token used to make this request idempotent.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.containerRecipeArn (p. 15)

Returns the Amazon Resource Name (ARN) of the container recipe that the request created.

Type: String

Pattern: ârn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):container-recipe/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+$

requestId (p. 15)


Type: String

















HTTP Status Code: 400ResourceAlreadyExistsException

The resource that you are trying to create already exists.














https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/CreateContainerRecipe

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/CreateContainerRecipe

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/CreateContainerRecipe

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/CreateContainerRecipe

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/CreateContainerRecipe

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/CreateContainerRecipe

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/CreateContainerRecipe

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/CreateContainerRecipe

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/CreateContainerRecipe

EC2 Image Builder API ReferenceCreateDistributionConfiguration

CreateDistributionConfigurationCreates a new distribution configuration. Distribution configurations define and configure the outputs ofyour pipeline.

Request Syntax

PUT /CreateDistributionConfiguration HTTP/1.1Content-type: application/json

{ "clientToken": "string", "description": "string", "distributions": [ { "amiDistributionConfiguration": { "amiTags": { "string" : "string" }, "description": "string", "kmsKeyId": "string", "launchPermission": { "organizationalUnitArns": [ "string" ], "organizationArns": [ "string" ], "userGroups": [ "string" ], "userIds": [ "string" ] }, "name": "string", "targetAccountIds": [ "string" ] }, "containerDistributionConfiguration": { "containerTags": [ "string" ], "description": "string", "targetRepository": { "repositoryName": "string", "service": "string" } }, "fastLaunchConfigurations": [ { "accountId": "string", "enabled": boolean, "launchTemplate": { "launchTemplateId": "string", "launchTemplateName": "string", "launchTemplateVersion": "string" }, "maxParallelLaunches": number, "snapshotConfiguration": { "targetResourceCount": number } } ], "launchTemplateConfigurations": [ { "accountId": "string", "launchTemplateId": "string", "setDefaultVersion": boolean } ], "licenseConfigurationArns": [ "string" ], "region": "string",



"s3ExportConfiguration": { "diskImageFormat": "string", "roleName": "string", "s3Bucket": "string", "s3Prefix": "string" } } ], "name": "string", "tags": { "string" : "string" }}



clientToken (p. 18)

The idempotency token of the distribution configuration.

Type: String


Required: Yesdescription (p. 18)

The description of the distribution configuration.

Type: String


Required: Nodistributions (p. 18)

The distributions of the distribution configuration.

Type: Array of Distribution (p. 212) objects

Required: Yesname (p. 18)

The name of the distribution configuration.

Type: String



The tags of the distribution configuration.








Required: No


{ "clientToken": "string", "distributionConfigurationArn": "string", "requestId": "string"}



clientToken (p. 20)


Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.distributionConfigurationArn (p. 20)

The Amazon Resource Name (ARN) of the distribution configuration that was created by this request.

Type: String

Pattern: ârn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):distribution-configuration/[a-z0-9-_]+$

requestId (p. 20)


Type: String




EC2 Image Builder API ReferenceErrors






























https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/CreateDistributionConfiguration

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/CreateDistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/CreateDistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/CreateDistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/CreateDistributionConfiguration

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/CreateDistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/CreateDistributionConfiguration

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/CreateDistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/CreateDistributionConfiguration

EC2 Image Builder API ReferenceCreateImage

CreateImageCreates a new image. This request will create a new image along with all of the configured outputresources defined in the distribution configuration. You must specify exactly one recipe for your image,using either a ContainerRecipeArn or an ImageRecipeArn.

Request Syntax

PUT /CreateImage HTTP/1.1Content-type: application/json

{ "clientToken": "string", "containerRecipeArn": "string", "distributionConfigurationArn": "string", "enhancedImageMetadataEnabled": boolean, "imageRecipeArn": "string", "imageTestsConfiguration": { "imageTestsEnabled": boolean, "timeoutMinutes": number }, "infrastructureConfigurationArn": "string", "tags": { "string" : "string" }}



clientToken (p. 23)


Type: String


Required: Yes

containerRecipeArn (p. 23)

The Amazon Resource Name (ARN) of the container recipe that defines how images are configuredand tested.

Type: String


Required: No



distributionConfigurationArn (p. 23)

The Amazon Resource Name (ARN) of the distribution configuration that defines and configures theoutputs of your pipeline.

Type: String


Required: No

enhancedImageMetadataEnabled (p. 23)

Collects additional information about the image being created, including the operating system (OS)version and package list. This information is used to enhance the overall experience of using EC2Image Builder. Enabled by default.

Type: Boolean

Required: No

imageRecipeArn (p. 23)

The Amazon Resource Name (ARN) of the image recipe that defines how images are configured,tested, and assessed.

Type: String

Pattern: ârn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image-recipe/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+$

Required: No

imageTestsConfiguration (p. 23)

The image tests configuration of the image.

Type: ImageTestsConfiguration (p. 242) object

Required: No

infrastructureConfigurationArn (p. 23)

The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environmentin which your image will be built and tested.

Type: String

Pattern: ârn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):infrastructure-configuration/[a-z0-9-_]+$

Required: Yes

tags (p. 23)

The tags of the image.








Required: No





clientToken (p. 25)


Type: String


The Amazon Resource Name (ARN) of the image that was created by this request.

Type: String


requestId (p. 25)


Type: String








ClientException


















• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript



https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/CreateImage

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/CreateImage

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/CreateImage

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/CreateImage

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/CreateImage

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/CreateImage


• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/CreateImage

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/CreateImage

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/CreateImage

EC2 Image Builder API ReferenceCreateImagePipeline

CreateImagePipelineCreates a new image pipeline. Image pipelines enable you to automate the creation and distribution ofimages.

Request SyntaxPUT /CreateImagePipeline HTTP/1.1Content-type: application/json

{ "clientToken": "string", "containerRecipeArn": "string", "description": "string", "distributionConfigurationArn": "string", "enhancedImageMetadataEnabled": boolean, "imageRecipeArn": "string", "imageTestsConfiguration": { "imageTestsEnabled": boolean, "timeoutMinutes": number }, "infrastructureConfigurationArn": "string", "name": "string", "schedule": { "pipelineExecutionStartCondition": "string", "scheduleExpression": "string", "timezone": "string" }, "status": "string", "tags": { "string" : "string" }}



clientToken (p. 28)


Type: String


Required: YescontainerRecipeArn (p. 28)

The Amazon Resource Name (ARN) of the container recipe that is used to configure images createdby this container pipeline.

Type: String





The description of the image pipeline.

Type: String


Required: NodistributionConfigurationArn (p. 28)

The Amazon Resource Name (ARN) of the distribution configuration that will be used to configureand distribute images created by this image pipeline.

Type: String


Required: NoenhancedImageMetadataEnabled (p. 28)


Type: Boolean

Required: NoimageRecipeArn (p. 28)

The Amazon Resource Name (ARN) of the image recipe that will be used to configure images createdby this image pipeline.

Type: String


Required: NoimageTestsConfiguration (p. 28)

The image test configuration of the image pipeline.


Required: NoinfrastructureConfigurationArn (p. 28)

The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to buildimages created by this image pipeline.

Type: String




Required: Yesname (p. 28)

The name of the image pipeline.

Type: String


Required: Yesschedule (p. 28)

The schedule of the image pipeline.

Type: Schedule (p. 262) object

Required: Nostatus (p. 28)

The status of the image pipeline.

Type: String

Valid Values: DISABLED | ENABLED


The tags of the image pipeline.






Required: No


{ "clientToken": "string", "imagePipelineArn": "string", "requestId": "string"}





clientToken (p. 30)


Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.imagePipelineArn (p. 30)

The Amazon Resource Name (ARN) of the image pipeline that was created by this request.

Type: String

Pattern: ârn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image-pipeline/[a-z0-9-_]+$

requestId (p. 30)


Type: String






























https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/CreateImagePipeline

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/CreateImagePipeline

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/CreateImagePipeline

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/CreateImagePipeline

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/CreateImagePipeline

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/CreateImagePipeline

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/CreateImagePipeline

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/CreateImagePipeline

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/CreateImagePipeline

EC2 Image Builder API ReferenceCreateImageRecipe

CreateImageRecipeCreates a new image recipe. Image recipes define how images are configured, tested, and assessed.

Request Syntax

PUT /CreateImageRecipe HTTP/1.1Content-type: application/json

{ "additionalInstanceConfiguration": { "systemsManagerAgent": { "uninstallAfterBuild": boolean }, "userDataOverride": "string" }, "blockDeviceMappings": [ { "deviceName": "string", "ebs": { "deleteOnTermination": boolean, "encrypted": boolean, "iops": number, "kmsKeyId": "string", "snapshotId": "string", "throughput": number, "volumeSize": number, "volumeType": "string" }, "noDevice": "string", "virtualName": "string" } ], "clientToken": "string", "components": [ { "componentArn": "string", "parameters": [ { "name": "string", "value": [ "string" ] } ] } ], "description": "string", "name": "string", "parentImage": "string", "semanticVersion": "string", "tags": { "string" : "string" }, "workingDirectory": "string"}





additionalInstanceConfiguration (p. 33)

Specify additional settings and launch scripts for your build instances.

Type: AdditionalInstanceConfiguration (p. 185) object

Required: NoblockDeviceMappings (p. 33)

The block device mappings of the image recipe.

Type: Array of InstanceBlockDeviceMapping (p. 251) objects

Required: NoclientToken (p. 33)


Type: String


Required: Yescomponents (p. 33)

The components included in the image recipe.




The description of the image recipe.

Type: String



The name of the image recipe.

Type: String


Required: YesparentImage (p. 33)

The base image of the image recipe. The value of the string can be the ARN of the base imageor an AMI ID. The format for the ARN follows this example: arn:aws:imagebuilder:us-



west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x. You canprovide the specific version that you want to use, or you can use a wildcard in all of the fields. If youenter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in thesame Region in which you are using Image Builder.

Type: String



The semantic version of the image recipe. This version follows the semantic version syntax.


Type: String

Pattern: ^[0-9]+\.[0-9]+\.[0-9]+$


The tags of the image recipe.






Required: NoworkingDirectory (p. 33)

The working directory used during build and test workflows.

Type: String


Required: No




{ "clientToken": "string", "imageRecipeArn": "string", "requestId": "string"}



clientToken (p. 35)


Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.imageRecipeArn (p. 35)

The Amazon Resource Name (ARN) of the image recipe that was created by this request.

Type: String


requestId (p. 35)


Type: String












IdempotentParameterMismatchException


















• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3



https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/CreateImageRecipe

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/CreateImageRecipe

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/CreateImageRecipe

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/CreateImageRecipe

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/CreateImageRecipe

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/CreateImageRecipe

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/CreateImageRecipe


• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/CreateImageRecipe

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/CreateImageRecipe

EC2 Image Builder API ReferenceCreateInfrastructureConfiguration

CreateInfrastructureConfigurationCreates a new infrastructure configuration. An infrastructure configuration defines the environment inwhich your image will be built and tested.

Request SyntaxPUT /CreateInfrastructureConfiguration HTTP/1.1Content-type: application/json

{ "clientToken": "string", "description": "string", "instanceMetadataOptions": { "httpPutResponseHopLimit": number, "httpTokens": "string" }, "instanceProfileName": "string", "instanceTypes": [ "string" ], "keyPair": "string", "logging": { "s3Logs": { "s3BucketName": "string", "s3KeyPrefix": "string" } }, "name": "string", "resourceTags": { "string" : "string" }, "securityGroupIds": [ "string" ], "snsTopicArn": "string", "subnetId": "string", "tags": { "string" : "string" }, "terminateInstanceOnFailure": boolean}



clientToken (p. 39)


Type: String



The description of the infrastructure configuration.



Type: String


Required: No

instanceMetadataOptions (p. 39)

The instance metadata options that you can set for the HTTP requests that pipeline builds use tolaunch EC2 build and test instances.

Type: InstanceMetadataOptions (p. 253) object

Required: No

instanceProfileName (p. 39)

The instance profile to associate with the instance used to customize your Amazon EC2 AMI.

Type: String


Pattern: ^[\w+=,.@-]+$

Required: Yes

instanceTypes (p. 39)

The instance types of the infrastructure configuration. You can specify one or more instance types touse for this build. The service will pick one of these instance types based on availability.


Required: No

keyPair (p. 39)

The key pair of the infrastructure configuration. You can use this to log on to and debug the instanceused to create your image.

Type: String


Required: No

logging (p. 39)

The logging configuration of the infrastructure configuration.

Type: Logging (p. 257) object

Required: No

name (p. 39)

The name of the infrastructure configuration.

Type: String


Required: Yes



resourceTags (p. 39)

The tags attached to the resource created by Image Builder.






Required: NosecurityGroupIds (p. 39)

The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.



Required: NosnsTopicArn (p. 39)

The Amazon Resource Name (ARN) for the SNS topic to which we send image build eventnotifications.

NoteEC2 Image Builder is unable to send notifications to SNS topics that are encrypted usingkeys from other accounts. The key that is used to encrypt the SNS topic must reside in theaccount that the Image Builder service runs under.

Type: String

Pattern: ârn:aws[^:]*:sns:[^:]+:[0-9]{12}:[a-zA-Z0-9-_]{1,256}$

Required: NosubnetId (p. 39)

The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.

Type: String



The tags of the infrastructure configuration.








Required: NoterminateInstanceOnFailure (p. 39)

The terminate instance on failure setting of the infrastructure configuration. Set to false if you wantImage Builder to retain the instance used to configure your AMI if the build or test phase of yourworkflow fails.

Type: Boolean

Required: No


{ "clientToken": "string", "infrastructureConfigurationArn": "string", "requestId": "string"}



clientToken (p. 42)


Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.infrastructureConfigurationArn (p. 42)

The Amazon Resource Name (ARN) of the infrastructure configuration that was created by thisrequest.

Type: String


requestId (p. 42)


Type: String
































https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/CreateInfrastructureConfiguration

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/CreateInfrastructureConfiguration

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/CreateInfrastructureConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/CreateInfrastructureConfiguration

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/CreateInfrastructureConfiguration

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/CreateInfrastructureConfiguration

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/CreateInfrastructureConfiguration

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/CreateInfrastructureConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/CreateInfrastructureConfiguration

EC2 Image Builder API ReferenceDeleteComponent

DeleteComponentDeletes a component build version.

Request SyntaxDELETE /DeleteComponent?componentBuildVersionArn=componentBuildVersionArn HTTP/1.1

URI Request ParametersThe request uses the following URI parameters.

componentBuildVersionArn (p. 45)

The Amazon Resource Name (ARN) of the component build version to delete.


Required: Yes

Request BodyThe request does not have a request body.


{ "componentBuildVersionArn": "string", "requestId": "string"}




The Amazon Resource Name (ARN) of the component build version that was deleted.

Type: String


requestId (p. 45)




Type: String











HTTP Status Code: 400ResourceDependencyException

You have attempted to mutate or delete a resource with a dependency that prohibits this action. Seethe error message for more details.







• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go


https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/DeleteComponent

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/DeleteComponent

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/DeleteComponent

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/DeleteComponent


• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/DeleteComponent

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/DeleteComponent

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/DeleteComponent

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/DeleteComponent

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/DeleteComponent

EC2 Image Builder API ReferenceDeleteContainerRecipe

DeleteContainerRecipeDeletes a container recipe.

Request SyntaxDELETE /DeleteContainerRecipe?containerRecipeArn=containerRecipeArn HTTP/1.1



The Amazon Resource Name (ARN) of the container recipe to delete.


Required: Yes



{ "containerRecipeArn": "string", "requestId": "string"}




The Amazon Resource Name (ARN) of the container recipe that was deleted.

Type: String


requestId (p. 48)




Type: String





















https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/DeleteContainerRecipe

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/DeleteContainerRecipe

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/DeleteContainerRecipe

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/DeleteContainerRecipe




https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/DeleteContainerRecipe

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/DeleteContainerRecipe

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/DeleteContainerRecipe

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/DeleteContainerRecipe

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/DeleteContainerRecipe

EC2 Image Builder API ReferenceDeleteDistributionConfiguration

DeleteDistributionConfigurationDeletes a distribution configuration.

Request SyntaxDELETE /DeleteDistributionConfiguration?distributionConfigurationArn=distributionConfigurationArn HTTP/1.1



The Amazon Resource Name (ARN) of the distribution configuration to delete.


Required: Yes



{ "distributionConfigurationArn": "string", "requestId": "string"}




The Amazon Resource Name (ARN) of the distribution configuration that was deleted.

Type: String


requestId (p. 51)




Type: String





















https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/DeleteDistributionConfiguration

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/DeleteDistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/DeleteDistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/DeleteDistributionConfiguration




https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/DeleteDistributionConfiguration

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/DeleteDistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/DeleteDistributionConfiguration

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/DeleteDistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/DeleteDistributionConfiguration

EC2 Image Builder API ReferenceDeleteImage

DeleteImageDeletes an Image Builder image resource. This does not delete any EC2 AMIs or ECR container imagesthat are created during the image build process. You must clean those up separately, using theappropriate Amazon EC2 or Amazon ECR console actions, or API or AWS CLI commands.

• To deregister an EC2 Linux AMI, see Deregister your Linux AMI in the Amazon EC2 User Guide .• To deregister an EC2 Windows AMI, see Deregister your Windows AMI in the Amazon EC2 Windows

Guide .• To delete a container image from Amazon ECR, see Deleting an image in the Amazon ECR User Guide.

Request SyntaxDELETE /DeleteImage?imageBuildVersionArn=imageBuildVersionArn HTTP/1.1


imageBuildVersionArn (p. 54)

The Amazon Resource Name (ARN) of the Image Builder image resource to delete.


Required: Yes



{ "imageBuildVersionArn": "string", "requestId": "string"}




The Amazon Resource Name (ARN) of the Image Builder image resource that was deleted.


https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/deregister-ami.html

https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/deregister-ami.html

https://docs.aws.amazon.com/AmazonECR/latest/userguide/delete_image.html


Type: String


requestId (p. 54)


Type: String























https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/DeleteImage

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/DeleteImage

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/DeleteImage

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/DeleteImage

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/DeleteImage

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/DeleteImage

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/DeleteImage

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/DeleteImage

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/DeleteImage

EC2 Image Builder API ReferenceDeleteImagePipeline

DeleteImagePipelineDeletes an image pipeline.

Request SyntaxDELETE /DeleteImagePipeline?imagePipelineArn=imagePipelineArn HTTP/1.1


imagePipelineArn (p. 57)

The Amazon Resource Name (ARN) of the image pipeline to delete.


Required: Yes



{ "imagePipelineArn": "string", "requestId": "string"}




The Amazon Resource Name (ARN) of the image pipeline that was deleted.

Type: String


requestId (p. 57)




Type: String





















https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/DeleteImagePipeline

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/DeleteImagePipeline

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/DeleteImagePipeline

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/DeleteImagePipeline




https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/DeleteImagePipeline

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/DeleteImagePipeline

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/DeleteImagePipeline

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/DeleteImagePipeline

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/DeleteImagePipeline

EC2 Image Builder API ReferenceDeleteImageRecipe

DeleteImageRecipeDeletes an image recipe.

Request SyntaxDELETE /DeleteImageRecipe?imageRecipeArn=imageRecipeArn HTTP/1.1



The Amazon Resource Name (ARN) of the image recipe to delete.


Required: Yes



{ "imageRecipeArn": "string", "requestId": "string"}




The Amazon Resource Name (ARN) of the image recipe that was deleted.

Type: String


requestId (p. 60)




Type: String





















https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/DeleteImageRecipe

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/DeleteImageRecipe

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/DeleteImageRecipe

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/DeleteImageRecipe




https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/DeleteImageRecipe

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/DeleteImageRecipe

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/DeleteImageRecipe

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/DeleteImageRecipe

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/DeleteImageRecipe

EC2 Image Builder API ReferenceDeleteInfrastructureConfiguration

DeleteInfrastructureConfigurationDeletes an infrastructure configuration.

Request SyntaxDELETE /DeleteInfrastructureConfiguration?infrastructureConfigurationArn=infrastructureConfigurationArn HTTP/1.1



The Amazon Resource Name (ARN) of the infrastructure configuration to delete.


Required: Yes



{ "infrastructureConfigurationArn": "string", "requestId": "string"}




The Amazon Resource Name (ARN) of the infrastructure configuration that was deleted.

Type: String


requestId (p. 63)




Type: String





















https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/DeleteInfrastructureConfiguration

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/DeleteInfrastructureConfiguration

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/DeleteInfrastructureConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/DeleteInfrastructureConfiguration




https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/DeleteInfrastructureConfiguration

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/DeleteInfrastructureConfiguration

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/DeleteInfrastructureConfiguration

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/DeleteInfrastructureConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/DeleteInfrastructureConfiguration

EC2 Image Builder API ReferenceGetComponent

GetComponentGets a component object.

Request SyntaxGET /GetComponent?componentBuildVersionArn=componentBuildVersionArn HTTP/1.1



The Amazon Resource Name (ARN) of the component that you want to retrieve. Regex requires "/\d+$" suffix.

Pattern: ârn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):component/[a-z0-9-_]+/(?:(?:([0-9]+|x)\.([0-9]+|x)\.([0-9]+|x))|(?:[0-9]+\.[0-9]+\.[0-9]+/[0-9]+))$

Required: Yes



{ "component": { "arn": "string", "changeDescription": "string", "data": "string", "dateCreated": "string", "description": "string", "encrypted": boolean, "kmsKeyId": "string", "name": "string", "owner": "string", "parameters": [ { "defaultValue": [ "string" ], "description": "string", "name": "string", "type": "string" } ], "platform": "string", "state": { "reason": "string", "status": "string" },



"supportedOsVersions": [ "string" ], "tags": { "string" : "string" }, "type": "string", "version": "string" }, "requestId": "string"}



component (p. 66)

The component object associated with the specified ARN.

Type: Component (p. 190) objectrequestId (p. 66)


Type: String





















https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/GetComponent

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/GetComponent

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/GetComponent

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/GetComponent

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/GetComponent

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/GetComponent

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/GetComponent

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/GetComponent

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/GetComponent

EC2 Image Builder API ReferenceGetComponentPolicy

GetComponentPolicyGets a component policy.

Request SyntaxGET /GetComponentPolicy?componentArn=componentArn HTTP/1.1


componentArn (p. 69)

The Amazon Resource Name (ARN) of the component whose policy you want to retrieve.


Required: Yes



{ "policy": "string", "requestId": "string"}



policy (p. 69)

The component policy.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 30000.requestId (p. 69)


Type: String











HTTP Status Code: 400ResourceNotFoundException

At least one of the resources referenced by your request does not exist.









https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/GetComponentPolicy

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/GetComponentPolicy

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/GetComponentPolicy

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/GetComponentPolicy

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/GetComponentPolicy

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/GetComponentPolicy

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/GetComponentPolicy

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/GetComponentPolicy

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/GetComponentPolicy

EC2 Image Builder API ReferenceGetContainerRecipe

GetContainerRecipeRetrieves a container recipe.

Request SyntaxGET /GetContainerRecipe?containerRecipeArn=containerRecipeArn HTTP/1.1



The Amazon Resource Name (ARN) of the container recipe to retrieve.


Required: Yes



{ "containerRecipe": { "arn": "string", "components": [ { "componentArn": "string", "parameters": [ { "name": "string", "value": [ "string" ] } ] } ], "containerType": "string", "dateCreated": "string", "description": "string", "dockerfileTemplateData": "string", "encrypted": boolean, "instanceConfiguration": { "blockDeviceMappings": [ { "deviceName": "string", "ebs": { "deleteOnTermination": boolean,



"encrypted": boolean, "iops": number, "kmsKeyId": "string", "snapshotId": "string", "throughput": number, "volumeSize": number, "volumeType": "string" }, "noDevice": "string", "virtualName": "string" } ], "image": "string" }, "kmsKeyId": "string", "name": "string", "owner": "string", "parentImage": "string", "platform": "string", "tags": { "string" : "string" }, "targetRepository": { "repositoryName": "string", "service": "string" }, "version": "string", "workingDirectory": "string" }, "requestId": "string"}



containerRecipe (p. 71)

The container recipe object that is returned.

Type: ContainerRecipe (p. 206) objectrequestId (p. 71)


Type: String








ClientException














https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/GetContainerRecipe

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/GetContainerRecipe

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/GetContainerRecipe

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/GetContainerRecipe

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/GetContainerRecipe

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/GetContainerRecipe

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/GetContainerRecipe

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/GetContainerRecipe

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/GetContainerRecipe

EC2 Image Builder API ReferenceGetContainerRecipePolicy

GetContainerRecipePolicyRetrieves the policy for a container recipe.

Request SyntaxGET /GetContainerRecipePolicy?containerRecipeArn=containerRecipeArn HTTP/1.1



The Amazon Resource Name (ARN) of the container recipe for the policy being requested.


Required: Yes






policy (p. 74)

The container recipe policy object that is returned.

Type: String



Type: String





















https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/GetContainerRecipePolicy

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/GetContainerRecipePolicy

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/GetContainerRecipePolicy

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/GetContainerRecipePolicy

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/GetContainerRecipePolicy

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/GetContainerRecipePolicy

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/GetContainerRecipePolicy

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/GetContainerRecipePolicy

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/GetContainerRecipePolicy

EC2 Image Builder API ReferenceGetDistributionConfiguration

GetDistributionConfigurationGets a distribution configuration.

Request SyntaxGET /GetDistributionConfiguration?distributionConfigurationArn=distributionConfigurationArn HTTP/1.1



The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve.


Required: Yes



{ "distributionConfiguration": { "arn": "string", "dateCreated": "string", "dateUpdated": "string", "description": "string", "distributions": [ { "amiDistributionConfiguration": { "amiTags": { "string" : "string" }, "description": "string", "kmsKeyId": "string", "launchPermission": { "organizationalUnitArns": [ "string" ], "organizationArns": [ "string" ], "userGroups": [ "string" ], "userIds": [ "string" ] }, "name": "string", "targetAccountIds": [ "string" ] }, "containerDistributionConfiguration": { "containerTags": [ "string" ],



"description": "string", "targetRepository": { "repositoryName": "string", "service": "string" } }, "fastLaunchConfigurations": [ { "accountId": "string", "enabled": boolean, "launchTemplate": { "launchTemplateId": "string", "launchTemplateName": "string", "launchTemplateVersion": "string" }, "maxParallelLaunches": number, "snapshotConfiguration": { "targetResourceCount": number } } ], "launchTemplateConfigurations": [ { "accountId": "string", "launchTemplateId": "string", "setDefaultVersion": boolean } ], "licenseConfigurationArns": [ "string" ], "region": "string", "s3ExportConfiguration": { "diskImageFormat": "string", "roleName": "string", "s3Bucket": "string", "s3Prefix": "string" } } ], "name": "string", "tags": { "string" : "string" }, "timeoutMinutes": number }, "requestId": "string"}



distributionConfiguration (p. 76)

The distribution configuration object.

Type: DistributionConfiguration (p. 214) objectrequestId (p. 76)


Type: String





















https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/GetDistributionConfiguration

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/GetDistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/GetDistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/GetDistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/GetDistributionConfiguration

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/GetDistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/GetDistributionConfiguration

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/GetDistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/GetDistributionConfiguration

EC2 Image Builder API ReferenceGetImage

GetImageGets an image.

Request SyntaxGET /GetImage?imageBuildVersionArn=imageBuildVersionArn HTTP/1.1



The Amazon Resource Name (ARN) of the image that you want to retrieve.

Pattern: ârn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image/[a-z0-9-_]+/(?:(?:([0-9]+|x)\.([0-9]+|x)\.([0-9]+|x))|(?:[0-9]+\.[0-9]+\.[0-9]+/[0-9]+))$

Required: Yes



{ "image": { "arn": "string", "buildType": "string", "containerRecipe": { "arn": "string", "components": [ { "componentArn": "string", "parameters": [ { "name": "string", "value": [ "string" ] } ] } ], "containerType": "string", "dateCreated": "string", "description": "string", "dockerfileTemplateData": "string", "encrypted": boolean, "instanceConfiguration": { "blockDeviceMappings": [ {



"deviceName": "string", "ebs": { "deleteOnTermination": boolean, "encrypted": boolean, "iops": number, "kmsKeyId": "string", "snapshotId": "string", "throughput": number, "volumeSize": number, "volumeType": "string" }, "noDevice": "string", "virtualName": "string" } ], "image": "string" }, "kmsKeyId": "string", "name": "string", "owner": "string", "parentImage": "string", "platform": "string", "tags": { "string" : "string" }, "targetRepository": { "repositoryName": "string", "service": "string" }, "version": "string", "workingDirectory": "string" }, "dateCreated": "string", "distributionConfiguration": { "arn": "string", "dateCreated": "string", "dateUpdated": "string", "description": "string", "distributions": [ { "amiDistributionConfiguration": { "amiTags": { "string" : "string" }, "description": "string", "kmsKeyId": "string", "launchPermission": { "organizationalUnitArns": [ "string" ], "organizationArns": [ "string" ], "userGroups": [ "string" ], "userIds": [ "string" ] }, "name": "string", "targetAccountIds": [ "string" ] }, "containerDistributionConfiguration": { "containerTags": [ "string" ], "description": "string", "targetRepository": { "repositoryName": "string", "service": "string" } }, "fastLaunchConfigurations": [ { "accountId": "string",



"enabled": boolean, "launchTemplate": { "launchTemplateId": "string", "launchTemplateName": "string", "launchTemplateVersion": "string" }, "maxParallelLaunches": number, "snapshotConfiguration": { "targetResourceCount": number } } ], "launchTemplateConfigurations": [ { "accountId": "string", "launchTemplateId": "string", "setDefaultVersion": boolean } ], "licenseConfigurationArns": [ "string" ], "region": "string", "s3ExportConfiguration": { "diskImageFormat": "string", "roleName": "string", "s3Bucket": "string", "s3Prefix": "string" } } ], "name": "string", "tags": { "string" : "string" }, "timeoutMinutes": number }, "enhancedImageMetadataEnabled": boolean, "imageRecipe": { "additionalInstanceConfiguration": { "systemsManagerAgent": { "uninstallAfterBuild": boolean }, "userDataOverride": "string" }, "arn": "string", "blockDeviceMappings": [ { "deviceName": "string", "ebs": { "deleteOnTermination": boolean, "encrypted": boolean, "iops": number, "kmsKeyId": "string", "snapshotId": "string", "throughput": number, "volumeSize": number, "volumeType": "string" }, "noDevice": "string", "virtualName": "string" } ], "components": [ { "componentArn": "string", "parameters": [ {



"name": "string", "value": [ "string" ] } ] } ], "dateCreated": "string", "description": "string", "name": "string", "owner": "string", "parentImage": "string", "platform": "string", "tags": { "string" : "string" }, "type": "string", "version": "string", "workingDirectory": "string" }, "imageTestsConfiguration": { "imageTestsEnabled": boolean, "timeoutMinutes": number }, "infrastructureConfiguration": { "arn": "string", "dateCreated": "string", "dateUpdated": "string", "description": "string", "instanceMetadataOptions": { "httpPutResponseHopLimit": number, "httpTokens": "string" }, "instanceProfileName": "string", "instanceTypes": [ "string" ], "keyPair": "string", "logging": { "s3Logs": { "s3BucketName": "string", "s3KeyPrefix": "string" } }, "name": "string", "resourceTags": { "string" : "string" }, "securityGroupIds": [ "string" ], "snsTopicArn": "string", "subnetId": "string", "tags": { "string" : "string" }, "terminateInstanceOnFailure": boolean }, "name": "string", "osVersion": "string", "outputResources": { "amis": [ { "accountId": "string", "description": "string", "image": "string", "name": "string", "region": "string", "state": { "reason": "string", "status": "string"



} } ], "containers": [ { "imageUris": [ "string" ], "region": "string" } ] }, "platform": "string", "sourcePipelineArn": "string", "sourcePipelineName": "string", "state": { "reason": "string", "status": "string" }, "tags": { "string" : "string" }, "type": "string", "version": "string" }, "requestId": "string"}



image (p. 79)

The image object.

Type: Image (p. 225) objectrequestId (p. 79)


Type: String





















https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/GetImage

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/GetImage

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/GetImage

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/GetImage

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/GetImage

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/GetImage

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/GetImage

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/GetImage

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/GetImage

EC2 Image Builder API ReferenceGetImagePipeline

GetImagePipelineGets an image pipeline.

Request SyntaxGET /GetImagePipeline?imagePipelineArn=imagePipelineArn HTTP/1.1



The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve.


Required: Yes



{ "imagePipeline": { "arn": "string", "containerRecipeArn": "string", "dateCreated": "string", "dateLastRun": "string", "dateNextRun": "string", "dateUpdated": "string", "description": "string", "distributionConfigurationArn": "string", "enhancedImageMetadataEnabled": boolean, "imageRecipeArn": "string", "imageTestsConfiguration": { "imageTestsEnabled": boolean, "timeoutMinutes": number }, "infrastructureConfigurationArn": "string", "name": "string", "platform": "string", "schedule": { "pipelineExecutionStartCondition": "string", "scheduleExpression": "string", "timezone": "string" }, "status": "string", "tags": {



"string" : "string" } }, "requestId": "string"}



imagePipeline (p. 85)

The image pipeline object.

Type: ImagePipeline (p. 230) objectrequestId (p. 85)


Type: String
















ServiceUnavailableException






https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/GetImagePipeline

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/GetImagePipeline

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/GetImagePipeline

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/GetImagePipeline

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/GetImagePipeline

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/GetImagePipeline

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/GetImagePipeline

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/GetImagePipeline

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/GetImagePipeline

EC2 Image Builder API ReferenceGetImagePolicy

GetImagePolicyGets an image policy.

Request SyntaxGET /GetImagePolicy?imageArn=imageArn HTTP/1.1


imageArn (p. 88)

The Amazon Resource Name (ARN) of the image whose policy you want to retrieve.


Required: Yes






policy (p. 88)

The image policy object.

Type: String



Type: String





















https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/GetImagePolicy

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/GetImagePolicy

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/GetImagePolicy

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/GetImagePolicy

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/GetImagePolicy

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/GetImagePolicy

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/GetImagePolicy

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/GetImagePolicy

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/GetImagePolicy

EC2 Image Builder API ReferenceGetImageRecipe

GetImageRecipeGets an image recipe.

Request SyntaxGET /GetImageRecipe?imageRecipeArn=imageRecipeArn HTTP/1.1



The Amazon Resource Name (ARN) of the image recipe that you want to retrieve.


Required: Yes



{ "imageRecipe": { "additionalInstanceConfiguration": { "systemsManagerAgent": { "uninstallAfterBuild": boolean }, "userDataOverride": "string" }, "arn": "string", "blockDeviceMappings": [ { "deviceName": "string", "ebs": { "deleteOnTermination": boolean, "encrypted": boolean, "iops": number, "kmsKeyId": "string", "snapshotId": "string", "throughput": number, "volumeSize": number, "volumeType": "string" }, "noDevice": "string", "virtualName": "string" } ],



"components": [ { "componentArn": "string", "parameters": [ { "name": "string", "value": [ "string" ] } ] } ], "dateCreated": "string", "description": "string", "name": "string", "owner": "string", "parentImage": "string", "platform": "string", "tags": { "string" : "string" }, "type": "string", "version": "string", "workingDirectory": "string" }, "requestId": "string"}



imageRecipe (p. 90)

The image recipe object.

Type: ImageRecipe (p. 233) objectrequestId (p. 90)


Type: String





















https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/GetImageRecipe

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/GetImageRecipe

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/GetImageRecipe

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/GetImageRecipe

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/GetImageRecipe

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/GetImageRecipe

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/GetImageRecipe

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/GetImageRecipe

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/GetImageRecipe

EC2 Image Builder API ReferenceGetImageRecipePolicy

GetImageRecipePolicyGets an image recipe policy.

Request SyntaxGET /GetImageRecipePolicy?imageRecipeArn=imageRecipeArn HTTP/1.1



The Amazon Resource Name (ARN) of the image recipe whose policy you want to retrieve.


Required: Yes






policy (p. 93)

The image recipe policy object.

Type: String



Type: String





















https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/GetImageRecipePolicy

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/GetImageRecipePolicy

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/GetImageRecipePolicy

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/GetImageRecipePolicy

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/GetImageRecipePolicy

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/GetImageRecipePolicy

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/GetImageRecipePolicy

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/GetImageRecipePolicy

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/GetImageRecipePolicy

EC2 Image Builder API ReferenceGetInfrastructureConfiguration

GetInfrastructureConfigurationGets an infrastructure configuration.

Request SyntaxGET /GetInfrastructureConfiguration?infrastructureConfigurationArn=infrastructureConfigurationArn HTTP/1.1



The Amazon Resource Name (ARN) of the infrastructure configuration that you want to retrieve.


Required: Yes



{ "infrastructureConfiguration": { "arn": "string", "dateCreated": "string", "dateUpdated": "string", "description": "string", "instanceMetadataOptions": { "httpPutResponseHopLimit": number, "httpTokens": "string" }, "instanceProfileName": "string", "instanceTypes": [ "string" ], "keyPair": "string", "logging": { "s3Logs": { "s3BucketName": "string", "s3KeyPrefix": "string" } }, "name": "string", "resourceTags": { "string" : "string" }, "securityGroupIds": [ "string" ], "snsTopicArn": "string",



"subnetId": "string", "tags": { "string" : "string" }, "terminateInstanceOnFailure": boolean }, "requestId": "string"}



infrastructureConfiguration (p. 95)

The infrastructure configuration object.

Type: InfrastructureConfiguration (p. 246) objectrequestId (p. 95)


Type: String





















https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/GetInfrastructureConfiguration

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/GetInfrastructureConfiguration

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/GetInfrastructureConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/GetInfrastructureConfiguration

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/GetInfrastructureConfiguration

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/GetInfrastructureConfiguration

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/GetInfrastructureConfiguration

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/GetInfrastructureConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/GetInfrastructureConfiguration

EC2 Image Builder API ReferenceImportComponent

ImportComponentImports a component and transforms its data into a component document.

Request SyntaxPUT /ImportComponent HTTP/1.1Content-type: application/json

{ "changeDescription": "string", "clientToken": "string", "data": "string", "description": "string", "format": "string", "kmsKeyId": "string", "name": "string", "platform": "string", "semanticVersion": "string", "tags": { "string" : "string" }, "type": "string", "uri": "string"}



changeDescription (p. 98)

The change description of the component. Describes what change has been made in this version, orwhat makes this version different from other versions of this component.

Type: String


Required: NoclientToken (p. 98)

The idempotency token of the component.

Type: String


Required: Yesdata (p. 98)

The data of the component. Used to specify the data inline. Either data or uri can be used tospecify the data within the component.



Type: String



The description of the component. Describes the contents of the component.

Type: String


Required: Noformat (p. 98)

The format of the resource that you want to import as a component.

Type: String

Valid Values: SHELL

Required: YeskmsKeyId (p. 98)

The ID of the KMS key that should be used to encrypt this component.

Type: String




Type: String


Required: Yesplatform (p. 98)


Type: String



The semantic version of the component. This version follows the semantic version syntax.

NoteThe semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assignvalues for the first three, and can filter on all of them.Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specifythe 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 mustalso be wildcards.

Type: String

Pattern: ^[0-9]+\.[0-9]+\.[0-9]+$


The tags of the component.






Required: Notype (p. 98)

The type of the component denotes whether the component is used to build the image, or only totest it.

Type: String

Valid Values: BUILD | TEST

Required: Yesuri (p. 98)

The uri of the component. Must be an Amazon S3 URL and the requester must have permission toaccess the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to yourservice quota. Either data or uri can be used to specify the data within the component.

Type: String

Required: No


{ "clientToken": "string", "componentBuildVersionArn": "string", "requestId": "string"}





clientToken (p. 100)


Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.componentBuildVersionArn (p. 100)

The Amazon Resource Name (ARN) of the imported component.

Type: String


requestId (p. 100)


Type: String






























https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/ImportComponent

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/ImportComponent

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ImportComponent

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ImportComponent

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ImportComponent

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/ImportComponent

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/ImportComponent

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/ImportComponent

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ImportComponent

EC2 Image Builder API ReferenceImportVmImage

ImportVmImageWhen you export your virtual machine (VM) from its virtualization environment, that process createsa set of one or more disk container files that act as snapshots of your VM’s environment, settings, anddata. The Amazon EC2 API ImportImage action uses those files to import your VM and create an AMI. Toimport using the AWS CLI command, see import-image

You can reference the task ID from the VM import to pull in the AMI that the import created as the baseimage for your Image Builder recipe.

Request Syntax

PUT /ImportVmImage HTTP/1.1Content-type: application/json

{ "clientToken": "string", "description": "string", "name": "string", "osVersion": "string", "platform": "string", "semanticVersion": "string", "tags": { "string" : "string" }, "vmImportTaskId": "string"}




Unique, case-sensitive identifier you provide to ensure idempotency of the request. For moreinformation, see Ensuring idempotency in the Amazon EC2 API Reference.

Type: String


Required: Yes

description (p. 103)

The description for the base image that is created by the import process.

Type: String


Required: No


https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportImage.html

https://docs.aws.amazon.com/cli/latest/reference/ec2/import-image.html

https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html


name (p. 103)

The name of the base image that is created by the import process.

Type: String


Required: YesosVersion (p. 103)

The operating system version for the imported VM.

Type: String


Required: Noplatform (p. 103)

The operating system platform for the imported VM.

Type: String



The semantic version to attach to the base image that was created during the import process. Thisversion follows the semantic version syntax.


Type: String

Pattern: ^[0-9]+\.[0-9]+\.[0-9]+$


Tags that are attached to the import resources.








Required: No

vmImportTaskId (p. 103)

The importTaskId (API) or ImportTaskId (AWS CLI) from the Amazon EC2 VM import process.Image Builder retrieves information from the import process to pull in the AMI that is created fromthe VM source as the base image for your recipe.

Type: String


Required: Yes


{ "clientToken": "string", "imageArn": "string", "requestId": "string"}




The idempotency token that was used for this request.

Type: String


imageArn (p. 105)

The Amazon Resource Name (ARN) of the AMI that was created during the VM import process. ThisAMI is used as the base image for the recipe that imported the VM.

Type: String

requestId (p. 105)


Type: String





ClientException










https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/ImportVmImage

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/ImportVmImage

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ImportVmImage

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ImportVmImage

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ImportVmImage

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/ImportVmImage

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/ImportVmImage

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/ImportVmImage

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ImportVmImage

EC2 Image Builder API ReferenceListComponentBuildVersions

ListComponentBuildVersionsReturns the list of component build versions for the specified semantic version.

NoteThe semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign valuesfor the first three, and can filter on all of them.Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify themost 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 bewildcards.

Request SyntaxPOST /ListComponentBuildVersions HTTP/1.1Content-type: application/json

{ "componentVersionArn": "string", "maxResults": number, "nextToken": "string"}



componentVersionArn (p. 107)

The component version Amazon Resource Name (ARN) whose versions you want to list.

Type: String

Pattern: ârn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):component/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+$

Required: YesmaxResults (p. 107)

The maximum items to return in a request.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 25.

Required: NonextToken (p. 107)

A token to specify where to start paginating. This is the NextToken from a previously truncatedresponse.

Type: String




Required: No


{ "componentSummaryList": [ { "arn": "string", "changeDescription": "string", "dateCreated": "string", "description": "string", "name": "string", "owner": "string", "platform": "string", "state": { "reason": "string", "status": "string" }, "supportedOsVersions": [ "string" ], "tags": { "string" : "string" }, "type": "string", "version": "string" } ], "nextToken": "string", "requestId": "string"}



componentSummaryList (p. 108)

The list of component summaries for the specified semantic version.

Type: Array of ComponentSummary (p. 198) objects

nextToken (p. 108)

The next token used for paginated responses. When this is not empty, there are additional elementsthat the service has not included in this request. Use this token with the next request to retrieveadditional objects.

Type: String


requestId (p. 108)




Type: String









HTTP Status Code: 403InvalidPaginationTokenException

You have provided an invalid pagination token in your request.









• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2


https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/ListComponentBuildVersions

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/ListComponentBuildVersions

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ListComponentBuildVersions

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ListComponentBuildVersions

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ListComponentBuildVersions


• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/ListComponentBuildVersions

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/ListComponentBuildVersions

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/ListComponentBuildVersions

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ListComponentBuildVersions

EC2 Image Builder API ReferenceListComponents

ListComponentsReturns the list of components that can be filtered by name, or by using the listed filtersto streamline results. Newly created components can take up to two minutes to appear in theListComponents API Results.

NoteThe semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign valuesfor the first three, and can filter on all of them.Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify themost 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 bewildcards.

Request SyntaxPOST /ListComponents HTTP/1.1Content-type: application/json

{ "byName": boolean, "filters": [ { "name": "string", "values": [ "string" ] } ], "maxResults": number, "nextToken": "string", "owner": "string"}



byName (p. 111)

Returns the list of components for the specified name.

Type: Boolean

Required: Nofilters (p. 111)

Use the following filters to streamline results:• description

• name

• platform

• supportedOsVersion

• type



• version

Type: Array of Filter (p. 224) objects


Required: NomaxResults (p. 111)


Type: Integer




Type: String


Required: Noowner (p. 111)

The owner defines which components you want to list. By default, this request will only showcomponents owned by your account. You can use this field to specify if you want to viewcomponents owned by yourself, by Amazon, or those components that have been shared with you byother customers.

Type: String

Valid Values: Self | Shared | Amazon

Required: No


{ "componentVersionList": [ { "arn": "string", "dateCreated": "string", "description": "string", "name": "string", "owner": "string", "platform": "string", "supportedOsVersions": [ "string" ], "type": "string", "version": "string" } ], "nextToken": "string", "requestId": "string"



}



componentVersionList (p. 112)

The list of component semantic versions.

NoteThe semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assignvalues for the first three, and can filter on all of them.

Type: Array of ComponentVersion (p. 201) objectsnextToken (p. 112)


Type: String



Type: String























https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/ListComponents

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/ListComponents

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ListComponents

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ListComponents

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ListComponents

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/ListComponents

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/ListComponents

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/ListComponents

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ListComponents

EC2 Image Builder API ReferenceListContainerRecipes

ListContainerRecipesReturns a list of container recipes.

Request SyntaxPOST /ListContainerRecipes HTTP/1.1Content-type: application/json

{ "filters": [ { "name": "string", "values": [ "string" ] } ], "maxResults": number, "nextToken": "string", "owner": "string"}



filters (p. 115)

Use the following filters to streamline results:• containerType

• name

• parentImage

• platform




The maximum number of results to return in the list.

Type: Integer



Provides a token for pagination, which determines where to begin the next set of results when thecurrent set reaches the maximum for one request.



Type: String



Returns container recipes belonging to the specified owner, that have been shared with you. You canomit this field to return container recipes belonging to your account.

Type: String


Required: No


{ "containerRecipeSummaryList": [ { "arn": "string", "containerType": "string", "dateCreated": "string", "name": "string", "owner": "string", "parentImage": "string", "platform": "string", "tags": { "string" : "string" } } ], "nextToken": "string", "requestId": "string"}



containerRecipeSummaryList (p. 116)

The list of container recipes returned for the request.

Type: Array of ContainerRecipeSummary (p. 210) objectsnextToken (p. 116)

The next token field is used for paginated responses. When this is not empty, there are additionalcontainer recipes that the service has not included in this response. Use this token with the nextrequest to retrieve additional list items.

Type: String





Type: String



















• AWS Command Line Interface


https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/ListContainerRecipes


• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/ListContainerRecipes

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ListContainerRecipes

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ListContainerRecipes

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ListContainerRecipes

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/ListContainerRecipes

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/ListContainerRecipes

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/ListContainerRecipes

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ListContainerRecipes

EC2 Image Builder API ReferenceListDistributionConfigurations

ListDistributionConfigurationsReturns a list of distribution configurations.

Request SyntaxPOST /ListDistributionConfigurations HTTP/1.1Content-type: application/json

{ "filters": [ { "name": "string", "values": [ "string" ] } ], "maxResults": number, "nextToken": "string"}



filters (p. 119)

You can filter on name to streamline results.





Type: Integer




Type: String


Required: No




{ "distributionConfigurationSummaryList": [ { "arn": "string", "dateCreated": "string", "dateUpdated": "string", "description": "string", "name": "string", "regions": [ "string" ], "tags": { "string" : "string" } } ], "nextToken": "string", "requestId": "string"}



distributionConfigurationSummaryList (p. 120)

The list of distributions.

Type: Array of DistributionConfigurationSummary (p. 216) objectsnextToken (p. 120)


Type: String



Type: String























https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/ListDistributionConfigurations

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/ListDistributionConfigurations

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ListDistributionConfigurations

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ListDistributionConfigurations

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ListDistributionConfigurations

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/ListDistributionConfigurations

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/ListDistributionConfigurations

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/ListDistributionConfigurations

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ListDistributionConfigurations

EC2 Image Builder API ReferenceListImageBuildVersions

ListImageBuildVersionsReturns a list of image build versions.

Request SyntaxPOST /ListImageBuildVersions HTTP/1.1Content-type: application/json

{ "filters": [ { "name": "string", "values": [ "string" ] } ], "imageVersionArn": "string", "maxResults": number, "nextToken": "string"}



filters (p. 122)

Use the following filters to streamline results:• name

• osVersion

• platform

• type

• version



Required: NoimageVersionArn (p. 122)

The Amazon Resource Name (ARN) of the image whose build versions you want to retrieve.

Type: String

Pattern: ârn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+$





Type: Integer




Type: String


Required: No


{ "imageSummaryList": [ { "arn": "string", "buildType": "string", "dateCreated": "string", "name": "string", "osVersion": "string", "outputResources": { "amis": [ { "accountId": "string", "description": "string", "image": "string", "name": "string", "region": "string", "state": { "reason": "string", "status": "string" } } ], "containers": [ { "imageUris": [ "string" ], "region": "string" } ] }, "owner": "string", "platform": "string", "state": { "reason": "string", "status": "string" }, "tags": { "string" : "string" }, "type": "string", "version": "string" }



], "nextToken": "string", "requestId": "string"}



imageSummaryList (p. 123)

The list of image build versions.

Type: Array of ImageSummary (p. 239) objectsnextToken (p. 123)


Type: String



Type: String























https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/ListImageBuildVersions

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/ListImageBuildVersions

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ListImageBuildVersions

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ListImageBuildVersions

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ListImageBuildVersions

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/ListImageBuildVersions

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/ListImageBuildVersions

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/ListImageBuildVersions

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ListImageBuildVersions

EC2 Image Builder API ReferenceListImagePackages

ListImagePackagesList the Packages that are associated with an Image Build Version, as determined by AWS SystemsManager Inventory at build time.

Request SyntaxPOST /ListImagePackages HTTP/1.1Content-type: application/json

{ "imageBuildVersionArn": "string", "maxResults": number, "nextToken": "string"}




Filter results for the ListImagePackages request by the Image Build Version ARN

Type: String



The maxiumum number of results to return from the ListImagePackages request.

Type: Integer




Type: String


Required: No

Response SyntaxHTTP/1.1 200



Content-type: application/json

{ "imagePackageList": [ { "packageName": "string", "packageVersion": "string" } ], "nextToken": "string", "requestId": "string"}



imagePackageList (p. 126)

The list of Image Packages returned in the response.

Type: Array of ImagePackage (p. 229) objectsnextToken (p. 126)


Type: String



Type: String

























https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/ListImagePackages

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/ListImagePackages

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ListImagePackages

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ListImagePackages

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ListImagePackages

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/ListImagePackages

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/ListImagePackages

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/ListImagePackages

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ListImagePackages

EC2 Image Builder API ReferenceListImagePipelineImages

ListImagePipelineImagesReturns a list of images created by the specified pipeline.

Request SyntaxPOST /ListImagePipelineImages HTTP/1.1Content-type: application/json

{ "filters": [ { "name": "string", "values": [ "string" ] } ], "imagePipelineArn": "string", "maxResults": number, "nextToken": "string"}



filters (p. 129)


• version



Required: NoimagePipelineArn (p. 129)

The Amazon Resource Name (ARN) of the image pipeline whose images you want to view.

Type: String




Type: Integer






Type: String


Required: No


{ "imageSummaryList": [ { "arn": "string", "buildType": "string", "dateCreated": "string", "name": "string", "osVersion": "string", "outputResources": { "amis": [ { "accountId": "string", "description": "string", "image": "string", "name": "string", "region": "string", "state": { "reason": "string", "status": "string" } } ], "containers": [ { "imageUris": [ "string" ], "region": "string" } ] }, "owner": "string", "platform": "string", "state": { "reason": "string", "status": "string" }, "tags": { "string" : "string" }, "type": "string", "version": "string" } ], "nextToken": "string",






imageSummaryList (p. 130)

The list of images built by this pipeline.

Type: Array of ImageSummary (p. 239) objectsnextToken (p. 130)


Type: String



Type: String


























https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/ListImagePipelineImages

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/ListImagePipelineImages

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ListImagePipelineImages

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ListImagePipelineImages

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ListImagePipelineImages

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/ListImagePipelineImages

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/ListImagePipelineImages

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/ListImagePipelineImages

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ListImagePipelineImages

EC2 Image Builder API ReferenceListImagePipelines

ListImagePipelinesReturns a list of image pipelines.

Request Syntax

POST /ListImagePipelines HTTP/1.1Content-type: application/json




filters (p. 133)

Use the following filters to streamline results:

• description

• distributionConfigurationArn

• imageRecipeArn

• infrastructureConfigurationArn

• name

• status



Required: No

maxResults (p. 133)


Type: Integer


Required: No



nextToken (p. 133)


Type: String


Required: No


{ "imagePipelineList": [ { "arn": "string", "containerRecipeArn": "string", "dateCreated": "string", "dateLastRun": "string", "dateNextRun": "string", "dateUpdated": "string", "description": "string", "distributionConfigurationArn": "string", "enhancedImageMetadataEnabled": boolean, "imageRecipeArn": "string", "imageTestsConfiguration": { "imageTestsEnabled": boolean, "timeoutMinutes": number }, "infrastructureConfigurationArn": "string", "name": "string", "platform": "string", "schedule": { "pipelineExecutionStartCondition": "string", "scheduleExpression": "string", "timezone": "string" }, "status": "string", "tags": { "string" : "string" } } ], "nextToken": "string", "requestId": "string"}



imagePipelineList (p. 134)

The list of image pipelines.



Type: Array of ImagePipeline (p. 230) objectsnextToken (p. 134)


Type: String



Type: String























https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/ListImagePipelines

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/ListImagePipelines

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ListImagePipelines

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ListImagePipelines

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ListImagePipelines

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/ListImagePipelines

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/ListImagePipelines

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/ListImagePipelines

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ListImagePipelines

EC2 Image Builder API ReferenceListImageRecipes

ListImageRecipesReturns a list of image recipes.

Request SyntaxPOST /ListImageRecipes HTTP/1.1Content-type: application/json

{ "filters": [ { "name": "string", "values": [ "string" ] } ], "maxResults": number, "nextToken": "string", "owner": "string"}



filters (p. 137)


• parentImage

• platform





Type: Integer




Type: String





The owner defines which image recipes you want to list. By default, this request will only showimage recipes owned by your account. You can use this field to specify if you want to view imagerecipes owned by yourself, by Amazon, or those image recipes that have been shared with you byother customers.

Type: String


Required: No


{ "imageRecipeSummaryList": [ { "arn": "string", "dateCreated": "string", "name": "string", "owner": "string", "parentImage": "string", "platform": "string", "tags": { "string" : "string" } } ], "nextToken": "string", "requestId": "string"}



imageRecipeSummaryList (p. 138)

The list of image pipelines.

Type: Array of ImageRecipeSummary (p. 236) objectsnextToken (p. 138)


Type: String




requestId (p. 138)


Type: String



















• AWS Command Line Interface• AWS SDK for .NET


https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/ListImageRecipes

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/ListImageRecipes


• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ListImageRecipes

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ListImageRecipes

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ListImageRecipes

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/ListImageRecipes

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/ListImageRecipes

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/ListImageRecipes

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ListImageRecipes

EC2 Image Builder API ReferenceListImages

ListImagesReturns the list of images that you have access to. Newly created images can take up to two minutes toappear in the ListImages API Results.

Request SyntaxPOST /ListImages HTTP/1.1Content-type: application/json

{ "byName": boolean, "filters": [ { "name": "string", "values": [ "string" ] } ], "includeDeprecated": boolean, "maxResults": number, "nextToken": "string", "owner": "string"}



byName (p. 141)

Requests a list of images with a specific recipe name.

Type: Boolean

Required: Nofilters (p. 141)


• osVersion

• platform

• type

• version



Required: NoincludeDeprecated (p. 141)

Includes deprecated images in the response list.



Type: Boolean



Type: Integer




Type: String



The owner defines which images you want to list. By default, this request will only show imagesowned by your account. You can use this field to specify if you want to view images owned byyourself, by Amazon, or those images that have been shared with you by other customers.

Type: String


Required: No


{ "imageVersionList": [ { "arn": "string", "buildType": "string", "dateCreated": "string", "name": "string", "osVersion": "string", "owner": "string", "platform": "string", "type": "string", "version": "string" } ], "nextToken": "string", "requestId": "string"}





imageVersionList (p. 142)

The list of image semantic versions.

NoteThe semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assignvalues for the first three, and can filter on all of them.Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specifythe most recent versions or nodes when selecting the base image or components for yourrecipe. When you use a wildcard in any node, all nodes to the right of the first wildcard mustalso be wildcards.

Type: Array of ImageVersion (p. 243) objectsnextToken (p. 142)


Type: String



Type: String
























https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/ListImages

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/ListImages

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ListImages

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ListImages

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ListImages

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/ListImages

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/ListImages

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/ListImages

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ListImages

EC2 Image Builder API ReferenceListInfrastructureConfigurations

ListInfrastructureConfigurationsReturns a list of infrastructure configurations.

Request SyntaxPOST /ListInfrastructureConfigurations HTTP/1.1Content-type: application/json




filters (p. 145)

You can filter on name to streamline results.





Type: Integer




Type: String


Required: No




{ "infrastructureConfigurationSummaryList": [ { "arn": "string", "dateCreated": "string", "dateUpdated": "string", "description": "string", "instanceProfileName": "string", "instanceTypes": [ "string" ], "name": "string", "resourceTags": { "string" : "string" }, "tags": { "string" : "string" } } ], "nextToken": "string", "requestId": "string"}



infrastructureConfigurationSummaryList (p. 146)

The list of infrastructure configurations.

Type: Array of InfrastructureConfigurationSummary (p. 249) objectsnextToken (p. 146)


Type: String



Type: String























https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/ListInfrastructureConfigurations

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/ListInfrastructureConfigurations

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ListInfrastructureConfigurations

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ListInfrastructureConfigurations

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ListInfrastructureConfigurations

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/ListInfrastructureConfigurations

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/ListInfrastructureConfigurations

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/ListInfrastructureConfigurations

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ListInfrastructureConfigurations

EC2 Image Builder API ReferenceListTagsForResource

ListTagsForResourceReturns the list of tags for the specified resource.

Request SyntaxGET /tags/resourceArn HTTP/1.1


resourceArn (p. 148)

The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

Pattern: ârn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline)/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\.(?:x|[0-9]+)\.(?:x|[0-9]+))(?:/[0-9]+)?)?$

Required: Yes



{ "tags": { "string" : "string" }}



tags (p. 148)

The tags for the specified resource.









InvalidParameterException

The specified parameter is invalid. Review the available parameters for the API request.









https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/ListTagsForResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ListTagsForResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/ListTagsForResource

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ListTagsForResource

EC2 Image Builder API ReferencePutComponentPolicy

PutComponentPolicyApplies a policy to a component. We recommend that you call the RAM API CreateResourceShare toshare resources. If you call the Image Builder API PutComponentPolicy, you must also call the RAMAPI PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals withwhom the resource is shared.

Request SyntaxPUT /PutComponentPolicy HTTP/1.1Content-type: application/json

{ "componentArn": "string", "policy": "string"}




The Amazon Resource Name (ARN) of the component that this policy should be applied to.

Type: String


Required: Yespolicy (p. 150)

The policy to apply.

Type: String


Required: Yes


{ "componentArn": "string", "requestId": "string"}


https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html

https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html





The Amazon Resource Name (ARN) of the component that this policy was applied to.

Type: String


requestId (p. 150)


Type: String









HTTP Status Code: 403InvalidParameterValueException

The value that you provided for the specified parameter is invalid.















https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/PutComponentPolicy

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/PutComponentPolicy

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/PutComponentPolicy

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/PutComponentPolicy

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/PutComponentPolicy

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/PutComponentPolicy

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/PutComponentPolicy

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/PutComponentPolicy

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/PutComponentPolicy

EC2 Image Builder API ReferencePutContainerRecipePolicy

PutContainerRecipePolicyApplies 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 shareresources. If you call the Image Builder API PutContainerImagePolicy, you must also call theRAM API PromoteResourceShareCreatedFromPolicy (https://docs.aws.amazon.com//ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) in order for the resource to be visibleto all principals with whom the resource is shared.

Request SyntaxPUT /PutContainerRecipePolicy HTTP/1.1Content-type: application/json

{ "containerRecipeArn": "string", "policy": "string"}




The Amazon Resource Name (ARN) of the container recipe that this policy should be applied to.

Type: String



The policy to apply to the container recipe.

Type: String


Required: Yes


{ "containerRecipeArn": "string",







The Amazon Resource Name (ARN) of the container recipe that this policy was applied to.

Type: String


requestId (p. 153)


Type: String
















ResourceNotFoundException










https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/PutContainerRecipePolicy

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/PutContainerRecipePolicy

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/PutContainerRecipePolicy

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/PutContainerRecipePolicy

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/PutContainerRecipePolicy

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/PutContainerRecipePolicy

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/PutContainerRecipePolicy

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/PutContainerRecipePolicy

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/PutContainerRecipePolicy

EC2 Image Builder API ReferencePutImagePolicy

PutImagePolicyApplies a policy to an image. We recommend that you call the RAM API CreateResourceShare toshare resources. If you call the Image Builder API PutImagePolicy, you must also call the RAM APIPromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals withwhom the resource is shared.

Request SyntaxPUT /PutImagePolicy HTTP/1.1Content-type: application/json

{ "imageArn": "string", "policy": "string"}



imageArn (p. 156)

The Amazon Resource Name (ARN) of the image that this policy should be applied to.

Type: String




Type: String


Required: Yes


{ "imageArn": "string", "requestId": "string"}







imageArn (p. 156)

The Amazon Resource Name (ARN) of the image that this policy was applied to.

Type: String


requestId (p. 156)


Type: String

























https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/PutImagePolicy

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/PutImagePolicy

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/PutImagePolicy

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/PutImagePolicy

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/PutImagePolicy

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/PutImagePolicy

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/PutImagePolicy

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/PutImagePolicy

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/PutImagePolicy

EC2 Image Builder API ReferencePutImageRecipePolicy

PutImageRecipePolicyApplies a policy to an image recipe. We recommend that you call the RAM API CreateResourceShare toshare resources. If you call the Image Builder API PutImageRecipePolicy, you must also call the RAMAPI PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals withwhom the resource is shared.

Request SyntaxPUT /PutImageRecipePolicy HTTP/1.1Content-type: application/json

{ "imageRecipeArn": "string", "policy": "string"}




The Amazon Resource Name (ARN) of the image recipe that this policy should be applied to.

Type: String




Type: String


Required: Yes


{ "imageRecipeArn": "string", "requestId": "string"}








The Amazon Resource Name (ARN) of the image recipe that this policy was applied to.

Type: String


requestId (p. 159)


Type: String

























https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/PutImageRecipePolicy

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/PutImageRecipePolicy

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/PutImageRecipePolicy

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/PutImageRecipePolicy

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/PutImageRecipePolicy

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/PutImageRecipePolicy

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/PutImageRecipePolicy

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/PutImageRecipePolicy

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/PutImageRecipePolicy

EC2 Image Builder API ReferenceStartImagePipelineExecution

StartImagePipelineExecutionManually triggers a pipeline to create an image.

Request Syntax

PUT /StartImagePipelineExecution HTTP/1.1Content-type: application/json

{ "clientToken": "string", "imagePipelineArn": "string"}





Type: String


Required: Yes


The Amazon Resource Name (ARN) of the image pipeline that you want to manually invoke.

Type: String


Required: Yes

Response Syntax

HTTP/1.1 200Content-type: application/json








Type: String


The Amazon Resource Name (ARN) of the image that was created by this request.

Type: String


requestId (p. 162)


Type: String




























https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/StartImagePipelineExecution

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/StartImagePipelineExecution

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/StartImagePipelineExecution

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/StartImagePipelineExecution

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/StartImagePipelineExecution

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/StartImagePipelineExecution

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/StartImagePipelineExecution

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/StartImagePipelineExecution

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/StartImagePipelineExecution

EC2 Image Builder API ReferenceTagResource

TagResourceAdds a tag to a resource.

Request SyntaxPOST /tags/resourceArn HTTP/1.1Content-type: application/json

{ "tags": { "string" : "string" }}



The Amazon Resource Name (ARN) of the resource that you want to tag.


Required: Yes


tags (p. 165)

The tags to apply to the resource.






Required: Yes




Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.












https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/TagResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/TagResource

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/TagResource

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/TagResource

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/TagResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/TagResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/TagResource

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/TagResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/TagResource

EC2 Image Builder API ReferenceUntagResource

UntagResourceRemoves a tag from a resource.

Request SyntaxDELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1



The Amazon Resource Name (ARN) of the resource that you want to untag.


Required: YestagKeys (p. 167)

The tag keys to remove from the resource.



Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Required: Yes



Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.














https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/UntagResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/UntagResource

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/UntagResource

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/UntagResource

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/UntagResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/UntagResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/UntagResource

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/UntagResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/UntagResource

EC2 Image Builder API ReferenceUpdateDistributionConfiguration

UpdateDistributionConfigurationUpdates a new distribution configuration. Distribution configurations define and configure the outputsof your pipeline.

Request Syntax

PUT /UpdateDistributionConfiguration HTTP/1.1Content-type: application/json

{ "clientToken": "string", "description": "string", "distributionConfigurationArn": "string", "distributions": [ { "amiDistributionConfiguration": { "amiTags": { "string" : "string" }, "description": "string", "kmsKeyId": "string", "launchPermission": { "organizationalUnitArns": [ "string" ], "organizationArns": [ "string" ], "userGroups": [ "string" ], "userIds": [ "string" ] }, "name": "string", "targetAccountIds": [ "string" ] }, "containerDistributionConfiguration": { "containerTags": [ "string" ], "description": "string", "targetRepository": { "repositoryName": "string", "service": "string" } }, "fastLaunchConfigurations": [ { "accountId": "string", "enabled": boolean, "launchTemplate": { "launchTemplateId": "string", "launchTemplateName": "string", "launchTemplateVersion": "string" }, "maxParallelLaunches": number, "snapshotConfiguration": { "targetResourceCount": number } } ], "launchTemplateConfigurations": [ { "accountId": "string", "launchTemplateId": "string", "setDefaultVersion": boolean } ], "licenseConfigurationArns": [ "string" ],



"region": "string", "s3ExportConfiguration": { "diskImageFormat": "string", "roleName": "string", "s3Bucket": "string", "s3Prefix": "string" } } ]}




The idempotency token of the distribution configuration.

Type: String




Type: String



The Amazon Resource Name (ARN) of the distribution configuration that you want to update.

Type: String


Required: Yesdistributions (p. 169)

The distributions of the distribution configuration.


Required: Yes




Content-type: application/json

{ "clientToken": "string", "distributionConfigurationArn": "string", "requestId": "string"}





Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.distributionConfigurationArn (p. 170)

The Amazon Resource Name (ARN) of the distribution configuration that was updated by thisrequest.

Type: String


requestId (p. 170)


Type: String



























https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/UpdateDistributionConfiguration

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/UpdateDistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/UpdateDistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/UpdateDistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/UpdateDistributionConfiguration

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/UpdateDistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/UpdateDistributionConfiguration

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/UpdateDistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/UpdateDistributionConfiguration

EC2 Image Builder API ReferenceUpdateImagePipeline

UpdateImagePipelineUpdates an image pipeline. Image pipelines enable you to automate the creation and distribution ofimages.

NoteUpdateImagePipeline does not support selective updates for the pipeline. You must specify allof the required properties in the update request, not just the properties that have changed.

Request SyntaxPUT /UpdateImagePipeline HTTP/1.1Content-type: application/json

{ "clientToken": "string", "containerRecipeArn": "string", "description": "string", "distributionConfigurationArn": "string", "enhancedImageMetadataEnabled": boolean, "imagePipelineArn": "string", "imageRecipeArn": "string", "imageTestsConfiguration": { "imageTestsEnabled": boolean, "timeoutMinutes": number }, "infrastructureConfigurationArn": "string", "schedule": { "pipelineExecutionStartCondition": "string", "scheduleExpression": "string", "timezone": "string" }, "status": "string"}





Type: String


Required: YescontainerRecipeArn (p. 173)

The Amazon Resource Name (ARN) of the container pipeline to update.

Type: String






Type: String



The Amazon Resource Name (ARN) of the distribution configuration that will be used to configureand distribute images updated by this image pipeline.

Type: String


Required: NoenhancedImageMetadataEnabled (p. 173)


Type: Boolean

Required: NoimagePipelineArn (p. 173)

The Amazon Resource Name (ARN) of the image pipeline that you want to update.

Type: String


Required: YesimageRecipeArn (p. 173)

The Amazon Resource Name (ARN) of the image recipe that will be used to configure imagesupdated by this image pipeline.

Type: String


Required: NoimageTestsConfiguration (p. 173)

The image test configuration of the image pipeline.




Required: NoinfrastructureConfigurationArn (p. 173)

The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to buildimages updated by this image pipeline.

Type: String


Required: Yesschedule (p. 173)



Required: Nostatus (p. 173)


Type: String


Required: No


{ "clientToken": "string", "imagePipelineArn": "string", "requestId": "string"}





Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.imagePipelineArn (p. 175)

The Amazon Resource Name (ARN) of the image pipeline that was updated by this request.

Type: String




requestId (p. 175)


Type: String

























https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/UpdateImagePipeline

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/UpdateImagePipeline

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/UpdateImagePipeline

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/UpdateImagePipeline

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/UpdateImagePipeline

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/UpdateImagePipeline

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/UpdateImagePipeline

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/UpdateImagePipeline

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/UpdateImagePipeline

EC2 Image Builder API ReferenceUpdateInfrastructureConfiguration

UpdateInfrastructureConfigurationUpdates a new infrastructure configuration. An infrastructure configuration defines the environment inwhich your image will be built and tested.

Request SyntaxPUT /UpdateInfrastructureConfiguration HTTP/1.1Content-type: application/json

{ "clientToken": "string", "description": "string", "infrastructureConfigurationArn": "string", "instanceMetadataOptions": { "httpPutResponseHopLimit": number, "httpTokens": "string" }, "instanceProfileName": "string", "instanceTypes": [ "string" ], "keyPair": "string", "logging": { "s3Logs": { "s3BucketName": "string", "s3KeyPrefix": "string" } }, "resourceTags": { "string" : "string" }, "securityGroupIds": [ "string" ], "snsTopicArn": "string", "subnetId": "string", "terminateInstanceOnFailure": boolean}





Type: String




Type: String




Required: No


The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.

Type: String


Required: Yes

instanceMetadataOptions (p. 178)

The instance metadata options that you can set for the HTTP requests that pipeline builds use tolaunch EC2 build and test instances. For more information about instance metadata options, see oneof the following links:

• Configure the instance metadata options in the Amazon EC2 User Guide for Linux instances.

• Configure the instance metadata options in the Amazon EC2 Windows Guide for Windowsinstances.


Required: No

instanceProfileName (p. 178)

The instance profile to associate with the instance used to customize your Amazon EC2 AMI.

Type: String


Pattern: ^[\w+=,.@-]+$

Required: Yes

instanceTypes (p. 178)

The instance types of the infrastructure configuration. You can specify one or more instance types touse for this build. The service will pick one of these instance types based on availability.


Required: No

keyPair (p. 178)

The key pair of the infrastructure configuration. You can use this to log on to and debug the instanceused to create your image.

Type: String


Required: No

logging (p. 178)



https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html

https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html



Required: NoresourceTags (p. 178)







Required: NosecurityGroupIds (p. 178)

The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.



Required: NosnsTopicArn (p. 178)



Type: String

Pattern: ârn:aws[^:]*:sns:[^:]+:[0-9]{12}:[a-zA-Z0-9-_]{1,256}$

Required: NosubnetId (p. 178)

The subnet ID to place the instance used to customize your Amazon EC2 AMI in.

Type: String


Required: NoterminateInstanceOnFailure (p. 178)

The terminate instance on failure setting of the infrastructure configuration. Set to false if you wantImage Builder to retain the instance used to configure your AMI if the build or test phase of yourworkflow fails.

Type: Boolean

Required: No




{ "clientToken": "string", "infrastructureConfigurationArn": "string", "requestId": "string"}





Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.infrastructureConfigurationArn (p. 181)

The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by thisrequest.

Type: String


requestId (p. 181)


Type: String










ForbiddenException
















https://docs.aws.amazon.com/goto/aws-cli/imagebuilder-2019-12-02/UpdateInfrastructureConfiguration

https://docs.aws.amazon.com/goto/DotNetSDKV3/imagebuilder-2019-12-02/UpdateInfrastructureConfiguration

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/UpdateInfrastructureConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/UpdateInfrastructureConfiguration

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/UpdateInfrastructureConfiguration

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/imagebuilder-2019-12-02/UpdateInfrastructureConfiguration

https://docs.aws.amazon.com/goto/SdkForPHPV3/imagebuilder-2019-12-02/UpdateInfrastructureConfiguration

https://docs.aws.amazon.com/goto/boto3/imagebuilder-2019-12-02/UpdateInfrastructureConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/UpdateInfrastructureConfiguration


Data TypesThe EC2 Image Builder API contains several data types that various actions use. This section describeseach data type in detail.

NoteThe order of each element in a data type structure is not guaranteed. Applications should notassume a particular order.

The following data types are supported:

• AdditionalInstanceConfiguration (p. 185)• Ami (p. 186)• AmiDistributionConfiguration (p. 188)• Component (p. 190)• ComponentConfiguration (p. 193)• ComponentParameter (p. 194)• ComponentParameterDetail (p. 195)• ComponentState (p. 197)• ComponentSummary (p. 198)• ComponentVersion (p. 201)• Container (p. 204)• ContainerDistributionConfiguration (p. 205)• ContainerRecipe (p. 206)• ContainerRecipeSummary (p. 210)• Distribution (p. 212)• DistributionConfiguration (p. 214)• DistributionConfigurationSummary (p. 216)• EbsInstanceBlockDeviceSpecification (p. 218)• FastLaunchConfiguration (p. 220)• FastLaunchLaunchTemplateSpecification (p. 222)• FastLaunchSnapshotConfiguration (p. 223)• Filter (p. 224)• Image (p. 225)• ImagePackage (p. 229)• ImagePipeline (p. 230)• ImageRecipe (p. 233)• ImageRecipeSummary (p. 236)• ImageState (p. 238)• ImageSummary (p. 239)• ImageTestsConfiguration (p. 242)• ImageVersion (p. 243)• InfrastructureConfiguration (p. 246)• InfrastructureConfigurationSummary (p. 249)• InstanceBlockDeviceMapping (p. 251)• InstanceConfiguration (p. 252)



• InstanceMetadataOptions (p. 253)• LaunchPermissionConfiguration (p. 254)• LaunchTemplateConfiguration (p. 256)• Logging (p. 257)• OutputResources (p. 258)• S3ExportConfiguration (p. 259)• S3Logs (p. 261)• Schedule (p. 262)• SystemsManagerAgent (p. 264)• TargetContainerRepository (p. 265)


EC2 Image Builder API ReferenceAdditionalInstanceConfiguration

AdditionalInstanceConfigurationIn addition to your infrastructure configuration, these settings provide an extra layer of control over yourbuild instances. You can also specify commands to run on launch for all of your build instances.

Image Builder does not automatically install the Systems Manager agent on Windows instances. If yourbase image includes the Systems Manager agent, then the AMI that you create will also include theagent. For Linux instances, if the base image does not already include the Systems Manager agent, ImageBuilder installs it. For Linux instances where Image Builder installs the Systems Manager agent, you canchoose whether to keep it for the AMI that you create.

ContentssystemsManagerAgent

Contains settings for the Systems Manager agent on your build instance.

Type: SystemsManagerAgent (p. 264) object

Required: NouserDataOverride

Use this property to provide commands or a command script to run when you launch your buildinstance.

The userDataOverride property replaces any commands that Image Builder might have added toensure that Systems Manager is installed on your Linux build instance. If you override the user data,make sure that you add commands to install Systems Manager, if it is not pre-installed on your baseimage.

NoteThe user data is always base 64 encoded. For example, the following commands areencoded as IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$:#!/bin/bashmkdir -p /var/bb/touch /var

Type: String


Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

Required: No


• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/AdditionalInstanceConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/AdditionalInstanceConfiguration

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/AdditionalInstanceConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/AdditionalInstanceConfiguration

EC2 Image Builder API ReferenceAmi

AmiDetails of an Amazon EC2 AMI.

ContentsaccountId

The account ID of the owner of the AMI.

Type: String


Required: Nodescription

The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.

Type: String


Required: Noimage

The AMI ID of the Amazon EC2 AMI.

Type: String


Required: Noname

The name of the Amazon EC2 AMI.

Type: String


Required: Noregion

The AWS Region of the Amazon EC2 AMI.

Type: String


Required: Nostate

Image state shows the image status and the reason for that status.

Type: ImageState (p. 238) object

Required: No






https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/Ami

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/Ami

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/Ami

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/Ami

EC2 Image Builder API ReferenceAmiDistributionConfiguration

AmiDistributionConfigurationDefine and configure the output AMIs of the pipeline.

ContentsamiTags

The tags to apply to AMIs distributed to this Region.







The description of the AMI distribution configuration. Minimum and maximum length are incharacters.

Type: String


Required: NokmsKeyId

The KMS key identifier used to encrypt the distributed image.

Type: String


Required: NolaunchPermission

Launch permissions can be used to configure which AWS accounts can use the AMI to launchinstances.

Type: LaunchPermissionConfiguration (p. 254) object

Required: Noname

The name of the output AMI.

Type: String


Pattern: ^[-_A-Za-z0-9{][-_A-Za-z0-9\s:{}\.]+[-_A-Za-z0-9}]$

Required: No



targetAccountIds

The ID of an account to which you want to distribute an image.



Pattern: ^[0-9]{12}$

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/AmiDistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/AmiDistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/AmiDistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/AmiDistributionConfiguration

EC2 Image Builder API ReferenceComponent

ComponentA detailed view of a component.

Contentsarn

The Amazon Resource Name (ARN) of the component.

Type: String


Required: NochangeDescription

The change description of the component.

Type: String


Required: Nodata

Component data contains the YAML document content for the component.

Type: String

Required: NodateCreated

The date that the component was created.

Type: String


The description of the component.

Type: String


Required: Noencrypted

The encryption status of the component.

Type: Boolean

Required: No


EC2 Image Builder API ReferenceContents

kmsKeyId

The KMS key identifier used to encrypt the component.

Type: String


Required: Noname


Type: String


Required: Noowner

The owner of the component.

Type: String


Required: Noparameters

Contains parameter details for each of the parameters that are defined for the component.

Type: Array of ComponentParameterDetail (p. 195) objects

Required: Noplatform


Type: String


Required: Nostate

Describes the current status of the component. This is used for components that are no longeractive.

Type: ComponentState (p. 197) object

Required: NosupportedOsVersions







Required: Notags

The tags associated with the component.






Required: Notype

The type of the component denotes whether the component is used to build the image or only totest it.

Type: String


Required: Noversion

The version of the component.

Type: String

Pattern: ^[0-9]+\.[0-9]+\.[0-9]+$

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/Component

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/Component

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/Component

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/Component

EC2 Image Builder API ReferenceComponentConfiguration

ComponentConfigurationConfiguration details of the component.

ContentscomponentArn


Type: String

Pattern: ârn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):component/[a-z0-9-_]+/(?:(?:([0-9]+|x)\.([0-9]+|x)\.([0-9]+|x))|(?:[0-9]+\.[0-9]+\.[0-9]+/[0-9]+))$

Required: Yesparameters

A group of parameter settings that are used to configure the component for a specific recipe.

Type: Array of ComponentParameter (p. 194) objects


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ComponentConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ComponentConfiguration

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ComponentConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ComponentConfiguration

EC2 Image Builder API ReferenceComponentParameter

ComponentParameterContains a key/value pair that sets the named component parameter.

Contentsname

The name of the component parameter to set.

Type: String


Pattern: [^\x00]+

Required: Yesvalue

Sets the value for the named component parameter.



Pattern: [^\x00]*

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ComponentParameter

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ComponentParameter

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ComponentParameter

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ComponentParameter

EC2 Image Builder API ReferenceComponentParameterDetail

ComponentParameterDetailDefines a parameter that is used to provide configuration details for the component.

ContentsdefaultValue

The default value of this parameter if no input is provided.



Pattern: [^\x00]*


Describes this parameter.

Type: String


Pattern: [^\x00]+

Required: Noname

The name of this input parameter.

Type: String


Pattern: [^\x00]+

Required: Yestype

The type of input this parameter provides. The currently supported value is "string".

Type: String


Pattern: ^String|Integer|Boolean|StringList$

Required: Yes


• AWS SDK for C++• AWS SDK for Go


https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ComponentParameterDetail

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ComponentParameterDetail


• AWS SDK for Java V2• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ComponentParameterDetail

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ComponentParameterDetail

EC2 Image Builder API ReferenceComponentState

ComponentStateA group of fields that describe the current status of components that are no longer active.

Contentsreason

Describes how or why the component changed state.

Type: String


Required: Nostatus

The current state of the component.

Type: String

Valid Values: DEPRECATED

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ComponentState

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ComponentState

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ComponentState

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ComponentState

EC2 Image Builder API ReferenceComponentSummary

ComponentSummaryA high-level summary of a component.

Contentsarn


Type: String


Required: NochangeDescription

The change description of the component.

Type: String




Type: String



Type: String


Required: Noname


Type: String


Required: Noowner


Type: String






Type: String


Required: Nostate

Describes the current status of the component.

Type: ComponentState (p. 197) object






Required: Notags

The tags associated with the component.






Required: Notype


Type: String


Required: Noversion

The version of the component.

Type: String



Pattern: ^[0-9]+\.[0-9]+\.[0-9]+$

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ComponentSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ComponentSummary

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ComponentSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ComponentSummary

EC2 Image Builder API ReferenceComponentVersion

ComponentVersionThe defining characteristics of a specific version of an AWSTOE component.

Contentsarn


NoteSemantic versioning is included in each object's Amazon Resource Name (ARN), at the levelthat applies to that object as follows:1. Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The

nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>3. Build version ARNs have all four nodes, and point to a specific build for a specific version

of an object.

Type: String




Type: String



Type: String


Required: Noname


Type: String


Required: Noowner


Type: String






Type: String



he operating system (OS) version supported by the component. If the OS information is available, aprefix match is performed against the base image OS version during image recipe creation.




Required: Notype


Type: String


Required: Noversion

The semantic version of the component.

NoteThe semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assignvalues for the first three, and can filter on all of them.Assignment: For the first three nodes you can assign any positive integer value, includingzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builderautomatically assigns the build number to the fourth node.Patterns: You can use any numeric pattern that adheres to the assignment requirements forthe nodes that you can assign. For example, you might choose a software version pattern,such as 1.0.0, or a date, such as 2021.01.01.Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specifythe most recent versions or nodes when selecting the base image or components for yourrecipe. When you use a wildcard in any node, all nodes to the right of the first wildcard mustalso be wildcards.

Type: String

Pattern: ^[0-9]+\.[0-9]+\.[0-9]+$

Required: No






https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ComponentVersion

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ComponentVersion

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ComponentVersion

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ComponentVersion

EC2 Image Builder API ReferenceContainer

ContainerA container encapsulates the runtime environment for an application.

ContentsimageUris

A list of URIs for containers created in the context Region.



Required: Noregion

Containers and container images are Region-specific. This is the Region context for the container.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/Container

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/Container

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/Container

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/Container

EC2 Image Builder API ReferenceContainerDistributionConfiguration

ContainerDistributionConfigurationContainer distribution settings for encryption, licensing, and sharing in a specific Region.

ContentscontainerTags

Tags that are attached to the container distribution configuration.




The description of the container distribution configuration.

Type: String


Required: NotargetRepository

The destination repository for the container distribution configuration.


Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ContainerDistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ContainerDistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ContainerDistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ContainerDistributionConfiguration

EC2 Image Builder API ReferenceContainerRecipe

ContainerRecipeA container recipe.

Contentsarn

The Amazon Resource Name (ARN) of the container recipe.



of an object.

Type: String


Required: Nocomponents

Build and test components that are included in the container recipe. Recipes require a minimumof one build component, and can have a maximum of 20 build and test components in anycombination.



Required: NocontainerType

Specifies the type of container, such as Docker.

Type: String



The date when this container recipe was created.

Type: String


The description of the container recipe.



Type: String


Required: NodockerfileTemplateData

Dockerfiles are text documents that are used to build Docker containers, and ensure that theycontain all of the elements required by the application running inside. The template data consistsof contextual variables where Image Builder places build information or scripts, based on yourcontainer image recipe.

Type: String


A flag that indicates if the target container is encrypted.

Type: Boolean

Required: NoinstanceConfiguration

A group of options that can be used to configure an instance for building and testing containerimages.

Type: InstanceConfiguration (p. 252) object


Identifies which KMS key is used to encrypt the container image for distribution to the target Region.

Type: String


Required: Noname


Type: String


Required: Noowner

The owner of the container recipe.

Type: String


Required: NoparentImage




Type: String



The system platform for the container, such as Windows or Linux.

Type: String


Required: Notags







Required: NotargetRepository

The destination repository for the container image.


Required: Noversion

The semantic version of the container recipe.


Type: String

Pattern: ^[0-9]+\.[0-9]+\.[0-9]+$

Required: No



workingDirectory

The working directory for use during build and test workflows.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ContainerRecipe

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ContainerRecipe

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ContainerRecipe

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ContainerRecipe

EC2 Image Builder API ReferenceContainerRecipeSummary

ContainerRecipeSummaryA summary of a container recipe

Contentsarn

The Amazon Resource Name (ARN) of the container recipe.

Type: String


Required: NocontainerType

Specifies the type of container, such as "Docker".

Type: String



The date when this container recipe was created.

Type: String

Required: Noname


Type: String


Required: Noowner

The owner of the container recipe.

Type: String




Type: String





The system platform for the container, such as Windows or Linux.

Type: String


Required: Notags







Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ContainerRecipeSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ContainerRecipeSummary

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ContainerRecipeSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ContainerRecipeSummary

EC2 Image Builder API ReferenceDistribution

DistributionDefines the settings for a specific Region.

ContentsamiDistributionConfiguration

The specific AMI settings; for example, launch permissions or AMI tags.

Type: AmiDistributionConfiguration (p. 188) object

Required: NocontainerDistributionConfiguration

Container distribution settings for encryption, licensing, and sharing in a specific Region.

Type: ContainerDistributionConfiguration (p. 205) object

Required: NofastLaunchConfigurations

The Windows faster-launching configurations to use for AMI distribution.

Type: Array of FastLaunchConfiguration (p. 220) objects


Required: NolaunchTemplateConfigurations

A group of launchTemplateConfiguration settings that apply to image distribution for specifiedaccounts.

Type: Array of LaunchTemplateConfiguration (p. 256) objects


Required: NolicenseConfigurationArns

The License Manager Configuration to associate with the AMI in the specified Region.



Pattern: ârn:aws[^:]*:license-manager:[^:]+:[0-9]{12}:license-configuration:lic-[a-z0-9-_]{32}$

Required: Noregion

The target Region.

Type: String




Required: Yess3ExportConfiguration

Configure export settings to deliver disk images created from your image build, using a file formatthat is compatible with your VMs in that Region.

Type: S3ExportConfiguration (p. 259) object

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/Distribution

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/Distribution

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/Distribution

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/Distribution

EC2 Image Builder API ReferenceDistributionConfiguration

DistributionConfigurationA distribution configuration.

Contentsarn

The Amazon Resource Name (ARN) of the distribution configuration.

Type: String



The date on which this distribution configuration was created.

Type: String

Required: NodateUpdated

The date on which this distribution configuration was last updated.

Type: String



Type: String


Required: Nodistributions

The distribution objects that apply Region-specific settings for the deployment of the image totargeted Regions.


Required: Noname


Type: String


Required: No



tags

The tags of the distribution configuration.






Required: NotimeoutMinutes

The maximum duration in minutes for this distribution configuration.

Type: Integer


Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/DistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/DistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/DistributionConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/DistributionConfiguration

EC2 Image Builder API ReferenceDistributionConfigurationSummary

DistributionConfigurationSummaryA high-level overview of a distribution configuration.

Contentsarn

The Amazon Resource Name (ARN) of the distribution configuration.

Type: String



The date on which the distribution configuration was created.

Type: String


The date on which the distribution configuration was updated.

Type: String



Type: String


Required: Noname


Type: String


Required: Noregions

A list of Regions where the container image is distributed to.





Required: Notags

The tags associated with the distribution configuration.






Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/DistributionConfigurationSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/DistributionConfigurationSummary

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/DistributionConfigurationSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/DistributionConfigurationSummary

EC2 Image Builder API ReferenceEbsInstanceBlockDeviceSpecification

EbsInstanceBlockDeviceSpecificationAmazon EBS-specific block device mapping specifications.

ContentsdeleteOnTermination

Use to configure delete on termination of the associated device.

Type: Boolean


Use to configure device encryption.

Type: Boolean

Required: Noiops

Use to configure device IOPS.

Type: Integer



Use to configure the KMS key to use when encrypting the device.

Type: String


Required: NosnapshotId

The snapshot that defines the device contents.

Type: String


Required: Nothroughput

For GP3 volumes only – The throughput in MiB/s that the volume supports.

Type: Integer


Required: NovolumeSize

Use to override the device's volume size.



Type: Integer


Required: NovolumeType

Use to override the device's volume type.

Type: String

Valid Values: standard | io1 | io2 | gp2 | gp3 | sc1 | st1

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/EbsInstanceBlockDeviceSpecification

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/EbsInstanceBlockDeviceSpecification

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/EbsInstanceBlockDeviceSpecification

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/EbsInstanceBlockDeviceSpecification

EC2 Image Builder API ReferenceFastLaunchConfiguration

FastLaunchConfigurationDefine and configure faster launching for output Windows AMIs.

ContentsaccountId

The owner account ID for the fast-launch enabled Windows AMI.

Type: String

Pattern: ^[0-9]{12}$

Required: Noenabled

A Boolean that represents the current state of faster launching for the Windows AMI. Set to true tostart using Windows faster launching, or false to stop using it.

Type: Boolean

Required: YeslaunchTemplate

The launch template that the fast-launch enabled Windows AMI uses when it launches Windowsinstances to create pre-provisioned snapshots.

Type: FastLaunchLaunchTemplateSpecification (p. 222) object

Required: NomaxParallelLaunches

The maximum number of parallel instances that are launched for creating resources.

Type: Integer


Required: NosnapshotConfiguration

Configuration settings for managing the number of snapshots that are created from pre-provisionedinstances for the Windows AMI when faster launching is enabled.

Type: FastLaunchSnapshotConfiguration (p. 223) object

Required: No


• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2


https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/FastLaunchConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/FastLaunchConfiguration

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/FastLaunchConfiguration


• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/FastLaunchConfiguration

EC2 Image Builder API ReferenceFastLaunchLaunchTemplateSpecification

FastLaunchLaunchTemplateSpecificationIdentifies the launch template that the associated Windows AMI uses for launching an instance whenfaster launching is enabled.

NoteYou can specify either the launchTemplateName or the launchTemplateId, but not both.

ContentslaunchTemplateId

The ID of the launch template to use for faster launching for a Windows AMI.

Type: String

Pattern: ^lt-[a-z0-9-_]{17}$

Required: NolaunchTemplateName

The name of the launch template to use for faster launching for a Windows AMI.

Type: String


Required: NolaunchTemplateVersion

The version of the launch template to use for faster launching for a Windows AMI.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/FastLaunchLaunchTemplateSpecification

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/FastLaunchLaunchTemplateSpecification

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/FastLaunchLaunchTemplateSpecification

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/FastLaunchLaunchTemplateSpecification

EC2 Image Builder API ReferenceFastLaunchSnapshotConfiguration

FastLaunchSnapshotConfigurationConfiguration settings for creating and managing pre-provisioned snapshots for a fast-launch enabledWindows AMI.

ContentstargetResourceCount

The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.

Type: Integer


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/FastLaunchSnapshotConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/FastLaunchSnapshotConfiguration

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/FastLaunchSnapshotConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/FastLaunchSnapshotConfiguration

EC2 Image Builder API ReferenceFilter

FilterA 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.

Contentsname

The name of the filter. Filter names are case-sensitive.

Type: String

Pattern: ^[a-zA-Z]{1,1024}$

Required: Novalues

The filter values. Filter values are case-sensitive.



Pattern: ^[0-9a-zA-Z./_ :-]{1,1024}$

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/Filter

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/Filter

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/Filter

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/Filter

EC2 Image Builder API ReferenceImage

ImageAn Image Builder image. You must specify exactly one recipe for the image – either a container recipe(containerRecipe), which creates a container image, or an image recipe (imageRecipe), whichcreates an AMI.

Contentsarn

The Amazon Resource Name (ARN) of the image.



of an object.

Type: String


Required: NobuildType

Indicates the type of build that created this image. The build can be initiated in the following ways:• USER_INITIATED – A manual pipeline build request.• SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from

EventBridge.• IMPORT – A VM import created the image to use as the base image for the recipe.

Type: String

Valid Values: USER_INITIATED | SCHEDULED | IMPORT

Required: NocontainerRecipe

The recipe that is used to create an Image Builder container image.

Type: ContainerRecipe (p. 206) object


The date on which this image was created.

Type: String

Required: No



distributionConfiguration

The distribution configuration used when creating this image.

Type: DistributionConfiguration (p. 214) object

Required: NoenhancedImageMetadataEnabled


Type: Boolean

Required: NoimageRecipe

The image recipe used when creating the image.

Type: ImageRecipe (p. 233) object

Required: NoimageTestsConfiguration

The image tests configuration used when creating this image.


Required: NoinfrastructureConfiguration

The infrastructure used when creating this image.

Type: InfrastructureConfiguration (p. 246) object

Required: Noname

The name of the image.

Type: String


Required: NoosVersion

The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or MicrosoftWindows Server 2019.

Type: String


Required: NooutputResources

The output resources produced when creating this image.



Type: OutputResources (p. 258) object


The platform of the image.

Type: String


Required: NosourcePipelineArn

The Amazon Resource Name (ARN) of the image pipeline that created this image.

Type: String

Required: NosourcePipelineName

The name of the image pipeline that created this image.

Type: String


Required: Nostate

The state of the image.


Required: Notags







Required: Notype

Specifies whether this is an AMI or container image.

Type: String

Valid Values: AMI | DOCKER

Required: No



version

The semantic version of the image.


Type: String

Pattern: ^[0-9]+\.[0-9]+\.[0-9]+$

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/Image

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/Image

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/Image

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/Image

EC2 Image Builder API ReferenceImagePackage

ImagePackageRepresents a package installed on an Image Builder image.

ContentspackageName

The name of the package as reported to the operating system package manager.

Type: String


Required: NopackageVersion

The version of the package as reported to the operating system package manager.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ImagePackage

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ImagePackage

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ImagePackage

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ImagePackage

EC2 Image Builder API ReferenceImagePipeline

ImagePipelineDetails of an image pipeline.

Contentsarn

The Amazon Resource Name (ARN) of the image pipeline.

Type: String


Required: NocontainerRecipeArn

The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.

Type: String


The date on which this image pipeline was created.

Type: String

Required: NodateLastRun

This is no longer supported, and does not return a value.

Type: String

Required: NodateNextRun

This is no longer supported, and does not return a value.

Type: String


The date on which this image pipeline was last updated.

Type: String



Type: String




Required: NodistributionConfigurationArn

The Amazon Resource Name (ARN) of the distribution configuration associated with this imagepipeline.

Type: String

Required: NoenhancedImageMetadataEnabled


Type: Boolean

Required: NoimageRecipeArn

The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.

Type: String

Required: NoimageTestsConfiguration

The image tests configuration of the image pipeline.


Required: NoinfrastructureConfigurationArn

The Amazon Resource Name (ARN) of the infrastructure configuration associated with this imagepipeline.

Type: String

Required: Noname

The name of the image pipeline.

Type: String



The platform of the image pipeline.

Type: String


Required: No



schedule



Required: Nostatus


Type: String


Required: Notags

The tags of this image pipeline.






Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ImagePipeline

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ImagePipeline

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ImagePipeline

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ImagePipeline

EC2 Image Builder API ReferenceImageRecipe

ImageRecipeAn image recipe.

ContentsadditionalInstanceConfiguration

Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build andtest 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.

Type: AdditionalInstanceConfiguration (p. 185) object

Required: Noarn

The Amazon Resource Name (ARN) of the image recipe.

Type: String


Required: NoblockDeviceMappings

The block device mappings to apply when creating images from this recipe.


Required: Nocomponents

The components that are included in the image recipe. Recipes require a minimum of one buildcomponent, and can have a maximum of 20 build and test components in any combination.




The date on which this image recipe was created.

Type: String


The description of the image recipe.

Type: String




Required: Noname


Type: String


Required: Noowner

The owner of the image recipe.

Type: String



The base image of the image recipe.

Type: String



The platform of the image recipe.

Type: String


Required: Notags







Required: Notype

Specifies which type of image is created by the recipe - an AMI or a container image.

Type: String


Required: No



version

The version of the image recipe.

Type: String

Pattern: ^[0-9]+\.[0-9]+\.[0-9]+$

Required: NoworkingDirectory

The working directory to be used during build and test workflows.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ImageRecipe

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ImageRecipe

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ImageRecipe

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ImageRecipe

EC2 Image Builder API ReferenceImageRecipeSummary

ImageRecipeSummaryA summary of an image recipe.

Contentsarn

The Amazon Resource Name (ARN) of the image recipe.

Type: String



The date on which this image recipe was created.

Type: String

Required: Noname


Type: String


Required: Noowner

The owner of the image recipe.

Type: String



The base image of the image recipe.

Type: String



The platform of the image recipe.

Type: String




Required: Notags







Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ImageRecipeSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ImageRecipeSummary

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ImageRecipeSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ImageRecipeSummary

EC2 Image Builder API ReferenceImageState

ImageStateImage state shows the image status and the reason for that status.

Contentsreason

The reason for the image's status.

Type: String


Required: Nostatus

The status of the image.

Type: String

Valid Values: PENDING | CREATING | BUILDING | TESTING | DISTRIBUTING |INTEGRATING | AVAILABLE | CANCELLED | FAILED | DEPRECATED | DELETED

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ImageState

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ImageState

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ImageState

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ImageState

EC2 Image Builder API ReferenceImageSummary

ImageSummaryAn image summary.

Contentsarn

The Amazon Resource Name (ARN) of the image.

Type: String





Type: String



The date on which this image was created.

Type: String

Required: Noname

The name of the image.

Type: String


Required: NoosVersion

The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or MicrosoftWindows Server 2019.

Type: String


Required: No



outputResources

The output resources produced when creating this image.

Type: OutputResources (p. 258) object

Required: Noowner

The owner of the image.

Type: String



The platform of the image.

Type: String


Required: Nostate

The state of the image.


Required: Notags







Required: Notype

Specifies whether this is an AMI or container image.

Type: String


Required: Noversion

The version of the image.

Type: String



Pattern: ^[0-9]+\.[0-9]+\.[0-9]+$

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ImageSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ImageSummary

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ImageSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ImageSummary

EC2 Image Builder API ReferenceImageTestsConfiguration

ImageTestsConfigurationConfigure image tests for your pipeline build. Tests run after building the image, to verify that the AMI orcontainer image is valid before distributing it.

ContentsimageTestsEnabled

Determines if tests should run after building the image. Image Builder defaults to enable tests to runfollowing the image build, before image distribution.

Type: Boolean

Required: NotimeoutMinutes

The maximum time in minutes that tests are permitted to run.

Type: Integer


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ImageTestsConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ImageTestsConfiguration

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ImageTestsConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ImageTestsConfiguration

EC2 Image Builder API ReferenceImageVersion

ImageVersionThe defining characteristics of a specific version of an Image Builder image.

Contentsarn

The Amazon Resource Name (ARN) of a specific version of an Image Builder image.



of an object.

Type: String





Type: String



The date on which this specific version of the Image Builder image was created.

Type: String

Required: Noname

The name of this specific version of an Image Builder image.

Type: String


Required: No



osVersion

The operating system version of the Amazon EC2 build instance. For example, Amazon Linux 2,Ubuntu 18, or Microsoft Windows Server 2019.

Type: String


Required: Noowner

The owner of the image version.

Type: String



The platform of the image version, for example "Windows" or "Linux".

Type: String


Required: Notype

Specifies whether this image is an AMI or a container image.

Type: String


Required: Noversion

Details for a specific version of an Image Builder image. This version follows the semantic versionsyntax.


Type: String

Pattern: ^[0-9]+\.[0-9]+\.[0-9]+$

Required: No






https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/ImageVersion

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/ImageVersion

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/ImageVersion

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/ImageVersion

EC2 Image Builder API ReferenceInfrastructureConfiguration

InfrastructureConfigurationDetails of the infrastructure configuration.

Contentsarn

The Amazon Resource Name (ARN) of the infrastructure configuration.

Type: String



The date on which the infrastructure configuration was created.

Type: String


The date on which the infrastructure configuration was last updated.

Type: String



Type: String


Required: NoinstanceMetadataOptions

The instance metadata option settings for the infrastructure configuration.


Required: NoinstanceProfileName

The instance profile of the infrastructure configuration.

Type: String


Pattern: ^[\w+=,.@-]+$

Required: No



instanceTypes

The instance types of the infrastructure configuration.


Required: NokeyPair

The Amazon EC2 key pair of the infrastructure configuration.

Type: String


Required: Nologging



Required: Noname


Type: String


Required: NoresourceTags







Required: NosecurityGroupIds

The security group IDs of the infrastructure configuration.



Required: NosnsTopicArn





Type: String


Required: NosubnetId

The subnet ID of the infrastructure configuration.

Type: String


Required: Notags







Required: NoterminateInstanceOnFailure

The terminate instance on failure configuration of the infrastructure configuration.

Type: Boolean

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/InfrastructureConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/InfrastructureConfiguration

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/InfrastructureConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/InfrastructureConfiguration

EC2 Image Builder API ReferenceInfrastructureConfigurationSummary

InfrastructureConfigurationSummaryThe infrastructure used when building Amazon EC2 AMIs.

Contentsarn

The Amazon Resource Name (ARN) of the infrastructure configuration.

Type: String



The date on which the infrastructure configuration was created.

Type: String


The date on which the infrastructure configuration was last updated.

Type: String



Type: String


Required: NoinstanceProfileName

The instance profile of the infrastructure configuration.

Type: String


Pattern: ^[\w+=,.@-]+$

Required: NoinstanceTypes

The instance types of the infrastructure configuration.




Required: Noname


Type: String


Required: NoresourceTags

The tags attached to the image created by Image Builder.






Required: Notags







Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/InfrastructureConfigurationSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/InfrastructureConfigurationSummary

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/InfrastructureConfigurationSummary

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/InfrastructureConfigurationSummary

EC2 Image Builder API ReferenceInstanceBlockDeviceMapping

InstanceBlockDeviceMappingDefines block device mappings for the instance used to configure your image.

ContentsdeviceName

The device to which these mappings apply.

Type: String


Required: Noebs

Use to manage Amazon EBS-specific configuration for this mapping.

Type: EbsInstanceBlockDeviceSpecification (p. 218) object

Required: NonoDevice

Use to remove a mapping from the base image.

Type: String

Length Constraints: Fixed length of 0.

Required: NovirtualName

Use to manage instance ephemeral devices.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/InstanceBlockDeviceMapping

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/InstanceBlockDeviceMapping

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/InstanceBlockDeviceMapping

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/InstanceBlockDeviceMapping

EC2 Image Builder API ReferenceInstanceConfiguration

InstanceConfigurationDefines a custom base AMI and block device mapping configurations of an instance used for building andtesting container images.

ContentsblockDeviceMappings

Defines the block devices to attach for building an instance from this Image Builder AMI.


Required: Noimage

The AMI ID to use as the base image for a container build and test instance. If not specified, ImageBuilder will use the appropriate ECS-optimized AMI as a base image.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/InstanceConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/InstanceConfiguration

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/InstanceConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/InstanceConfiguration

EC2 Image Builder API ReferenceInstanceMetadataOptions

InstanceMetadataOptionsThe instance metadata options that apply to the HTTP requests that pipeline builds use to launch EC2build and test instances. For more information about instance metadata options, see Configure theinstance metadata options in the Amazon EC2 User Guide for Linux instances, or Configure the instancemetadata options in the Amazon EC2 Windows Guide for Windows instances.

ContentshttpPutResponseHopLimit

Limit the number of hops that an instance metadata request can traverse to reach its destination.The default is one hop. However, if HTTP tokens are required, container image builds need aminimum of two hops.

Type: Integer


Required: NohttpTokens

Indicates whether a signed token header is required for instance metadata retrieval requests. Thevalues affect the response as follows:• required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all

cases.• optional – You can include a signed token header in your request to retrieve instance metadata,

or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role.Otherwise, version 1.0 credentials are returned.

The default setting is optional.

Type: String

Pattern: optional|required

Required: No








https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/InstanceMetadataOptions

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/InstanceMetadataOptions

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/InstanceMetadataOptions

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/InstanceMetadataOptions

EC2 Image Builder API ReferenceLaunchPermissionConfiguration

LaunchPermissionConfigurationDescribes the configuration for a launch permission. The launch permission modification request is sentto the Amazon EC2 ModifyImageAttribute API on behalf of the user for each Region they have selectedto distribute the AMI. To make an AMI public, set the launch permission authorized accounts to all. Seethe examples for making an AMI public at Amazon EC2 ModifyImageAttribute.

ContentsorganizationalUnitArns

The ARN for an AWS Organizations organizational unit (OU) that you want to share your AMIwith. For more information about key concepts for AWS Organizations, see AWS Organizationsterminology and concepts.



Pattern: ârn:aws[^:]*:organizations::[0-9]{12}:ou/o-[a-z0-9]{10,32}/ou-[0-9a-z]{4,32}-[0-9a-z]{8,32}

Required: No

organizationArns

The ARN for an AWS Organization that you want to share your AMI with. For more information, seeWhat is AWS Organizations?.



Pattern: ârn:aws[^:]*:organizations::[0-9]{12}:organization/o-[a-z0-9]{10,32}$

Required: No

userGroups

The name of the group.



Required: No

userIds

The AWS account ID.



Pattern: ^[0-9]{12}$

Required: No


https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html

https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html

https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html

https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html

https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html





https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/LaunchPermissionConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/LaunchPermissionConfiguration

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/LaunchPermissionConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/LaunchPermissionConfiguration

EC2 Image Builder API ReferenceLaunchTemplateConfiguration

LaunchTemplateConfigurationIdentifies an Amazon EC2 launch template to use for a specific account.

ContentsaccountId

The account ID that this configuration applies to.

Type: String

Pattern: ^[0-9]{12}$

Required: NolaunchTemplateId

Identifies the Amazon EC2 launch template to use.

Type: String

Pattern: ^lt-[a-z0-9-_]{17}$

Required: YessetDefaultVersion

Set the specified Amazon EC2 launch template as the default launch template for the specifiedaccount.

Type: Boolean

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/LaunchTemplateConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/LaunchTemplateConfiguration

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/LaunchTemplateConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/LaunchTemplateConfiguration

EC2 Image Builder API ReferenceLogging

LoggingLogging configuration defines where Image Builder uploads your logs.

Contentss3Logs

The Amazon S3 logging configuration.

Type: S3Logs (p. 261) object

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/Logging

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/Logging

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/Logging

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/Logging

EC2 Image Builder API ReferenceOutputResources

OutputResourcesThe resources produced by this image.

Contentsamis

The Amazon EC2 AMIs created by this image.

Type: Array of Ami (p. 186) objects

Required: Nocontainers

Container images that the pipeline has generated and stored in the output repository.

Type: Array of Container (p. 204) objects

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/OutputResources

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/OutputResources

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/OutputResources

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/OutputResources

EC2 Image Builder API ReferenceS3ExportConfiguration

S3ExportConfigurationProperties that configure export from your build instance to a compatible file format for your VM.

ContentsdiskImageFormat

Export the updated image to one of the following supported disk image formats:• Virtual Hard Disk (VHD) – Compatible with Citrix Xen and Microsoft Hyper-V virtualization

products.• Stream-optimized ESX Virtual Machine Disk (VMDK) – Compatible with VMware ESX and

VMware vSphere versions 4, 5, and 6.• Raw – Raw format.

Type: String

Valid Values: VMDK | RAW | VHD

Required: YesroleName

The name of the role that grants VM Import/Export permission to export images to your S3 bucket.

Type: String


Required: Yess3Bucket

The S3 bucket in which to store the output disk images for your VM.

Type: String


Required: Yess3Prefix

The Amazon S3 path for the bucket where the output disk images for your VM are stored.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/S3ExportConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/S3ExportConfiguration

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/S3ExportConfiguration




https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/S3ExportConfiguration

EC2 Image Builder API ReferenceS3Logs

S3LogsAmazon S3 logging configuration.

Contentss3BucketName

The S3 bucket in which to store the logs.

Type: String


Required: Nos3KeyPrefix

The Amazon S3 path to the bucket where the logs are stored.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/S3Logs

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/S3Logs

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/S3Logs

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/S3Logs

EC2 Image Builder API ReferenceSchedule

ScheduleA schedule configures how often and when a pipeline will automatically create a new image.

ContentspipelineExecutionStartCondition

The condition configures when the pipeline should trigger a new imagebuild. When the pipelineExecutionStartCondition is set toEXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic versionfilters on the base image or components in your image recipe, EC2 Image Builder will build anew image only when there are new versions of the image or components in your recipe thatmatch the semantic version filter. When it is set to EXPRESSION_MATCH_ONLY, it will build a newimage every time the CRON expression matches the current time. For semantic version syntax, seeCreateComponent in the EC2 Image Builder API Reference.

Type: String

Valid Values: EXPRESSION_MATCH_ONLY |EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE

Required: NoscheduleExpression

The cron expression determines how often EC2 Image Builder evaluates yourpipelineExecutionStartCondition.

For information on how to format a cron expression in Image Builder, see Use cron expressions inEC2 Image Builder.

Type: String


Required: Notimezone

The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.

Type: String


Pattern: [a-zA-Z0-9]{2,}(?:\/[a-zA-z0-9-_+]+)*

Required: No




https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html

https://docs.aws.amazon.com/imagebuilder/latest/userguide/image-builder-cron.html

https://docs.aws.amazon.com/imagebuilder/latest/userguide/image-builder-cron.html

https://www.joda.org/joda-time/timezones.html

https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/Schedule

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/Schedule

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/Schedule




https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/Schedule

EC2 Image Builder API ReferenceSystemsManagerAgent

SystemsManagerAgentContains settings for the Systems Manager agent on your build instance.

ContentsuninstallAfterBuild

Controls whether the Systems Manager agent is removed from your final build image, prior tocreating the new AMI. If this is set to true, then the agent is removed from the final image. If it's setto false, then the agent is left in, so that it is included in the new AMI. The default value is false.

Type: Boolean

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/SystemsManagerAgent

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/SystemsManagerAgent

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/SystemsManagerAgent

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/SystemsManagerAgent

EC2 Image Builder API ReferenceTargetContainerRepository

TargetContainerRepositoryThe container repository where the output container image is stored.

ContentsrepositoryName

The name of the container repository where the output container image is stored. This name isprefixed by the repository location.

Type: String


Required: Yesservice

Specifies the service in which this image was registered.

Type: String

Valid Values: ECR

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/imagebuilder-2019-12-02/TargetContainerRepository

https://docs.aws.amazon.com/goto/SdkForGoV1/imagebuilder-2019-12-02/TargetContainerRepository

https://docs.aws.amazon.com/goto/SdkForJavaV2/imagebuilder-2019-12-02/TargetContainerRepository

https://docs.aws.amazon.com/goto/SdkForRubyV3/imagebuilder-2019-12-02/TargetContainerRepository


Common ParametersThe following list contains the parameters that all actions use for signing Signature Version 4 requestswith a query string. Any action-specific parameters are listed in the topic for that action. For moreinformation about Signature Version 4, see Signature Version 4 Signing Process in the Amazon WebServices General Reference.

Action

The action to be performed.

Type: string

Required: YesVersion

The API version that the request is written for, expressed in the format YYYY-MM-DD.

Type: string

Required: YesX-Amz-Algorithm

The hash algorithm that you used to create the request signature.

Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.

Type: string

Valid Values: AWS4-HMAC-SHA256

Required: ConditionalX-Amz-Credential

The credential scope value, which is a string that includes your access key, the date, the region youare targeting, the service you are requesting, and a termination string ("aws4_request"). The value isexpressed in the following format: access_key/YYYYMMDD/region/service/aws4_request.

For more information, see Task 2: Create a String to Sign for Signature Version 4 in the Amazon WebServices General Reference.


Type: string

Required: ConditionalX-Amz-Date

The date that is used to create the signature. The format must be ISO 8601 basic format(YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value:20120325T120000Z.

Condition: X-Amz-Date is optional for all requests; it can be used to override the date used forsigning requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is


http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html


not required. When X-Amz-Date is used, it always overrides the value of the Date header. Formore information, see Handling Dates in Signature Version 4 in the Amazon Web Services GeneralReference.

Type: string

Required: ConditionalX-Amz-Security-Token

The temporary security token that was obtained through a call to AWS Security Token Service (AWSSTS). For a list of services that support temporary security credentials from AWS Security TokenService, go to AWS Services That Work with IAM in the IAM User Guide.

Condition: If you're using temporary security credentials from the AWS Security Token Service, youmust include the security token.

Type: string

Required: ConditionalX-Amz-Signature

Specifies the hex-encoded signature that was calculated from the string to sign and the derivedsigning key.


Type: string

Required: ConditionalX-Amz-SignedHeaders

Specifies all the HTTP headers that were included as part of the canonical request. For moreinformation about specifying signed headers, see Task 1: Create a Canonical Request For SignatureVersion 4 in the Amazon Web Services General Reference.


Type: string

Required: Conditional


http://docs.aws.amazon.com/general/latest/gr/sigv4-date-handling.html

http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html


Common ErrorsThis section lists the errors common to the API actions of all AWS services. For errors specific to an APIaction for this service, see the topic for that API action.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400IncompleteSignature

The request signature does not conform to AWS standards.

HTTP Status Code: 400InternalFailure

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500InvalidAction

The action or operation requested is invalid. Verify that the action is typed correctly.

HTTP Status Code: 400InvalidClientTokenId

The X.509 certificate or AWS access key ID provided does not exist in our records.

HTTP Status Code: 403InvalidParameterCombination

Parameters that must not be used together were used together.

HTTP Status Code: 400InvalidParameterValue

An invalid or out-of-range value was supplied for the input parameter.

HTTP Status Code: 400InvalidQueryParameter

The AWS query string is malformed or does not adhere to AWS standards.

HTTP Status Code: 400MalformedQueryString

The query string contains a syntax error.

HTTP Status Code: 404MissingAction

The request is missing an action or a required parameter.




MissingAuthenticationToken

The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

HTTP Status Code: 403MissingParameter

A required parameter for the specified action is not supplied.

HTTP Status Code: 400NotAuthorized

You do not have permission to perform this action.

HTTP Status Code: 400OptInRequired

The AWS access key ID needs a subscription for the service.

HTTP Status Code: 403RequestExpired

The request reached the service more than 15 minutes after the date stamp on the request or morethan 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stampon the request is more than 15 minutes in the future.

HTTP Status Code: 400ServiceUnavailable

The request has failed due to a temporary failure of the server.

HTTP Status Code: 503ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400ValidationError

The input fails to satisfy the constraints specified by an AWS service.



Documents

EC2 Image Builder - docs.aws.amazon.com