2026/06/22 - Lambda MicroVMs - 24 new api methods
Changes Add support for tagging Network Connector resources in AWS Lambda.
Lists AWS managed MicroVM images available for use as base images. We recommend using pagination to ensure that the operation returns quickly and successfully.
See also: AWS API Documentation
Request Syntax
client.list_managed_microvm_images(
maxResults=123,
nextToken='string'
)
integer
The maximum number of results to return in a single call.
string
The pagination token from a previous call. Use this token to retrieve the next page of results.
dict
Response Syntax
{
'nextToken': 'string',
'items': [
{
'imageArn': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
nextToken (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.
items (list) --
The list of managed MicroVM images.
(dict) --
Contains summary information about a managed MicroVM image.
imageArn (string) --
The ARN of the managed MicroVM image.
createdAt (datetime) --
The timestamp when the managed MicroVM image was created.
updatedAt (datetime) --
The timestamp when the managed MicroVM image was last updated.
Updates the status of a specific MicroVM image version.
See also: AWS API Documentation
Request Syntax
client.update_microvm_image_version(
imageIdentifier='string',
imageVersion='string',
status='ACTIVE'|'INACTIVE'
)
string
[REQUIRED]
The unique identifier (ARN or ID) of the MicroVM image.
string
[REQUIRED]
The version of the MicroVM image to update.
string
[REQUIRED]
The new status to set for the MicroVM image version.
dict
Response Syntax
{
'baseImageArn': 'string',
'baseImageVersion': 'string',
'buildRoleArn': 'string',
'description': 'string',
'codeArtifact': {
'uri': 'string'
},
'logging': {
'disabled': {},
'cloudWatch': {
'logGroup': 'string',
'logStream': 'string'
}
},
'egressNetworkConnectors': [
'string',
],
'cpuConfigurations': [
{
'architecture': 'ARM_64'
},
],
'resources': [
{
'minimumMemoryInMiB': 123
},
],
'additionalOsCapabilities': [
'ALL',
],
'hooks': {
'port': 123,
'microvmHooks': {
'run': 'DISABLED'|'ENABLED',
'runTimeoutInSeconds': 123,
'resume': 'DISABLED'|'ENABLED',
'resumeTimeoutInSeconds': 123,
'suspend': 'DISABLED'|'ENABLED',
'suspendTimeoutInSeconds': 123,
'terminate': 'DISABLED'|'ENABLED',
'terminateTimeoutInSeconds': 123
},
'microvmImageHooks': {
'ready': 'DISABLED'|'ENABLED',
'readyTimeoutInSeconds': 123,
'validate': 'DISABLED'|'ENABLED',
'validateTimeoutInSeconds': 123
}
},
'environmentVariables': {
'string': 'string'
},
'imageArn': 'string',
'imageVersion': 'string',
'state': 'PENDING'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'DELETING'|'DELETED'|'DELETE_FAILED',
'status': 'ACTIVE'|'INACTIVE',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'stateReason': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
baseImageArn (string) --
The ARN of the base MicroVM image used.
baseImageVersion (string) --
The specific version of the base MicroVM image.
buildRoleArn (string) --
The ARN of the IAM build role.
description (string) --
The description of the version.
codeArtifact (dict) --
The code artifact for this version.
uri (string) --
The URI of the code artifact, such as an Amazon S3 path or Amazon ECR image URI.
logging (dict) --
The logging configuration for this version.
disabled (dict) --
Specifies that logging is disabled.
cloudWatch (dict) --
Configuration for sending logs to Amazon CloudWatch Logs.
logGroup (string) --
The name of the CloudWatch Logs log group to send logs to.
logStream (string) --
The name of the CloudWatch Logs log stream within the log group.
egressNetworkConnectors (list) --
The list of egress network connectors available to the MicroVM at runtime.
(string) --
cpuConfigurations (list) --
The list of supported CPU configurations for the MicroVM.
(dict) --
Configuration for the CPU architecture of a MicroVM.
architecture (string) --
The CPU architecture.
resources (list) --
The resource requirements for the MicroVM.
(dict) --
Resource requirements for a MicroVM.
minimumMemoryInMiB (integer) --
The minimum amount of memory in MiB to allocate to the MicroVM.
additionalOsCapabilities (list) --
Additional OS capabilities granted to the MicroVM runtime environment.
(string) --
Capability granted to the application when booted
hooks (dict) --
Lifecycle hook configuration for MicroVMs and MicroVM images.
port (integer) --
The port number on which the hooks listener runs.
microvmHooks (dict) --
The lifecycle hooks for MicroVM events.
run (string) --
The path of the hook invoked when the MicroVM starts running.
runTimeoutInSeconds (integer) --
The maximum time in seconds for the run hook to complete.
resume (string) --
The path of the hook invoked when the MicroVM resumes from a suspended state.
resumeTimeoutInSeconds (integer) --
The maximum time in seconds for the resume hook to complete.
suspend (string) --
The path of the hook invoked when the MicroVM is suspended.
suspendTimeoutInSeconds (integer) --
The maximum time in seconds for the suspend hook to complete.
terminate (string) --
The path of the hook invoked when the MicroVM is terminated.
terminateTimeoutInSeconds (integer) --
The maximum time in seconds for the terminate hook to complete.
microvmImageHooks (dict) --
The hooks for MicroVM image build events.
ready (string) --
The path of the hook invoked when the MicroVM image build is ready.
readyTimeoutInSeconds (integer) --
The maximum time in seconds for the ready hook to complete.
validate (string) --
The path of the hook invoked to validate the MicroVM image build.
validateTimeoutInSeconds (integer) --
The maximum time in seconds for the validate hook to complete.
environmentVariables (dict) --
Environment variables set in the MicroVM runtime environment.
(string) --
(string) --
imageArn (string) --
The ARN of the MicroVM image.
imageVersion (string) --
The version of the MicroVM image.
state (string) --
The current state of the version.
status (string) --
The availability status of the version: ACTIVE (can be used by RunMicrovm) or INACTIVE (blocked from launching new MicroVMs).
createdAt (datetime) --
The timestamp when the version was created.
updatedAt (datetime) --
The timestamp when the version was last updated.
stateReason (string) --
The reason for the current state. For example, one or more builds failed.
tags (dict) --
Key-value pairs associated with the version.
(string) --
(string) --
Retrieves the details of a specific version of a MicroVM image, including its configuration, state, and build information.
See also: AWS API Documentation
Request Syntax
client.get_microvm_image_version(
imageIdentifier='string',
imageVersion='string'
)
string
[REQUIRED]
The unique identifier (ARN or ID) of the MicroVM image.
string
[REQUIRED]
The version of the MicroVM image to retrieve.
dict
Response Syntax
{
'baseImageArn': 'string',
'baseImageVersion': 'string',
'buildRoleArn': 'string',
'description': 'string',
'codeArtifact': {
'uri': 'string'
},
'logging': {
'disabled': {},
'cloudWatch': {
'logGroup': 'string',
'logStream': 'string'
}
},
'egressNetworkConnectors': [
'string',
],
'cpuConfigurations': [
{
'architecture': 'ARM_64'
},
],
'resources': [
{
'minimumMemoryInMiB': 123
},
],
'additionalOsCapabilities': [
'ALL',
],
'hooks': {
'port': 123,
'microvmHooks': {
'run': 'DISABLED'|'ENABLED',
'runTimeoutInSeconds': 123,
'resume': 'DISABLED'|'ENABLED',
'resumeTimeoutInSeconds': 123,
'suspend': 'DISABLED'|'ENABLED',
'suspendTimeoutInSeconds': 123,
'terminate': 'DISABLED'|'ENABLED',
'terminateTimeoutInSeconds': 123
},
'microvmImageHooks': {
'ready': 'DISABLED'|'ENABLED',
'readyTimeoutInSeconds': 123,
'validate': 'DISABLED'|'ENABLED',
'validateTimeoutInSeconds': 123
}
},
'environmentVariables': {
'string': 'string'
},
'imageArn': 'string',
'imageVersion': 'string',
'state': 'PENDING'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'DELETING'|'DELETED'|'DELETE_FAILED',
'status': 'ACTIVE'|'INACTIVE',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'stateReason': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
baseImageArn (string) --
The ARN of the base MicroVM image used.
baseImageVersion (string) --
The specific version of the base MicroVM image.
buildRoleArn (string) --
The ARN of the IAM build role.
description (string) --
The description of the version.
codeArtifact (dict) --
The code artifact for this version.
uri (string) --
The URI of the code artifact, such as an Amazon S3 path or Amazon ECR image URI.
logging (dict) --
The logging configuration for this version.
disabled (dict) --
Specifies that logging is disabled.
cloudWatch (dict) --
Configuration for sending logs to Amazon CloudWatch Logs.
logGroup (string) --
The name of the CloudWatch Logs log group to send logs to.
logStream (string) --
The name of the CloudWatch Logs log stream within the log group.
egressNetworkConnectors (list) --
The list of egress network connectors available to the MicroVM at runtime.
(string) --
cpuConfigurations (list) --
The list of supported CPU configurations for the MicroVM.
(dict) --
Configuration for the CPU architecture of a MicroVM.
architecture (string) --
The CPU architecture.
resources (list) --
The resource requirements for the MicroVM.
(dict) --
Resource requirements for a MicroVM.
minimumMemoryInMiB (integer) --
The minimum amount of memory in MiB to allocate to the MicroVM.
additionalOsCapabilities (list) --
Additional OS capabilities granted to the MicroVM runtime environment.
(string) --
Capability granted to the application when booted
hooks (dict) --
Lifecycle hook configuration for MicroVMs and MicroVM images.
port (integer) --
The port number on which the hooks listener runs.
microvmHooks (dict) --
The lifecycle hooks for MicroVM events.
run (string) --
The path of the hook invoked when the MicroVM starts running.
runTimeoutInSeconds (integer) --
The maximum time in seconds for the run hook to complete.
resume (string) --
The path of the hook invoked when the MicroVM resumes from a suspended state.
resumeTimeoutInSeconds (integer) --
The maximum time in seconds for the resume hook to complete.
suspend (string) --
The path of the hook invoked when the MicroVM is suspended.
suspendTimeoutInSeconds (integer) --
The maximum time in seconds for the suspend hook to complete.
terminate (string) --
The path of the hook invoked when the MicroVM is terminated.
terminateTimeoutInSeconds (integer) --
The maximum time in seconds for the terminate hook to complete.
microvmImageHooks (dict) --
The hooks for MicroVM image build events.
ready (string) --
The path of the hook invoked when the MicroVM image build is ready.
readyTimeoutInSeconds (integer) --
The maximum time in seconds for the ready hook to complete.
validate (string) --
The path of the hook invoked to validate the MicroVM image build.
validateTimeoutInSeconds (integer) --
The maximum time in seconds for the validate hook to complete.
environmentVariables (dict) --
Environment variables set in the MicroVM runtime environment.
(string) --
(string) --
imageArn (string) --
The ARN of the MicroVM image.
imageVersion (string) --
The version of the MicroVM image.
state (string) --
The current state of the version.
status (string) --
The availability status of the version: ACTIVE (can be used by RunMicrovm) or INACTIVE (blocked from launching new MicroVMs).
createdAt (datetime) --
The timestamp when the version was created.
updatedAt (datetime) --
The timestamp when the version was last updated.
stateReason (string) --
The reason for the current state. For example, one or more builds failed.
tags (dict) --
Key-value pairs associated with the version.
(string) --
(string) --
Lists versions of a MicroVM image. We recommend using pagination to ensure that the operation returns quickly and successfully.
See also: AWS API Documentation
Request Syntax
client.list_microvm_image_versions(
maxResults=123,
nextToken='string',
imageIdentifier='string'
)
integer
The maximum number of results to return in a single call.
string
The pagination token from a previous call. Use this token to retrieve the next page of results.
string
[REQUIRED]
The unique identifier (ARN or ID) of the MicroVM image to list versions for.
dict
Response Syntax
{
'nextToken': 'string',
'items': [
{
'baseImageArn': 'string',
'baseImageVersion': 'string',
'buildRoleArn': 'string',
'description': 'string',
'codeArtifact': {
'uri': 'string'
},
'logging': {
'disabled': {},
'cloudWatch': {
'logGroup': 'string',
'logStream': 'string'
}
},
'egressNetworkConnectors': [
'string',
],
'cpuConfigurations': [
{
'architecture': 'ARM_64'
},
],
'resources': [
{
'minimumMemoryInMiB': 123
},
],
'additionalOsCapabilities': [
'ALL',
],
'hooks': {
'port': 123,
'microvmHooks': {
'run': 'DISABLED'|'ENABLED',
'runTimeoutInSeconds': 123,
'resume': 'DISABLED'|'ENABLED',
'resumeTimeoutInSeconds': 123,
'suspend': 'DISABLED'|'ENABLED',
'suspendTimeoutInSeconds': 123,
'terminate': 'DISABLED'|'ENABLED',
'terminateTimeoutInSeconds': 123
},
'microvmImageHooks': {
'ready': 'DISABLED'|'ENABLED',
'readyTimeoutInSeconds': 123,
'validate': 'DISABLED'|'ENABLED',
'validateTimeoutInSeconds': 123
}
},
'environmentVariables': {
'string': 'string'
},
'imageArn': 'string',
'imageVersion': 'string',
'state': 'PENDING'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'DELETING'|'DELETED'|'DELETE_FAILED',
'status': 'ACTIVE'|'INACTIVE',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'stateReason': 'string',
'tags': {
'string': 'string'
}
},
]
}
Response Structure
(dict) --
nextToken (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.
items (list) --
The list of MicroVM image versions.
(dict) --
Contains summary information about a version of a MicroVM image.
baseImageArn (string) --
The ARN of the base MicroVM image used.
baseImageVersion (string) --
The specific version of the base MicroVM image.
buildRoleArn (string) --
The ARN of the IAM build role.
description (string) --
The description of the version.
codeArtifact (dict) --
The code artifact for this version.
uri (string) --
The URI of the code artifact, such as an Amazon S3 path or Amazon ECR image URI.
logging (dict) --
The logging configuration for this version.
disabled (dict) --
Specifies that logging is disabled.
cloudWatch (dict) --
Configuration for sending logs to Amazon CloudWatch Logs.
logGroup (string) --
The name of the CloudWatch Logs log group to send logs to.
logStream (string) --
The name of the CloudWatch Logs log stream within the log group.
egressNetworkConnectors (list) --
The list of egress network connectors available to the MicroVM at runtime.
(string) --
cpuConfigurations (list) --
The list of supported CPU configurations for the MicroVM.
(dict) --
Configuration for the CPU architecture of a MicroVM.
architecture (string) --
The CPU architecture.
resources (list) --
The resource requirements for the MicroVM.
(dict) --
Resource requirements for a MicroVM.
minimumMemoryInMiB (integer) --
The minimum amount of memory in MiB to allocate to the MicroVM.
additionalOsCapabilities (list) --
Additional OS capabilities granted to the MicroVM runtime environment.
(string) --
Capability granted to the application when booted
hooks (dict) --
Lifecycle hook configuration for MicroVMs and MicroVM images.
port (integer) --
The port number on which the hooks listener runs.
microvmHooks (dict) --
The lifecycle hooks for MicroVM events.
run (string) --
The path of the hook invoked when the MicroVM starts running.
runTimeoutInSeconds (integer) --
The maximum time in seconds for the run hook to complete.
resume (string) --
The path of the hook invoked when the MicroVM resumes from a suspended state.
resumeTimeoutInSeconds (integer) --
The maximum time in seconds for the resume hook to complete.
suspend (string) --
The path of the hook invoked when the MicroVM is suspended.
suspendTimeoutInSeconds (integer) --
The maximum time in seconds for the suspend hook to complete.
terminate (string) --
The path of the hook invoked when the MicroVM is terminated.
terminateTimeoutInSeconds (integer) --
The maximum time in seconds for the terminate hook to complete.
microvmImageHooks (dict) --
The hooks for MicroVM image build events.
ready (string) --
The path of the hook invoked when the MicroVM image build is ready.
readyTimeoutInSeconds (integer) --
The maximum time in seconds for the ready hook to complete.
validate (string) --
The path of the hook invoked to validate the MicroVM image build.
validateTimeoutInSeconds (integer) --
The maximum time in seconds for the validate hook to complete.
environmentVariables (dict) --
Environment variables set in the MicroVM runtime environment.
(string) --
(string) --
imageArn (string) --
The ARN of the MicroVM image.
imageVersion (string) --
The version of the MicroVM image.
state (string) --
The current state of the version.
status (string) --
The availability status of the version: ACTIVE (can be used by RunMicrovm) or INACTIVE (blocked from launching new MicroVMs).
createdAt (datetime) --
The timestamp when the version was created.
updatedAt (datetime) --
The timestamp when the version was last updated.
stateReason (string) --
The reason for the current state. For example, one or more builds failed.
tags (dict) --
Key-value pairs associated with the version.
(string) --
(string) --
Lists MicroVM images in the account with optional name filtering. We recommend using pagination to ensure that the operation returns quickly and successfully.
See also: AWS API Documentation
Request Syntax
client.list_microvm_images(
maxResults=123,
nextToken='string',
nameFilter='string'
)
integer
The maximum number of results to return in a single call.
string
The pagination token from a previous call. Use this token to retrieve the next page of results.
string
Filters images whose name contains the specified string.
dict
Response Syntax
{
'nextToken': 'string',
'items': [
{
'imageArn': 'string',
'name': 'string',
'state': 'CREATING'|'CREATED'|'CREATE_FAILED'|'UPDATING'|'UPDATED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED'|'DELETED',
'latestActiveImageVersion': 'string',
'latestFailedImageVersion': 'string',
'createdAt': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
nextToken (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.
items (list) --
The list of MicroVM images.
(dict) --
Contains summary information about a MicroVM image.
imageArn (string) --
The ARN of the MicroVM image.
name (string) --
The name of the MicroVM image.
state (string) --
The current state of the MicroVM image.
latestActiveImageVersion (string) --
The latest active version of the MicroVM image.
latestFailedImageVersion (string) --
The latest failed version of the MicroVM image, if any.
createdAt (datetime) --
The timestamp when the MicroVM image was created.
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.
See also: AWS API Documentation
Request Syntax
client.list_microvm_image_builds(
maxResults=123,
nextToken='string',
imageIdentifier='string',
imageVersion='string',
architecture='ARM_64',
chipset='GRAVITON',
chipsetGeneration='string'
)
integer
The maximum number of results to return in a single call.
string
The pagination token from a previous call. Use this token to retrieve the next page of results.
string
[REQUIRED]
The unique identifier (ARN or ID) of the MicroVM image.
string
[REQUIRED]
The version of the MicroVM image to list builds for.
string
Filters builds by target CPU architecture.
string
Filters builds by target chipset.
string
Filters builds by target chipset generation.
dict
Response Syntax
{
'nextToken': 'string',
'items': [
{
'imageArn': 'string',
'imageVersion': 'string',
'buildId': 'string',
'buildState': 'PENDING'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED',
'architecture': 'ARM_64',
'chipset': 'GRAVITON',
'chipsetGeneration': 'string',
'stateReason': 'string',
'createdAt': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
nextToken (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.
items (list) --
The list of MicroVM image builds.
(dict) --
Contains summary information about a MicroVM image build.
imageArn (string) --
The ARN of the MicroVM image.
imageVersion (string) --
The version of the MicroVM image.
buildId (string) --
The build request ID.
buildState (string) --
The current state of the build.
architecture (string) --
The target CPU architecture for the build. Supported value: ARM_64.
chipset (string) --
The target chipset for the build.
chipsetGeneration (string) --
The target chipset generation for the build.
stateReason (string) --
The reason for the build state, if applicable.
createdAt (datetime) --
The timestamp when the build was created.
Lists versions of a managed MicroVM image. We recommend using pagination to ensure that the operation returns quickly and successfully.
See also: AWS API Documentation
Request Syntax
client.list_managed_microvm_image_versions(
maxResults=123,
nextToken='string',
imageIdentifier='string'
)
integer
The maximum number of results to return in a single call.
string
The pagination token from a previous call. Use this token to retrieve the next page of results.
string
[REQUIRED]
The unique identifier (ARN or ID) of the managed MicroVM image to list versions for.
dict
Response Syntax
{
'nextToken': 'string',
'items': [
{
'imageArn': 'string',
'imageVersion': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
nextToken (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.
items (list) --
The list of managed MicroVM image versions.
(dict) --
Contains version information for a managed MicroVM image.
imageArn (string) --
The ARN of the managed MicroVM image.
imageVersion (string) --
The version of the managed MicroVM image.
createdAt (datetime) --
The timestamp when the version was created.
updatedAt (datetime) --
The timestamp when the version was last updated.
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.
See also: AWS API Documentation
Request Syntax
client.create_microvm_image(
baseImageArn='string',
baseImageVersion='string',
buildRoleArn='string',
description='string',
codeArtifact={
'uri': 'string'
},
logging={
'disabled': {}
,
'cloudWatch': {
'logGroup': 'string',
'logStream': 'string'
}
},
egressNetworkConnectors=[
'string',
],
cpuConfigurations=[
{
'architecture': 'ARM_64'
},
],
resources=[
{
'minimumMemoryInMiB': 123
},
],
additionalOsCapabilities=[
'ALL',
],
hooks={
'port': 123,
'microvmHooks': {
'run': 'DISABLED'|'ENABLED',
'runTimeoutInSeconds': 123,
'resume': 'DISABLED'|'ENABLED',
'resumeTimeoutInSeconds': 123,
'suspend': 'DISABLED'|'ENABLED',
'suspendTimeoutInSeconds': 123,
'terminate': 'DISABLED'|'ENABLED',
'terminateTimeoutInSeconds': 123
},
'microvmImageHooks': {
'ready': 'DISABLED'|'ENABLED',
'readyTimeoutInSeconds': 123,
'validate': 'DISABLED'|'ENABLED',
'validateTimeoutInSeconds': 123
}
},
environmentVariables={
'string': 'string'
},
name='string',
tags={
'string': 'string'
},
clientToken='string'
)
string
[REQUIRED]
The ARN of the Lambda-managed base MicroVM image to build upon. Use ListManagedMicrovmImages to discover available base images.
string
The specific version of the base MicroVM image to use.
string
[REQUIRED]
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.
string
A description of the MicroVM image.
dict
[REQUIRED]
The code artifact containing the application code and metadata for the MicroVM image.
uri (string) --
The URI of the code artifact, such as an Amazon S3 path or Amazon ECR image URI.
dict
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.
disabled (dict) --
Specifies that logging is disabled.
cloudWatch (dict) --
Configuration for sending logs to Amazon CloudWatch Logs.
logGroup (string) --
The name of the CloudWatch Logs log group to send logs to.
logStream (string) --
The name of the CloudWatch Logs log stream within the log group.
list
The list of egress network connectors available to the MicroVM at runtime.
(string) --
list
The list of supported CPU configurations for the MicroVM.
(dict) --
Configuration for the CPU architecture of a MicroVM.
architecture (string) -- [REQUIRED]
The CPU architecture.
list
The resource requirements for the MicroVM.
(dict) --
Resource requirements for a MicroVM.
minimumMemoryInMiB (integer) -- [REQUIRED]
The minimum amount of memory in MiB to allocate to the MicroVM.
list
Additional OS capabilities granted to the MicroVM runtime environment.
(string) --
Capability granted to the application when booted
dict
Lifecycle hook configuration for MicroVMs and MicroVM images.
port (integer) --
The port number on which the hooks listener runs.
microvmHooks (dict) --
The lifecycle hooks for MicroVM events.
run (string) --
The path of the hook invoked when the MicroVM starts running.
runTimeoutInSeconds (integer) --
The maximum time in seconds for the run hook to complete.
resume (string) --
The path of the hook invoked when the MicroVM resumes from a suspended state.
resumeTimeoutInSeconds (integer) --
The maximum time in seconds for the resume hook to complete.
suspend (string) --
The path of the hook invoked when the MicroVM is suspended.
suspendTimeoutInSeconds (integer) --
The maximum time in seconds for the suspend hook to complete.
terminate (string) --
The path of the hook invoked when the MicroVM is terminated.
terminateTimeoutInSeconds (integer) --
The maximum time in seconds for the terminate hook to complete.
microvmImageHooks (dict) --
The hooks for MicroVM image build events.
ready (string) --
The path of the hook invoked when the MicroVM image build is ready.
readyTimeoutInSeconds (integer) --
The maximum time in seconds for the ready hook to complete.
validate (string) --
The path of the hook invoked to validate the MicroVM image build.
validateTimeoutInSeconds (integer) --
The maximum time in seconds for the validate hook to complete.
dict
Environment variables set in the MicroVM runtime environment.
(string) --
(string) --
string
[REQUIRED]
The name of the MicroVM image. Must be unique within the AWS account.
dict
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.
(string) --
(string) --
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.
This field is autopopulated if not provided.
dict
Response Syntax
{
'imageArn': 'string',
'name': 'string',
'state': 'CREATING'|'CREATED'|'CREATE_FAILED'|'UPDATING'|'UPDATED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED'|'DELETED',
'latestActiveImageVersion': 'string',
'latestFailedImageVersion': 'string',
'createdAt': datetime(2015, 1, 1),
'baseImageArn': 'string',
'baseImageVersion': 'string',
'buildRoleArn': 'string',
'description': 'string',
'codeArtifact': {
'uri': 'string'
},
'logging': {
'disabled': {},
'cloudWatch': {
'logGroup': 'string',
'logStream': 'string'
}
},
'egressNetworkConnectors': [
'string',
],
'cpuConfigurations': [
{
'architecture': 'ARM_64'
},
],
'resources': [
{
'minimumMemoryInMiB': 123
},
],
'additionalOsCapabilities': [
'ALL',
],
'hooks': {
'port': 123,
'microvmHooks': {
'run': 'DISABLED'|'ENABLED',
'runTimeoutInSeconds': 123,
'resume': 'DISABLED'|'ENABLED',
'resumeTimeoutInSeconds': 123,
'suspend': 'DISABLED'|'ENABLED',
'suspendTimeoutInSeconds': 123,
'terminate': 'DISABLED'|'ENABLED',
'terminateTimeoutInSeconds': 123
},
'microvmImageHooks': {
'ready': 'DISABLED'|'ENABLED',
'readyTimeoutInSeconds': 123,
'validate': 'DISABLED'|'ENABLED',
'validateTimeoutInSeconds': 123
}
},
'environmentVariables': {
'string': 'string'
},
'tags': {
'string': 'string'
},
'updatedAt': datetime(2015, 1, 1),
'imageVersion': 'string'
}
Response Structure
(dict) --
imageArn (string) --
The ARN of the created MicroVM image.
name (string) --
The name of the MicroVM image.
state (string) --
The current state of the MicroVM image.
latestActiveImageVersion (string) --
The latest active version of the MicroVM image.
latestFailedImageVersion (string) --
The latest failed version of the MicroVM image, if any.
createdAt (datetime) --
The timestamp when the MicroVM image was created.
baseImageArn (string) --
The ARN of the base MicroVM image.
baseImageVersion (string) --
The specific version of the base MicroVM image.
buildRoleArn (string) --
The ARN of the IAM build role.
description (string) --
The description of the MicroVM image.
codeArtifact (dict) --
The code artifact containing the application code and metadata for the MicroVM image.
uri (string) --
The URI of the code artifact, such as an Amazon S3 path or Amazon ECR image URI.
logging (dict) --
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.
disabled (dict) --
Specifies that logging is disabled.
cloudWatch (dict) --
Configuration for sending logs to Amazon CloudWatch Logs.
logGroup (string) --
The name of the CloudWatch Logs log group to send logs to.
logStream (string) --
The name of the CloudWatch Logs log stream within the log group.
egressNetworkConnectors (list) --
The list of egress network connectors available to the MicroVM at runtime.
(string) --
cpuConfigurations (list) --
The list of supported CPU configurations for the MicroVM.
(dict) --
Configuration for the CPU architecture of a MicroVM.
architecture (string) --
The CPU architecture.
resources (list) --
The resource requirements for the MicroVM.
(dict) --
Resource requirements for a MicroVM.
minimumMemoryInMiB (integer) --
The minimum amount of memory in MiB to allocate to the MicroVM.
additionalOsCapabilities (list) --
Additional OS capabilities granted to the MicroVM runtime environment.
(string) --
Capability granted to the application when booted
hooks (dict) --
Lifecycle hook configuration for MicroVMs and MicroVM images.
port (integer) --
The port number on which the hooks listener runs.
microvmHooks (dict) --
The lifecycle hooks for MicroVM events.
run (string) --
The path of the hook invoked when the MicroVM starts running.
runTimeoutInSeconds (integer) --
The maximum time in seconds for the run hook to complete.
resume (string) --
The path of the hook invoked when the MicroVM resumes from a suspended state.
resumeTimeoutInSeconds (integer) --
The maximum time in seconds for the resume hook to complete.
suspend (string) --
The path of the hook invoked when the MicroVM is suspended.
suspendTimeoutInSeconds (integer) --
The maximum time in seconds for the suspend hook to complete.
terminate (string) --
The path of the hook invoked when the MicroVM is terminated.
terminateTimeoutInSeconds (integer) --
The maximum time in seconds for the terminate hook to complete.
microvmImageHooks (dict) --
The hooks for MicroVM image build events.
ready (string) --
The path of the hook invoked when the MicroVM image build is ready.
readyTimeoutInSeconds (integer) --
The maximum time in seconds for the ready hook to complete.
validate (string) --
The path of the hook invoked to validate the MicroVM image build.
validateTimeoutInSeconds (integer) --
The maximum time in seconds for the validate hook to complete.
environmentVariables (dict) --
Environment variables set in the MicroVM runtime environment.
(string) --
(string) --
tags (dict) --
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.
(string) --
(string) --
updatedAt (datetime) --
The timestamp when the MicroVM image was last updated.
imageVersion (string) --
The version of the MicroVM image.
Resumes a suspended MicroVM, restoring it to RUNNING state with all state intact. The MicroVM must be in SUSPENDED state.
See also: AWS API Documentation
Request Syntax
client.resume_microvm(
microvmIdentifier='string'
)
string
[REQUIRED]
The ID of the MicroVM to resume.
dict
Response Syntax
{}
Response Structure
(dict) --
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.
See also: AWS API Documentation
Request Syntax
client.list_microvms(
maxResults=123,
nextToken='string',
imageIdentifier='string',
imageVersion='string'
)
integer
The maximum number of results to return in a single call.
string
The pagination token from a previous call. Use this token to retrieve the next page of results.
string
Optional filter to list only MicroVMs running the specified image.
string
Optional filter to list only MicroVMs running the specified image version.
dict
Response Syntax
{
'nextToken': 'string',
'items': [
{
'microvmId': 'string',
'state': 'PENDING'|'RUNNING'|'SUSPENDING'|'SUSPENDED'|'TERMINATING'|'TERMINATED',
'imageArn': 'string',
'imageVersion': 'string',
'startedAt': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
nextToken (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.
items (list) --
The list of MicroVMs.
(dict) --
Contains summary information about a MicroVM instance.
microvmId (string) --
The unique identifier of the MicroVM.
state (string) --
The current lifecycle state of the MicroVM.
imageArn (string) --
The ARN of the MicroVM image used to run this MicroVM.
imageVersion (string) --
The version of the MicroVM image used to run this MicroVM.
startedAt (datetime) --
The timestamp when the MicroVM started.
Creates an authentication token for accessing a running MicroVM. The token grants access to the specified ports on the MicroVM endpoint.
See also: AWS API Documentation
Request Syntax
client.create_microvm_auth_token(
microvmIdentifier='string',
expirationInMinutes=123,
allowedPorts=[
{
'port': 123,
'range': {
'startPort': 123,
'endPort': 123
},
'allPorts': {}
},
]
)
string
[REQUIRED]
The ID of the MicroVM to create an authentication token for.
integer
[REQUIRED]
The duration in minutes before the authentication token expires. Maximum: 60 minutes.
list
[REQUIRED]
The list of port specifications that the authentication token grants access to on the MicroVM.
(dict) --
Specifies which ports are accessible on a MicroVM. Only one of the port specification options can be set.
port (integer) --
A single port number.
range (dict) --
A range of ports.
startPort (integer) -- [REQUIRED]
The starting port number of the range.
endPort (integer) -- [REQUIRED]
The ending port number of the range.
allPorts (dict) --
Indicates that all ports are accessible.
dict
Response Syntax
{
'authToken': {
'string': 'string'
}
}
Response Structure
(dict) --
authToken (dict) --
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.
(string) --
(string) --
Retrieves the details of a MicroVM image, including its state, versions, and configuration.
See also: AWS API Documentation
Request Syntax
client.get_microvm_image(
imageIdentifier='string'
)
string
[REQUIRED]
The unique identifier (ARN or ID) of the MicroVM image to retrieve.
dict
Response Syntax
{
'imageArn': 'string',
'name': 'string',
'state': 'CREATING'|'CREATED'|'CREATE_FAILED'|'UPDATING'|'UPDATED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED'|'DELETED',
'latestActiveImageVersion': 'string',
'latestFailedImageVersion': 'string',
'createdAt': datetime(2015, 1, 1),
'tags': {
'string': 'string'
},
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
imageArn (string) --
The ARN of the MicroVM image.
name (string) --
The name of the MicroVM image.
state (string) --
The current state of the MicroVM image.
latestActiveImageVersion (string) --
The latest active version of the MicroVM image.
latestFailedImageVersion (string) --
The latest failed version of the MicroVM image, if any.
createdAt (datetime) --
The timestamp when the MicroVM image was created.
tags (dict) --
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.
(string) --
(string) --
updatedAt (datetime) --
The timestamp when the MicroVM image was last updated.
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.
See also: AWS API Documentation
Request Syntax
client.suspend_microvm(
microvmIdentifier='string'
)
string
[REQUIRED]
The ID of the MicroVM to suspend.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists the tags associated with a Lambda MicroVM resource.
See also: AWS API Documentation
Request Syntax
client.list_tags(
Resource='string'
)
string
[REQUIRED]
The ARN of the resource to list tags for.
dict
Response Syntax
{
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Tags (dict) --
The key-value pairs of tags associated with the resource.
(string) --
(string) --
Terminates a MicroVM. This operation is idempotent; terminating a MicroVM that has already been terminated succeeds without error.
See also: AWS API Documentation
Request Syntax
client.terminate_microvm(
microvmIdentifier='string'
)
string
[REQUIRED]
The ID of the MicroVM to terminate.
dict
Response Syntax
{}
Response Structure
(dict) --
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.
See also: AWS API Documentation
Request Syntax
client.run_microvm(
ingressNetworkConnectors=[
'string',
],
egressNetworkConnectors=[
'string',
],
imageIdentifier='string',
imageVersion='string',
executionRoleArn='string',
idlePolicy={
'maxIdleDurationSeconds': 123,
'suspendedDurationSeconds': 123,
'autoResumeEnabled': True|False
},
logging={
'disabled': {}
,
'cloudWatch': {
'logGroup': 'string',
'logStream': 'string'
}
},
runHookPayload='string',
maximumDurationInSeconds=123,
clientToken='string'
)
list
The list of ingress network connectors to configure for the MicroVM.
(string) --
list
The list of egress network connectors to configure for the MicroVM.
(string) --
string
[REQUIRED]
The identifier (ARN or ID) of the MicroVM image to run.
string
The version of the MicroVM image to run.
string
The ARN of the IAM role to be assumed by the MicroVM during execution.
dict
Configuration to control auto-suspend and auto-resume behavior.
maxIdleDurationSeconds (integer) -- [REQUIRED]
The maximum time in seconds that a MicroVM can remain idle before it is automatically suspended.
suspendedDurationSeconds (integer) -- [REQUIRED]
The maximum time in seconds that a MicroVM can remain suspended before it is automatically terminated.
autoResumeEnabled (boolean) -- [REQUIRED]
Indicates whether the MicroVM automatically resumes when it receives a request while suspended.
dict
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.
disabled (dict) --
Specifies that logging is disabled.
cloudWatch (dict) --
Configuration for sending logs to Amazon CloudWatch Logs.
logGroup (string) --
The name of the CloudWatch Logs log group to send logs to.
logStream (string) --
The name of the CloudWatch Logs log stream within the log group.
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.
integer
The maximum duration in seconds that the MicroVM can exist before being terminated by the platform. Valid range: 1–28,800 (8 hours).
string
A unique, case-sensitive identifier you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'microvmId': 'string',
'state': 'PENDING'|'RUNNING'|'SUSPENDING'|'SUSPENDED'|'TERMINATING'|'TERMINATED',
'endpoint': 'string',
'imageArn': 'string',
'imageVersion': 'string',
'executionRoleArn': 'string',
'idlePolicy': {
'maxIdleDurationSeconds': 123,
'suspendedDurationSeconds': 123,
'autoResumeEnabled': True|False
},
'maximumDurationInSeconds': 123,
'startedAt': datetime(2015, 1, 1),
'terminatedAt': datetime(2015, 1, 1),
'stateReason': 'string',
'ingressNetworkConnectors': [
'string',
],
'egressNetworkConnectors': [
'string',
]
}
Response Structure
(dict) --
microvmId (string) --
The unique identifier of the MicroVM.
state (string) --
The current lifecycle state of the MicroVM.
endpoint (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.
imageArn (string) --
The ARN of the MicroVM image used to run this MicroVM.
imageVersion (string) --
The version of the MicroVM image used to run this MicroVM.
executionRoleArn (string) --
The ARN of the IAM execution role assumed by the MicroVM.
idlePolicy (dict) --
The idle policy configuration of the MicroVM.
maxIdleDurationSeconds (integer) --
The maximum time in seconds that a MicroVM can remain idle before it is automatically suspended.
suspendedDurationSeconds (integer) --
The maximum time in seconds that a MicroVM can remain suspended before it is automatically terminated.
autoResumeEnabled (boolean) --
Indicates whether the MicroVM automatically resumes when it receives a request while suspended.
maximumDurationInSeconds (integer) --
The maximum duration in seconds that the MicroVM can exist.
startedAt (datetime) --
The timestamp when the MicroVM first started.
terminatedAt (datetime) --
The timestamp when the MicroVM terminated.
stateReason (string) --
The reason for why the MicroVM is in the current state.
ingressNetworkConnectors (list) --
The list of ingress network connectors configured for the MicroVM.
(string) --
egressNetworkConnectors (list) --
The list of egress network connectors configured for the MicroVM.
(string) --
Adds tags to a Lambda MicroVM resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
Resource='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The ARN of the resource to tag.
dict
[REQUIRED]
The key-value pairs of tags to add to the resource.
(string) --
(string) --
None
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.
See also: AWS API Documentation
Request Syntax
client.create_microvm_shell_auth_token(
microvmIdentifier='string',
expirationInMinutes=123
)
string
[REQUIRED]
The ID of the MicroVM to create a shell authentication token for.
integer
[REQUIRED]
The duration in minutes before the shell authentication token expires.
dict
Response Syntax
{
'authToken': {
'string': 'string'
}
}
Response Structure
(dict) --
authToken (dict) --
The generated shell authentication token key-value pairs for accessing the MicroVM.
(string) --
(string) --
Deletes a specific version of a MicroVM image. This operation is idempotent; deleting a version that has already been deleted succeeds without error.
See also: AWS API Documentation
Request Syntax
client.delete_microvm_image_version(
imageIdentifier='string',
imageVersion='string'
)
string
[REQUIRED]
The unique identifier (ARN or ID) of the MicroVM image.
string
[REQUIRED]
The version of the MicroVM image to delete.
dict
Response Syntax
{
'imageIdentifier': 'string',
'imageVersion': 'string',
'state': 'PENDING'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'DELETING'|'DELETED'|'DELETE_FAILED'
}
Response Structure
(dict) --
imageIdentifier (string) --
The identifier of the MicroVM image.
imageVersion (string) --
The version that was deleted.
state (string) --
The current state of the MicroVM image version after deletion.
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.
See also: AWS API Documentation
Request Syntax
client.update_microvm_image(
baseImageArn='string',
baseImageVersion='string',
buildRoleArn='string',
description='string',
codeArtifact={
'uri': 'string'
},
logging={
'disabled': {}
,
'cloudWatch': {
'logGroup': 'string',
'logStream': 'string'
}
},
egressNetworkConnectors=[
'string',
],
cpuConfigurations=[
{
'architecture': 'ARM_64'
},
],
resources=[
{
'minimumMemoryInMiB': 123
},
],
additionalOsCapabilities=[
'ALL',
],
hooks={
'port': 123,
'microvmHooks': {
'run': 'DISABLED'|'ENABLED',
'runTimeoutInSeconds': 123,
'resume': 'DISABLED'|'ENABLED',
'resumeTimeoutInSeconds': 123,
'suspend': 'DISABLED'|'ENABLED',
'suspendTimeoutInSeconds': 123,
'terminate': 'DISABLED'|'ENABLED',
'terminateTimeoutInSeconds': 123
},
'microvmImageHooks': {
'ready': 'DISABLED'|'ENABLED',
'readyTimeoutInSeconds': 123,
'validate': 'DISABLED'|'ENABLED',
'validateTimeoutInSeconds': 123
}
},
environmentVariables={
'string': 'string'
},
imageIdentifier='string',
clientToken='string'
)
string
[REQUIRED]
The ARN of the base MicroVM image.
string
The specific version of the base MicroVM image to use.
string
[REQUIRED]
The ARN of the IAM build role.
string
The description of the MicroVM image.
dict
[REQUIRED]
The code artifact containing the application code and metadata for the MicroVM image.
uri (string) --
The URI of the code artifact, such as an Amazon S3 path or Amazon ECR image URI.
dict
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.
disabled (dict) --
Specifies that logging is disabled.
cloudWatch (dict) --
Configuration for sending logs to Amazon CloudWatch Logs.
logGroup (string) --
The name of the CloudWatch Logs log group to send logs to.
logStream (string) --
The name of the CloudWatch Logs log stream within the log group.
list
The list of egress network connectors available to the MicroVM at runtime.
(string) --
list
The list of supported CPU configurations for the MicroVM.
(dict) --
Configuration for the CPU architecture of a MicroVM.
architecture (string) -- [REQUIRED]
The CPU architecture.
list
The resource requirements for the MicroVM.
(dict) --
Resource requirements for a MicroVM.
minimumMemoryInMiB (integer) -- [REQUIRED]
The minimum amount of memory in MiB to allocate to the MicroVM.
list
Additional OS capabilities granted to the MicroVM runtime environment.
(string) --
Capability granted to the application when booted
dict
Lifecycle hook configuration for MicroVMs and MicroVM images.
port (integer) --
The port number on which the hooks listener runs.
microvmHooks (dict) --
The lifecycle hooks for MicroVM events.
run (string) --
The path of the hook invoked when the MicroVM starts running.
runTimeoutInSeconds (integer) --
The maximum time in seconds for the run hook to complete.
resume (string) --
The path of the hook invoked when the MicroVM resumes from a suspended state.
resumeTimeoutInSeconds (integer) --
The maximum time in seconds for the resume hook to complete.
suspend (string) --
The path of the hook invoked when the MicroVM is suspended.
suspendTimeoutInSeconds (integer) --
The maximum time in seconds for the suspend hook to complete.
terminate (string) --
The path of the hook invoked when the MicroVM is terminated.
terminateTimeoutInSeconds (integer) --
The maximum time in seconds for the terminate hook to complete.
microvmImageHooks (dict) --
The hooks for MicroVM image build events.
ready (string) --
The path of the hook invoked when the MicroVM image build is ready.
readyTimeoutInSeconds (integer) --
The maximum time in seconds for the ready hook to complete.
validate (string) --
The path of the hook invoked to validate the MicroVM image build.
validateTimeoutInSeconds (integer) --
The maximum time in seconds for the validate hook to complete.
dict
Environment variables set in the MicroVM runtime environment.
(string) --
(string) --
string
[REQUIRED]
The unique identifier (ARN or ID) of the MicroVM image to update.
string
A unique, case-sensitive identifier you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'imageArn': 'string',
'name': 'string',
'state': 'CREATING'|'CREATED'|'CREATE_FAILED'|'UPDATING'|'UPDATED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED'|'DELETED',
'latestActiveImageVersion': 'string',
'latestFailedImageVersion': 'string',
'createdAt': datetime(2015, 1, 1),
'baseImageArn': 'string',
'baseImageVersion': 'string',
'buildRoleArn': 'string',
'description': 'string',
'codeArtifact': {
'uri': 'string'
},
'logging': {
'disabled': {},
'cloudWatch': {
'logGroup': 'string',
'logStream': 'string'
}
},
'egressNetworkConnectors': [
'string',
],
'cpuConfigurations': [
{
'architecture': 'ARM_64'
},
],
'resources': [
{
'minimumMemoryInMiB': 123
},
],
'additionalOsCapabilities': [
'ALL',
],
'hooks': {
'port': 123,
'microvmHooks': {
'run': 'DISABLED'|'ENABLED',
'runTimeoutInSeconds': 123,
'resume': 'DISABLED'|'ENABLED',
'resumeTimeoutInSeconds': 123,
'suspend': 'DISABLED'|'ENABLED',
'suspendTimeoutInSeconds': 123,
'terminate': 'DISABLED'|'ENABLED',
'terminateTimeoutInSeconds': 123
},
'microvmImageHooks': {
'ready': 'DISABLED'|'ENABLED',
'readyTimeoutInSeconds': 123,
'validate': 'DISABLED'|'ENABLED',
'validateTimeoutInSeconds': 123
}
},
'environmentVariables': {
'string': 'string'
},
'updatedAt': datetime(2015, 1, 1),
'imageVersion': 'string'
}
Response Structure
(dict) --
imageArn (string) --
The ARN of the MicroVM image.
name (string) --
The name of the MicroVM image.
state (string) --
The current state of the MicroVM image.
latestActiveImageVersion (string) --
The latest active version of the MicroVM image.
latestFailedImageVersion (string) --
The latest failed version of the MicroVM image, if any.
createdAt (datetime) --
The timestamp when the MicroVM image was created.
baseImageArn (string) --
The ARN of the base MicroVM image.
baseImageVersion (string) --
The specific version of the base MicroVM image.
buildRoleArn (string) --
The ARN of the IAM build role.
description (string) --
The description of the MicroVM image.
codeArtifact (dict) --
The code artifact containing the application code and metadata for the MicroVM image.
uri (string) --
The URI of the code artifact, such as an Amazon S3 path or Amazon ECR image URI.
logging (dict) --
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.
disabled (dict) --
Specifies that logging is disabled.
cloudWatch (dict) --
Configuration for sending logs to Amazon CloudWatch Logs.
logGroup (string) --
The name of the CloudWatch Logs log group to send logs to.
logStream (string) --
The name of the CloudWatch Logs log stream within the log group.
egressNetworkConnectors (list) --
The list of egress network connectors available to the MicroVM at runtime.
(string) --
cpuConfigurations (list) --
The list of supported CPU configurations for the MicroVM.
(dict) --
Configuration for the CPU architecture of a MicroVM.
architecture (string) --
The CPU architecture.
resources (list) --
The resource requirements for the MicroVM.
(dict) --
Resource requirements for a MicroVM.
minimumMemoryInMiB (integer) --
The minimum amount of memory in MiB to allocate to the MicroVM.
additionalOsCapabilities (list) --
Additional OS capabilities granted to the MicroVM runtime environment.
(string) --
Capability granted to the application when booted
hooks (dict) --
Lifecycle hook configuration for MicroVMs and MicroVM images.
port (integer) --
The port number on which the hooks listener runs.
microvmHooks (dict) --
The lifecycle hooks for MicroVM events.
run (string) --
The path of the hook invoked when the MicroVM starts running.
runTimeoutInSeconds (integer) --
The maximum time in seconds for the run hook to complete.
resume (string) --
The path of the hook invoked when the MicroVM resumes from a suspended state.
resumeTimeoutInSeconds (integer) --
The maximum time in seconds for the resume hook to complete.
suspend (string) --
The path of the hook invoked when the MicroVM is suspended.
suspendTimeoutInSeconds (integer) --
The maximum time in seconds for the suspend hook to complete.
terminate (string) --
The path of the hook invoked when the MicroVM is terminated.
terminateTimeoutInSeconds (integer) --
The maximum time in seconds for the terminate hook to complete.
microvmImageHooks (dict) --
The hooks for MicroVM image build events.
ready (string) --
The path of the hook invoked when the MicroVM image build is ready.
readyTimeoutInSeconds (integer) --
The maximum time in seconds for the ready hook to complete.
validate (string) --
The path of the hook invoked to validate the MicroVM image build.
validateTimeoutInSeconds (integer) --
The maximum time in seconds for the validate hook to complete.
environmentVariables (dict) --
Environment variables set in the MicroVM runtime environment.
(string) --
(string) --
updatedAt (datetime) --
The timestamp when the MicroVM image was last updated.
imageVersion (string) --
The version of the MicroVM image.
Retrieves the details of a specific MicroVM image build, including its state, target architecture, and snapshot information.
See also: AWS API Documentation
Request Syntax
client.get_microvm_image_build(
imageIdentifier='string',
imageVersion='string',
buildId='string'
)
string
[REQUIRED]
The unique identifier (ARN or ID) of the MicroVM image.
string
[REQUIRED]
The version of the MicroVM image.
string
[REQUIRED]
The unique identifier of the build to retrieve.
dict
Response Syntax
{
'imageArn': 'string',
'imageVersion': 'string',
'buildId': 'string',
'buildState': 'PENDING'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED',
'architecture': 'ARM_64',
'chipset': 'GRAVITON',
'chipsetGeneration': 'string',
'stateReason': 'string',
'createdAt': datetime(2015, 1, 1),
'snapshotBuild': {
'memorySnapshotSizeInBytes': 123,
'codeInstallSizeInBytes': 123,
'diskSnapshotSizeInBytes': 123
}
}
Response Structure
(dict) --
imageArn (string) --
The ARN of the MicroVM image.
imageVersion (string) --
The version of the MicroVM image.
buildId (string) --
The build request ID.
buildState (string) --
The current state of the build.
architecture (string) --
The target CPU architecture for the build. Supported value: ARM_64.
chipset (string) --
The target chipset for the build.
chipsetGeneration (string) --
The target chipset generation for the build.
stateReason (string) --
The reason for the build state, if applicable.
createdAt (datetime) --
The timestamp when the build was created.
snapshotBuild (dict) --
The snapshot build details, including memory and disk snapshot sizes.
memorySnapshotSizeInBytes (integer) --
The size of the memory snapshot in bytes.
codeInstallSizeInBytes (integer) --
The size of the installed code in bytes.
diskSnapshotSizeInBytes (integer) --
The size of the disk snapshot in bytes.
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.
See also: AWS API Documentation
Request Syntax
client.get_microvm(
microvmIdentifier='string'
)
string
[REQUIRED]
The ID of the MicroVM to retrieve.
dict
Response Syntax
{
'microvmId': 'string',
'state': 'PENDING'|'RUNNING'|'SUSPENDING'|'SUSPENDED'|'TERMINATING'|'TERMINATED',
'endpoint': 'string',
'imageArn': 'string',
'imageVersion': 'string',
'executionRoleArn': 'string',
'idlePolicy': {
'maxIdleDurationSeconds': 123,
'suspendedDurationSeconds': 123,
'autoResumeEnabled': True|False
},
'maximumDurationInSeconds': 123,
'startedAt': datetime(2015, 1, 1),
'terminatedAt': datetime(2015, 1, 1),
'stateReason': 'string',
'ingressNetworkConnectors': [
'string',
],
'egressNetworkConnectors': [
'string',
]
}
Response Structure
(dict) --
microvmId (string) --
The unique identifier of the MicroVM.
state (string) --
The current lifecycle state of the MicroVM.
endpoint (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.
imageArn (string) --
The ARN of the MicroVM image used to run this MicroVM.
imageVersion (string) --
The version of the MicroVM image used to run this MicroVM.
executionRoleArn (string) --
The ARN of the IAM execution role assumed by the MicroVM.
idlePolicy (dict) --
The idle policy configuration of the MicroVM, controlling auto-suspend and auto-resume behavior.
maxIdleDurationSeconds (integer) --
The maximum time in seconds that a MicroVM can remain idle before it is automatically suspended.
suspendedDurationSeconds (integer) --
The maximum time in seconds that a MicroVM can remain suspended before it is automatically terminated.
autoResumeEnabled (boolean) --
Indicates whether the MicroVM automatically resumes when it receives a request while suspended.
maximumDurationInSeconds (integer) --
The maximum duration in seconds that the MicroVM can exist before being terminated by the platform.
startedAt (datetime) --
The timestamp when the MicroVM first started.
terminatedAt (datetime) --
The timestamp when the MicroVM terminated.
stateReason (string) --
The reason for why the MicroVM is in the current state.
ingressNetworkConnectors (list) --
The list of ingress network connectors configured for the MicroVM.
(string) --
egressNetworkConnectors (list) --
The list of egress network connectors configured for the MicroVM.
(string) --
Removes tags from a Lambda MicroVM resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
Resource='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The ARN of the resource to remove tags from.
list
[REQUIRED]
The list of tag keys to remove from the resource.
(string) --
None
Deletes a MicroVM image. This operation is idempotent; deleting an image that has already been deleted succeeds without error.
See also: AWS API Documentation
Request Syntax
client.delete_microvm_image(
imageIdentifier='string'
)
string
[REQUIRED]
The unique identifier (ARN or ID) of the MicroVM image to delete.
dict
Response Syntax
{
'imageIdentifier': 'string',
'state': 'CREATING'|'CREATED'|'CREATE_FAILED'|'UPDATING'|'UPDATED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED'|'DELETED'
}
Response Structure
(dict) --
imageIdentifier (string) --
The identifier of the deleted MicroVM image.
state (string) --
The current state of the MicroVM image after deletion.