v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1424154118.9 KB

Runs a new MicroVM from the specified image. The MicroVM starts in PENDING state and transitions to RUNNING once provisioning completes. To connect, generate an authentication token using CreateMicrovmAuthToken.

post/2025-09-09/microvms

Request body

ingressNetworkConnectorsNetworkConnector[]

The list of ingress network connectors to configure for the MicroVM.

egressNetworkConnectorsNetworkConnector[]

The list of egress network connectors to configure for the MicroVM.

imageIdentifierstring required

The ARN or ID of the MicroVmImage

imageVersionstring

The version of the MicroVM image to run.

executionRoleArnstring

The ARN of an IAM role that the service assumes to perform actions on behalf of the caller.

runHookPayloadstring

Per-MicroVM initialization data delivered as the request body of the /run lifecycle hook. Use to pass tenant-specific configuration such as session IDs or secret references. Maximum: 16,384 bytes.

maximumDurationInSecondsinteger

The maximum duration in seconds that the MicroVM can exist before being terminated by the platform. Valid range: 1–28,800 (8 hours).

clientTokenstring

A unique, case-sensitive identifier you provide to ensure the idempotency of the request.

Response

Success

microvmIdstring required

The unique identifier of the MicroVM.

state'PENDING' | 'RUNNING' | 'SUSPENDING' | 'SUSPENDED' | 'TERMINATING' | 'TERMINATED' required

The current lifecycle state of the MicroVM.

endpointstring required

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

imageArnstring required

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

imageVersionstring required

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

executionRoleArnstring

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

maximumDurationInSecondsinteger required

The maximum duration in seconds that the MicroVM can exist.

startedAtstring date-time required

The timestamp when the MicroVM first started.

terminatedAtstring date-time

The timestamp when the MicroVM terminated.

stateReasonstring

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

ingressNetworkConnectorsNetworkConnector[]

The list of ingress network connectors configured for the MicroVM.

egressNetworkConnectorsNetworkConnector[]

The list of egress network connectors configured for the MicroVM.