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.

When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.

You can only call this operation from the management account or a member account that is a delegated administrator.

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

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 maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining 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"|"RESOURCE_CONTROL_POLICY"|"TAG_POLICY"|"BACKUP_POLICY"|"AISERVICES_OPT_OUT_POLICY"|"CHATBOT_POLICY"|"DECLARATIVE_POLICY_EC2"|"SECURITYHUB_POLICY"|"INSPECTOR_POLICY"|"UPGRADE_ROLLOUT_POLICY"|"BEDROCK_POLICY"|"S3_POLICY"|"NETWORK_SECURITY_DIRECTOR_POLICY",
          Status = "ENABLED"|"PENDING_ENABLE"|"PENDING_DISABLE"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_roots(
  NextToken = "string",
  MaxResults = 123
)

Examples

## 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)