LambdaMicroVMs / Paginator / ListMicrovms

ListMicrovms

class LambdaMicroVMs.Paginator.ListMicrovms

paginator = client.get_paginator('list_microvms')

paginate(**kwargs)

Creates an iterator that will paginate through responses from LambdaMicroVMs.Client.list_microvms().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    imageIdentifier='string',
    imageVersion='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'microvmId': 'string',
            'state': 'PENDING'|'RUNNING'|'SUSPENDING'|'SUSPENDED'|'TERMINATING'|'TERMINATED',
            'imageArn': 'string',
            'imageVersion': 'string',
            'startedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

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

  • NextToken (string) –

    A token to resume pagination.