| 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.ListRoots
Description
Lists the roots that are defined in the current organization.
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.
Policy types can be enabled and disabled in roots. This is distinct from whether they're available in the organization. When you enable all features, you make policy types available for use in that organization. Individual policy types can then be enabled and disabled in a root. To see the availability of a policy type in an organization, use DescribeOrganization.
This operation returns paginated results.
Synopsis
- data ListRoots = ListRoots' {}
- newListRoots :: ListRoots
- listRoots_nextToken :: Lens' ListRoots (Maybe Text)
- listRoots_maxResults :: Lens' ListRoots (Maybe Natural)
- data ListRootsResponse = ListRootsResponse' {}
- newListRootsResponse :: Int -> ListRootsResponse
- listRootsResponse_roots :: Lens' ListRootsResponse (Maybe [Root])
- listRootsResponse_nextToken :: Lens' ListRootsResponse (Maybe Text)
- listRootsResponse_httpStatus :: Lens' ListRootsResponse Int
Creating a Request
See: newListRoots smart constructor.
Constructors
| ListRoots' | |
Fields
| |
Instances
newListRoots :: ListRoots Source #
Create a value of ListRoots 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:ListRoots', listRoots_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:ListRoots', listRoots_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.
Request Lenses
listRoots_nextToken :: Lens' ListRoots (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.
listRoots_maxResults :: Lens' ListRoots (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.
Destructuring the Response
data ListRootsResponse Source #
See: newListRootsResponse smart constructor.
Constructors
| ListRootsResponse' | |
Fields
| |
Instances
Arguments
| :: Int | |
| -> ListRootsResponse |
Create a value of ListRootsResponse 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:roots:ListRootsResponse', listRootsResponse_roots - A list of roots that are defined in an organization.
$sel:nextToken:ListRoots', listRootsResponse_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:httpStatus:ListRootsResponse', listRootsResponse_httpStatus - The response's http status code.
Response Lenses
listRootsResponse_roots :: Lens' ListRootsResponse (Maybe [Root]) Source #
A list of roots that are defined in an organization.
listRootsResponse_nextToken :: Lens' ListRootsResponse (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.
listRootsResponse_httpStatus :: Lens' ListRootsResponse Int Source #
The response's http status code.