AWS API Changes

2026/11/05 - Lambda MicroVMs - 8 updated api methods

Changes AWS Lambda MicroVMs now support the x86-64 CPU architecture, which you can select in addition to ARM64 (Graviton) when launching a MicroVM.

CreateMicrovmImage (updated)

Link ¶
Changes (both)

{'cpuConfigurations': {'architecture': {'X86_64'}}}

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'|'X86_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'
)

type baseImageArn:

string

param baseImageArn:

[REQUIRED]

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

type baseImageVersion:

string

param baseImageVersion:

The specific version of the base MicroVM image to use.

type buildRoleArn:

string

param buildRoleArn:

[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.

type description:

string

param description:

A description of the MicroVM image.

type codeArtifact:

dict

param codeArtifact:

[REQUIRED]

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

uri (string) --

The URI of the code artifact in Amazon S3.

type logging:

dict

param logging:

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.

type egressNetworkConnectors:

list

param egressNetworkConnectors:

The list of egress network connectors available to the MicroVM at image build time.

(string) --

type cpuConfigurations:

list

param cpuConfigurations:

The list of supported CPU configurations for the MicroVM.

(dict) --

Configuration for the CPU architecture of a MicroVM.
- architecture (string) -- [REQUIRED]
  
  The CPU architecture.

type resources:

list

param resources:

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.

type additionalOsCapabilities:

list

param additionalOsCapabilities:

Additional OS capabilities granted to the MicroVM runtime environment.

(string) --

Capability granted to the application when booted

type hooks:

dict

param hooks:

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.

type environmentVariables:

dict

param environmentVariables:

Environment variables set in the MicroVM runtime environment.

(string) --
- (string) --

type name:

string

param name:

[REQUIRED]

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

type tags:

dict

param tags:

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) --

type clientToken:

string

param clientToken:

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.

rtype:

dict

returns:

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'|'X86_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.
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys will be set: uri. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
  - uri (string) --
    
    The URI of the code artifact in Amazon S3.
- 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.
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys will be set: disabled, cloudWatch. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
  - 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 image build time.
  - (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.

GetMicrovmImageBuild (updated)

Link ¶
Changes (response)

{'architecture': {'X86_64'}, 'chipset': {'INTEL'}}

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'
)

type imageIdentifier:

string

param imageIdentifier:

[REQUIRED]

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

type imageVersion:

string

param imageVersion:

[REQUIRED]

The version of the MicroVM image.

type buildId:

string

param buildId:

[REQUIRED]

The unique identifier of the build to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'imageArn': 'string',
    'imageVersion': 'string',
    'buildId': 'string',
    'buildState': 'PENDING'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED',
    'architecture': 'ARM_64'|'X86_64',
    'chipset': 'GRAVITON'|'INTEL',
    '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.

GetMicrovmImageVersion (updated)

Link ¶
Changes (response)

{'cpuConfigurations': {'architecture': {'X86_64'}}}

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'
)

type imageIdentifier:

string

param imageIdentifier:

[REQUIRED]

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

type imageVersion:

string

param imageVersion:

[REQUIRED]

The version of the MicroVM image to retrieve.

rtype:

dict

returns:

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'|'X86_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.
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys will be set: uri. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
  - uri (string) --
    
    The URI of the code artifact in Amazon S3.
- logging (dict) --
  
  The logging configuration for this version.
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys will be set: disabled, cloudWatch. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
  - 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 image build time.
  - (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) --

ListManagedMicrovmImageVersions (updated)

Link ¶
Changes (response)

{'items': {'status': {'RECALLED'},
           'supportedCpuConfigurations': [{'architecture': 'ARM_64 | X86_64'}]}}

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'
)

type maxResults:

integer

param maxResults:

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

type nextToken:

string

param nextToken:

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

type imageIdentifier:

string

param imageIdentifier:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'items': [
        {
            'imageArn': 'string',
            'imageVersion': 'string',
            'status': 'AVAILABLE'|'DEPRECATED'|'RECALLED',
            'supportedCpuConfigurations': [
                {
                    'architecture': 'ARM_64'|'X86_64'
                },
            ],
            '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.
    - status (string) --
      
      The lifecycle status of the managed MicroVM image version. Valid values: AVAILABLE (the version is available for use) or DEPRECATED (the version is deprecated; do not use it for new MicroVM images).
    - supportedCpuConfigurations (list) --
      
      CPU configurations supported by this managed base image version.
      - (dict) --
        
        Configuration for the CPU architecture of a MicroVM.
        
        architecture (string) --
        
        The CPU architecture.
    - createdAt (datetime) --
      
      The timestamp when the version was created.
    - updatedAt (datetime) --
      
      The timestamp when the version was last updated.

ListMicrovmImageBuilds (updated)

Link ¶
Changes (request, response)
Request

{'architecture': {'X86_64'}, 'chipset': {'INTEL'}}

Response

{'items': {'architecture': {'X86_64'}, 'chipset': {'INTEL'}}}

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'|'X86_64',
    chipset='GRAVITON'|'INTEL',
    chipsetGeneration='string'
)

type maxResults:

integer

param maxResults:

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

type nextToken:

string

param nextToken:

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

type imageIdentifier:

string

param imageIdentifier:

[REQUIRED]

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

type imageVersion:

string

param imageVersion:

[REQUIRED]

The version of the MicroVM image to list builds for.

type architecture:

string

param architecture:

Filters builds by target CPU architecture.

type chipset:

string

param chipset:

Filters builds by target chipset.

type chipsetGeneration:

string

param chipsetGeneration:

Filters builds by target chipset generation.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'items': [
        {
            'imageArn': 'string',
            'imageVersion': 'string',
            'buildId': 'string',
            'buildState': 'PENDING'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED',
            'architecture': 'ARM_64'|'X86_64',
            'chipset': 'GRAVITON'|'INTEL',
            '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.

ListMicrovmImageVersions (updated)

Link ¶
Changes (response)

{'items': {'cpuConfigurations': {'architecture': {'X86_64'}}}}

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'
)

type maxResults:

integer

param maxResults:

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

type nextToken:

string

param nextToken:

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

type imageIdentifier:

string

param imageIdentifier:

[REQUIRED]

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

rtype:

dict

returns:

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'|'X86_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.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: uri. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - uri (string) --
        
        The URI of the code artifact in Amazon S3.
    - logging (dict) --
      
      The logging configuration for this version.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: disabled, cloudWatch. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - 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 image build time.
      - (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) --

UpdateMicrovmImage (updated)

Link ¶
Changes (both)

{'cpuConfigurations': {'architecture': {'X86_64'}}}

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'|'X86_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'
)

type baseImageArn:

string

param baseImageArn:

[REQUIRED]

The ARN of the base MicroVM image.

type baseImageVersion:

string

param baseImageVersion:

The specific version of the base MicroVM image to use.

type buildRoleArn:

string

param buildRoleArn:

[REQUIRED]

The ARN of the IAM build role.

type description:

string

param description:

The description of the MicroVM image.

type codeArtifact:

dict

param codeArtifact:

[REQUIRED]

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

uri (string) --

The URI of the code artifact in Amazon S3.

type logging:

dict

param logging:

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.

type egressNetworkConnectors:

list

param egressNetworkConnectors:

The list of egress network connectors available to the MicroVM at image build time.

(string) --

type cpuConfigurations:

list

param cpuConfigurations:

The list of supported CPU configurations for the MicroVM.

(dict) --

Configuration for the CPU architecture of a MicroVM.
- architecture (string) -- [REQUIRED]
  
  The CPU architecture.

type resources:

list

param resources:

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.

type additionalOsCapabilities:

list

param additionalOsCapabilities:

Additional OS capabilities granted to the MicroVM runtime environment.

(string) --

Capability granted to the application when booted

type hooks:

dict

param hooks:

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.

type environmentVariables:

dict

param environmentVariables:

Environment variables set in the MicroVM runtime environment.

(string) --
- (string) --

type imageIdentifier:

string

param imageIdentifier:

[REQUIRED]

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

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

rtype:

dict

returns:

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'|'X86_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.
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys will be set: uri. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
  - uri (string) --
    
    The URI of the code artifact in Amazon S3.
- 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.
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys will be set: disabled, cloudWatch. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
  - 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 image build time.
  - (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.

UpdateMicrovmImageVersion (updated)

Link ¶
Changes (response)

{'cpuConfigurations': {'architecture': {'X86_64'}}}

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'
)

type imageIdentifier:

string

param imageIdentifier:

[REQUIRED]

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

type imageVersion:

string

param imageVersion:

[REQUIRED]

The version of the MicroVM image to update.

type status:

string

param status:

[REQUIRED]

The new status to set for the MicroVM image version.

rtype:

dict

returns:

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'|'X86_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.
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys will be set: uri. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
  - uri (string) --
    
    The URI of the code artifact in Amazon S3.
- logging (dict) --
  
  The logging configuration for this version.
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys will be set: disabled, cloudWatch. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
  - 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 image build time.
  - (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) --