Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1456338351.9 KB

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

put/ImportComponent

Request body

namestring required

The name of the component.

semanticVersionstring required
<p>The semantic version of the component. 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>Filtering:</b> With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.</p> </note>
descriptionstring

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

changeDescriptionstring

The change description of the component. This description indicates the change that has been made in this version, or what makes this version different from other versions of this component.

type'BUILD' | 'TEST' required

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

format'SHELL' required

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

platform'Windows' | 'Linux' required

The platform of the component.

datastring

The data of the component. Used to specify the data inline. Either <code>data</code> or <code>uri</code> can be used to specify the data within the component.

uristring

The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service quota. Either <code>data</code> or <code>uri</code> can be used to specify the data within the component.

kmsKeyIdstring

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

tagsobject

The tags of the component.

clientTokenstring required

The idempotency token of the component.

Response

Success

requestIdstring

The request ID that uniquely identifies this request.

clientTokenstring

The idempotency token used to make this request idempotent.

componentBuildVersionArnstring

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