LambdaMicroVMs / Client / list_microvms

list_microvms¶

LambdaMicroVMs.Client.list_microvms(**kwargs)¶

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.

Request Syntax

response = client.list_microvms(
    maxResults=123,
    nextToken='string',
    imageIdentifier='string',
    imageVersion='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) – Optional filter to list only MicroVMs running the specified image.
imageVersion (string) – Optional filter to list only MicroVMs running the specified image version.

Return type:

dict

Returns:

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.

Exceptions

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