LambdaMicroVMs / Client / list_microvm_image_versions

list_microvm_image_versions¶

LambdaMicroVMs.Client.list_microvm_image_versions(**kwargs)¶

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

Request Syntax

response = client.list_microvm_image_versions(
    maxResults=123,
    nextToken='string',
    imageIdentifier='string'
)

Parameters:

maxResults (integer) – The maximum number of results to return in a single call.
nextToken (string) – The pagination token from a previous call. Use this token to retrieve the next page of results.
imageIdentifier (string) –
[REQUIRED]

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

Return type:

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'
                },
            ],
            '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, such as an Amazon S3 path or Amazon ECR image URI.
    - 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 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) –

Exceptions

LambdaMicroVMs.Client.exceptions.InternalServerException
LambdaMicroVMs.Client.exceptions.AccessDeniedException
LambdaMicroVMs.Client.exceptions.ResourceNotFoundException
LambdaMicroVMs.Client.exceptions.ThrottlingException
LambdaMicroVMs.Client.exceptions.ValidationException