paws.management (version 0.1.0)

organizations_list_children: 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 ListParents enables you to traverse the tree structure that makes up this root.

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 lower-case letters or digits.

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

ChildType

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

NextToken

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

MaxResults

(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Request syntax

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

Details

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization's master account.

Examples

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