organizations_delete_organizational_unit: Deletes an organizational unit (OU) from a root or another OU

Description Usage Arguments Value Request syntax Examples

View source: R/organizations_operations.R

Description

Deletes an organizational unit (OU) from a root or another OU. You must first remove all accounts and child OUs from the OU that you want to delete.

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

Usage

1

Arguments

OrganizationalUnitId

[required] The unique identifier (ID) of the organizational unit that you want to delete. You can get the ID from the list_organizational_units_for_parent operation.

The regex pattern for an organizational unit ID string requires "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). 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
svc$delete_organizational_unit(
  OrganizationalUnitId = "string"
)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
# The following example shows how to delete an OU. The example assumes
# that you previously removed all accounts and other OUs from the OU:
# 
# 
svc$delete_organizational_unit(
  OrganizationalUnitId = "ou-examplerootid111-exampleouid111"
)

## End(Not run)

paws.management documentation built on March 8, 2021, 1:07 a.m.