amazonka-organizations-2.0: Amazon Organizations SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Organizations.Types.Root

Description

 
Synopsis

Documentation

data Root Source #

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. The root contains every Amazon Web Services account in the organization.

See: newRoot smart constructor.

Constructors

Root' 

Fields

  • arn :: Maybe Text

    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 :: Maybe Text

    The unique identifier (ID) for the root.

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

  • name :: Maybe Text

    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.

  • policyTypes :: Maybe [PolicyTypeSummary]

    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.

Instances

Instances details
FromJSON Root Source # 
Instance details

Defined in Amazonka.Organizations.Types.Root

Methods

parseJSON :: Value -> Parser Root #

parseJSONList :: Value -> Parser [Root] #

Generic Root Source # 
Instance details

Defined in Amazonka.Organizations.Types.Root

Associated Types

type Rep Root :: Type -> Type #

Methods

from :: Root -> Rep Root x #

to :: Rep Root x -> Root #

Read Root Source # 
Instance details

Defined in Amazonka.Organizations.Types.Root

Methods

readsPrec :: Int -> ReadS Root #

readList :: ReadS [Root] #

readPrec :: ReadPrec Root #

readListPrec :: ReadPrec [Root] #

Show Root Source # 
Instance details

Defined in Amazonka.Organizations.Types.Root

Methods

showsPrec :: Int -> Root -> ShowS #

show :: Root -> String #

showList :: [Root] -> ShowS #

NFData Root Source # 
Instance details

Defined in Amazonka.Organizations.Types.Root

Methods

rnf :: Root -> () #

Eq Root Source # 
Instance details

Defined in Amazonka.Organizations.Types.Root

Methods

(==) :: Root -> Root -> Bool #

(/=) :: Root -> Root -> Bool #

Hashable Root Source # 
Instance details

Defined in Amazonka.Organizations.Types.Root

Methods

hashWithSalt :: Int -> Root -> Int #

hash :: Root -> Int #

type Rep Root Source # 
Instance details

Defined in Amazonka.Organizations.Types.Root

type Rep Root = D1 ('MetaData "Root" "Amazonka.Organizations.Types.Root" "amazonka-organizations-2.0-JONpdX4PtttLcKxQshpOlA" 'False) (C1 ('MetaCons "Root'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "policyTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PolicyTypeSummary])))))

newRoot :: Root Source #

Create a value of Root with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arn:Root', root_arn - 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.

$sel:id:Root', root_id - The unique identifier (ID) for the root.

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

$sel:name:Root', root_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.

$sel:policyTypes:Root', root_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.

root_arn :: Lens' Root (Maybe Text) Source #

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.

root_id :: Lens' Root (Maybe Text) Source #

The unique identifier (ID) for the root.

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

root_name :: Lens' Root (Maybe Text) Source #

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.

root_policyTypes :: Lens' Root (Maybe [PolicyTypeSummary]) Source #

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.