View Source AWS.LambdaMicrovms (aws-elixir v1.0.13)

Provides APIs to create, manage, and operate AWS Lambda MicroVMs and their associated MicroVM Image environments.

Link to this section Summary

Functions

Creates an authentication token for accessing a running MicroVM.

Creates a MicroVM image from the specified code artifact and base image.

Creates a shell authentication token for interactive shell access to a running MicroVM.

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

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.

Lists MicroVM images in the account with optional name filtering.

Lists the tags associated with a Lambda MicroVM resource.

Resumes a suspended MicroVM, restoring it to RUNNING state with all state intact.

Runs a new MicroVM from the specified image.

Suspends a running MicroVM, preserving its full memory and disk state.

Adds tags to a Lambda MicroVM resource.

Removes tags from a Lambda MicroVM resource.

Updates the configuration of a MicroVM image and triggers a new version build.

Link to this section Functions

Link to this function

create_microvm_auth_token(client, microvm_identifier, input, options \\ [])

View Source

Creates an authentication token for accessing a running MicroVM.

The token grants access to the specified ports on the MicroVM endpoint.

Link to this function

create_microvm_image(client, input, options \\ [])

View Source

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.

Link to this function

create_microvm_shell_auth_token(client, microvm_identifier, input, options \\ [])

View Source

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.

Link to this function

delete_microvm_image(client, image_identifier, input, options \\ [])

View Source

Deletes a MicroVM image.

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

Link to this function

delete_microvm_image_version(client, image_identifier, image_version, input, options \\ [])

View Source

Deletes a specific version of a MicroVM image.

This operation is idempotent; deleting a version that has already been deleted succeeds without error.

Link to this function

get_microvm(client, microvm_identifier, options \\ [])

View Source

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.

Link to this function

get_microvm_image(client, image_identifier, options \\ [])

View Source

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

Link to this function

get_microvm_image_build(client, build_id, image_identifier, image_version, options \\ [])

View Source

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

Link to this function

get_microvm_image_version(client, image_identifier, image_version, options \\ [])

View Source

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

Link to this function

list_managed_microvm_image_versions(client, image_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists versions of a managed MicroVM image.

We recommend using pagination to ensure that the operation returns quickly and successfully.

Link to this function

list_managed_microvm_images(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists AWS managed MicroVM images available for use as base images.

We recommend using pagination to ensure that the operation returns quickly and successfully.

Link to this function

list_microvm_image_builds(client, image_identifier, image_version, architecture \\ nil, chipset \\ nil, chipset_generation \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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.

Link to this function

list_microvm_image_versions(client, image_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists versions of a MicroVM image.

We recommend using pagination to ensure that the operation returns quickly and successfully.

Link to this function

list_microvm_images(client, max_results \\ nil, name_filter \\ nil, next_token \\ nil, options \\ [])

View Source

Lists MicroVM images in the account with optional name filtering.

We recommend using pagination to ensure that the operation returns quickly and successfully.

Link to this function

list_microvms(client, image_identifier \\ nil, image_version \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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.

Link to this function

list_tags(client, resource, options \\ [])

View Source

Lists the tags associated with a Lambda MicroVM resource.

Link to this function

resume_microvm(client, microvm_identifier, input, options \\ [])

View Source

Resumes a suspended MicroVM, restoring it to RUNNING state with all state intact.

The MicroVM must be in SUSPENDED state.

Link to this function

run_microvm(client, input, options \\ [])

View Source

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.

Link to this function

suspend_microvm(client, microvm_identifier, input, options \\ [])

View Source

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.

Link to this function

tag_resource(client, resource, input, options \\ [])

View Source

Adds tags to a Lambda MicroVM resource.

Link to this function

terminate_microvm(client, microvm_identifier, input, options \\ [])

View Source

Terminates a MicroVM.

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

Link to this function

untag_resource(client, resource, input, options \\ [])

View Source

Removes tags from a Lambda MicroVM resource.

Link to this function

update_microvm_image(client, image_identifier, input, options \\ [])

View Source

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.

Link to this function

update_microvm_image_version(client, image_identifier, image_version, input, options \\ [])

View Source

Updates the status of a specific MicroVM image version.