Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateMicrovmImageVersion

Updates the status of a specific MicroVM image version.

Request Syntax


PATCH /2025-09-09/microvm-images/imageIdentifier/versions/imageVersion HTTP/1.1
Content-type: application/json

{
   "status": "string"
}

URI Request Parameters

The request uses the following URI parameters.

imageIdentifier

The unique identifier (ARN or ID) of the MicroVM image.

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

imageVersion

The version of the MicroVM image to update.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [^\s]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

status

The new status to set for the MicroVM image version.

Type: String

Valid Values: ACTIVE | INACTIVE

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "additionalOsCapabilities": [ "string" ],
   "baseImageArn": "string",
   "baseImageVersion": "string",
   "buildRoleArn": "string",
   "codeArtifact": { ... },
   "cpuConfigurations": [ 
      { 
         "architecture": "string"
      }
   ],
   "createdAt": number,
   "description": "string",
   "egressNetworkConnectors": [ "string" ],
   "environmentVariables": { 
      "string" : "string" 
   },
   "hooks": { 
      "microvmHooks": { 
         "resume": "string",
         "resumeTimeoutInSeconds": number,
         "run": "string",
         "runTimeoutInSeconds": number,
         "suspend": "string",
         "suspendTimeoutInSeconds": number,
         "terminate": "string",
         "terminateTimeoutInSeconds": number
      },
      "microvmImageHooks": { 
         "ready": "string",
         "readyTimeoutInSeconds": number,
         "validate": "string",
         "validateTimeoutInSeconds": number
      },
      "port": number
   },
   "imageArn": "string",
   "imageVersion": "string",
   "logging": { ... },
   "resources": [ 
      { 
         "minimumMemoryInMiB": number
      }
   ],
   "state": "string",
   "stateReason": "string",
   "status": "string",
   "tags": { 
      "string" : "string" 
   },
   "updatedAt": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

additionalOsCapabilities

Additional OS capabilities granted to the MicroVM runtime environment.

Type: Array of strings

Valid Values: ALL

baseImageArn

The ARN of the base MicroVM image used.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [^\s]+

baseImageVersion

The specific version of the base MicroVM image.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [^\s]+

buildRoleArn

The ARN of the IAM build role.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws[a-z\-]*:iam::[0-9]{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

codeArtifact

The code artifact for this version.

Type: CodeArtifact object

Note: This object is a Union. Only one member of this object can be specified or returned.

cpuConfigurations

The list of supported CPU configurations for the MicroVM.

Type: Array of CpuConfiguration objects

createdAt

The timestamp when the version was created.

Type: Timestamp

description

The description of the version.

Type: String

egressNetworkConnectors

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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 1 item.

Length Constraints: Minimum length of 1. Maximum length of 2048.

environmentVariables

Environment variables set in the MicroVM runtime environment.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 256.

Key Pattern: [^\s]+

Value Length Constraints: Minimum length of 0. Maximum length of 4096.

hooks

Lifecycle hook configuration for MicroVMs and MicroVM images.

Type: Hooks object

imageArn

The ARN of the MicroVM image.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [^\s]+

imageVersion

The version of the MicroVM image.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [^\s]+

logging

The logging configuration for this version.

Type: Logging object

Note: This object is a Union. Only one member of this object can be specified or returned.

resources

The resource requirements for the MicroVM.

Type: Array of Resources objects

Array Members: Minimum number of 0 items. Maximum number of 1 item.

state

The current state of the version.

Type: String

stateReason

The reason for the current state. For example, one or more builds failed.

Type: String

status

The availability status of the version: ACTIVE (can be used by RunMicrovm) or INACTIVE (blocked from launching new MicroVMs).

Type: String

Valid Values: ACTIVE | INACTIVE

tags

Key-value pairs associated with the version.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

updatedAt

The timestamp when the version was last updated.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The request could not be completed due to a conflict with the current state of the resource.

resourceId: The identifier of the resource that caused the conflict.
resourceType: The type of the resource that caused the conflict.

HTTP Status Code: 409

InternalServerException

An internal server error occurred. Retry the request later.

retryAfterSeconds: The number of seconds to wait before retrying the request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource does not exist.

resourceId: The identifier of the resource that was not found.
resourceType: The type of the resource that was not found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling. Retry the request later.

quotaCode: The quota code of the throttled service quota.
retryAfterSeconds: The number of seconds to wait before retrying the request.
serviceCode: The service code of the throttled service quota.

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints specified by the service.

HTTP Status Code: 400