Skip to content

/AWS1/IF_BTC=>LISTQUOTASHARES()

About ListQuotaShares

Returns a list of Batch quota shares associated with a job queue.

Method Signature

METHODS /AWS1/IF_BTC~LISTQUOTASHARES
  IMPORTING
    !IV_JOBQUEUE TYPE /AWS1/BTCSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BTCINTEGER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/BTCSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_btclistquotasharesrsp
  RAISING
    /AWS1/CX_BTCCLIENTEXCEPTION
    /AWS1/CX_BTCSERVEREXCEPTION
    /AWS1/CX_BTCCLIENTEXC
    /AWS1/CX_BTCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_jobqueue TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

The name or full Amazon Resource Name (ARN) of the job queue used to list quota shares.

Optional arguments:

iv_maxresults TYPE /AWS1/BTCINTEGER /AWS1/BTCINTEGER

The maximum number of results returned by ListQuotaShares in paginated output. When this parameter is used, ListQuotaShares only returns maxResults results in a single page and a nextToken response element. You can see the remaining results of the initial request by sending another ListQuotaShares request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, ListQuotaShares returns up to 100 results and a nextToken value if applicable.

iv_nexttoken TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

The nextToken value that's returned from a previous paginated ListQuotaShares request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

RETURNING

oo_output TYPE REF TO /aws1/cl_btclistquotasharesrsp /AWS1/CL_BTCLISTQUOTASHARESRSP

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->listquotashares(
  iv_jobqueue = |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.
  LOOP AT lo_result->get_quotashares( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_quotasharename( ).
      lv_string = lo_row_1->get_quotasharearn( ).
      lv_string = lo_row_1->get_jobqueuearn( ).
      LOOP AT lo_row_1->get_capacitylimits( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_integer = lo_row_3->get_maxcapacity( ).
          lv_string = lo_row_3->get_capacityunit( ).
        ENDIF.
      ENDLOOP.
      lo_quotashareresourceshari = lo_row_1->get_resourcesharingconf( ).
      IF lo_quotashareresourceshari IS NOT INITIAL.
        lv_quotashareresourceshari_1 = lo_quotashareresourceshari->get_strategy( ).
        lv_integer = lo_quotashareresourceshari->get_borrowlimit( ).
      ENDIF.
      lo_quotasharepreemptioncon = lo_row_1->get_preemptionconfiguration( ).
      IF lo_quotasharepreemptioncon IS NOT INITIAL.
        lv_quotashareinsharepreemp = lo_quotasharepreemptioncon->get_insharepreemption( ).
      ENDIF.
      lv_quotasharestate = lo_row_1->get_state( ).
      lv_quotasharestatus = lo_row_1->get_status( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.