organizations_list_roots: Lists the roots that are defined in the current organization

Description Usage Arguments Value Request syntax Examples

View source: R/organizations_operations.R

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 describe_organization.

Usage

1
organizations_list_roots(NextToken, MaxResults)

Arguments

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.

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.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
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"
)

Request syntax

1
2
3
4
svc$list_roots(
  NextToken = "string",
  MaxResults = 123
)

Examples

1
2
3
4
5
6
## Not run: 
# The following example shows how to get the list of the roots in the
# current organization:/n/n
svc$list_roots()

## End(Not run)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.