Skip to content

Lists the organizational units (OUs) in a parent organizational unit or root

Description

Lists the organizational units (OUs) in a parent organizational unit or 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_organizational_units_for_parent(ParentId, NextToken,
  MaxResults)

Arguments

  • ParentId

    [required] ID for the root or OU whose child OUs 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.

  • 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(
  OrganizationalUnits = list(
    list(
      Id = "string",
      Arn = "string",
      Name = "string",
      Path = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_organizational_units_for_parent(
  ParentId = "string",
  NextToken = "string",
  MaxResults = 123
)

Examples

# The following example shows how to get a list of OUs in a specified
# root:/n/n
svc$list_organizational_units_for_parent(
  ParentId = "r-examplerootid111"
)