v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1424154118.9 KB

Creates a MicroVM image from the specified code artifact and base image. The build is asynchronous — the image transitions from CREATING to CREATED on success, or CREATE_FAILED on failure. Use GetMicrovmImage to poll for completion.

post/2025-09-09/microvm-images

Request body

baseImageArnstring required

A string which is not empty or blank (only whitespace).

baseImageVersionstring

The specific version of the base MicroVM image to use.

buildRoleArnstring required

The ARN of an IAM role that the service assumes to perform actions on behalf of the caller.

descriptionstring

A description of the MicroVM image.

egressNetworkConnectorsNetworkConnector[]

The list of egress network connectors available to the MicroVM at runtime.

additionalOsCapabilitiesCapability[]

List of capabilities granted to the application when booted

environmentVariablesobject

Environment variables set in the MicroVM runtime environment.

namestring required

Name of a MicroVM image.

tagsobject

A set of key-value pairs that you can attach to the resource. Use tags to categorize resources for cost allocation, access control (ABAC), and organization.

clientTokenstring

A unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the operation returns the successful response without performing any further actions.

Response

Success

imageArnstring required

The ARN of the created MicroVM image.

namestring required

The name of the MicroVM image.

state'CREATING' | 'CREATED' | 'CREATE_FAILED' | 'UPDATING' | 'UPDATED' | 'UPDATE_FAILED' | 'DELETING' | 'DELETE_FAILED' | 'DELETED' required

The current state of the MicroVM image.

latestActiveImageVersionstring

The latest active version of the MicroVM image.

latestFailedImageVersionstring

The latest failed version of the MicroVM image, if any.

createdAtstring date-time required

The timestamp when the MicroVM image was created.

baseImageArnstring required

The ARN of the base MicroVM image.

baseImageVersionstring

The specific version of the base MicroVM image.

buildRoleArnstring required

The ARN of the IAM build role.

descriptionstring

The description of the MicroVM image.

egressNetworkConnectorsNetworkConnector[]

The list of egress network connectors available to the MicroVM at runtime.

additionalOsCapabilitiesCapability[]

Additional OS capabilities granted to the MicroVM runtime environment.

environmentVariablesobject

Environment variables set in the MicroVM runtime environment.

tagsobject

A set of key-value pairs that you can attach to the resource. Use tags to categorize resources for cost allocation, access control (ABAC), and organization.

updatedAtstring date-time

The timestamp when the MicroVM image was last updated.

imageVersionstring required

The version of the MicroVM image.