DESCRIBERULE()`¶

About DescribeRule¶

Describes the specified rule.

DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.

Method Signature¶

METHODS /AWS1/IF_EVB~DESCRIBERULE
  IMPORTING
    !IV_NAME TYPE /AWS1/EVBRULENAME OPTIONAL
    !IV_EVENTBUSNAME TYPE /AWS1/EVBEVENTBUSNAMEORARN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_evbdescrruleresponse
  RAISING
    /AWS1/CX_EVBINTERNALEXCEPTION
    /AWS1/CX_EVBRESOURCENOTFOUNDEX
    /AWS1/CX_EVBCLIENTEXC
    /AWS1/CX_EVBSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_name` `TYPE /AWS1/EVBRULENAME` `/AWS1/EVBRULENAME`¶

The name of the rule.

Optional arguments:¶

`iv_eventbusname` `TYPE /AWS1/EVBEVENTBUSNAMEORARN` `/AWS1/EVBEVENTBUSNAMEORARN`¶

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_evbdescrruleresponse` `/AWS1/CL_EVBDESCRRULERESPONSE`¶

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->describerule(
  iv_eventbusname = |string|
  iv_name = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_rulename = lo_result->get_name( ).
  lv_rulearn = lo_result->get_arn( ).
  lv_eventpattern = lo_result->get_eventpattern( ).
  lv_scheduleexpression = lo_result->get_scheduleexpression( ).
  lv_rulestate = lo_result->get_state( ).
  lv_ruledescription = lo_result->get_description( ).
  lv_rolearn = lo_result->get_rolearn( ).
  lv_managedby = lo_result->get_managedby( ).
  lv_eventbusname = lo_result->get_eventbusname( ).
  lv_createdby = lo_result->get_createdby( ).
ENDIF.

/AWS1/IF_EVB=>DESCRIBERULE()¶