Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Organizations.DisablePolicyType

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Disables an organizational policy type in a root. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any organizational unit (OU) or account in that root. You can undo this by using the EnablePolicyType operation.

This is an asynchronous request that Amazon Web Services performs in the background. If you disable a policy type for a root, it still appears enabled for the organization if all features are enabled for the organization. Amazon Web Services recommends that you first use ListRoots to see the status of policy types for a specified root, and then use this operation.

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

To view the status of available policy types in the organization, use DescribeOrganization.

Creating a Request

data DisablePolicyType Source #

See: newDisablePolicyType smart constructor.

Constructors

DisablePolicyType'

Fields

rootId :: Text
The unique identifier (ID) of the root in which you want to disable a policy type. You can get the ID from the ListRoots operation.
The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.
policyType :: PolicyType
The policy type that you want to disable in this root. You can specify one of the following values:

Instances

Instances details

ToJSON DisablePolicyType Source #
Instance details Defined in Amazonka.Organizations.DisablePolicyType Methods toJSON :: DisablePolicyType -> Value # toEncoding :: DisablePolicyType -> Encoding # toJSONList :: [DisablePolicyType] -> Value # toEncodingList :: [DisablePolicyType] -> Encoding #
ToHeaders DisablePolicyType Source #
Instance details Defined in Amazonka.Organizations.DisablePolicyType Methods toHeaders :: DisablePolicyType -> [Header] #
ToPath DisablePolicyType Source #
Instance details Defined in Amazonka.Organizations.DisablePolicyType Methods toPath :: DisablePolicyType -> ByteString #
ToQuery DisablePolicyType Source #
Instance details Defined in Amazonka.Organizations.DisablePolicyType Methods toQuery :: DisablePolicyType -> QueryString #
AWSRequest DisablePolicyType Source #
Instance details Defined in Amazonka.Organizations.DisablePolicyType Associated Types type AWSResponse DisablePolicyType # Methods request :: (Service -> Service) -> DisablePolicyType -> Request DisablePolicyType # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DisablePolicyType -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DisablePolicyType))) #
Generic DisablePolicyType Source #
Instance details Defined in Amazonka.Organizations.DisablePolicyType Associated Types type Rep DisablePolicyType :: Type -> Type # Methods from :: DisablePolicyType -> Rep DisablePolicyType x # to :: Rep DisablePolicyType x -> DisablePolicyType #
Read DisablePolicyType Source #
Instance details Defined in Amazonka.Organizations.DisablePolicyType Methods readsPrec :: Int -> ReadS DisablePolicyType # readList :: ReadS [DisablePolicyType] # readPrec :: ReadPrec DisablePolicyType # readListPrec :: ReadPrec [DisablePolicyType] #
Show DisablePolicyType Source #
Instance details Defined in Amazonka.Organizations.DisablePolicyType Methods showsPrec :: Int -> DisablePolicyType -> ShowS # show :: DisablePolicyType -> String # showList :: [DisablePolicyType] -> ShowS #
NFData DisablePolicyType Source #
Instance details Defined in Amazonka.Organizations.DisablePolicyType Methods rnf :: DisablePolicyType -> () #
Eq DisablePolicyType Source #
Instance details Defined in Amazonka.Organizations.DisablePolicyType Methods (==) :: DisablePolicyType -> DisablePolicyType -> Bool # (/=) :: DisablePolicyType -> DisablePolicyType -> Bool #
Hashable DisablePolicyType Source #
Instance details Defined in Amazonka.Organizations.DisablePolicyType Methods hashWithSalt :: Int -> DisablePolicyType -> Int # hash :: DisablePolicyType -> Int #
type AWSResponse DisablePolicyType Source #
Instance details Defined in Amazonka.Organizations.DisablePolicyType type AWSResponse DisablePolicyType = DisablePolicyTypeResponse
type Rep DisablePolicyType Source #
Instance details Defined in Amazonka.Organizations.DisablePolicyType type Rep DisablePolicyType = D1 ('MetaData "DisablePolicyType" "Amazonka.Organizations.DisablePolicyType" "amazonka-organizations-2.0-JONpdX4PtttLcKxQshpOlA" 'False) (C1 ('MetaCons "DisablePolicyType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "rootId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "policyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PolicyType)))

newDisablePolicyType Source #

Arguments

:: Text	`$sel:rootId:DisablePolicyType'`
-> PolicyType	`DisablePolicyType`
-> DisablePolicyType

Create a value of DisablePolicyType 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:rootId:DisablePolicyType', disablePolicyType_rootId - The unique identifier (ID) of the root in which you want to disable a policy type. You can get the ID from the ListRoots operation.

The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.

DisablePolicyType, disablePolicyType_policyType - The policy type that you want to disable in this root. You can specify one of the following values:

Request Lenses

disablePolicyType_rootId :: Lens' DisablePolicyType Text Source #

The unique identifier (ID) of the root in which you want to disable a policy type. You can get the ID from the ListRoots operation.

The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.

disablePolicyType_policyType :: Lens' DisablePolicyType PolicyType Source #

The policy type that you want to disable in this root. You can specify one of the following values:

Destructuring the Response

data DisablePolicyTypeResponse Source #

See: newDisablePolicyTypeResponse smart constructor.

Constructors

DisablePolicyTypeResponse'
Fields root :: Maybe Root A structure that shows the root with the updated list of enabled policy types. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DisablePolicyTypeResponse Source #
Instance details Defined in Amazonka.Organizations.DisablePolicyType Associated Types type Rep DisablePolicyTypeResponse :: Type -> Type # Methods from :: DisablePolicyTypeResponse -> Rep DisablePolicyTypeResponse x # to :: Rep DisablePolicyTypeResponse x -> DisablePolicyTypeResponse #
Read DisablePolicyTypeResponse Source #
Instance details Defined in Amazonka.Organizations.DisablePolicyType Methods readsPrec :: Int -> ReadS DisablePolicyTypeResponse # readList :: ReadS [DisablePolicyTypeResponse] # readPrec :: ReadPrec DisablePolicyTypeResponse # readListPrec :: ReadPrec [DisablePolicyTypeResponse] #
Show DisablePolicyTypeResponse Source #
Instance details Defined in Amazonka.Organizations.DisablePolicyType Methods showsPrec :: Int -> DisablePolicyTypeResponse -> ShowS # show :: DisablePolicyTypeResponse -> String # showList :: [DisablePolicyTypeResponse] -> ShowS #
NFData DisablePolicyTypeResponse Source #
Instance details Defined in Amazonka.Organizations.DisablePolicyType Methods rnf :: DisablePolicyTypeResponse -> () #
Eq DisablePolicyTypeResponse Source #
Instance details Defined in Amazonka.Organizations.DisablePolicyType Methods (==) :: DisablePolicyTypeResponse -> DisablePolicyTypeResponse -> Bool # (/=) :: DisablePolicyTypeResponse -> DisablePolicyTypeResponse -> Bool #
type Rep DisablePolicyTypeResponse Source #
Instance details Defined in Amazonka.Organizations.DisablePolicyType type Rep DisablePolicyTypeResponse = D1 ('MetaData "DisablePolicyTypeResponse" "Amazonka.Organizations.DisablePolicyType" "amazonka-organizations-2.0-JONpdX4PtttLcKxQshpOlA" 'False) (C1 ('MetaCons "DisablePolicyTypeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "root") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Root)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDisablePolicyTypeResponse Source #

Arguments

:: Int	`$sel:httpStatus:DisablePolicyTypeResponse'`
-> DisablePolicyTypeResponse

Create a value of DisablePolicyTypeResponse 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:root:DisablePolicyTypeResponse', disablePolicyTypeResponse_root - A structure that shows the root with the updated list of enabled policy types.

$sel:httpStatus:DisablePolicyTypeResponse', disablePolicyTypeResponse_httpStatus - The response's http status code.

Response Lenses

disablePolicyTypeResponse_root :: Lens' DisablePolicyTypeResponse (Maybe Root) Source #

A structure that shows the root with the updated list of enabled policy types.

disablePolicyTypeResponse_httpStatus :: Lens' DisablePolicyTypeResponse Int Source #

The response's http status code.