microvm image-set-status

1. Synopsis

Retire an image version (INACTIVE) or restore it (ACTIVE), and read the change back

microvm image-set-status <image> <image_version> <status> [options]

2. Parameters

Parameter	Kind	Type	Required	Default	Choices	Help
image	positional	string	yes	none	any	The image: its ARN, or its name, which is looked up in the account
image_version	positional	string	yes	none	any	The version, as image-versions lists it (a custom image’s read 1.0, 2.0, …)
status	positional	enum	yes	none	ACTIVE, INACTIVE	ACTIVE to make the version launchable, INACTIVE to have RunMicrovm refuse it
--region	flag	string	no	none	any	AWS region. Defaults to $AWS_REGION, then $AWS_DEFAULT_REGION, then us-east-1
--unlisted-region	flag	string	no	none	any	Deprecated since 1.3.0: --region takes any region name

The 3 global flags (--json, --dense, --quiet) are accepted here as on every command, and are left out of the table above for that reason; see Global flags.

3. Response

On success stdout carries one envelope whose type is microvm.image.status. Its data object carries these keys: imageArn, imageVersion, status, version.

The envelope describes the fields around data. Response types lists every type the CLI emits and which commands share each one.

4. Failures

A failure exits with one of the statuses on Exit codes and writes the error shape on The envelope: a stable code to branch on, an exitCode that matches the process status, a human-readable error, and suggestions.

Where a failure is one this project has measured on the platform, the envelope’s finding names the section of the platform notes that documents it. The exit-code table links each one.

5. Provenance

This page is generated from docs/manifest.json, the output of microvm manifest, which the CLI derives from its own argument tree. This page reads the image-set-status entry of data.commands. site/scripts/gen-reference.mjs writes it into the site’s content directory on every pnpm run sync, so an edit made here is overwritten by the next run.

To change the page, change the source. Regenerate the source with mise run manifest from the repository root; mise run manifest:check fails when the committed file no longer matches what the binary emits.