/AWS1/IF_CNT=>SEARCHQUEUES()

About SearchQueues

Searches queues in an Amazon Connect instance, with optional filtering.

Method Signature

METHODS /AWS1/IF_CNT~SEARCHQUEUES
  IMPORTING
    !IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CNTNEXTTOKEN2500 OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/CNTMAXRESULT500 OPTIONAL
    !IO_SEARCHFILTER TYPE REF TO /AWS1/CL_CNTQUEUESEARCHFILTER OPTIONAL
    !IO_SEARCHCRITERIA TYPE REF TO /AWS1/CL_CNTQUEUESEARCHCRIT OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntsearchqueuesrsp
  RAISING
    /AWS1/CX_CNTINTERNALSERVICEEX
    /AWS1/CX_CNTINVALIDPARAMETEREX
    /AWS1/CX_CNTINVALIDREQUESTEX
    /AWS1/CX_CNTRESOURCENOTFOUNDEX
    /AWS1/CX_CNTTHROTTLINGEX
    /AWS1/CX_CNTCLIENTEXC
    /AWS1/CX_CNTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_instanceid TYPE /AWS1/CNTINSTANCEID /AWS1/CNTINSTANCEID

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Optional arguments:

iv_nexttoken TYPE /AWS1/CNTNEXTTOKEN2500 /AWS1/CNTNEXTTOKEN2500

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

iv_maxresults TYPE /AWS1/CNTMAXRESULT500 /AWS1/CNTMAXRESULT500

The maximum number of results to return per page.

io_searchfilter TYPE REF TO /AWS1/CL_CNTQUEUESEARCHFILTER /AWS1/CL_CNTQUEUESEARCHFILTER

Filters to be applied to search results.

io_searchcriteria TYPE REF TO /AWS1/CL_CNTQUEUESEARCHCRIT /AWS1/CL_CNTQUEUESEARCHCRIT

The search criteria to be used to return queues.

The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

RETURNING

oo_output TYPE REF TO /aws1/cl_cntsearchqueuesrsp /AWS1/CL_CNTSEARCHQUEUESRSP

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->searchqueues(
  io_searchcriteria = new /aws1/cl_cntqueuesearchcrit(
    io_stringcondition = new /aws1/cl_cntstringcondition(
      iv_comparisontype = |string|
      iv_fieldname = |string|
      iv_value = |string|
    )
    it_andconditions = VALUE /aws1/cl_cntqueuesearchcrit=>tt_queuesearchconditionlist(
      (
        new /aws1/cl_cntqueuesearchcrit(
          io_stringcondition = new /aws1/cl_cntstringcondition(
            iv_comparisontype = |string|
            iv_fieldname = |string|
            iv_value = |string|
          )
          it_orconditions = VALUE /aws1/cl_cntqueuesearchcrit=>tt_queuesearchconditionlist(
          )
          iv_queuetypecondition = |string|
        )
      )
    )
    it_orconditions = VALUE /aws1/cl_cntqueuesearchcrit=>tt_queuesearchconditionlist(
      (
        new /aws1/cl_cntqueuesearchcrit(
          io_stringcondition = new /aws1/cl_cntstringcondition(
            iv_comparisontype = |string|
            iv_fieldname = |string|
            iv_value = |string|
          )
          it_andconditions = VALUE /aws1/cl_cntqueuesearchcrit=>tt_queuesearchconditionlist(
          )
          iv_queuetypecondition = |string|
        )
      )
    )
    iv_queuetypecondition = |string|
  )
  io_searchfilter = new /aws1/cl_cntqueuesearchfilter(
    io_tagfilter = new /aws1/cl_cntctlplanetagfilter(
      io_tagcondition = new /aws1/cl_cnttagcondition(
        iv_tagkey = |string|
        iv_tagvalue = |string|
      )
      it_andconditions = VALUE /aws1/cl_cnttagcondition=>tt_tagandconditionlist(
        (
          new /aws1/cl_cnttagcondition(
            iv_tagkey = |string|
            iv_tagvalue = |string|
          )
        )
      )
      it_orconditions = VALUE /aws1/cl_cnttagcondition=>tt_tagorconditionlist(
        (
          VALUE /aws1/cl_cnttagcondition=>tt_tagandconditionlist(
            (
              new /aws1/cl_cnttagcondition(
                iv_tagkey = |string|
                iv_tagvalue = |string|
              )
            )
          )
        )
      )
    )
  )
  iv_instanceid = |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_queues( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_commonnamelength127 = lo_row_1->get_name( ).
      lv_arn = lo_row_1->get_queuearn( ).
      lv_queueid = lo_row_1->get_queueid( ).
      lv_queuedescription = lo_row_1->get_description( ).
      lo_outboundcallerconfig = lo_row_1->get_outboundcallerconfig( ).
      IF lo_outboundcallerconfig IS NOT INITIAL.
        lv_outboundcalleridname = lo_outboundcallerconfig->get_outboundcalleridname( ).
        lv_phonenumberid = lo_outboundcallerconfig->get_outboundcalleridnumberid( ).
        lv_contactflowid = lo_outboundcallerconfig->get_outboundflowid( ).
      ENDIF.
      lo_outboundemailconfig = lo_row_1->get_outboundemailconfig( ).
      IF lo_outboundemailconfig IS NOT INITIAL.
        lv_emailaddressid = lo_outboundemailconfig->get_outboundemailaddressid( ).
      ENDIF.
      lv_hoursofoperationid = lo_row_1->get_hoursofoperationid( ).
      lv_queuemaxcontacts = lo_row_1->get_maxcontacts( ).
      lv_queuestatus = lo_row_1->get_status( ).
      LOOP AT lo_row_1->get_tags( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_tagvalue = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_timestamp = lo_row_1->get_lastmodifiedtime( ).
      lv_regionname = lo_row_1->get_lastmodifiedregion( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken2500 = lo_result->get_nexttoken( ).
  lv_approximatetotalcount = lo_result->get_approximatetotalcount( ).
ENDIF.