organizations_enable_policy_type: Enables a policy type in a root

Description Usage Arguments Value Request syntax Examples

View source: R/organizations_operations.R

Description

Enables a policy type in a root. After you enable a policy type in a root, you can attach policies of that type to the root, any organizational unit (OU), or account in that root. You can undo this by using the disable_policy_type operation.

This is an asynchronous request that AWS performs in the background. AWS recommends that you first use list_roots to see the status of policy types for a specified root, and then use this operation.

This operation can be called only from the organization's management account.

You can enable a policy type in a root only if that policy type is available in the organization. To view the status of available policy types in the organization, use describe_organization.

Usage

1

Arguments

RootId

[required] The unique identifier (ID) of the root in which you want to enable a policy type. You can get the ID from the list_roots operation.

The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.

PolicyType

[required] The policy type that you want to enable. You can specify one of the following values:

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
list(
  Root = 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"
      )
    )
  )
)

Request syntax

1
2
3
4
svc$enable_policy_type(
  RootId = "string",
  PolicyType = "SERVICE_CONTROL_POLICY"|"TAG_POLICY"|"BACKUP_POLICY"|"AISERVICES_OPT_OUT_POLICY"
)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
# The following example shows how to enable the service control policy
# (SCP) policy type in a root. The output shows a root object with a
# PolicyTypes response element showing that SCPs are now enabled:/n/n
svc$enable_policy_type(
  PolicyType = "SERVICE_CONTROL_POLICY",
  RootId = "r-examplerootid111"
)

## End(Not run)

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