DESCRIBEPOOLS()`¶

About DescribePools¶

Retrieves the specified pools or all pools associated with your Amazon Web Services account.

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

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

A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.

Method Signature¶

METHODS /AWS1/IF_PP2~DESCRIBEPOOLS
  IMPORTING
    !IT_POOLIDS TYPE /AWS1/CL_PP2POOLIDLIST_W=>TT_POOLIDLIST OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_PP2POOLFILTER=>TT_POOLFILTERLIST 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_pp2descrpoolsresult
  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_poolids` `TYPE /AWS1/CL_PP2POOLIDLIST_W=>TT_POOLIDLIST` `TT_POOLIDLIST`¶

The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.

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

`it_filters` `TYPE /AWS1/CL_PP2POOLFILTER=>TT_POOLFILTERLIST` `TT_POOLFILTERLIST`¶

An array of PoolFilter 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 Pools to ones your account owns or use SHARED to filter on Pools shared with your account. The Owner and PoolIds parameters can't be used at the same time.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_pp2descrpoolsresult` `/AWS1/CL_PP2DESCRPOOLSRESULT`¶

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->describepools(
  it_filters = VALUE /aws1/cl_pp2poolfilter=>tt_poolfilterlist(
    (
      new /aws1/cl_pp2poolfilter(
        it_values = VALUE /aws1/cl_pp2filtervaluelist_w=>tt_filtervaluelist(
          ( new /aws1/cl_pp2filtervaluelist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  it_poolids = VALUE /aws1/cl_pp2poolidlist_w=>tt_poolidlist(
    ( new /aws1/cl_pp2poolidlist_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_pools( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_poolarn( ).
      lv_string = lo_row_1->get_poolid( ).
      lv_poolstatus = lo_row_1->get_status( ).
      lv_messagetype = lo_row_1->get_messagetype( ).
      lv_primitiveboolean = lo_row_1->get_twowayenabled( ).
      lv_twowaychannelarn = lo_row_1->get_twowaychannelarn( ).
      lv_iamrolearn = lo_row_1->get_twowaychannelrole( ).
      lv_primitiveboolean = lo_row_1->get_selfmanagedoptoutsenbd( ).
      lv_optoutlistname = lo_row_1->get_optoutlistname( ).
      lv_primitiveboolean = lo_row_1->get_sharedroutesenabled( ).
      lv_primitiveboolean = lo_row_1->get_deletionprotectionenbd( ).
      lv_timestamp = lo_row_1->get_createdtimestamp( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_PP2=>DESCRIBEPOOLS()¶