LambdaMicrovmsClient
Provides APIs to create, manage, and operate AWS Lambda MicroVMs and their associated MicroVM Image environments.
Functions
Creates an authentication token for accessing a running MicroVM. The token grants access to the specified ports on the MicroVM endpoint.
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.
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.
Deletes a MicroVM image. This operation is idempotent; deleting an image that has already been deleted succeeds without error.
Deletes a specific version of a MicroVM image. This operation is idempotent; deleting a version that has already been deleted succeeds without error.
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.
Retrieves the details of a MicroVM image, including its state, versions, and configuration.
Retrieves the details of a specific MicroVM image build, including its state, target architecture, and snapshot information.
Retrieves the details of a specific version of a MicroVM image, including its configuration, state, and build information.
Lists AWS managed MicroVM images available for use as base images. We recommend using pagination to ensure that the operation returns quickly and successfully.
Lists versions of a managed MicroVM image. We recommend using pagination to ensure that the operation returns quickly and successfully.
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.
Lists MicroVM images in the account with optional name filtering. We recommend using pagination to ensure that the operation returns quickly and successfully.
Lists versions of a MicroVM image. We recommend using pagination to ensure that the operation returns quickly and successfully.
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.
Lists the tags associated with a Lambda MicroVM resource.
Resumes a suspended MicroVM, restoring it to RUNNING state with all state intact. The MicroVM must be in SUSPENDED state.
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.
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.
Adds tags to a Lambda MicroVM resource.
Terminates a MicroVM. This operation is idempotent; terminating a MicroVM that has already been terminated succeeds without error.
Removes tags from a Lambda MicroVM resource.
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.
Updates the status of a specific MicroVM image version.
Inherited functions
Creates an authentication token for accessing a running MicroVM. The token grants access to the specified ports on the MicroVM endpoint.
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.
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.
Deletes a MicroVM image. This operation is idempotent; deleting an image that has already been deleted succeeds without error.
Deletes a specific version of a MicroVM image. This operation is idempotent; deleting a version that has already been deleted succeeds without error.
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.
Retrieves the details of a MicroVM image, including its state, versions, and configuration.
Retrieves the details of a specific MicroVM image build, including its state, target architecture, and snapshot information.
Retrieves the details of a specific version of a MicroVM image, including its configuration, state, and build information.
Lists AWS managed MicroVM images available for use as base images. We recommend using pagination to ensure that the operation returns quickly and successfully.
Paginate over ListManagedMicrovmImagesResponse results.
Lists versions of a managed MicroVM image. We recommend using pagination to ensure that the operation returns quickly and successfully.
Paginate over ListManagedMicrovmImageVersionsResponse results.
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.
Paginate over ListMicrovmImageBuildsResponse results.
Lists MicroVM images in the account with optional name filtering. We recommend using pagination to ensure that the operation returns quickly and successfully.
Paginate over ListMicrovmImagesResponse results.
Lists versions of a MicroVM image. We recommend using pagination to ensure that the operation returns quickly and successfully.
Paginate over ListMicrovmImageVersionsResponse results.
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.
Paginate over ListMicrovmsResponse results.
Lists the tags associated with a Lambda MicroVM resource.
Resumes a suspended MicroVM, restoring it to RUNNING state with all state intact. The MicroVM must be in SUSPENDED state.
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.
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.
Adds tags to a Lambda MicroVM resource.
Terminates a MicroVM. This operation is idempotent; terminating a MicroVM that has already been terminated succeeds without error.
Removes tags from a Lambda MicroVM resource.
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.
Updates the status of a specific MicroVM image version.
Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.