DESCRIBEJOBQUEUES()`¶

About DescribeJobQueues¶

Describes one or more of your job queues.

Method Signature¶

METHODS /AWS1/IF_BTC~DESCRIBEJOBQUEUES
  IMPORTING
    !IT_JOBQUEUES TYPE /AWS1/CL_BTCSTRINGLIST_W=>TT_STRINGLIST OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BTCINTEGER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/BTCSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_btcdescrjobqueuesrsp
  RAISING
    /AWS1/CX_BTCCLIENTEXCEPTION
    /AWS1/CX_BTCSERVEREXCEPTION
    /AWS1/CX_BTCCLIENTEXC
    /AWS1/CX_BTCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`it_jobqueues` `TYPE /AWS1/CL_BTCSTRINGLIST_W=>TT_STRINGLIST` `TT_STRINGLIST`¶

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

`iv_maxresults` `TYPE /AWS1/BTCINTEGER` `/AWS1/BTCINTEGER`¶

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

`iv_nexttoken` `TYPE /AWS1/BTCSTRING` `/AWS1/BTCSTRING`¶

The nextToken value returned from a previous paginated DescribeJobQueues 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_btcdescrjobqueuesrsp` `/AWS1/CL_BTCDESCRJOBQUEUESRSP`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

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->describejobqueues(
  it_jobqueues = VALUE /aws1/cl_btcstringlist_w=>tt_stringlist(
    ( new /aws1/cl_btcstringlist_w( |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_jobqueues( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_jobqueuename( ).
      lv_string = lo_row_1->get_jobqueuearn( ).
      lv_jqstate = lo_row_1->get_state( ).
      lv_string = lo_row_1->get_schedulingpolicyarn( ).
      lv_jqstatus = lo_row_1->get_status( ).
      lv_string = lo_row_1->get_statusreason( ).
      lv_integer = lo_row_1->get_priority( ).
      LOOP AT lo_row_1->get_computeenvironmentorder( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_integer = lo_row_3->get_order( ).
          lv_string = lo_row_3->get_computeenvironment( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_serviceenvironmentorder( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_integer = lo_row_5->get_order( ).
          lv_string = lo_row_5->get_serviceenvironment( ).
        ENDIF.
      ENDLOOP.
      lv_jobqueuetype = lo_row_1->get_jobqueuetype( ).
      LOOP AT lo_row_1->get_tags( ) into ls_row_6.
        lv_key = ls_row_6-key.
        lo_value = ls_row_6-value.
        IF lo_value IS NOT INITIAL.
          lv_tagvalue = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_jobstatetimelimitactions( ) into lo_row_7.
        lo_row_8 = lo_row_7.
        IF lo_row_8 IS NOT INITIAL.
          lv_string = lo_row_8->get_reason( ).
          lv_jobstatetimelimitaction = lo_row_8->get_state( ).
          lv_integer = lo_row_8->get_maxtimeseconds( ).
          lv_jobstatetimelimitaction_1 = lo_row_8->get_action( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

To describe a job queue¶

This example describes the HighPriority job queue.

DATA(lo_result) = lo_client->describejobqueues(
  it_jobqueues = VALUE /aws1/cl_btcstringlist_w=>tt_stringlist(
    ( new /aws1/cl_btcstringlist_w( |HighPriority| ) )
  )
).

/AWS1/IF_BTC=>DESCRIBEJOBQUEUES()¶