List Children

organizations_list_children

R Documentation

Lists all of the organizational units (OUs) or accounts that are contained in the specified parent OU or root¶

Description¶

Lists all of the organizational units (OUs) or accounts that are contained in the specified parent OU or root. This operation, along with list_parents 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.

Usage¶

organizations_list_children(ParentId, ChildType, NextToken, MaxResults)

Arguments¶

ParentId

[required] 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.

ChildType

[required] Filters the output to include only the specified child type.

NextToken

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.

MaxResults

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.

Value¶

A list with the following syntax:

list(
  Children = list(
    list(
      Id = "string",
      Type = "ACCOUNT"|"ORGANIZATIONAL_UNIT"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_children(
  ParentId = "string",
  ChildType = "ACCOUNT"|"ORGANIZATIONAL_UNIT",
  NextToken = "string",
  MaxResults = 123
)

Examples¶

## Not run: 
# The following example shows how to request a list of the child OUs in a
# parent root or OU:/n/n
svc$list_children(
  ChildType = "ORGANIZATIONAL_UNIT",
  ParentId = "ou-examplerootid111-exampleouid111"
)

## End(Not run)