organizations_create_organizational_unit: Creates an organizational unit (OU) within a root or parent...

Description Usage Arguments Value Request syntax Examples

View source: R/organizations_operations.R

Description

Creates an organizational unit (OU) within a root or parent OU. An OU is a container for accounts that enables you to organize your accounts to apply policies according to your business requirements. The number of levels deep that you can nest OUs is dependent upon the policy types enabled for that root. For service control policies, the limit is five.

For more information about OUs, see Managing Organizational Units in the AWS Organizations User Guide.

If the request includes tags, then the requester must have the organizations:TagResource permission.

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

Usage

1

Arguments

ParentId

[required] The unique identifier (ID) of the parent root or OU that you want to create the new OU in.

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

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or 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.

Name

[required] The friendly name to assign to the new OU.

Tags

A list of tags that you want to attach to the newly created OU. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null. For more information about tagging, see Tagging AWS Organizations resources in the AWS Organizations User Guide.

If any one of the tags is invalid or if you exceed the allowed number of tags for an OU, then the entire request fails and the OU is not created.

Value

A list with the following syntax:

1
2
3
4
5
6
7
list(
  OrganizationalUnit = list(
    Id = "string",
    Arn = "string",
    Name = "string"
  )
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
svc$create_organizational_unit(
  ParentId = "string",
  Name = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## Not run: 
# The following example shows how to create an OU that is named
# AccountingOU. The new OU is directly under the root.:
# 
# 
svc$create_organizational_unit(
  Name = "AccountingOU",
  ParentId = "r-examplerootid111"
)

## End(Not run)

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