organizations_detach_policy: Detaches a policy from a target root, organizational unit...

Description Usage Arguments Value Request syntax Examples

View source: R/organizations_operations.R

Description

Detaches a policy from a target root, organizational unit (OU), or account.

If the policy being detached is a service control policy (SCP), the changes to permissions for AWS Identity and Access Management (IAM) users and roles in affected accounts are immediate.

Every root, OU, and account must have at least one SCP attached. If you want to replace the default FullAWSAccess policy with an SCP that limits the permissions that can be delegated, you must attach the replacement SCP before you can remove the default SCP. This is the authorization strategy of an "allow list". If you instead attach a second SCP and leave the FullAWSAccess SCP still attached, and specify "Effect": "Deny" in the second SCP to override the "Effect": "Allow" in the FullAWSAccess policy (or any other attached SCP), you're using the authorization strategy of a "deny list".

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

Usage

1
organizations_detach_policy(PolicyId, TargetId)

Arguments

PolicyId

[required] The unique identifier (ID) of the policy you want to detach. You can get the ID from the list_policies or list_policies_for_target operations.

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 detach the policy from. You can get the ID from 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$detach_policy(
  PolicyId = "string",
  TargetId = "string"
)

Examples

1
2
3
4
5
6
7
8
## Not run: 
# The following example shows how to detach a policy from an OU:/n/n
svc$detach_policy(
  PolicyId = "p-examplepolicyid111",
  TargetId = "ou-examplerootid111-exampleouid111"
)

## End(Not run)

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