Skip to content

Root

Source code in docs_src/capo_organizations/types/root.py 
14
15
16
17
18
19
20
21
22
class Root(TypedDict, closed=True):
    id: NotRequired["capo_organizations.types.root_id.RootId"]
    """<p>The unique identifier (ID) for the root. The ID is unique to the organization only.</p> <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.</p>"""
    arn: NotRequired["capo_organizations.types.root_arn.RootArn"]
    """<p>The Amazon Resource Name (ARN) of the root.</p> <p>For more information about ARNs in Organizations, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies">ARN Formats Supported by Organizations</a> in the <i>Amazon Web Services Service Authorization Reference</i>.</p>"""
    name: NotRequired["capo_organizations.types.root_name.RootName"]
    """<p>The friendly name of the root.</p> <p>The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> that is used to validate this parameter is a string of any of the characters in the ASCII character range.</p>"""
    policy_types: NotRequired["capo_organizations.types.policy_types.PolicyTypes"]
    """<p>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.</p> <note> <p>Even if a policy type is shown as available in the organization, you can separately enable and disable them at the root level by using <a>EnablePolicyType</a> and <a>DisablePolicyType</a>. Use <a>DescribeOrganization</a> to see the availability of the policy types in that organization.</p> </note>"""

arn instance-attribute 

arn: NotRequired[RootArn]

The Amazon Resource Name (ARN) of the root.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.

id instance-attribute 

id: NotRequired[RootId]

The unique identifier (ID) for the root. The ID is unique to the organization only.

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

name instance-attribute 

name: NotRequired[RootName]

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.

policy_types instance-attribute 

policy_types: NotRequired[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.

Even if a policy type is shown as available in the organization, you can separately enable and disable them at the root level by using EnablePolicyType and DisablePolicyType. Use DescribeOrganization to see the availability of the policy types in that organization.