View a markdown version of this page

GetMicrovmImage - AWS Lambda MicroVMs

GetMicrovmImage

Retrieves the details of a MicroVM image, including its state, versions, and configuration.

Request Syntax

GET /2025-09-09/microvm-images/imageIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

imageIdentifier

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

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "createdAt": number, "imageArn": "string", "latestActiveImageVersion": "string", "latestFailedImageVersion": "string", "name": "string", "state": "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.

createdAt

The timestamp when the MicroVM image was created.

Type: Timestamp

imageArn

The ARN of the MicroVM image.

Type: String

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

Pattern: [^\s]+

latestActiveImageVersion

The latest active version of the MicroVM image.

Type: String

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

Pattern: [^\s]+

latestFailedImageVersion

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

Type: String

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

Pattern: [^\s]+

name

The name of the MicroVM image.

Type: String

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

Pattern: [a-zA-Z0-9-_]+

state

The current state of the MicroVM image.

Type: String

Valid Values: CREATING | CREATED | CREATE_FAILED | UPDATING | UPDATED | UPDATE_FAILED | DELETING | DELETE_FAILED | DELETED

tags

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.

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 MicroVM image 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

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: