Skip to content

/AWS1/IF_COA=>LISTAUTOMATIONRULES()

About ListAutomationRules

Lists the automation rules that match specified filters.

Method Signature

METHODS /AWS1/IF_COA~LISTAUTOMATIONRULES
  IMPORTING
    !IT_FILTERS TYPE /AWS1/CL_COAFILTER=>TT_FILTERLIST OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/COAINTEGER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/COANEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_coalistautorulesrsp
  RAISING
    /AWS1/CX_COAACCESSDENIEDEX
    /AWS1/CX_COAFORBIDDENEXCEPTION
    /AWS1/CX_COAINTERNALSERVEREX
    /AWS1/CX_COAINVPARAMVALUEEX
    /AWS1/CX_COAOPTINREQUIREDEX
    /AWS1/CX_COASERVICEUNAVAILEX
    /AWS1/CX_COATHROTTLINGEX
    /AWS1/CX_COACLIENTEXC
    /AWS1/CX_COASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

it_filters TYPE /AWS1/CL_COAFILTER=>TT_FILTERLIST TT_FILTERLIST

The filters to apply to the list of automation rules.

iv_maxresults TYPE /AWS1/COAINTEGER /AWS1/COAINTEGER

The maximum number of automation rules to return in a single response. Valid range is 1-1000.

iv_nexttoken TYPE /AWS1/COANEXTTOKEN /AWS1/COANEXTTOKEN

A token used for pagination to retrieve the next set of results when the response is truncated.

RETURNING

oo_output TYPE REF TO /aws1/cl_coalistautorulesrsp /AWS1/CL_COALISTAUTORULESRSP

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->listautomationrules(
  it_filters = VALUE /aws1/cl_coafilter=>tt_filterlist(
    (
      new /aws1/cl_coafilter(
        it_values = VALUE /aws1/cl_coafiltervalues_w=>tt_filtervalues(
          ( new /aws1/cl_coafiltervalues_w( |string| ) )
        )
        iv_name = |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_automationrules( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_rulearn = lo_row_1->get_rulearn( ).
      lv_ruleid = lo_row_1->get_ruleid( ).
      lv_rulename = lo_row_1->get_name( ).
      lv_string = lo_row_1->get_description( ).
      lv_ruletype = lo_row_1->get_ruletype( ).
      lv_long = lo_row_1->get_rulerevision( ).
      lv_accountid = lo_row_1->get_accountid( ).
      lo_organizationconfigurati = lo_row_1->get_organizationconf( ).
      IF lo_organizationconfigurati IS NOT INITIAL.
        lv_ruleapplyorder = lo_organizationconfigurati->get_ruleapplyorder( ).
        LOOP AT lo_organizationconfigurati->get_accountids( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_accountid = lo_row_3->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
      lv_string = lo_row_1->get_priority( ).
      LOOP AT lo_row_1->get_recommendedactiontypes( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_recommendedactiontype = lo_row_5->get_value( ).
        ENDIF.
      ENDLOOP.
      lo_schedule = lo_row_1->get_schedule( ).
      IF lo_schedule IS NOT INITIAL.
        lv_string = lo_schedule->get_scheduleexpression( ).
        lv_string = lo_schedule->get_schedulexprsntimezone( ).
        lv_integer = lo_schedule->get_executionwindowinminutes( ).
      ENDIF.
      lv_rulestatus = lo_row_1->get_status( ).
      lv_timestamp = lo_row_1->get_createdtimestamp( ).
      lv_timestamp = lo_row_1->get_lastupdatedtimestamp( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.