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.UpdateOrganizationalUnit

Description

Renames the specified organizational unit (OU). The ID and ARN don't change. The child OUs and accounts remain in place, and any attached policies of the OU remain attached.

This operation can be called only from the organization's management account.

Synopsis

Creating a Request

data UpdateOrganizationalUnit Source #

See: newUpdateOrganizationalUnit smart constructor.

Constructors

UpdateOrganizationalUnit' 

Fields

  • name :: Maybe Text

    The new name that you want to assign to the OU.

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

  • organizationalUnitId :: Text

    The unique identifier (ID) of the OU that you want to rename. 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 UpdateOrganizationalUnit Source # 
Instance details

Defined in Amazonka.Organizations.UpdateOrganizationalUnit

Read UpdateOrganizationalUnit Source # 
Instance details

Defined in Amazonka.Organizations.UpdateOrganizationalUnit

Show UpdateOrganizationalUnit Source # 
Instance details

Defined in Amazonka.Organizations.UpdateOrganizationalUnit

Generic UpdateOrganizationalUnit Source # 
Instance details

Defined in Amazonka.Organizations.UpdateOrganizationalUnit

Associated Types

type Rep UpdateOrganizationalUnit :: Type -> Type #

NFData UpdateOrganizationalUnit Source # 
Instance details

Defined in Amazonka.Organizations.UpdateOrganizationalUnit

Hashable UpdateOrganizationalUnit Source # 
Instance details

Defined in Amazonka.Organizations.UpdateOrganizationalUnit

ToJSON UpdateOrganizationalUnit Source # 
Instance details

Defined in Amazonka.Organizations.UpdateOrganizationalUnit

AWSRequest UpdateOrganizationalUnit Source # 
Instance details

Defined in Amazonka.Organizations.UpdateOrganizationalUnit

ToHeaders UpdateOrganizationalUnit Source # 
Instance details

Defined in Amazonka.Organizations.UpdateOrganizationalUnit

ToPath UpdateOrganizationalUnit Source # 
Instance details

Defined in Amazonka.Organizations.UpdateOrganizationalUnit

ToQuery UpdateOrganizationalUnit Source # 
Instance details

Defined in Amazonka.Organizations.UpdateOrganizationalUnit

type Rep UpdateOrganizationalUnit Source # 
Instance details

Defined in Amazonka.Organizations.UpdateOrganizationalUnit

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

Defined in Amazonka.Organizations.UpdateOrganizationalUnit

newUpdateOrganizationalUnit Source #

Create a value of UpdateOrganizationalUnit 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:name:UpdateOrganizationalUnit', updateOrganizationalUnit_name - The new name that you want to assign to the OU.

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

$sel:organizationalUnitId:UpdateOrganizationalUnit', updateOrganizationalUnit_organizationalUnitId - The unique identifier (ID) of the OU that you want to rename. 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

updateOrganizationalUnit_name :: Lens' UpdateOrganizationalUnit (Maybe Text) Source #

The new name that you want to assign to the OU.

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

updateOrganizationalUnit_organizationalUnitId :: Lens' UpdateOrganizationalUnit Text Source #

The unique identifier (ID) of the OU that you want to rename. 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 UpdateOrganizationalUnitResponse Source #

See: newUpdateOrganizationalUnitResponse smart constructor.

Constructors

UpdateOrganizationalUnitResponse' 

Fields

Instances

Instances details
Eq UpdateOrganizationalUnitResponse Source # 
Instance details

Defined in Amazonka.Organizations.UpdateOrganizationalUnit

Read UpdateOrganizationalUnitResponse Source # 
Instance details

Defined in Amazonka.Organizations.UpdateOrganizationalUnit

Show UpdateOrganizationalUnitResponse Source # 
Instance details

Defined in Amazonka.Organizations.UpdateOrganizationalUnit

Generic UpdateOrganizationalUnitResponse Source # 
Instance details

Defined in Amazonka.Organizations.UpdateOrganizationalUnit

Associated Types

type Rep UpdateOrganizationalUnitResponse :: Type -> Type #

NFData UpdateOrganizationalUnitResponse Source # 
Instance details

Defined in Amazonka.Organizations.UpdateOrganizationalUnit

type Rep UpdateOrganizationalUnitResponse Source # 
Instance details

Defined in Amazonka.Organizations.UpdateOrganizationalUnit

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

newUpdateOrganizationalUnitResponse Source #

Create a value of UpdateOrganizationalUnitResponse 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:UpdateOrganizationalUnitResponse', updateOrganizationalUnitResponse_organizationalUnit - A structure that contains the details about the specified OU, including its new name.

$sel:httpStatus:UpdateOrganizationalUnitResponse', updateOrganizationalUnitResponse_httpStatus - The response's http status code.

Response Lenses

updateOrganizationalUnitResponse_organizationalUnit :: Lens' UpdateOrganizationalUnitResponse (Maybe OrganizationalUnit) Source #

A structure that contains the details about the specified OU, including its new name.