Menu
AWS Organizations API Reference
API Reference (API Version 2016-11-28)

Root

Contains details about a root. A root is a top-level parent node in the hierarchy of an organization that can contain organizational units (OUs) and accounts. Every root contains every AWS account in the organization. Each root enables the accounts to be organized in a different way and to have different policy types enabled for use in that root.

Contents

Arn

The Amazon Resource Name (ARN) of the root.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

Type: String

Pattern: ^arn:aws:organizations::\d{12}:root\/o-[a-z0-9]{10,32}\/r-[0-9a-z]{4,32}

Required: No

Id

The unique identifier (ID) for the root.

The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lower-case letters or digits.

Type: String

Pattern: ^r-[0-9a-z]{4,32}$

Required: No

Name

The friendly name of the root.

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

PolicyTypes

The types of policies that are currently enabled for the root and therefore can be attached to the root or to its OUs or accounts.

Type: Array of PolicyTypeSummary objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: