Amazonka.Organizations.Types.OrganizationalUnit

Documentation

data OrganizationalUnit

Contains details about an organizational unit (OU). An OU is a container of Amazon Web Services accounts within a root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any child OUs.

See: newOrganizationalUnit smart constructor.

Constructors

OrganizationalUnit'

Fields

• arn :: Maybe Text

  The Amazon Resource Name (ARN) of this OU.

  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) associated with this OU.

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

  The friendly name of this OU.

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

Instances

FromJSON OrganizationalUnit

Defined in Amazonka.Organizations.Types.OrganizationalUnit

Methods

parseJSON :: Value -> Parser OrganizationalUnit

parseJSONList :: Value -> Parser [OrganizationalUnit]

Generic OrganizationalUnit

Defined in Amazonka.Organizations.Types.OrganizationalUnit

Associated Types

type Rep OrganizationalUnit :: Type -> Type

Methods

from :: OrganizationalUnit -> Rep OrganizationalUnit x

to :: Rep OrganizationalUnit x -> OrganizationalUnit

Read OrganizationalUnit

Defined in Amazonka.Organizations.Types.OrganizationalUnit

Methods

readsPrec :: Int -> ReadS OrganizationalUnit

readList :: ReadS [OrganizationalUnit]

readPrec :: ReadPrec OrganizationalUnit

readListPrec :: ReadPrec [OrganizationalUnit]

Show OrganizationalUnit

Defined in Amazonka.Organizations.Types.OrganizationalUnit

Methods

showsPrec :: Int -> OrganizationalUnit -> ShowS

show :: OrganizationalUnit -> String

showList :: [OrganizationalUnit] -> ShowS

NFData OrganizationalUnit

Defined in Amazonka.Organizations.Types.OrganizationalUnit

Methods

rnf :: OrganizationalUnit -> ()

Eq OrganizationalUnit

Defined in Amazonka.Organizations.Types.OrganizationalUnit

Methods

(==) :: OrganizationalUnit -> OrganizationalUnit -> Bool

(/=) :: OrganizationalUnit -> OrganizationalUnit -> Bool

Hashable OrganizationalUnit

Defined in Amazonka.Organizations.Types.OrganizationalUnit

Methods

hashWithSalt :: Int -> OrganizationalUnit -> Int

hash :: OrganizationalUnit -> Int

type Rep OrganizationalUnit

Defined in Amazonka.Organizations.Types.OrganizationalUnit

type Rep OrganizationalUnit = D1 ('MetaData "OrganizationalUnit" "Amazonka.Organizations.Types.OrganizationalUnit" "amazonka-organizations-2.0-JONpdX4PtttLcKxQshpOlA" 'False) (C1 ('MetaCons "OrganizationalUnit'" '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)))))

newOrganizationalUnit :: OrganizationalUnit

Create a value of OrganizationalUnit 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:OrganizationalUnit', organizationalUnit_arn - The Amazon Resource Name (ARN) of this OU.

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

$sel:id:OrganizationalUnit', organizationalUnit_id - The unique identifier (ID) associated with this OU.

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.

$sel:name:OrganizationalUnit', organizationalUnit_name - The friendly name of this OU.

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

organizationalUnit_arn :: Lens' OrganizationalUnit (Maybe Text)

The Amazon Resource Name (ARN) of this OU.

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

organizationalUnit_id :: Lens' OrganizationalUnit (Maybe Text)

The unique identifier (ID) associated with this OU.

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.

organizationalUnit_name :: Lens' OrganizationalUnit (Maybe Text)

The friendly name of this OU.

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