paws.management (version 0.1.12)

organizations_update_organizational_unit: Renames the specified organizational unit (OU)

Description

Renames the specified organizational unit (OU). The ID and ARN don't change. The child OUs and accounts remain in place, and any attached policies of the OU remain attached.

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

Usage

organizations_update_organizational_unit(OrganizationalUnitId, Name)

Value

A list with the following syntax:

list(
  OrganizationalUnit = list(
    Id = "string",
    Arn = "string",
    Name = "string"
  )
)

Arguments

OrganizationalUnitId

[required] The unique identifier (ID) of the OU that you want to rename. 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.

Name

The new name that you want to assign to the OU.

The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

Request syntax

svc$update_organizational_unit(
  OrganizationalUnitId = "string",
  Name = "string"
)

Examples

if (FALSE) {
# The following example shows how to rename an OU. The output confirms the
# new name:/n/n
svc$update_organizational_unit(
  Name = "AccountingOU",
  OrganizationalUnitId = "ou-examplerootid111-exampleouid111"
)
}