Skip to content

/AWS1/IF_LMV=>LISTMICROVMS()

About ListMicrovms

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.

Method Signature

METHODS /AWS1/IF_LMV~LISTMICROVMS
  IMPORTING
    !IV_MAXRESULTS TYPE /AWS1/LMVINTEGER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/LMVSTRING00 OPTIONAL
    !IV_IMAGEIDENTIFIER TYPE /AWS1/LMVMICROVMIMAGEID OPTIONAL
    !IV_IMAGEVERSION TYPE /AWS1/LMVSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lmvlistmicrovmsrsp
  RAISING
    /AWS1/CX_LMVACCESSDENIEDEX
    /AWS1/CX_LMVINTERNALSERVEREX
    /AWS1/CX_LMVRESOURCENOTFOUNDEX
    /AWS1/CX_LMVTHROTTLINGEX
    /AWS1/CX_LMVVLDTNEXCEPTION
    /AWS1/CX_LMVCLIENTEXC
    /AWS1/CX_LMVSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_maxresults TYPE /AWS1/LMVINTEGER /AWS1/LMVINTEGER

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

iv_nexttoken TYPE /AWS1/LMVSTRING00 /AWS1/LMVSTRING00

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

iv_imageidentifier TYPE /AWS1/LMVMICROVMIMAGEID /AWS1/LMVMICROVMIMAGEID

Optional filter to list only MicroVMs running the specified image.

iv_imageversion TYPE /AWS1/LMVSTRING /AWS1/LMVSTRING

Optional filter to list only MicroVMs running the specified image version.

RETURNING

oo_output TYPE REF TO /aws1/cl_lmvlistmicrovmsrsp /AWS1/CL_LMVLISTMICROVMSRSP

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->listmicrovms(
  iv_imageidentifier = |string|
  iv_imageversion = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_items( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_microvmidentifier = lo_row_1->get_microvmid( ).
      lv_microvmstate = lo_row_1->get_state( ).
      lv_microvmimagearn = lo_row_1->get_imagearn( ).
      lv_version = lo_row_1->get_imageversion( ).
      lv_timestamp = lo_row_1->get_startedat( ).
    ENDIF.
  ENDLOOP.
ENDIF.