organizations_describe_organizational_unit: Retrieves information about an organizational unit (OU)

Description Usage Arguments Value Request syntax Examples

View source: R/organizations_operations.R

Description

Retrieves information about an organizational unit (OU).

This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.

Usage

1

Arguments

OrganizationalUnitId

[required] The unique identifier (ID) of 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:

1
2
3
4
5
6
7
list(
  OrganizationalUnit = list(
    Id = "string",
    Arn = "string",
    Name = "string"
  )
)

Request syntax

1
2
3
svc$describe_organizational_unit(
  OrganizationalUnitId = "string"
)

Examples

1
2
3
4
5
6
7
## Not run: 
# The following example shows how to request details about an OU:/n/n
svc$describe_organizational_unit(
  OrganizationalUnitId = "ou-examplerootid111-exampleouid111"
)

## End(Not run)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.