| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Organizations.DescribeOrganizationalUnit
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.
Synopsis
- data DescribeOrganizationalUnit = DescribeOrganizationalUnit' {}
- newDescribeOrganizationalUnit :: Text -> DescribeOrganizationalUnit
- describeOrganizationalUnit_organizationalUnitId :: Lens' DescribeOrganizationalUnit Text
- data DescribeOrganizationalUnitResponse = DescribeOrganizationalUnitResponse' {}
- newDescribeOrganizationalUnitResponse :: Int -> DescribeOrganizationalUnitResponse
- describeOrganizationalUnitResponse_organizationalUnit :: Lens' DescribeOrganizationalUnitResponse (Maybe OrganizationalUnit)
- describeOrganizationalUnitResponse_httpStatus :: Lens' DescribeOrganizationalUnitResponse Int
Creating a Request
data DescribeOrganizationalUnit Source #
See: newDescribeOrganizationalUnit smart constructor.
Constructors
| DescribeOrganizationalUnit' | |
Fields
| |
Instances
newDescribeOrganizationalUnit Source #
Create a value of DescribeOrganizationalUnit 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:organizationalUnitId:DescribeOrganizationalUnit', describeOrganizationalUnit_organizationalUnitId - The unique identifier (ID) of the organizational unit that you want
details about. You can get the ID from the
ListOrganizationalUnitsForParent 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.
Request Lenses
describeOrganizationalUnit_organizationalUnitId :: Lens' DescribeOrganizationalUnit Text Source #
The unique identifier (ID) of the organizational unit that you want details about. You can get the ID from the ListOrganizationalUnitsForParent 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.
Destructuring the Response
data DescribeOrganizationalUnitResponse Source #
See: newDescribeOrganizationalUnitResponse smart constructor.
Constructors
| DescribeOrganizationalUnitResponse' | |
Fields
| |
Instances
newDescribeOrganizationalUnitResponse Source #
Arguments
| :: Int | |
| -> DescribeOrganizationalUnitResponse |
Create a value of DescribeOrganizationalUnitResponse 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:organizationalUnit:DescribeOrganizationalUnitResponse', describeOrganizationalUnitResponse_organizationalUnit - A structure that contains details about the specified OU.
$sel:httpStatus:DescribeOrganizationalUnitResponse', describeOrganizationalUnitResponse_httpStatus - The response's http status code.
Response Lenses
describeOrganizationalUnitResponse_organizationalUnit :: Lens' DescribeOrganizationalUnitResponse (Maybe OrganizationalUnit) Source #
A structure that contains details about the specified OU.
describeOrganizationalUnitResponse_httpStatus :: Lens' DescribeOrganizationalUnitResponse Int Source #
The response's http status code.