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

GetMicrovm

Retrieves the details of a specific MicroVM, including its state, endpoint, image information, and configuration. The state field is eventually consistent — determine readiness by connecting to the endpoint.

Request Syntax


GET /2025-09-09/microvms/microvmIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

microvmIdentifier

The ID of the MicroVM 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

{
   "egressNetworkConnectors": [ "string" ],
   "endpoint": "string",
   "executionRoleArn": "string",
   "idlePolicy": { 
      "autoResumeEnabled": boolean,
      "maxIdleDurationSeconds": number,
      "suspendedDurationSeconds": number
   },
   "imageArn": "string",
   "imageVersion": "string",
   "ingressNetworkConnectors": [ "string" ],
   "maximumDurationInSeconds": number,
   "microvmId": "string",
   "startedAt": number,
   "state": "string",
   "stateReason": "string",
   "terminatedAt": 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.

egressNetworkConnectors

The list of egress network connectors configured for the MicroVM.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

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

endpoint

The HTTPS endpoint URL for communicating with the MicroVM. Include a valid authentication token in the X-aws-proxy-auth header when sending requests.

Type: String

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

executionRoleArn

The ARN of the IAM execution role assumed by the MicroVM.

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+=,.@\-_/]+

idlePolicy

The idle policy configuration of the MicroVM, controlling auto-suspend and auto-resume behavior.

Type: IdlePolicy object

imageArn

The ARN of the MicroVM image used to run this MicroVM.

Type: String

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

imageVersion

The version of the MicroVM image used to run this MicroVM.

Type: String

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

Pattern: [^\s]+

ingressNetworkConnectors

The list of ingress network connectors configured for the MicroVM.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

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

maximumDurationInSeconds

The maximum duration in seconds that the MicroVM can exist before being terminated by the platform.

Type: Integer

microvmId

The unique identifier of the MicroVM.

Type: String

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

startedAt

The timestamp when the MicroVM first started.

Type: Timestamp

state

The current lifecycle state of the MicroVM.

Type: String

stateReason

The reason for why the MicroVM is in the current state.

Type: String

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

Pattern: [^\s]+

terminatedAt

The timestamp when the MicroVM terminated.

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