Skip to content

/AWS1/IF_DZN=>LISTACCOUNTPOOLS()

About ListAccountPools

Lists existing account pools.

Method Signature

METHODS /AWS1/IF_DZN~LISTACCOUNTPOOLS
  IMPORTING
    !IV_DOMAINIDENTIFIER TYPE /AWS1/DZNDOMAINID OPTIONAL
    !IV_NAME TYPE /AWS1/DZNACCOUNTPOOLNAME OPTIONAL
    !IV_SORTBY TYPE /AWS1/DZNSORTFIELDACCOUNTPOOL OPTIONAL
    !IV_SORTORDER TYPE /AWS1/DZNSORTORDER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/DZNPAGINATIONTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/DZNMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dznlistacctpoolsout
  RAISING
    /AWS1/CX_DZNACCESSDENIEDEX
    /AWS1/CX_DZNTHROTTLINGEX
    /AWS1/CX_DZNUNAUTHORIZEDEX
    /AWS1/CX_DZNINTERNALSERVEREX
    /AWS1/CX_DZNVALIDATIONEX
    /AWS1/CX_DZNCLIENTEXC
    /AWS1/CX_DZNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_domainidentifier TYPE /AWS1/DZNDOMAINID /AWS1/DZNDOMAINID

The ID of the domain where exsting account pools are to be listed.

Optional arguments:

iv_name TYPE /AWS1/DZNACCOUNTPOOLNAME /AWS1/DZNACCOUNTPOOLNAME

The name of the account pool to be listed.

iv_sortby TYPE /AWS1/DZNSORTFIELDACCOUNTPOOL /AWS1/DZNSORTFIELDACCOUNTPOOL

The sort by mechanism in which the existing account pools are to be listed.

iv_sortorder TYPE /AWS1/DZNSORTORDER /AWS1/DZNSORTORDER

The sort order in which the existing account pools are to be listed.

iv_nexttoken TYPE /AWS1/DZNPAGINATIONTOKEN /AWS1/DZNPAGINATIONTOKEN

When the number of account pools is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of account pools, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAccountPools to list the next set of account pools.

iv_maxresults TYPE /AWS1/DZNMAXRESULTS /AWS1/DZNMAXRESULTS

The maximum number of account pools to return in a single call to ListAccountPools. When the number of account pools to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListAccountPools to list the next set of account pools.

RETURNING

oo_output TYPE REF TO /aws1/cl_dznlistacctpoolsout /AWS1/CL_DZNLISTACCTPOOLSOUT

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->listaccountpools(
  iv_domainidentifier = |string|
  iv_maxresults = 123
  iv_name = |string|
  iv_nexttoken = |string|
  iv_sortby = |string|
  iv_sortorder = |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_items( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_domainid = lo_row_1->get_domainid( ).
      lv_accountpoolid = lo_row_1->get_id( ).
      lv_accountpoolname = lo_row_1->get_name( ).
      lv_resolutionstrategy = lo_row_1->get_resolutionstrategy( ).
      lv_domainunitid = lo_row_1->get_domainunitid( ).
      lv_createdby = lo_row_1->get_createdby( ).
      lv_updatedby = lo_row_1->get_updatedby( ).
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.