Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1456338351.9 KB

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

put/CreateImageRecipe

Request body

namestring required

The name of the image recipe.

descriptionstring

The description of the image recipe.

semanticVersionstring required
<p>The semantic version of the image recipe. This version follows the semantic version syntax.</p> <note> <p>The semantic version has four nodes: &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can assign values for the first three, and can filter on all of them.</p> <p> <b>Assignment:</b> For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.</p> <p> <b>Patterns:</b> You can use any numeric pattern that adheres to the assignment requirements for the 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.</p> </note>
parentImagestring required

The base image of the image recipe. The value of the string can be the ARN of the base image or an AMI ID. The format for the ARN follows this example: <code>arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x</code>. You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.

tagsobject

The tags of the image recipe.

workingDirectorystring

The working directory used during build and test workflows.

clientTokenstring required

The idempotency token used to make this request idempotent.

Response

Success

requestIdstring

The request ID that uniquely identifies this request.

clientTokenstring

The idempotency token used to make this request idempotent.

imageRecipeArnstring

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