List Roots
organizations_list_roots | R Documentation |
Lists the roots that are defined in the current organization¶
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 Amazon Web Services 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
describe_organization
.
Usage¶
Arguments¶
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(
Roots = list(
list(
Id = "string",
Arn = "string",
Name = "string",
PolicyTypes = list(
list(
Type = "SERVICE_CONTROL_POLICY"|"TAG_POLICY"|"BACKUP_POLICY"|"AISERVICES_OPT_OUT_POLICY",
Status = "ENABLED"|"PENDING_ENABLE"|"PENDING_DISABLE"
)
)
)
),
NextToken = "string"
)