One image version as ListMicrovmImageVersions or UpdateMicrovmImageVersion reads it
back: its build state, whether RunMicrovm launches it, and what it was built with.
Properties
Section titled “Properties”additionalOsCapabilities?
Section titled “additionalOsCapabilities?”optional additionalOsCapabilities?: string[];baseImageArn
Section titled “baseImageArn”baseImageArn: string;baseImageVersion?
Section titled “baseImageVersion?”optional baseImageVersion?: string;The base version the build used, as the service spells it ("1.0" where the managed
base lists "1"). A record of the build, not a value to pass back as a pin.
buildRoleArn
Section titled “buildRoleArn”buildRoleArn: string;codeArtifactUri
Section titled “codeArtifactUri”codeArtifactUri: string;codeArtifact.uri: the artifact the version was built from.
createdAt
Section titled “createdAt”createdAt: number;Unix seconds.
description?
Section titled “description?”optional description?: string;egressNetworkConnectors?
Section titled “egressNetworkConnectors?”optional egressNetworkConnectors?: string[];environmentVariables?
Section titled “environmentVariables?”optional environmentVariables?: Record<string, string>;imageArn
Section titled “imageArn”imageArn: string;imageVersion
Section titled “imageVersion”imageVersion: string;isActive
Section titled “isActive”isActive: boolean;Whether RunMicrovm launches this version.
minimumMemoryMib?
Section titled “minimumMemoryMib?”optional minimumMemoryMib?: number;resources[0].minimumMemoryInMiB, the list’s one member: the size class the version
was built for, and the only place a built image reports it.
state: string;The version’s build state, as the service spells it.
stateReason?
Section titled “stateReason?”optional stateReason?: string;Why the version is in this state, when the service said. A failed build’s reason is on
its build (listImageBuilds), and this one is usually absent.
status
Section titled “status”status: string;"ACTIVE" (RunMicrovm launches it) or "INACTIVE" (it refuses; running VMs keep
running).
optional tags?: Record<string, string>;updatedAt?
Section titled “updatedAt?”optional updatedAt?: number;Unix seconds, when the service reported it.
Provenance
Section titled “Provenance”This page is generated from bindings/microvms-js/index.d.ts by TypeDoc 0.28.20 and typedoc-plugin-markdown 4.13.1, run from site/scripts/gen-reference.mjs on every pnpm run sync, so an edit made here is overwritten by the next run.
To change the page, change the doc comment in the binding’s Rust source, then regenerate the declarations with mise run dts. mise run dts:check fails when the committed file no longer matches the source.