SEARCHRULES()`¶

About SearchRules¶

Searches rules in an Connect Customer instance, with optional filtering.

Method Signature¶

METHODS /AWS1/IF_CNT~SEARCHRULES
  IMPORTING
    !IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/CNTMAXRESULT200 OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CNTNEXTTOKEN2500 OPTIONAL
    !IO_SEARCHCRITERIA TYPE REF TO /AWS1/CL_CNTRULESSEARCHCRIT OPTIONAL
    !IO_SEARCHFILTER TYPE REF TO /AWS1/CL_CNTRULESSEARCHFILTER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntsearchrulesrsp
  RAISING
    /AWS1/CX_CNTACCESSDENIEDEX
    /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 Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Optional arguments:¶

`iv_maxresults` `TYPE /AWS1/CNTMAXRESULT200` `/AWS1/CNTMAXRESULT200`¶

The maximum number of results to return per page.

`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.

`io_searchcriteria` `TYPE REF TO /AWS1/CL_CNTRULESSEARCHCRIT` `/AWS1/CL_CNTRULESSEARCHCRIT`¶

The search criteria to be used to return rules.

`io_searchfilter` `TYPE REF TO /AWS1/CL_CNTRULESSEARCHFILTER` `/AWS1/CL_CNTRULESSEARCHFILTER`¶

Filters to be applied to search results, such as tag-based filters.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cntsearchrulesrsp` `/AWS1/CL_CNTSEARCHRULESRSP`¶

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->searchrules(
  io_searchcriteria = new /aws1/cl_cntrulessearchcrit(
    io_stringcondition = new /aws1/cl_cntstringcondition(
      iv_comparisontype = |string|
      iv_fieldname = |string|
      iv_value = |string|
    )
    it_andconditions = VALUE /aws1/cl_cntrulessearchcrit=>tt_rulessearchconditionlist(
      (
        new /aws1/cl_cntrulessearchcrit(
          io_stringcondition = new /aws1/cl_cntstringcondition(
            iv_comparisontype = |string|
            iv_fieldname = |string|
            iv_value = |string|
          )
          it_orconditions = VALUE /aws1/cl_cntrulessearchcrit=>tt_rulessearchconditionlist(
          )
        )
      )
    )
    it_orconditions = VALUE /aws1/cl_cntrulessearchcrit=>tt_rulessearchconditionlist(
      (
        new /aws1/cl_cntrulessearchcrit(
          io_stringcondition = new /aws1/cl_cntstringcondition(
            iv_comparisontype = |string|
            iv_fieldname = |string|
            iv_value = |string|
          )
          it_andconditions = VALUE /aws1/cl_cntrulessearchcrit=>tt_rulessearchconditionlist(
          )
        )
      )
    )
  )
  io_searchfilter = new /aws1/cl_cntrulessearchfilter(
    io_attributefilter = new /aws1/cl_cntruleattrfilter(
      io_andcondition = new /aws1/cl_cntruleattrandcond(
        it_tagconditions = VALUE /aws1/cl_cnttagcondition=>tt_tagandconditionlist(
          (
            new /aws1/cl_cnttagcondition(
              iv_tagkey = |string|
              iv_tagvalue = |string|
            )
          )
        )
      )
      io_tagcondition = new /aws1/cl_cnttagcondition(
        iv_tagkey = |string|
        iv_tagvalue = |string|
      )
      it_orconditions = VALUE /aws1/cl_cntruleattrandcond=>tt_ruleattributeorcondlist(
        (
          new /aws1/cl_cntruleattrandcond(
            it_tagconditions = 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_rules( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_rulename = lo_row_1->get_name( ).
      lv_ruleid = lo_row_1->get_ruleid( ).
      lv_arn = lo_row_1->get_rulearn( ).
      lo_ruletriggereventsource = lo_row_1->get_triggereventsource( ).
      IF lo_ruletriggereventsource IS NOT INITIAL.
        lv_eventsourcename = lo_ruletriggereventsource->get_eventsourcename( ).
        lv_integrationassociationi = lo_ruletriggereventsource->get_integrationassociationid( ).
      ENDIF.
      LOOP AT lo_row_1->get_actionsummaries( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_actiontype = lo_row_3->get_actiontype( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_rulecapabilitytiers( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_rulecapabilitytier = lo_row_5->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_rulepublishstatus = lo_row_1->get_publishstatus( ).
      lv_timestamp = lo_row_1->get_createdtime( ).
      lv_timestamp = lo_row_1->get_lastupdatedtime( ).
      lv_arn = lo_row_1->get_lastupdatedby( ).
      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.
    ENDIF.
  ENDLOOP.
  lv_approximatetotalcount = lo_result->get_approximatetotalcount( ).
  lv_nexttoken2500 = lo_result->get_nexttoken( ).
ENDIF.

SearchRules¶

Searches for published rules in an Amazon Connect instance.

DATA(lo_result) = lo_client->searchrules(
  io_searchcriteria = new /aws1/cl_cntrulessearchcrit(
    io_stringcondition = new /aws1/cl_cntstringcondition(
      iv_comparisontype = |EXACT|
      iv_fieldname = |PublishStatus|
      iv_value = |PUBLISHED|
    )
  )
  iv_instanceid = |12345678-1234-1234-1234-123456789012|
  iv_maxresults = 10
).

/AWS1/IF_CNT=>SEARCHRULES()¶