LambdaMicroVMs / Client / list_microvm_images

list_microvm_images¶

LambdaMicroVMs.Client.list_microvm_images(**kwargs)¶

Lists MicroVM images in the account with optional name filtering. We recommend using pagination to ensure that the operation returns quickly and successfully.

Request Syntax

response = client.list_microvm_images(
    maxResults=123,
    nextToken='string',
    nameFilter='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.
nameFilter (string) – Filters images whose name contains the specified string.

Return type:

dict

Returns:

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.

Exceptions

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