DESCRIBEOPTOUTLISTS()`¶

About DescribeOptOutLists¶

Describes the specified opt-out list or all opt-out lists in your account.

If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists.

If you specify an opt-out list name that isn't valid, an error is returned.

Method Signature¶

METHODS /AWS1/IF_PP2~DESCRIBEOPTOUTLISTS
  IMPORTING
    !IT_OPTOUTLISTNAMES TYPE /AWS1/CL_PP2OPTOUTLSTNAMELST_W=>TT_OPTOUTLISTNAMELIST 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_pp2dscoptoutlistsrs
  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_optoutlistnames` `TYPE /AWS1/CL_PP2OPTOUTLSTNAMELST_W=>TT_OPTOUTLISTNAMELIST` `TT_OPTOUTLISTNAMELIST`¶

The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.

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

`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 Opt-Out List to ones your account owns or use SHARED to filter on Opt-Out List shared with your account. The Owner and OptOutListNames parameters can't be used at the same time.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_pp2dscoptoutlistsrs` `/AWS1/CL_PP2DSCOPTOUTLISTSRS`¶

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->describeoptoutlists(
  it_optoutlistnames = VALUE /aws1/cl_pp2optoutlstnamelst_w=>tt_optoutlistnamelist(
    ( new /aws1/cl_pp2optoutlstnamelst_w( |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_optoutlists( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_optoutlistarn( ).
      lv_optoutlistname = lo_row_1->get_optoutlistname( ).
      lv_timestamp = lo_row_1->get_createdtimestamp( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_PP2=>DESCRIBEOPTOUTLISTS()¶