Skip to content

/AWS1/IF_PP2=>DESCRIBENOTIFYCONFIGURATIONS()

About DescribeNotifyConfigurations

Describes the specified notify configurations or all notify configurations in your account.

If you specify notify configuration IDs, the output includes information for only the specified notify configurations. If you specify filters, the output includes information for only those notify configurations that meet the filter criteria. If you don't specify notify configuration IDs or filters, the output includes information for all notify configurations.

If you specify a notify configuration ID that isn't valid, an error is returned.

Method Signature

METHODS /AWS1/IF_PP2~DESCRIBENOTIFYCONFIGURATIONS
  IMPORTING
    !IT_NOTIFYCONFIGURATIONIDS TYPE /AWS1/CL_PP2NOTIFYCONFIDLIST_W=>TT_NOTIFYCONFIGURATIONIDLIST OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_PP2NOTIFYCONFFILTER=>TT_NOTIFYCONFFILTERLIST OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/PP2NEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/PP2MAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_pp2descrntfyconfsrslt
  RAISING
    /AWS1/CX_PP2ACCESSDENIEDEX
    /AWS1/CX_PP2INTERNALSERVEREX
    /AWS1/CX_PP2RESOURCENOTFOUNDEX
    /AWS1/CX_PP2THROTTLINGEX
    /AWS1/CX_PP2VALIDATIONEX
    /AWS1/CX_PP2CLIENTEXC
    /AWS1/CX_PP2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

it_notifyconfigurationids TYPE /AWS1/CL_PP2NOTIFYCONFIDLIST_W=>TT_NOTIFYCONFIGURATIONIDLIST TT_NOTIFYCONFIGURATIONIDLIST

An array of notify configuration IDs to describe.

it_filters TYPE /AWS1/CL_PP2NOTIFYCONFFILTER=>TT_NOTIFYCONFFILTERLIST TT_NOTIFYCONFFILTERLIST

An array of NotifyConfigurationFilter objects to filter the results on.

iv_nexttoken TYPE /AWS1/PP2NEXTTOKEN /AWS1/PP2NEXTTOKEN

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

iv_maxresults TYPE /AWS1/PP2MAXRESULTS /AWS1/PP2MAXRESULTS

The maximum number of results to return per each request.

RETURNING

oo_output TYPE REF TO /aws1/cl_pp2descrntfyconfsrslt /AWS1/CL_PP2DESCRNTFYCONFSRSLT

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->describenotifyconfigurations(
  it_filters = VALUE /aws1/cl_pp2notifyconffilter=>tt_notifyconffilterlist(
    (
      new /aws1/cl_pp2notifyconffilter(
        it_values = VALUE /aws1/cl_pp2filtervaluelist_w=>tt_filtervaluelist(
          ( new /aws1/cl_pp2filtervaluelist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  it_notifyconfigurationids = VALUE /aws1/cl_pp2notifyconfidlist_w=>tt_notifyconfigurationidlist(
    ( new /aws1/cl_pp2notifyconfidlist_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_notifyconfigurations( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_notifyconfigurationarn = lo_row_1->get_notifyconfigurationarn( ).
      lv_notifyconfigurationid = lo_row_1->get_notifyconfigurationid( ).
      lv_notifyconfigurationdisp = lo_row_1->get_displayname( ).
      lv_notifyconfigurationusec = lo_row_1->get_usecase( ).
      lv_notifytemplateid = lo_row_1->get_defaulttemplateid( ).
      lv_string = lo_row_1->get_poolid( ).
      LOOP AT lo_row_1->get_enabledcountries( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_isocountrycode = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_enabledchannels( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_numbercapability = lo_row_5->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_notifyconfigurationtier = lo_row_1->get_tier( ).
      lv_tierupgradestatus = lo_row_1->get_tierupgradestatus( ).
      lv_notifyconfigurationstat = lo_row_1->get_status( ).
      lv_string = lo_row_1->get_rejectionreason( ).
      lv_primitiveboolean = lo_row_1->get_deletionprotectionenbd( ).
      lv_timestamp = lo_row_1->get_createdtimestamp( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

DescribeNotifyConfigurations

Describe notify configurations filtered by status.

DATA(lo_result) = lo_client->describenotifyconfigurations(
  it_filters = VALUE /aws1/cl_pp2notifyconffilter=>tt_notifyconffilterlist(
    (
      new /aws1/cl_pp2notifyconffilter(
        it_values = VALUE /aws1/cl_pp2filtervaluelist_w=>tt_filtervaluelist(
          ( new /aws1/cl_pp2filtervaluelist_w( |ACTIVE| ) )
        )
        iv_name = |status|
      )
    )
  )
  iv_maxresults = 10
).