LISTVMENTITLEMENTS()`¶

About ListVmEntitlements¶

Lists the Windows Server License entitlements for virtual machines in an Amazon EVS environment. Returns existing entitlements for virtual machines associated with the specified environment and connector.

Method Signature¶

METHODS /AWS1/IF_EVS~LISTVMENTITLEMENTS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/EVSPAGINATIONTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/EVSMAXRESULTS OPTIONAL
    !IV_ENVIRONMENTID TYPE /AWS1/EVSENVIRONMENTID OPTIONAL
    !IV_CONNECTORID TYPE /AWS1/EVSCONNECTORID OPTIONAL
    !IV_ENTITLEMENTTYPE TYPE /AWS1/EVSENTITLEMENTTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_evslistvmentsresponse
  RAISING
    /AWS1/CX_EVSRESOURCENOTFOUNDEX
    /AWS1/CX_EVSVALIDATIONEX
    /AWS1/CX_EVSCLIENTEXC
    /AWS1/CX_EVSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_environmentid` `TYPE /AWS1/EVSENVIRONMENTID` `/AWS1/EVSENVIRONMENTID`¶

A unique ID for the environment.

`iv_connectorid` `TYPE /AWS1/EVSCONNECTORID` `/AWS1/EVSCONNECTORID`¶

A unique ID for the connector.

`iv_entitlementtype` `TYPE /AWS1/EVSENTITLEMENTTYPE` `/AWS1/EVSENTITLEMENTTYPE`¶

The type of entitlement to list.

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/EVSPAGINATIONTOKEN` `/AWS1/EVSPAGINATIONTOKEN`¶

A unique pagination token for each page. If nextToken is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

`iv_maxresults` `TYPE /AWS1/EVSMAXRESULTS` `/AWS1/EVSMAXRESULTS`¶

The maximum number of results to return. If you specify MaxResults in the request, the response includes information up to the limit specified.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_evslistvmentsresponse` `/AWS1/CL_EVSLISTVMENTSRESPONSE`¶

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->listvmentitlements(
  iv_connectorid = |string|
  iv_entitlementtype = |string|
  iv_environmentid = |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_paginationtoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_entitlements( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_vmid = lo_row_1->get_vmid( ).
      lv_environmentid = lo_row_1->get_environmentid( ).
      lv_connectorid = lo_row_1->get_connectorid( ).
      lv_vmname = lo_row_1->get_vmname( ).
      lv_entitlementtype = lo_row_1->get_type( ).
      lv_entitlementstatus = lo_row_1->get_status( ).
      lv_timestamp = lo_row_1->get_lastsyncedat( ).
      lv_timestamp = lo_row_1->get_startedat( ).
      lv_timestamp = lo_row_1->get_stoppedat( ).
      lo_errordetail = lo_row_1->get_errordetail( ).
      IF lo_errordetail IS NOT INITIAL.
        lv_string = lo_errordetail->get_errorcode( ).
        lv_string = lo_errordetail->get_errormessage( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_EVS=>LISTVMENTITLEMENTS()¶