organizations_attach_policy: Attaches a policy to a root, an organizational unit (OU), or...

Description Usage Arguments Value Request syntax Examples

View source: R/organizations_operations.R

Description

Attaches a policy to a root, an organizational unit (OU), or an individual account. How the policy affects accounts depends on the type of policy. Refer to the AWS Organizations User Guide for information about each policy type:

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

Usage

1
organizations_attach_policy(PolicyId, TargetId)

Arguments

PolicyId

[required] The unique identifier (ID) of the policy that you want to attach to the target. You can get the ID for the policy by calling the list_policies operation.

The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

TargetId

[required] The unique identifier (ID) of the root, OU, or account that you want to attach the policy to. You can get the ID by calling the list_roots, list_organizational_units_for_parent, or list_accounts operations.

The regex pattern for a target ID string requires one of the following:

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.

  • Account - A string that consists of exactly 12 digits.

  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

Value

An empty list.

Request syntax

1
2
3
4
svc$attach_policy(
  PolicyId = "string",
  TargetId = "string"
)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
## Not run: 
# The following example shows how to attach a service control policy (SCP)
# to an OU:
# 
svc$attach_policy(
  PolicyId = "p-examplepolicyid111",
  TargetId = "ou-examplerootid111-exampleouid111"
)

# The following example shows how to attach a service control policy (SCP)
# to an account:
# 
svc$attach_policy(
  PolicyId = "p-examplepolicyid111",
  TargetId = "333333333333"
)

## End(Not run)

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