LISTCHILDREN()`¶

About ListChildren¶

Lists all of the organizational units (OUs) or accounts that are contained in the specified parent OU or root. This operation, along with ListParents enables you to traverse the tree structure that makes up this root.

When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.

You can only call this operation from the management account or a member account that is a delegated administrator.

Method Signature¶

METHODS /AWS1/IF_ORG~LISTCHILDREN
  IMPORTING
    !IV_PARENTID TYPE /AWS1/ORGPARENTID OPTIONAL
    !IV_CHILDTYPE TYPE /AWS1/ORGCHILDTYPE OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/ORGNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/ORGMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_orglistchildrenrsp
  RAISING
    /AWS1/CX_ORGACCESSDENIEDEX
    /AWS1/CX_ORGAWSORGSNOTINUSEEX
    /AWS1/CX_ORGINVALIDINPUTEX
    /AWS1/CX_ORGPARENTNOTFOUNDEX
    /AWS1/CX_ORGSERVICEEXCEPTION
    /AWS1/CX_ORGTOOMANYREQUESTSEX
    /AWS1/CX_ORGCLIENTEXC
    /AWS1/CX_ORGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_parentid` `TYPE /AWS1/ORGPARENTID` `/AWS1/ORGPARENTID`¶

The unique identifier (ID) for the parent root or OU whose children you want to list.

The regex pattern for a parent ID string requires one of the following:

Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.

Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

`iv_childtype` `TYPE /AWS1/ORGCHILDTYPE` `/AWS1/ORGCHILDTYPE`¶

Filters the output to include only the specified child type.

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/ORGNEXTTOKEN` `/AWS1/ORGNEXTTOKEN`¶

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

`iv_maxresults` `TYPE /AWS1/ORGMAXRESULTS` `/AWS1/ORGMAXRESULTS`¶

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_orglistchildrenrsp` `/AWS1/CL_ORGLISTCHILDRENRSP`¶

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->listchildren(
  iv_childtype = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_parentid = |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_children( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_childid = lo_row_1->get_id( ).
      lv_childtype = lo_row_1->get_type( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

To retrieve a list of all of the child accounts and OUs in a parent root or OU¶

The following example shows how to request a list of the child OUs in a parent root or OU:/n/n

DATA(lo_result) = lo_client->listchildren(
  iv_childtype = |ORGANIZATIONAL_UNIT|
  iv_parentid = |ou-examplerootid111-exampleouid111|
).

/AWS1/IF_ORG=>LISTCHILDREN()¶