| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Organizations.ListParents
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 ListChildren 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 AWS service.
In the current release, a child can have only a single parent.
This operation returns paginated results.
Synopsis
- data ListParents = ListParents' {}
- newListParents :: Text -> ListParents
- listParents_nextToken :: Lens' ListParents (Maybe Text)
- listParents_maxResults :: Lens' ListParents (Maybe Natural)
- listParents_childId :: Lens' ListParents Text
- data ListParentsResponse = ListParentsResponse' {}
- newListParentsResponse :: Int -> ListParentsResponse
- listParentsResponse_nextToken :: Lens' ListParentsResponse (Maybe Text)
- listParentsResponse_parents :: Lens' ListParentsResponse (Maybe [Parent])
- listParentsResponse_httpStatus :: Lens' ListParentsResponse Int
Creating a Request
data ListParents Source #
See: newListParents smart constructor.
Constructors
| ListParents' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ListParents |
Create a value of ListParents with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListParents', listParents_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.
$sel:maxResults:ListParents', listParents_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 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.
$sel:childId:ListParents', listParents_childId - 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.
Request Lenses
listParents_nextToken :: Lens' ListParents (Maybe Text) Source #
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.
listParents_maxResults :: Lens' ListParents (Maybe Natural) Source #
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 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.
listParents_childId :: Lens' ListParents Text Source #
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.
Destructuring the Response
data ListParentsResponse Source #
See: newListParentsResponse smart constructor.
Constructors
| ListParentsResponse' | |
Fields
| |
Instances
newListParentsResponse Source #
Arguments
| :: Int | |
| -> ListParentsResponse |
Create a value of ListParentsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListParents', listParentsResponse_nextToken - If present, indicates that more output is available than is included in
the current response. Use this value in the NextToken request
parameter in a subsequent call to the operation to get the next part of
the output. You should repeat this until the NextToken response
element comes back as null.
$sel:parents:ListParentsResponse', listParentsResponse_parents - A list of parents for the specified child account or OU.
$sel:httpStatus:ListParentsResponse', listParentsResponse_httpStatus - The response's http status code.
Response Lenses
listParentsResponse_nextToken :: Lens' ListParentsResponse (Maybe Text) Source #
If present, indicates that more output is available than is included in
the current response. Use this value in the NextToken request
parameter in a subsequent call to the operation to get the next part of
the output. You should repeat this until the NextToken response
element comes back as null.
listParentsResponse_parents :: Lens' ListParentsResponse (Maybe [Parent]) Source #
A list of parents for the specified child account or OU.
listParentsResponse_httpStatus :: Lens' ListParentsResponse Int Source #
The response's http status code.