Skip to content

Retrieves information about an organizational unit (OU)

Description

Retrieves information about an organizational unit (OU).

You can only call this operation from the management account or a member account that is a delegated administrator.

Usage

organizations_describe_organizational_unit(OrganizationalUnitId)

Arguments

  • OrganizationalUnitId

[required] ID for the organizational unit that you want details about. You can get the ID from the list_organizational_units_for_parent operation.

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.

Value

A list with the following syntax:

list(
  OrganizationalUnit = list(
    Id = "string",
    Arn = "string",
    Name = "string",
    Path = "string"
  )
)

Request syntax

svc$describe_organizational_unit(
  OrganizationalUnitId = "string"
)

Examples

# The following example shows how to request details about an OU:/n/n
svc$describe_organizational_unit(
  OrganizationalUnitId = "ou-examplerootid111-exampleouid111"
)