libZSservicesZSamazonka-organizationsZSamazonka-organizations
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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

Creating a Request

data DescribeOrganizationalUnit Source #

See: newDescribeOrganizationalUnit smart constructor.

Constructors

DescribeOrganizationalUnit' 

Fields

  • organizationalUnitId :: Text

    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.

Instances

Instances details
Eq DescribeOrganizationalUnit Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganizationalUnit

Read DescribeOrganizationalUnit Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganizationalUnit

Show DescribeOrganizationalUnit Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganizationalUnit

Generic DescribeOrganizationalUnit Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganizationalUnit

Associated Types

type Rep DescribeOrganizationalUnit :: Type -> Type #

NFData DescribeOrganizationalUnit Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganizationalUnit

Hashable DescribeOrganizationalUnit Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganizationalUnit

ToJSON DescribeOrganizationalUnit Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganizationalUnit

AWSRequest DescribeOrganizationalUnit Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganizationalUnit

ToHeaders DescribeOrganizationalUnit Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganizationalUnit

ToPath DescribeOrganizationalUnit Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganizationalUnit

ToQuery DescribeOrganizationalUnit Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganizationalUnit

type Rep DescribeOrganizationalUnit Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganizationalUnit

type Rep DescribeOrganizationalUnit = D1 ('MetaData "DescribeOrganizationalUnit" "Amazonka.Organizations.DescribeOrganizationalUnit" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "DescribeOrganizationalUnit'" 'PrefixI 'True) (S1 ('MetaSel ('Just "organizationalUnitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeOrganizationalUnit Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganizationalUnit

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 #

Constructors

DescribeOrganizationalUnitResponse' 

Fields

Instances

Instances details
Eq DescribeOrganizationalUnitResponse Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganizationalUnit

Read DescribeOrganizationalUnitResponse Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganizationalUnit

Show DescribeOrganizationalUnitResponse Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganizationalUnit

Generic DescribeOrganizationalUnitResponse Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganizationalUnit

Associated Types

type Rep DescribeOrganizationalUnitResponse :: Type -> Type #

NFData DescribeOrganizationalUnitResponse Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganizationalUnit

type Rep DescribeOrganizationalUnitResponse Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganizationalUnit

type Rep DescribeOrganizationalUnitResponse = D1 ('MetaData "DescribeOrganizationalUnitResponse" "Amazonka.Organizations.DescribeOrganizationalUnit" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "DescribeOrganizationalUnitResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "organizationalUnit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OrganizationalUnit)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeOrganizationalUnitResponse Source #

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