List Parents
organizations_list_parents | R Documentation |
Lists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or account¶
Description¶
Lists the root or organizational units (OUs) that serve as the immediate
parent of the specified child OU or account. This operation, along with
list_children
enables you to traverse the tree structure that makes up
this root.
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 management account or by a member account that is a delegated administrator for an Amazon Web Services service.
In the current release, a child can have only a single parent.
Usage¶
Arguments¶
ChildId
[required] The unique identifier (ID) of the OU or account whose parent containers you want to list. Don't specify a root.
The regex pattern for a child ID string requires one of the following:
Account - A string that consists of exactly 12 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 contains the OU). 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. ANextToken
response indicates that more output is available. Set this parameter to the value of the previous call'sNextToken
response to indicate where the output should continue from.MaxResults
The total number of results that you want included on each page of 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 theNextToken
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 checkNextToken
after every operation to ensure that you receive all of the results.
Value¶
A list with the following syntax:
list(
Parents = list(
list(
Id = "string",
Type = "ROOT"|"ORGANIZATIONAL_UNIT"
)
),
NextToken = "string"
)