Api-Lambda-Microvms-2025-09-09 - AWS SDK for PHP V3

Client: Aws\LambdaMicrovms\LambdaMicrovmsClient

Service ID: lambda-microvms

Version: 2025-09-09

This page describes the parameters and results for the operations of the Lambda MicroVMs (2025-09-09), and shows how to use the Aws\LambdaMicrovms\LambdaMicrovmsClient object to call the described operations. This documentation is specific to the 2025-09-09 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateMicrovmAuthToken ( array $params = [] ): Creates an authentication token for accessing a running MicroVM.
CreateMicrovmImage ( array $params = [] ): Creates a MicroVM image from the specified code artifact and base image.
CreateMicrovmShellAuthToken ( array $params = [] ): Creates a shell authentication token for interactive shell access to a running MicroVM.
DeleteMicrovmImage ( array $params = [] ): Deletes a MicroVM image.
DeleteMicrovmImageVersion ( array $params = [] ): Deletes a specific version of a MicroVM image.
GetMicrovm ( array $params = [] ): Retrieves the details of a specific MicroVM, including its state, endpoint, image information, and configuration.
GetMicrovmImage ( array $params = [] ): Retrieves the details of a MicroVM image, including its state, versions, and configuration.
GetMicrovmImageBuild ( array $params = [] ): Retrieves the details of a specific MicroVM image build, including its state, target architecture, and snapshot information.
GetMicrovmImageVersion ( array $params = [] ): Retrieves the details of a specific version of a MicroVM image, including its configuration, state, and build information.
ListManagedMicrovmImageVersions ( array $params = [] ): Lists versions of a managed MicroVM image.
ListManagedMicrovmImages ( array $params = [] ): Lists AWS managed MicroVM images available for use as base images.
ListMicrovmImageBuilds ( array $params = [] ): Lists builds for a MicroVM image version with optional filtering by architecture and chipset.
ListMicrovmImageVersions ( array $params = [] ): Lists versions of a MicroVM image.
ListMicrovmImages ( array $params = [] ): Lists MicroVM images in the account with optional name filtering.
ListMicrovms ( array $params = [] ): Lists MicroVMs in the account with optional filtering by image and version.
ListTags ( array $params = [] ): Lists the tags associated with a Lambda MicroVM resource.
ResumeMicrovm ( array $params = [] ): Resumes a suspended MicroVM, restoring it to RUNNING state with all state intact.
RunMicrovm ( array $params = [] ): Runs a new MicroVM from the specified image.
SuspendMicrovm ( array $params = [] ): Suspends a running MicroVM, preserving its full memory and disk state.
TagResource ( array $params = [] ): Adds tags to a Lambda MicroVM resource.
TerminateMicrovm ( array $params = [] ): Terminates a MicroVM.
UntagResource ( array $params = [] ): Removes tags from a Lambda MicroVM resource.
UpdateMicrovmImage ( array $params = [] ): Updates the configuration of a MicroVM image and triggers a new version build.
UpdateMicrovmImageVersion ( array $params = [] ): Updates the status of a specific MicroVM image version.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListManagedMicrovmImageVersions
ListManagedMicrovmImages
ListMicrovmImageBuilds
ListMicrovmImageVersions
ListMicrovmImages
ListMicrovms

Operations

CreateMicrovmAuthToken

$result = $client->createMicrovmAuthToken([/* ... */]);
$promise = $client->createMicrovmAuthTokenAsync([/* ... */]);

Creates an authentication token for accessing a running MicroVM. The token grants access to the specified ports on the MicroVM endpoint.

Parameter Syntax

$result = $client->createMicrovmAuthToken([
    'allowedPorts' => [ // REQUIRED
        [
            'allPorts' => [
            ],
            'port' => <integer>,
            'range' => [
                'endPort' => <integer>, // REQUIRED
                'startPort' => <integer>, // REQUIRED
            ],
        ],
        // ...
    ],
    'expirationInMinutes' => <integer>, // REQUIRED
    'microvmIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

allowedPorts

: Required: Yes
: Type: Array of PortSpecification structures

The list of port specifications that the authentication token grants access to on the MicroVM.

expirationInMinutes

: Required: Yes
: Type: int

The duration in minutes before the authentication token expires. Maximum: 60 minutes.

microvmIdentifier

: Required: Yes
: Type: string

The ID of the MicroVM to create an authentication token for.

Result Syntax

[
    'authToken' => ['<string>', ...],
]

Result Details

Members

authToken

: Required: Yes
: Type: Associative array of custom strings keys (AuthTokenKey) to strings

A map containing the authentication token. Use the value at key "X-aws-proxy-auth" as the header value when connecting to the MicroVM endpoint.

Errors

InternalServerException:: An internal server error occurred. Retry the request later.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The specified resource does not exist.
ThrottlingException:: The request was denied due to request throttling. Retry the request later.
ValidationException:: The input does not satisfy the constraints specified by the service.

CreateMicrovmImage

$result = $client->createMicrovmImage([/* ... */]);
$promise = $client->createMicrovmImageAsync([/* ... */]);

Creates a MicroVM image from the specified code artifact and base image. The build is asynchronous — the image transitions from CREATING to CREATED on success, or CREATE_FAILED on failure. Use GetMicrovmImage to poll for completion.

Parameter Syntax

$result = $client->createMicrovmImage([
    'additionalOsCapabilities' => ['<string>', ...],
    'baseImageArn' => '<string>', // REQUIRED
    'baseImageVersion' => '<string>',
    'buildRoleArn' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'codeArtifact' => [ // REQUIRED
        'uri' => '<string>',
    ],
    'cpuConfigurations' => [
        [
            'architecture' => 'ARM_64', // REQUIRED
        ],
        // ...
    ],
    'description' => '<string>',
    'egressNetworkConnectors' => ['<string>', ...],
    'environmentVariables' => ['<string>', ...],
    'hooks' => [
        'microvmHooks' => [
            'resume' => 'DISABLED|ENABLED',
            'resumeTimeoutInSeconds' => <integer>,
            'run' => 'DISABLED|ENABLED',
            'runTimeoutInSeconds' => <integer>,
            'suspend' => 'DISABLED|ENABLED',
            'suspendTimeoutInSeconds' => <integer>,
            'terminate' => 'DISABLED|ENABLED',
            'terminateTimeoutInSeconds' => <integer>,
        ],
        'microvmImageHooks' => [
            'ready' => 'DISABLED|ENABLED',
            'readyTimeoutInSeconds' => <integer>,
            'validate' => 'DISABLED|ENABLED',
            'validateTimeoutInSeconds' => <integer>,
        ],
        'port' => <integer>,
    ],
    'logging' => [
        'cloudWatch' => [
            'logGroup' => '<string>',
            'logStream' => '<string>',
        ],
        'disabled' => [
        ],
    ],
    'name' => '<string>', // REQUIRED
    'resources' => [
        [
            'minimumMemoryInMiB' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

additionalOsCapabilities

: Type: Array of strings

Additional OS capabilities granted to the MicroVM runtime environment.

baseImageArn

: Required: Yes
: Type: string

The ARN of the Lambda-managed base MicroVM image to build upon. Use ListManagedMicrovmImages to discover available base images.

baseImageVersion

: Type: string

The specific version of the base MicroVM image to use.

buildRoleArn

: Required: Yes
: Type: string

The ARN of the IAM role assumed during the image build process. This role must have permissions to access the code artifact and any required resources.

clientToken

: Type: string

A unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the operation returns the successful response without performing any further actions.

codeArtifact

: Required: Yes
: Type: CodeArtifact structure

The code artifact containing the application code and metadata for the MicroVM image.

cpuConfigurations

: Type: Array of CpuConfiguration structures

The list of supported CPU configurations for the MicroVM.

description

: Type: string

A description of the MicroVM image.

egressNetworkConnectors

: Type: Array of strings

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

environmentVariables

: Type: Associative array of custom strings keys (EnvironmentVariableKey) to strings

Environment variables set in the MicroVM runtime environment.

hooks

: Type: Hooks structure

Lifecycle hook configuration for MicroVMs and MicroVM images.

logging

: Type: Logging structure

The logging configuration for build-time and runtime logs. Specify {"cloudWatch": {"logGroup": "..."}} to stream logs to a custom CloudWatch log group, or {"disabled": {}} to turn off logging.

name

: Required: Yes
: Type: string

The name of the MicroVM image. Must be unique within the AWS account.

resources

: Type: Array of Resources structures

The resource requirements for the MicroVM.

tags

: Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

[
    'additionalOsCapabilities' => ['<string>', ...],
    'baseImageArn' => '<string>',
    'baseImageVersion' => '<string>',
    'buildRoleArn' => '<string>',
    'codeArtifact' => [
        'uri' => '<string>',
    ],
    'cpuConfigurations' => [
        [
            'architecture' => 'ARM_64',
        ],
        // ...
    ],
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'egressNetworkConnectors' => ['<string>', ...],
    'environmentVariables' => ['<string>', ...],
    'hooks' => [
        'microvmHooks' => [
            'resume' => 'DISABLED|ENABLED',
            'resumeTimeoutInSeconds' => <integer>,
            'run' => 'DISABLED|ENABLED',
            'runTimeoutInSeconds' => <integer>,
            'suspend' => 'DISABLED|ENABLED',
            'suspendTimeoutInSeconds' => <integer>,
            'terminate' => 'DISABLED|ENABLED',
            'terminateTimeoutInSeconds' => <integer>,
        ],
        'microvmImageHooks' => [
            'ready' => 'DISABLED|ENABLED',
            'readyTimeoutInSeconds' => <integer>,
            'validate' => 'DISABLED|ENABLED',
            'validateTimeoutInSeconds' => <integer>,
        ],
        'port' => <integer>,
    ],
    'imageArn' => '<string>',
    'imageVersion' => '<string>',
    'latestActiveImageVersion' => '<string>',
    'latestFailedImageVersion' => '<string>',
    'logging' => [
        'cloudWatch' => [
            'logGroup' => '<string>',
            'logStream' => '<string>',
        ],
        'disabled' => [
        ],
    ],
    'name' => '<string>',
    'resources' => [
        [
            'minimumMemoryInMiB' => <integer>,
        ],
        // ...
    ],
    'state' => 'CREATING|CREATED|CREATE_FAILED|UPDATING|UPDATED|UPDATE_FAILED|DELETING|DELETE_FAILED|DELETED',
    'tags' => ['<string>', ...],
    'updatedAt' => <DateTime>,
]

Result Details

Members

additionalOsCapabilities

: Type: Array of strings

Additional OS capabilities granted to the MicroVM runtime environment.

baseImageArn

: Required: Yes
: Type: string

The ARN of the base MicroVM image.

baseImageVersion

: Type: string

The specific version of the base MicroVM image.

buildRoleArn

: Required: Yes
: Type: string

The ARN of the IAM build role.

codeArtifact

: Required: Yes
: Type: CodeArtifact structure

The code artifact containing the application code and metadata for the MicroVM image.

cpuConfigurations

: Type: Array of CpuConfiguration structures

The list of supported CPU configurations for the MicroVM.

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the MicroVM image was created.

description

: Type: string

The description of the MicroVM image.

egressNetworkConnectors

: Type: Array of strings

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

environmentVariables

: Type: Associative array of custom strings keys (EnvironmentVariableKey) to strings

Environment variables set in the MicroVM runtime environment.

hooks

: Type: Hooks structure

Lifecycle hook configuration for MicroVMs and MicroVM images.

imageArn

: Required: Yes
: Type: string

The ARN of the created MicroVM image.

imageVersion

: Required: Yes
: Type: string

The version of the MicroVM image.

latestActiveImageVersion

: Type: string

The latest active version of the MicroVM image.

latestFailedImageVersion

: Type: string

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

logging

: Type: Logging structure

The logging configuration for build-time and runtime logs. Specify {"cloudWatch": {"logGroup": "..."}} to stream logs to a custom CloudWatch log group, or {"disabled": {}} to turn off logging.

name

: Required: Yes
: Type: string

The name of the MicroVM image.

resources

: Type: Array of Resources structures

The resource requirements for the MicroVM.

state

: Required: Yes
: Type: string

The current state of the MicroVM image.

tags

: Type: Associative array of custom strings keys (TagKey) to strings

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.

updatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the MicroVM image was last updated.

Errors

InternalServerException:: An internal server error occurred. Retry the request later.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The specified resource does not exist.
ThrottlingException:: The request was denied due to request throttling. Retry the request later.
ConflictException:: The request could not be completed due to a conflict with the current state of the resource.
ValidationException:: The input does not satisfy the constraints specified by the service.
ServiceQuotaExceededException:: You have exceeded a service quota for Lambda MicroVMs.

CreateMicrovmShellAuthToken

$result = $client->createMicrovmShellAuthToken([/* ... */]);
$promise = $client->createMicrovmShellAuthTokenAsync([/* ... */]);

Creates a shell authentication token for interactive shell access to a running MicroVM. The MicroVM must have been run with the SHELL_INGRESS network connector attached.

Parameter Syntax

$result = $client->createMicrovmShellAuthToken([
    'expirationInMinutes' => <integer>, // REQUIRED
    'microvmIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

expirationInMinutes

: Required: Yes
: Type: int

The duration in minutes before the shell authentication token expires.

microvmIdentifier

: Required: Yes
: Type: string

The ID of the MicroVM to create a shell authentication token for.

Result Syntax

[
    'authToken' => ['<string>', ...],
]

Result Details

Members

authToken

: Required: Yes
: Type: Associative array of custom strings keys (AuthTokenKey) to strings

The generated shell authentication token key-value pairs for accessing the MicroVM.

Errors

InternalServerException:: An internal server error occurred. Retry the request later.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The specified resource does not exist.
ThrottlingException:: The request was denied due to request throttling. Retry the request later.
ValidationException:: The input does not satisfy the constraints specified by the service.

DeleteMicrovmImage

$result = $client->deleteMicrovmImage([/* ... */]);
$promise = $client->deleteMicrovmImageAsync([/* ... */]);

Deletes a MicroVM image. This operation is idempotent; deleting an image that has already been deleted succeeds without error.

Parameter Syntax

$result = $client->deleteMicrovmImage([
    'imageIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

imageIdentifier

: Required: Yes
: Type: string

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

Result Syntax

[
    'imageIdentifier' => '<string>',
    'state' => 'CREATING|CREATED|CREATE_FAILED|UPDATING|UPDATED|UPDATE_FAILED|DELETING|DELETE_FAILED|DELETED',
]

Result Details

Members

imageIdentifier

: Required: Yes
: Type: string

The identifier of the deleted MicroVM image.

state

: Required: Yes
: Type: string

The current state of the MicroVM image after deletion.

Errors

InternalServerException:: An internal server error occurred. Retry the request later.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The specified resource does not exist.
ThrottlingException:: The request was denied due to request throttling. Retry the request later.
ConflictException:: The request could not be completed due to a conflict with the current state of the resource.
ValidationException:: The input does not satisfy the constraints specified by the service.

DeleteMicrovmImageVersion

$result = $client->deleteMicrovmImageVersion([/* ... */]);
$promise = $client->deleteMicrovmImageVersionAsync([/* ... */]);

Deletes a specific version of a MicroVM image. This operation is idempotent; deleting a version that has already been deleted succeeds without error.

Parameter Syntax

$result = $client->deleteMicrovmImageVersion([
    'imageIdentifier' => '<string>', // REQUIRED
    'imageVersion' => '<string>', // REQUIRED
]);

Parameter Details

Members

imageIdentifier

: Required: Yes
: Type: string

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

imageVersion

: Required: Yes
: Type: string

The version of the MicroVM image to delete.

Result Syntax

[
    'imageIdentifier' => '<string>',
    'imageVersion' => '<string>',
    'state' => 'PENDING|IN_PROGRESS|SUCCESSFUL|FAILED|DELETING|DELETED|DELETE_FAILED',
]

Result Details

Members

imageIdentifier

: Required: Yes
: Type: string

The identifier of the MicroVM image.

imageVersion

: Required: Yes
: Type: string

The version that was deleted.

state

: Required: Yes
: Type: string

The current state of the MicroVM image version after deletion.

Errors

InternalServerException:: An internal server error occurred. Retry the request later.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The specified resource does not exist.
ThrottlingException:: The request was denied due to request throttling. Retry the request later.
ConflictException:: The request could not be completed due to a conflict with the current state of the resource.
ValidationException:: The input does not satisfy the constraints specified by the service.

GetMicrovm

$result = $client->getMicrovm([/* ... */]);
$promise = $client->getMicrovmAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getMicrovm([
    'microvmIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

microvmIdentifier

: Required: Yes
: Type: string

The ID of the MicroVM to retrieve.

Result Syntax

[
    'egressNetworkConnectors' => ['<string>', ...],
    'endpoint' => '<string>',
    'executionRoleArn' => '<string>',
    'idlePolicy' => [
        'autoResumeEnabled' => true || false,
        'maxIdleDurationSeconds' => <integer>,
        'suspendedDurationSeconds' => <integer>,
    ],
    'imageArn' => '<string>',
    'imageVersion' => '<string>',
    'ingressNetworkConnectors' => ['<string>', ...],
    'maximumDurationInSeconds' => <integer>,
    'microvmId' => '<string>',
    'startedAt' => <DateTime>,
    'state' => 'PENDING|RUNNING|SUSPENDING|SUSPENDED|TERMINATING|TERMINATED',
    'stateReason' => '<string>',
    'terminatedAt' => <DateTime>,
]

Result Details

Members

egressNetworkConnectors

: Type: Array of strings

The list of egress network connectors configured for the MicroVM.

endpoint

: Required: Yes
: Type: string

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

executionRoleArn

: Type: string

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

idlePolicy

: Type: IdlePolicy structure

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

imageArn

: Required: Yes
: Type: string

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

imageVersion

: Required: Yes
: Type: string

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

ingressNetworkConnectors

: Type: Array of strings

The list of ingress network connectors configured for the MicroVM.

maximumDurationInSeconds

: Required: Yes
: Type: int

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

microvmId

: Required: Yes
: Type: string

The unique identifier of the MicroVM.

startedAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the MicroVM first started.

state

: Required: Yes
: Type: string

The current lifecycle state of the MicroVM.

stateReason

: Type: string

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

terminatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the MicroVM terminated.

Errors

InternalServerException:: An internal server error occurred. Retry the request later.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The specified resource does not exist.
ThrottlingException:: The request was denied due to request throttling. Retry the request later.
ValidationException:: The input does not satisfy the constraints specified by the service.

GetMicrovmImage

$result = $client->getMicrovmImage([/* ... */]);
$promise = $client->getMicrovmImageAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getMicrovmImage([
    'imageIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

imageIdentifier

: Required: Yes
: Type: string

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

Result Syntax

[
    'createdAt' => <DateTime>,
    'imageArn' => '<string>',
    'latestActiveImageVersion' => '<string>',
    'latestFailedImageVersion' => '<string>',
    'name' => '<string>',
    'state' => 'CREATING|CREATED|CREATE_FAILED|UPDATING|UPDATED|UPDATE_FAILED|DELETING|DELETE_FAILED|DELETED',
    'tags' => ['<string>', ...],
    'updatedAt' => <DateTime>,
]

Result Details

Members

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the MicroVM image was created.

imageArn

: Required: Yes
: Type: string

The ARN of the MicroVM image.

latestActiveImageVersion

: Type: string

The latest active version of the MicroVM image.

latestFailedImageVersion

: Type: string

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

name

: Required: Yes
: Type: string

The name of the MicroVM image.

state

: Required: Yes
: Type: string

The current state of the MicroVM image.

tags

: Type: Associative array of custom strings keys (TagKey) to strings

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.

updatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the MicroVM image was last updated.

Errors

InternalServerException:: An internal server error occurred. Retry the request later.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The specified resource does not exist.
ThrottlingException:: The request was denied due to request throttling. Retry the request later.
ValidationException:: The input does not satisfy the constraints specified by the service.

GetMicrovmImageBuild

$result = $client->getMicrovmImageBuild([/* ... */]);
$promise = $client->getMicrovmImageBuildAsync([/* ... */]);

Retrieves the details of a specific MicroVM image build, including its state, target architecture, and snapshot information.

Parameter Syntax

$result = $client->getMicrovmImageBuild([
    'buildId' => '<string>', // REQUIRED
    'imageIdentifier' => '<string>', // REQUIRED
    'imageVersion' => '<string>', // REQUIRED
]);

Parameter Details

Members

buildId

: Required: Yes
: Type: string

The unique identifier of the build to retrieve.

imageIdentifier

: Required: Yes
: Type: string

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

imageVersion

: Required: Yes
: Type: string

The version of the MicroVM image.

Result Syntax

[
    'architecture' => 'ARM_64',
    'buildId' => '<string>',
    'buildState' => 'PENDING|IN_PROGRESS|SUCCESSFUL|FAILED',
    'chipset' => 'GRAVITON',
    'chipsetGeneration' => '<string>',
    'createdAt' => <DateTime>,
    'imageArn' => '<string>',
    'imageVersion' => '<string>',
    'snapshotBuild' => [
        'codeInstallSizeInBytes' => <integer>,
        'diskSnapshotSizeInBytes' => <integer>,
        'memorySnapshotSizeInBytes' => <integer>,
    ],
    'stateReason' => '<string>',
]

Result Details

Members

architecture

: Required: Yes
: Type: string

The target CPU architecture for the build. Supported value: ARM_64.

buildId

: Required: Yes
: Type: string

The build request ID.

buildState

: Required: Yes
: Type: string

The current state of the build.

chipset

: Required: Yes
: Type: string

The target chipset for the build.

chipsetGeneration

: Required: Yes
: Type: string

The target chipset generation for the build.

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the build was created.

imageArn

: Required: Yes
: Type: string

The ARN of the MicroVM image.

imageVersion

: Required: Yes
: Type: string

The version of the MicroVM image.

snapshotBuild

: Type: SnapshotBuild structure

The snapshot build details, including memory and disk snapshot sizes.

stateReason

: Type: string

The reason for the build state, if applicable.

Errors

InternalServerException:: An internal server error occurred. Retry the request later.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The specified resource does not exist.
ThrottlingException:: The request was denied due to request throttling. Retry the request later.
ValidationException:: The input does not satisfy the constraints specified by the service.

GetMicrovmImageVersion

$result = $client->getMicrovmImageVersion([/* ... */]);
$promise = $client->getMicrovmImageVersionAsync([/* ... */]);

Retrieves the details of a specific version of a MicroVM image, including its configuration, state, and build information.

Parameter Syntax

$result = $client->getMicrovmImageVersion([
    'imageIdentifier' => '<string>', // REQUIRED
    'imageVersion' => '<string>', // REQUIRED
]);

Parameter Details

Members

imageIdentifier

: Required: Yes
: Type: string

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

imageVersion

: Required: Yes
: Type: string

The version of the MicroVM image to retrieve.

Result Syntax

[
    'additionalOsCapabilities' => ['<string>', ...],
    'baseImageArn' => '<string>',
    'baseImageVersion' => '<string>',
    'buildRoleArn' => '<string>',
    'codeArtifact' => [
        'uri' => '<string>',
    ],
    'cpuConfigurations' => [
        [
            'architecture' => 'ARM_64',
        ],
        // ...
    ],
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'egressNetworkConnectors' => ['<string>', ...],
    'environmentVariables' => ['<string>', ...],
    'hooks' => [
        'microvmHooks' => [
            'resume' => 'DISABLED|ENABLED',
            'resumeTimeoutInSeconds' => <integer>,
            'run' => 'DISABLED|ENABLED',
            'runTimeoutInSeconds' => <integer>,
            'suspend' => 'DISABLED|ENABLED',
            'suspendTimeoutInSeconds' => <integer>,
            'terminate' => 'DISABLED|ENABLED',
            'terminateTimeoutInSeconds' => <integer>,
        ],
        'microvmImageHooks' => [
            'ready' => 'DISABLED|ENABLED',
            'readyTimeoutInSeconds' => <integer>,
            'validate' => 'DISABLED|ENABLED',
            'validateTimeoutInSeconds' => <integer>,
        ],
        'port' => <integer>,
    ],
    'imageArn' => '<string>',
    'imageVersion' => '<string>',
    'logging' => [
        'cloudWatch' => [
            'logGroup' => '<string>',
            'logStream' => '<string>',
        ],
        'disabled' => [
        ],
    ],
    'resources' => [
        [
            'minimumMemoryInMiB' => <integer>,
        ],
        // ...
    ],
    'state' => 'PENDING|IN_PROGRESS|SUCCESSFUL|FAILED|DELETING|DELETED|DELETE_FAILED',
    'stateReason' => '<string>',
    'status' => 'ACTIVE|INACTIVE',
    'tags' => ['<string>', ...],
    'updatedAt' => <DateTime>,
]

Result Details

Members

additionalOsCapabilities

: Type: Array of strings

Additional OS capabilities granted to the MicroVM runtime environment.

baseImageArn

: Required: Yes
: Type: string

The ARN of the base MicroVM image used.

baseImageVersion

: Type: string

The specific version of the base MicroVM image.

buildRoleArn

: Required: Yes
: Type: string

The ARN of the IAM build role.

codeArtifact

: Required: Yes
: Type: CodeArtifact structure

The code artifact for this version.

cpuConfigurations

: Type: Array of CpuConfiguration structures

The list of supported CPU configurations for the MicroVM.

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the version was created.

description

: Type: string

The description of the version.

egressNetworkConnectors

: Type: Array of strings

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

environmentVariables

: Type: Associative array of custom strings keys (EnvironmentVariableKey) to strings

Environment variables set in the MicroVM runtime environment.

hooks

: Type: Hooks structure

Lifecycle hook configuration for MicroVMs and MicroVM images.

imageArn

: Required: Yes
: Type: string

The ARN of the MicroVM image.

imageVersion

: Required: Yes
: Type: string

The version of the MicroVM image.

logging

: Type: Logging structure

The logging configuration for this version.

resources

: Type: Array of Resources structures

The resource requirements for the MicroVM.

state

: Required: Yes
: Type: string

The current state of the version.

stateReason

: Type: string

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

status

: Required: Yes
: Type: string

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

tags

: Type: Associative array of custom strings keys (TagKey) to strings

Key-value pairs associated with the version.

updatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the version was last updated.

Errors

InternalServerException:: An internal server error occurred. Retry the request later.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The specified resource does not exist.
ThrottlingException:: The request was denied due to request throttling. Retry the request later.
ValidationException:: The input does not satisfy the constraints specified by the service.

ListManagedMicrovmImageVersions

$result = $client->listManagedMicrovmImageVersions([/* ... */]);
$promise = $client->listManagedMicrovmImageVersionsAsync([/* ... */]);

Lists versions of a managed MicroVM image. We recommend using pagination to ensure that the operation returns quickly and successfully.

Parameter Syntax

$result = $client->listManagedMicrovmImageVersions([
    'imageIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

imageIdentifier

: Required: Yes
: Type: string

The unique identifier (ARN or ID) of the managed MicroVM image to list versions for.

maxResults

: Type: int

The maximum number of results to return in a single call.

nextToken

: Type: string

The pagination token from a previous call. Use this token to retrieve the next page of results.

Result Syntax

[
    'items' => [
        [
            'createdAt' => <DateTime>,
            'imageArn' => '<string>',
            'imageVersion' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

items

: Required: Yes
: Type: Array of ManagedMicrovmImageVersion structures

The list of managed MicroVM image versions.

nextToken

: Type: string

The pagination token to use in a subsequent request to retrieve the next page of results. This value is null when there are no more results to return.

Errors

InternalServerException:: An internal server error occurred. Retry the request later.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The specified resource does not exist.
ThrottlingException:: The request was denied due to request throttling. Retry the request later.
ValidationException:: The input does not satisfy the constraints specified by the service.

ListManagedMicrovmImages

$result = $client->listManagedMicrovmImages([/* ... */]);
$promise = $client->listManagedMicrovmImagesAsync([/* ... */]);

Lists AWS managed MicroVM images available for use as base images. We recommend using pagination to ensure that the operation returns quickly and successfully.

Parameter Syntax

$result = $client->listManagedMicrovmImages([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

: Type: int

The maximum number of results to return in a single call.

nextToken

: Type: string

The pagination token from a previous call. Use this token to retrieve the next page of results.

Result Syntax

[
    'items' => [
        [
            'createdAt' => <DateTime>,
            'imageArn' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

items

: Required: Yes
: Type: Array of ManagedMicrovmImageSummary structures

The list of managed MicroVM images.

nextToken

: Type: string

The pagination token to use in a subsequent request to retrieve the next page of results. This value is null when there are no more results to return.

Errors

InternalServerException:: An internal server error occurred. Retry the request later.
AccessDeniedException:: You do not have sufficient access to perform this action.
ThrottlingException:: The request was denied due to request throttling. Retry the request later.
ValidationException:: The input does not satisfy the constraints specified by the service.

ListMicrovmImageBuilds

$result = $client->listMicrovmImageBuilds([/* ... */]);
$promise = $client->listMicrovmImageBuildsAsync([/* ... */]);

Lists builds for a MicroVM image version with optional filtering by architecture and chipset. We recommend using pagination to ensure that the operation returns quickly and successfully.

Parameter Syntax

$result = $client->listMicrovmImageBuilds([
    'architecture' => 'ARM_64',
    'chipset' => 'GRAVITON',
    'chipsetGeneration' => '<string>',
    'imageIdentifier' => '<string>', // REQUIRED
    'imageVersion' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

architecture

: Type: string

Filters builds by target CPU architecture.

chipset

: Type: string

Filters builds by target chipset.

chipsetGeneration

: Type: string

Filters builds by target chipset generation.

imageIdentifier

: Required: Yes
: Type: string

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

imageVersion

: Required: Yes
: Type: string

The version of the MicroVM image to list builds for.

maxResults

: Type: int

The maximum number of results to return in a single call.

nextToken

: Type: string

The pagination token from a previous call. Use this token to retrieve the next page of results.

Result Syntax

[
    'items' => [
        [
            'architecture' => 'ARM_64',
            'buildId' => '<string>',
            'buildState' => 'PENDING|IN_PROGRESS|SUCCESSFUL|FAILED',
            'chipset' => 'GRAVITON',
            'chipsetGeneration' => '<string>',
            'createdAt' => <DateTime>,
            'imageArn' => '<string>',
            'imageVersion' => '<string>',
            'stateReason' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

items

: Required: Yes
: Type: Array of MicrovmImageBuildSummary structures

The list of MicroVM image builds.

nextToken

: Type: string

The pagination token to use in a subsequent request to retrieve the next page of results. This value is null when there are no more results to return.

Errors

InternalServerException:: An internal server error occurred. Retry the request later.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The specified resource does not exist.
ThrottlingException:: The request was denied due to request throttling. Retry the request later.
ValidationException:: The input does not satisfy the constraints specified by the service.

ListMicrovmImageVersions

$result = $client->listMicrovmImageVersions([/* ... */]);
$promise = $client->listMicrovmImageVersionsAsync([/* ... */]);

Lists versions of a MicroVM image. We recommend using pagination to ensure that the operation returns quickly and successfully.

Parameter Syntax

$result = $client->listMicrovmImageVersions([
    'imageIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

imageIdentifier

: Required: Yes
: Type: string

The unique identifier (ARN or ID) of the MicroVM image to list versions for.

maxResults

: Type: int

The maximum number of results to return in a single call.

nextToken

: Type: string

The pagination token from a previous call. Use this token to retrieve the next page of results.

Result Syntax

[
    'items' => [
        [
            'additionalOsCapabilities' => ['<string>', ...],
            'baseImageArn' => '<string>',
            'baseImageVersion' => '<string>',
            'buildRoleArn' => '<string>',
            'codeArtifact' => [
                'uri' => '<string>',
            ],
            'cpuConfigurations' => [
                [
                    'architecture' => 'ARM_64',
                ],
                // ...
            ],
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'egressNetworkConnectors' => ['<string>', ...],
            'environmentVariables' => ['<string>', ...],
            'hooks' => [
                'microvmHooks' => [
                    'resume' => 'DISABLED|ENABLED',
                    'resumeTimeoutInSeconds' => <integer>,
                    'run' => 'DISABLED|ENABLED',
                    'runTimeoutInSeconds' => <integer>,
                    'suspend' => 'DISABLED|ENABLED',
                    'suspendTimeoutInSeconds' => <integer>,
                    'terminate' => 'DISABLED|ENABLED',
                    'terminateTimeoutInSeconds' => <integer>,
                ],
                'microvmImageHooks' => [
                    'ready' => 'DISABLED|ENABLED',
                    'readyTimeoutInSeconds' => <integer>,
                    'validate' => 'DISABLED|ENABLED',
                    'validateTimeoutInSeconds' => <integer>,
                ],
                'port' => <integer>,
            ],
            'imageArn' => '<string>',
            'imageVersion' => '<string>',
            'logging' => [
                'cloudWatch' => [
                    'logGroup' => '<string>',
                    'logStream' => '<string>',
                ],
                'disabled' => [
                ],
            ],
            'resources' => [
                [
                    'minimumMemoryInMiB' => <integer>,
                ],
                // ...
            ],
            'state' => 'PENDING|IN_PROGRESS|SUCCESSFUL|FAILED|DELETING|DELETED|DELETE_FAILED',
            'stateReason' => '<string>',
            'status' => 'ACTIVE|INACTIVE',
            'tags' => ['<string>', ...],
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

items

: Required: Yes
: Type: Array of MicrovmImageVersionSummary structures

The list of MicroVM image versions.

nextToken

: Type: string

The pagination token to use in a subsequent request to retrieve the next page of results. This value is null when there are no more results to return.

Errors

InternalServerException:: An internal server error occurred. Retry the request later.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The specified resource does not exist.
ThrottlingException:: The request was denied due to request throttling. Retry the request later.
ValidationException:: The input does not satisfy the constraints specified by the service.

ListMicrovmImages

$result = $client->listMicrovmImages([/* ... */]);
$promise = $client->listMicrovmImagesAsync([/* ... */]);

Lists MicroVM images in the account with optional name filtering. We recommend using pagination to ensure that the operation returns quickly and successfully.

Parameter Syntax

$result = $client->listMicrovmImages([
    'maxResults' => <integer>,
    'nameFilter' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

: Type: int

The maximum number of results to return in a single call.

nameFilter

: Type: string

Filters images whose name contains the specified string.

nextToken

: Type: string

The pagination token from a previous call. Use this token to retrieve the next page of results.

Result Syntax

[
    'items' => [
        [
            'createdAt' => <DateTime>,
            'imageArn' => '<string>',
            'latestActiveImageVersion' => '<string>',
            'latestFailedImageVersion' => '<string>',
            'name' => '<string>',
            'state' => 'CREATING|CREATED|CREATE_FAILED|UPDATING|UPDATED|UPDATE_FAILED|DELETING|DELETE_FAILED|DELETED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

items

: Required: Yes
: Type: Array of MicrovmImageSummary structures

The list of MicroVM images.

nextToken

: Type: string

The pagination token to use in a subsequent request to retrieve the next page of results. This value is null when there are no more results to return.

Errors

InternalServerException:: An internal server error occurred. Retry the request later.
AccessDeniedException:: You do not have sufficient access to perform this action.
ThrottlingException:: The request was denied due to request throttling. Retry the request later.
ValidationException:: The input does not satisfy the constraints specified by the service.

ListMicrovms

$result = $client->listMicrovms([/* ... */]);
$promise = $client->listMicrovmsAsync([/* ... */]);

Lists MicroVMs in the account with optional filtering by image and version. We recommend using pagination to ensure that the operation returns quickly and successfully.

Parameter Syntax

$result = $client->listMicrovms([
    'imageIdentifier' => '<string>',
    'imageVersion' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

imageIdentifier

: Type: string

Optional filter to list only MicroVMs running the specified image.

imageVersion

: Type: string

Optional filter to list only MicroVMs running the specified image version.

maxResults

: Type: int

The maximum number of results to return in a single call.

nextToken

: Type: string

The pagination token from a previous call. Use this token to retrieve the next page of results.

Result Syntax

[
    'items' => [
        [
            'imageArn' => '<string>',
            'imageVersion' => '<string>',
            'microvmId' => '<string>',
            'startedAt' => <DateTime>,
            'state' => 'PENDING|RUNNING|SUSPENDING|SUSPENDED|TERMINATING|TERMINATED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

items

: Required: Yes
: Type: Array of MicrovmItem structures

The list of MicroVMs.

nextToken

: Type: string

The pagination token to use in a subsequent request to retrieve the next page of results. This value is null when there are no more results to return.

Errors

InternalServerException:: An internal server error occurred. Retry the request later.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The specified resource does not exist.
ThrottlingException:: The request was denied due to request throttling. Retry the request later.
ValidationException:: The input does not satisfy the constraints specified by the service.

$result = $client->listTags([/* ... */]);
$promise = $client->listTagsAsync([/* ... */]);

Lists the tags associated with a Lambda MicroVM resource.

Parameter Syntax

$result = $client->listTags([
    'Resource' => '<string>', // REQUIRED
]);

Parameter Details

Members

Resource

: Required: Yes
: Type: string

The ARN of the resource to list tags for.

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members

Tags

: Type: Associative array of custom strings keys (TagKey) to strings

The key-value pairs of tags associated with the resource.

Errors

TooManyRequestsException:: The request throughput limit was exceeded. Retry the request later.
ResourceNotFoundException:: The specified resource does not exist.
ServiceException:: The AWS Lambda MicroVMs service encountered an internal error.
InvalidParameterValueException:: One of the parameters in the request is not valid.

ResumeMicrovm

$result = $client->resumeMicrovm([/* ... */]);
$promise = $client->resumeMicrovmAsync([/* ... */]);

Resumes a suspended MicroVM, restoring it to RUNNING state with all state intact. The MicroVM must be in SUSPENDED state.

Parameter Syntax

$result = $client->resumeMicrovm([
    'microvmIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

microvmIdentifier

: Required: Yes
: Type: string

The ID of the MicroVM to resume.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: An internal server error occurred. Retry the request later.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The specified resource does not exist.
ThrottlingException:: The request was denied due to request throttling. Retry the request later.
ConflictException:: The request could not be completed due to a conflict with the current state of the resource.
ValidationException:: The input does not satisfy the constraints specified by the service.

RunMicrovm

$result = $client->runMicrovm([/* ... */]);
$promise = $client->runMicrovmAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->runMicrovm([
    'clientToken' => '<string>',
    'egressNetworkConnectors' => ['<string>', ...],
    'executionRoleArn' => '<string>',
    'idlePolicy' => [
        'autoResumeEnabled' => true || false, // REQUIRED
        'maxIdleDurationSeconds' => <integer>, // REQUIRED
        'suspendedDurationSeconds' => <integer>, // REQUIRED
    ],
    'imageIdentifier' => '<string>', // REQUIRED
    'imageVersion' => '<string>',
    'ingressNetworkConnectors' => ['<string>', ...],
    'logging' => [
        'cloudWatch' => [
            'logGroup' => '<string>',
            'logStream' => '<string>',
        ],
        'disabled' => [
        ],
    ],
    'maximumDurationInSeconds' => <integer>,
    'runHookPayload' => '<string>',
]);

Parameter Details

Members

clientToken

: Type: string

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

egressNetworkConnectors

: Type: Array of strings

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

executionRoleArn

: Type: string

The ARN of the IAM role to be assumed by the MicroVM during execution.

idlePolicy

: Type: IdlePolicy structure

Configuration to control auto-suspend and auto-resume behavior.

imageIdentifier

: Required: Yes
: Type: string

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

imageVersion

: Type: string

The version of the MicroVM image to run.

ingressNetworkConnectors

: Type: Array of strings

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

logging

: Type: Logging structure

The logging configuration for this MicroVM instance. Specify {"cloudWatch": {"logGroup": "..."}} to stream application logs to a custom CloudWatch log group, or {"disabled": {}} to turn off logging.

maximumDurationInSeconds

: Type: int

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

runHookPayload

: Type: string

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.

Result Syntax

[
    'egressNetworkConnectors' => ['<string>', ...],
    'endpoint' => '<string>',
    'executionRoleArn' => '<string>',
    'idlePolicy' => [
        'autoResumeEnabled' => true || false,
        'maxIdleDurationSeconds' => <integer>,
        'suspendedDurationSeconds' => <integer>,
    ],
    'imageArn' => '<string>',
    'imageVersion' => '<string>',
    'ingressNetworkConnectors' => ['<string>', ...],
    'maximumDurationInSeconds' => <integer>,
    'microvmId' => '<string>',
    'startedAt' => <DateTime>,
    'state' => 'PENDING|RUNNING|SUSPENDING|SUSPENDED|TERMINATING|TERMINATED',
    'stateReason' => '<string>',
    'terminatedAt' => <DateTime>,
]

Result Details

Members

egressNetworkConnectors

: Type: Array of strings

The list of egress network connectors configured for the MicroVM.

endpoint

: Required: Yes
: Type: string

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

executionRoleArn

: Type: string

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

idlePolicy

: Type: IdlePolicy structure

The idle policy configuration of the MicroVM.

imageArn

: Required: Yes
: Type: string

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

imageVersion

: Required: Yes
: Type: string

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

ingressNetworkConnectors

: Type: Array of strings

The list of ingress network connectors configured for the MicroVM.

maximumDurationInSeconds

: Required: Yes
: Type: int

The maximum duration in seconds that the MicroVM can exist.

microvmId

: Required: Yes
: Type: string

The unique identifier of the MicroVM.

startedAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the MicroVM first started.

state

: Required: Yes
: Type: string

The current lifecycle state of the MicroVM.

stateReason

: Type: string

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

terminatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the MicroVM terminated.

Errors

InternalServerException:: An internal server error occurred. Retry the request later.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The specified resource does not exist.
ThrottlingException:: The request was denied due to request throttling. Retry the request later.
ConflictException:: The request could not be completed due to a conflict with the current state of the resource.
ValidationException:: The input does not satisfy the constraints specified by the service.
ServiceQuotaExceededException:: You have exceeded a service quota for Lambda MicroVMs.

SuspendMicrovm

$result = $client->suspendMicrovm([/* ... */]);
$promise = $client->suspendMicrovmAsync([/* ... */]);

Suspends a running MicroVM, preserving its full memory and disk state. The MicroVM transitions through SUSPENDING to SUSPENDED. To restore, call ResumeMicrovm or send traffic to the endpoint if autoResumeEnabled is true.

Parameter Syntax

$result = $client->suspendMicrovm([
    'microvmIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

microvmIdentifier

: Required: Yes
: Type: string

The ID of the MicroVM to suspend.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: An internal server error occurred. Retry the request later.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The specified resource does not exist.
ThrottlingException:: The request was denied due to request throttling. Retry the request later.
ConflictException:: The request could not be completed due to a conflict with the current state of the resource.
ValidationException:: The input does not satisfy the constraints specified by the service.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds tags to a Lambda MicroVM resource.

Parameter Syntax

$result = $client->tagResource([
    'Resource' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

Resource

: Required: Yes
: Type: string

The ARN of the resource to tag.

Tags

: Required: Yes
: Type: Associative array of custom strings keys (TagKey) to strings

The key-value pairs of tags to add to the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

TooManyRequestsException:: The request throughput limit was exceeded. Retry the request later.
ResourceNotFoundException:: The specified resource does not exist.
ServiceException:: The AWS Lambda MicroVMs service encountered an internal error.
InvalidParameterValueException:: One of the parameters in the request is not valid.
ResourceConflictException:: The resource already exists, or another operation is in progress.

TerminateMicrovm

$result = $client->terminateMicrovm([/* ... */]);
$promise = $client->terminateMicrovmAsync([/* ... */]);

Terminates a MicroVM. This operation is idempotent; terminating a MicroVM that has already been terminated succeeds without error.

Parameter Syntax

$result = $client->terminateMicrovm([
    'microvmIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

microvmIdentifier

: Required: Yes
: Type: string

The ID of the MicroVM to terminate.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: An internal server error occurred. Retry the request later.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The specified resource does not exist.
ThrottlingException:: The request was denied due to request throttling. Retry the request later.
ConflictException:: The request could not be completed due to a conflict with the current state of the resource.
ValidationException:: The input does not satisfy the constraints specified by the service.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from a Lambda MicroVM resource.

Parameter Syntax

$result = $client->untagResource([
    'Resource' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

Resource

: Required: Yes
: Type: string

The ARN of the resource to remove tags from.

TagKeys

: Required: Yes
: Type: Array of strings

The list of tag keys to remove from the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

TooManyRequestsException:: The request throughput limit was exceeded. Retry the request later.
ResourceNotFoundException:: The specified resource does not exist.
ServiceException:: The AWS Lambda MicroVMs service encountered an internal error.
InvalidParameterValueException:: One of the parameters in the request is not valid.
ResourceConflictException:: The resource already exists, or another operation is in progress.

UpdateMicrovmImage

$result = $client->updateMicrovmImage([/* ... */]);
$promise = $client->updateMicrovmImageAsync([/* ... */]);

Updates the configuration of a MicroVM image and triggers a new version build. This operation uses PUT semantics — all required fields (codeArtifact, baseImageArn, buildRoleArn) must be provided with every request.

Parameter Syntax

$result = $client->updateMicrovmImage([
    'additionalOsCapabilities' => ['<string>', ...],
    'baseImageArn' => '<string>', // REQUIRED
    'baseImageVersion' => '<string>',
    'buildRoleArn' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'codeArtifact' => [ // REQUIRED
        'uri' => '<string>',
    ],
    'cpuConfigurations' => [
        [
            'architecture' => 'ARM_64', // REQUIRED
        ],
        // ...
    ],
    'description' => '<string>',
    'egressNetworkConnectors' => ['<string>', ...],
    'environmentVariables' => ['<string>', ...],
    'hooks' => [
        'microvmHooks' => [
            'resume' => 'DISABLED|ENABLED',
            'resumeTimeoutInSeconds' => <integer>,
            'run' => 'DISABLED|ENABLED',
            'runTimeoutInSeconds' => <integer>,
            'suspend' => 'DISABLED|ENABLED',
            'suspendTimeoutInSeconds' => <integer>,
            'terminate' => 'DISABLED|ENABLED',
            'terminateTimeoutInSeconds' => <integer>,
        ],
        'microvmImageHooks' => [
            'ready' => 'DISABLED|ENABLED',
            'readyTimeoutInSeconds' => <integer>,
            'validate' => 'DISABLED|ENABLED',
            'validateTimeoutInSeconds' => <integer>,
        ],
        'port' => <integer>,
    ],
    'imageIdentifier' => '<string>', // REQUIRED
    'logging' => [
        'cloudWatch' => [
            'logGroup' => '<string>',
            'logStream' => '<string>',
        ],
        'disabled' => [
        ],
    ],
    'resources' => [
        [
            'minimumMemoryInMiB' => <integer>, // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

additionalOsCapabilities

: Type: Array of strings

Additional OS capabilities granted to the MicroVM runtime environment.

baseImageArn

: Required: Yes
: Type: string

The ARN of the base MicroVM image.

baseImageVersion

: Type: string

The specific version of the base MicroVM image to use.

buildRoleArn

: Required: Yes
: Type: string

The ARN of the IAM build role.

clientToken

: Type: string

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

codeArtifact

: Required: Yes
: Type: CodeArtifact structure

The code artifact containing the application code and metadata for the MicroVM image.

cpuConfigurations

: Type: Array of CpuConfiguration structures

The list of supported CPU configurations for the MicroVM.

description

: Type: string

The description of the MicroVM image.

egressNetworkConnectors

: Type: Array of strings

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

environmentVariables

: Type: Associative array of custom strings keys (EnvironmentVariableKey) to strings

Environment variables set in the MicroVM runtime environment.

hooks

: Type: Hooks structure

Lifecycle hook configuration for MicroVMs and MicroVM images.

imageIdentifier

: Required: Yes
: Type: string

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

logging

: Type: Logging structure

The logging configuration for build-time and runtime logs. Specify {"cloudWatch": {"logGroup": "..."}} to stream logs to a custom CloudWatch log group, or {"disabled": {}} to turn off logging.

resources

: Type: Array of Resources structures

The resource requirements for the MicroVM.

Result Syntax

[
    'additionalOsCapabilities' => ['<string>', ...],
    'baseImageArn' => '<string>',
    'baseImageVersion' => '<string>',
    'buildRoleArn' => '<string>',
    'codeArtifact' => [
        'uri' => '<string>',
    ],
    'cpuConfigurations' => [
        [
            'architecture' => 'ARM_64',
        ],
        // ...
    ],
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'egressNetworkConnectors' => ['<string>', ...],
    'environmentVariables' => ['<string>', ...],
    'hooks' => [
        'microvmHooks' => [
            'resume' => 'DISABLED|ENABLED',
            'resumeTimeoutInSeconds' => <integer>,
            'run' => 'DISABLED|ENABLED',
            'runTimeoutInSeconds' => <integer>,
            'suspend' => 'DISABLED|ENABLED',
            'suspendTimeoutInSeconds' => <integer>,
            'terminate' => 'DISABLED|ENABLED',
            'terminateTimeoutInSeconds' => <integer>,
        ],
        'microvmImageHooks' => [
            'ready' => 'DISABLED|ENABLED',
            'readyTimeoutInSeconds' => <integer>,
            'validate' => 'DISABLED|ENABLED',
            'validateTimeoutInSeconds' => <integer>,
        ],
        'port' => <integer>,
    ],
    'imageArn' => '<string>',
    'imageVersion' => '<string>',
    'latestActiveImageVersion' => '<string>',
    'latestFailedImageVersion' => '<string>',
    'logging' => [
        'cloudWatch' => [
            'logGroup' => '<string>',
            'logStream' => '<string>',
        ],
        'disabled' => [
        ],
    ],
    'name' => '<string>',
    'resources' => [
        [
            'minimumMemoryInMiB' => <integer>,
        ],
        // ...
    ],
    'state' => 'CREATING|CREATED|CREATE_FAILED|UPDATING|UPDATED|UPDATE_FAILED|DELETING|DELETE_FAILED|DELETED',
    'updatedAt' => <DateTime>,
]

Result Details

Members

additionalOsCapabilities

: Type: Array of strings

Additional OS capabilities granted to the MicroVM runtime environment.

baseImageArn

: Required: Yes
: Type: string

The ARN of the base MicroVM image.

baseImageVersion

: Type: string

The specific version of the base MicroVM image.

buildRoleArn

: Required: Yes
: Type: string

The ARN of the IAM build role.

codeArtifact

: Required: Yes
: Type: CodeArtifact structure

The code artifact containing the application code and metadata for the MicroVM image.

cpuConfigurations

: Type: Array of CpuConfiguration structures

The list of supported CPU configurations for the MicroVM.

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the MicroVM image was created.

description

: Type: string

The description of the MicroVM image.

egressNetworkConnectors

: Type: Array of strings

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

environmentVariables

: Type: Associative array of custom strings keys (EnvironmentVariableKey) to strings

Environment variables set in the MicroVM runtime environment.

hooks

: Type: Hooks structure

Lifecycle hook configuration for MicroVMs and MicroVM images.

imageArn

: Required: Yes
: Type: string

The ARN of the MicroVM image.

imageVersion

: Required: Yes
: Type: string

The version of the MicroVM image.

latestActiveImageVersion

: Type: string

The latest active version of the MicroVM image.

latestFailedImageVersion

: Type: string

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

logging

: Type: Logging structure

The logging configuration for build-time and runtime logs. Specify {"cloudWatch": {"logGroup": "..."}} to stream logs to a custom CloudWatch log group, or {"disabled": {}} to turn off logging.

name

: Required: Yes
: Type: string

The name of the MicroVM image.

resources

: Type: Array of Resources structures

The resource requirements for the MicroVM.

state

: Required: Yes
: Type: string

The current state of the MicroVM image.

updatedAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the MicroVM image was last updated.

Errors

InternalServerException:: An internal server error occurred. Retry the request later.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The specified resource does not exist.
ThrottlingException:: The request was denied due to request throttling. Retry the request later.
ConflictException:: The request could not be completed due to a conflict with the current state of the resource.
ValidationException:: The input does not satisfy the constraints specified by the service.
ServiceQuotaExceededException:: You have exceeded a service quota for Lambda MicroVMs.

UpdateMicrovmImageVersion

$result = $client->updateMicrovmImageVersion([/* ... */]);
$promise = $client->updateMicrovmImageVersionAsync([/* ... */]);

Updates the status of a specific MicroVM image version.

Parameter Syntax

$result = $client->updateMicrovmImageVersion([
    'imageIdentifier' => '<string>', // REQUIRED
    'imageVersion' => '<string>', // REQUIRED
    'status' => 'ACTIVE|INACTIVE', // REQUIRED
]);

Parameter Details

Members

imageIdentifier

: Required: Yes
: Type: string

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

imageVersion

: Required: Yes
: Type: string

The version of the MicroVM image to update.

status

: Required: Yes
: Type: string

The new status to set for the MicroVM image version.

Result Syntax

[
    'additionalOsCapabilities' => ['<string>', ...],
    'baseImageArn' => '<string>',
    'baseImageVersion' => '<string>',
    'buildRoleArn' => '<string>',
    'codeArtifact' => [
        'uri' => '<string>',
    ],
    'cpuConfigurations' => [
        [
            'architecture' => 'ARM_64',
        ],
        // ...
    ],
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'egressNetworkConnectors' => ['<string>', ...],
    'environmentVariables' => ['<string>', ...],
    'hooks' => [
        'microvmHooks' => [
            'resume' => 'DISABLED|ENABLED',
            'resumeTimeoutInSeconds' => <integer>,
            'run' => 'DISABLED|ENABLED',
            'runTimeoutInSeconds' => <integer>,
            'suspend' => 'DISABLED|ENABLED',
            'suspendTimeoutInSeconds' => <integer>,
            'terminate' => 'DISABLED|ENABLED',
            'terminateTimeoutInSeconds' => <integer>,
        ],
        'microvmImageHooks' => [
            'ready' => 'DISABLED|ENABLED',
            'readyTimeoutInSeconds' => <integer>,
            'validate' => 'DISABLED|ENABLED',
            'validateTimeoutInSeconds' => <integer>,
        ],
        'port' => <integer>,
    ],
    'imageArn' => '<string>',
    'imageVersion' => '<string>',
    'logging' => [
        'cloudWatch' => [
            'logGroup' => '<string>',
            'logStream' => '<string>',
        ],
        'disabled' => [
        ],
    ],
    'resources' => [
        [
            'minimumMemoryInMiB' => <integer>,
        ],
        // ...
    ],
    'state' => 'PENDING|IN_PROGRESS|SUCCESSFUL|FAILED|DELETING|DELETED|DELETE_FAILED',
    'stateReason' => '<string>',
    'status' => 'ACTIVE|INACTIVE',
    'tags' => ['<string>', ...],
    'updatedAt' => <DateTime>,
]

Result Details

Members

additionalOsCapabilities

: Type: Array of strings

Additional OS capabilities granted to the MicroVM runtime environment.

baseImageArn

: Required: Yes
: Type: string

The ARN of the base MicroVM image used.

baseImageVersion

: Type: string

The specific version of the base MicroVM image.

buildRoleArn

: Required: Yes
: Type: string

The ARN of the IAM build role.

codeArtifact

: Required: Yes
: Type: CodeArtifact structure

The code artifact for this version.

cpuConfigurations

: Type: Array of CpuConfiguration structures

The list of supported CPU configurations for the MicroVM.

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the version was created.

description

: Type: string

The description of the version.

egressNetworkConnectors

: Type: Array of strings

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

environmentVariables

: Type: Associative array of custom strings keys (EnvironmentVariableKey) to strings

Environment variables set in the MicroVM runtime environment.

hooks

: Type: Hooks structure

Lifecycle hook configuration for MicroVMs and MicroVM images.

imageArn

: Required: Yes
: Type: string

The ARN of the MicroVM image.

imageVersion

: Required: Yes
: Type: string

The version of the MicroVM image.

logging

: Type: Logging structure

The logging configuration for this version.

resources

: Type: Array of Resources structures

The resource requirements for the MicroVM.

state

: Required: Yes
: Type: string

The current state of the version.

stateReason

: Type: string

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

status

: Required: Yes
: Type: string

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

tags

: Type: Associative array of custom strings keys (TagKey) to strings

Key-value pairs associated with the version.

updatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the version was last updated.

Errors

InternalServerException:: An internal server error occurred. Retry the request later.
AccessDeniedException:: You do not have sufficient access to perform this action.
ResourceNotFoundException:: The specified resource does not exist.
ThrottlingException:: The request was denied due to request throttling. Retry the request later.
ConflictException:: The request could not be completed due to a conflict with the current state of the resource.
ValidationException:: The input does not satisfy the constraints specified by the service.

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members

message

: Type: string

CloudWatchLogging

Description

Configuration for Amazon CloudWatch Logs logging.

Members

logGroup

: Type: string

The name of the CloudWatch Logs log group to send logs to.

logStream

: Type: string

The name of the CloudWatch Logs log stream within the log group.

CodeArtifact

Description

Contains the location of the code artifact for a MicroVM image.

Members

uri

: Type: string

The URI of the code artifact, such as an Amazon S3 path or Amazon ECR image URI.

ConflictException

Description

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

Members

message

: Type: string

resourceId

: Type: string

The identifier of the resource that caused the conflict.

resourceType

: Type: string

The type of the resource that caused the conflict.

CpuConfiguration

Description

Configuration for the CPU architecture of a MicroVM.

Members

architecture

: Required: Yes
: Type: string

The CPU architecture.

Hooks

Description

Lifecycle hook configuration for MicroVMs and MicroVM images.

Members

microvmHooks

: Type: MicrovmHooks structure

The lifecycle hooks for MicroVM events.

microvmImageHooks

: Type: MicrovmImageHooks structure

The hooks for MicroVM image build events.

port

: Type: int

The port number on which the hooks listener runs.

IdlePolicy

Description

Configuration that controls MicroVM auto-suspend and auto-resume behavior. Idle time is measured by inbound traffic through the MicroVM proxy endpoint — if no requests arrive within the configured duration, the MicroVM is suspended.

Members

autoResumeEnabled

: Required: Yes
: Type: boolean

Indicates whether the MicroVM automatically resumes when it receives a request while suspended.

maxIdleDurationSeconds

: Required: Yes
: Type: int

The maximum time in seconds that a MicroVM can remain idle before it is automatically suspended.

suspendedDurationSeconds

: Required: Yes
: Type: int

The maximum time in seconds that a MicroVM can remain suspended before it is automatically terminated.

InternalServerException

Description

An internal server error occurred. Retry the request later.

Members

message

: Type: string

retryAfterSeconds

: Type: int

The number of seconds to wait before retrying the request.

InvalidParameterValueException

Description

One of the parameters in the request is not valid.

Members

Type

: Type: string

The exception type.

message

: Type: string

Logging

Description

Configuration for MicroVM logging output. Specify exactly one: cloudWatch to enable CloudWatch logging, or disabled to turn off logging.

Members

cloudWatch

: Type: CloudWatchLogging structure

Configuration for sending logs to Amazon CloudWatch Logs.

disabled

: Type: LoggingDisabled structure

Specifies that logging is disabled.

LoggingDisabled

Description

Specifies that logging is disabled for the MicroVM.

Members

ManagedMicrovmImageSummary

Description

Contains summary information about a managed MicroVM image.

Members

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the managed MicroVM image was created.

imageArn

: Required: Yes
: Type: string

The ARN of the managed MicroVM image.

updatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the managed MicroVM image was last updated.

ManagedMicrovmImageVersion

Description

Contains version information for a managed MicroVM image.

Members

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the version was created.

imageArn

: Required: Yes
: Type: string

The ARN of the managed MicroVM image.

imageVersion

: Required: Yes
: Type: string

The version of the managed MicroVM image.

updatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the version was last updated.

MicrovmHooks

Description

Configuration for lifecycle hooks invoked during MicroVM events such as run, resume, suspend, and terminate.

Members

resume

: Type: string

The path of the hook invoked when the MicroVM resumes from a suspended state.

resumeTimeoutInSeconds

: Type: int

The maximum time in seconds for the resume hook to complete.

run

: Type: string

The path of the hook invoked when the MicroVM starts running.

runTimeoutInSeconds

: Type: int

The maximum time in seconds for the run hook to complete.

suspend

: Type: string

The path of the hook invoked when the MicroVM is suspended.

suspendTimeoutInSeconds

: Type: int

The maximum time in seconds for the suspend hook to complete.

terminate

: Type: string

The path of the hook invoked when the MicroVM is terminated.

terminateTimeoutInSeconds

: Type: int

The maximum time in seconds for the terminate hook to complete.

MicrovmImageBuildSummary

Description

Contains summary information about a MicroVM image build.

Members

architecture

: Required: Yes
: Type: string

The target CPU architecture for the build. Supported value: ARM_64.

buildId

: Required: Yes
: Type: string

The build request ID.

buildState

: Required: Yes
: Type: string

The current state of the build.

chipset

: Required: Yes
: Type: string

The target chipset for the build.

chipsetGeneration

: Required: Yes
: Type: string

The target chipset generation for the build.

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the build was created.

imageArn

: Required: Yes
: Type: string

The ARN of the MicroVM image.

imageVersion

: Required: Yes
: Type: string

The version of the MicroVM image.

stateReason

: Type: string

The reason for the build state, if applicable.

MicrovmImageHooks

Description

Configuration for hooks invoked during MicroVM image build events such as ready and validate.

Members

ready

: Type: string

The path of the hook invoked when the MicroVM image build is ready.

readyTimeoutInSeconds

: Type: int

The maximum time in seconds for the ready hook to complete.

validate

: Type: string

The path of the hook invoked to validate the MicroVM image build.

validateTimeoutInSeconds

: Type: int

The maximum time in seconds for the validate hook to complete.

MicrovmImageSummary

Description

Contains summary information about a MicroVM image.

Members

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the MicroVM image was created.

imageArn

: Required: Yes
: Type: string

The ARN of the MicroVM image.

latestActiveImageVersion

: Type: string

The latest active version of the MicroVM image.

latestFailedImageVersion

: Type: string

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

name

: Required: Yes
: Type: string

The name of the MicroVM image.

state

: Required: Yes
: Type: string

The current state of the MicroVM image.

MicrovmImageVersionSummary

Description

Contains summary information about a version of a MicroVM image.

Members

additionalOsCapabilities

: Type: Array of strings

Additional OS capabilities granted to the MicroVM runtime environment.

baseImageArn

: Required: Yes
: Type: string

The ARN of the base MicroVM image used.

baseImageVersion

: Type: string

The specific version of the base MicroVM image.

buildRoleArn

: Required: Yes
: Type: string

The ARN of the IAM build role.

codeArtifact

: Required: Yes
: Type: CodeArtifact structure

The code artifact for this version.

cpuConfigurations

: Type: Array of CpuConfiguration structures

The list of supported CPU configurations for the MicroVM.

createdAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the version was created.

description

: Type: string

The description of the version.

egressNetworkConnectors

: Type: Array of strings

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

environmentVariables

: Type: Associative array of custom strings keys (EnvironmentVariableKey) to strings

Environment variables set in the MicroVM runtime environment.

hooks

: Type: Hooks structure

Lifecycle hook configuration for MicroVMs and MicroVM images.

imageArn

: Required: Yes
: Type: string

The ARN of the MicroVM image.

imageVersion

: Required: Yes
: Type: string

The version of the MicroVM image.

logging

: Type: Logging structure

The logging configuration for this version.

resources

: Type: Array of Resources structures

The resource requirements for the MicroVM.

state

: Required: Yes
: Type: string

The current state of the version.

stateReason

: Type: string

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

status

: Required: Yes
: Type: string

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

tags

: Type: Associative array of custom strings keys (TagKey) to strings

Key-value pairs associated with the version.

updatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the version was last updated.

MicrovmItem

Description

Contains summary information about a MicroVM instance.

Members

imageArn

: Required: Yes
: Type: string

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

imageVersion

: Required: Yes
: Type: string

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

microvmId

: Required: Yes
: Type: string

The unique identifier of the MicroVM.

startedAt

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the MicroVM started.

state

: Required: Yes
: Type: string

The current lifecycle state of the MicroVM.

PortRange

Description

Specifies a range of ports.

Members

endPort

: Required: Yes
: Type: int

The ending port number of the range.

startPort

: Required: Yes
: Type: int

The starting port number of the range.

PortSpecification

Description

Specifies which ports are accessible on a MicroVM. Only one of the port specification options can be set.

Members

allPorts

: Type: Unit structure

Indicates that all ports are accessible.

port

: Type: int

A single port number.

range

: Type: PortRange structure

A range of ports.

ResourceConflictException

Description

The resource already exists, or another operation is in progress.

Members

Type

: Type: string

The exception type.

message

: Type: string

ResourceNotFoundException

Description

The specified resource does not exist.

Members

message

: Required: Yes
: Type: string

resourceId

: Type: string

The identifier of the resource that was not found.

resourceType

: Type: string

The type of the resource that was not found.

Resources

Description

Resource requirements for a MicroVM.

Members

minimumMemoryInMiB

: Required: Yes
: Type: int

The minimum amount of memory in MiB to allocate to the MicroVM.

ServiceException

Description

The AWS Lambda MicroVMs service encountered an internal error.

Members

Type

: Type: string

The exception type.

message

: Type: string

ServiceQuotaExceededException

Description

You have exceeded a service quota for Lambda MicroVMs.

Members

message

: Type: string

quotaCode

: Type: string

The quota code of the exceeded service quota.

resourceId

: Type: string

The identifier of the resource that exceeded the quota.

resourceType

: Type: string

The type of the resource that exceeded the quota.

serviceCode

: Type: string

The service code of the exceeded service quota.

SnapshotBuild

Description

Contains size information about a MicroVM image snapshot build.

Members

codeInstallSizeInBytes

: Type: long (int|float)

The size of the installed code in bytes.

diskSnapshotSizeInBytes

: Type: long (int|float)

The size of the disk snapshot in bytes.

memorySnapshotSizeInBytes

: Type: long (int|float)

The size of the memory snapshot in bytes.

ThrottlingException

Description

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

Members

message

: Type: string

quotaCode

: Type: string

The quota code of the throttled service quota.

retryAfterSeconds

: Type: int

The number of seconds to wait before retrying the request.

serviceCode

: Type: string

The service code of the throttled service quota.

TooManyRequestsException

Description

The request throughput limit was exceeded. Retry the request later.

Members

Type

: Type: string

The exception type.

message

: Type: string

Unit

Members

ValidationException

Description

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

Members

message

: Type: string

Lambda MicroVMs 2025-09-09

Operation Summary

Paginators

Operations

CreateMicrovmAuthToken

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateMicrovmImage

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateMicrovmShellAuthToken

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteMicrovmImage

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteMicrovmImageVersion

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetMicrovm

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetMicrovmImage

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetMicrovmImageBuild

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetMicrovmImageVersion

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListManagedMicrovmImageVersions

Parameter Syntax

Parameter Details

Members