DESCRIBESENDERIDS()`¶

About DescribeSenderIds¶

Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.

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

f you specify a sender ID that isn't valid, an error is returned.

Method Signature¶

METHODS /AWS1/IF_PP2~DESCRIBESENDERIDS
  IMPORTING
    !IT_SENDERIDS TYPE /AWS1/CL_PP2SENDERIDANDCOUNTRY=>TT_SENDERIDLIST OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_PP2SENDERIDFILTER=>TT_SENDERIDFILTERLIST OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/PP2NEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/PP2MAXRESULTS OPTIONAL
    !IV_OWNER TYPE /AWS1/PP2OWNER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_pp2descrsenderidsrslt
  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_senderids` `TYPE /AWS1/CL_PP2SENDERIDANDCOUNTRY=>TT_SENDERIDLIST` `TT_SENDERIDLIST`¶

An array of SenderIdAndCountry objects to search for.

If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).

`it_filters` `TYPE /AWS1/CL_PP2SENDERIDFILTER=>TT_SENDERIDFILTERLIST` `TT_SENDERIDFILTERLIST`¶

An array of SenderIdFilter objects to filter the results.

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

`iv_owner` `TYPE /AWS1/PP2OWNER` `/AWS1/PP2OWNER`¶

Use SELF to filter the list of Sender Ids to ones your account owns or use SHARED to filter on Sender Ids shared with your account. The Owner and SenderIds parameters can't be used at the same time.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_pp2descrsenderidsrslt` `/AWS1/CL_PP2DESCRSENDERIDSRSLT`¶

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->describesenderids(
  it_filters = VALUE /aws1/cl_pp2senderidfilter=>tt_senderidfilterlist(
    (
      new /aws1/cl_pp2senderidfilter(
        it_values = VALUE /aws1/cl_pp2filtervaluelist_w=>tt_filtervaluelist(
          ( new /aws1/cl_pp2filtervaluelist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  it_senderids = VALUE /aws1/cl_pp2senderidandcountry=>tt_senderidlist(
    (
      new /aws1/cl_pp2senderidandcountry(
        iv_isocountrycode = |string|
        iv_senderid = |string|
      )
    )
  )
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_owner = |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_senderids( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_senderidarn( ).
      lv_senderid = lo_row_1->get_senderid( ).
      lv_isocountrycode = lo_row_1->get_isocountrycode( ).
      LOOP AT lo_row_1->get_messagetypes( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_messagetype = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_monthlyleasingprice( ).
      lv_primitiveboolean = lo_row_1->get_deletionprotectionenbd( ).
      lv_primitiveboolean = lo_row_1->get_registered( ).
      lv_string = lo_row_1->get_registrationid( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_PP2=>DESCRIBESENDERIDS()¶