Network.AWS.Organizations.UpdatePolicy

Updates an existing policy with a new name, description, or content. If any parameter is not supplied, that value remains unchanged. Note that you cannot change a policy's type.

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

Creating a Request

updatePolicy

Arguments

:: Text

upPolicyId

-> UpdatePolicy

Creates a value of UpdatePolicy with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• upContent - If provided, the new content for the policy. The text must be correctly formatted JSON that complies with the syntax for the policy's type. For more information, see Service Control Policy Syntax in the AWS Organizations User Guide .
• upName - If provided, the new name for the policy. The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
• upDescription - If provided, the new description for the policy.
• upPolicyId - The unique identifier (ID) of the policy that you want to update. The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits.

data UpdatePolicy

See: updatePolicy smart constructor.

Instances

Eq UpdatePolicy

Methods

(==) :: UpdatePolicy -> UpdatePolicy -> Bool

(/=) :: UpdatePolicy -> UpdatePolicy -> Bool

Data UpdatePolicy

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdatePolicy -> c UpdatePolicy

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdatePolicy

toConstr :: UpdatePolicy -> Constr

dataTypeOf :: UpdatePolicy -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdatePolicy)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdatePolicy)

gmapT :: (forall b. Data b => b -> b) -> UpdatePolicy -> UpdatePolicy

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdatePolicy -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdatePolicy -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdatePolicy -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdatePolicy -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdatePolicy -> m UpdatePolicy

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdatePolicy -> m UpdatePolicy

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdatePolicy -> m UpdatePolicy

Read UpdatePolicy

Methods

readsPrec :: Int -> ReadS UpdatePolicy

readList :: ReadS [UpdatePolicy]

readPrec :: ReadPrec UpdatePolicy

readListPrec :: ReadPrec [UpdatePolicy]

Show UpdatePolicy

Methods

showsPrec :: Int -> UpdatePolicy -> ShowS

show :: UpdatePolicy -> String

showList :: [UpdatePolicy] -> ShowS

Generic UpdatePolicy

Associated Types

type Rep UpdatePolicy :: * -> *

Methods

from :: UpdatePolicy -> Rep UpdatePolicy x

to :: Rep UpdatePolicy x -> UpdatePolicy

Hashable UpdatePolicy

Methods

hashWithSalt :: Int -> UpdatePolicy -> Int

hash :: UpdatePolicy -> Int

ToJSON UpdatePolicy

Methods

toJSON :: UpdatePolicy -> Value

toEncoding :: UpdatePolicy -> Encoding

toJSONList :: [UpdatePolicy] -> Value

toEncodingList :: [UpdatePolicy] -> Encoding

NFData UpdatePolicy

Methods

rnf :: UpdatePolicy -> ()

AWSRequest UpdatePolicy

Associated Types

type Rs UpdatePolicy :: *

Methods

request :: UpdatePolicy -> Request UpdatePolicy

response :: MonadResource m => Logger -> Service -> Proxy * UpdatePolicy -> ClientResponse -> m (Response UpdatePolicy)

ToQuery UpdatePolicy

Methods

toQuery :: UpdatePolicy -> QueryString

ToPath UpdatePolicy

Methods

toPath :: UpdatePolicy -> ByteString

ToHeaders UpdatePolicy

Methods

toHeaders :: UpdatePolicy -> [Header]

type Rep UpdatePolicy

type Rep UpdatePolicy = D1 (MetaData "UpdatePolicy" "Network.AWS.Organizations.UpdatePolicy" "amazonka-organizations-1.5.0-9d9i18lsT75IlwObP60hiK" False) (C1 (MetaCons "UpdatePolicy'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_upContent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_upName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_upDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_upPolicyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs UpdatePolicy

type Rs UpdatePolicy = UpdatePolicyResponse

Request Lenses

upContent :: Lens' UpdatePolicy (Maybe Text)

If provided, the new content for the policy. The text must be correctly formatted JSON that complies with the syntax for the policy's type. For more information, see Service Control Policy Syntax in the AWS Organizations User Guide .

upName :: Lens' UpdatePolicy (Maybe Text)

If provided, the new name for the policy. The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

upDescription :: Lens' UpdatePolicy (Maybe Text)

If provided, the new description for the policy.

upPolicyId :: Lens' UpdatePolicy Text

The unique identifier (ID) of the policy that you want to update. The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lower-case letters or digits.

Destructuring the Response

updatePolicyResponse

Arguments

:: Int

uprsResponseStatus

-> UpdatePolicyResponse

Creates a value of UpdatePolicyResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• uprsPolicy - A structure that contains details about the updated policy, showing the requested changes.
• uprsResponseStatus - -- | The response status code.

data UpdatePolicyResponse

See: updatePolicyResponse smart constructor.

Instances

Eq UpdatePolicyResponse

Methods

(==) :: UpdatePolicyResponse -> UpdatePolicyResponse -> Bool

(/=) :: UpdatePolicyResponse -> UpdatePolicyResponse -> Bool

Data UpdatePolicyResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdatePolicyResponse -> c UpdatePolicyResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdatePolicyResponse

toConstr :: UpdatePolicyResponse -> Constr

dataTypeOf :: UpdatePolicyResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdatePolicyResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdatePolicyResponse)

gmapT :: (forall b. Data b => b -> b) -> UpdatePolicyResponse -> UpdatePolicyResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdatePolicyResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdatePolicyResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdatePolicyResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdatePolicyResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdatePolicyResponse -> m UpdatePolicyResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdatePolicyResponse -> m UpdatePolicyResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdatePolicyResponse -> m UpdatePolicyResponse

Read UpdatePolicyResponse

Methods

readsPrec :: Int -> ReadS UpdatePolicyResponse

readList :: ReadS [UpdatePolicyResponse]

readPrec :: ReadPrec UpdatePolicyResponse

readListPrec :: ReadPrec [UpdatePolicyResponse]

Show UpdatePolicyResponse

Methods

showsPrec :: Int -> UpdatePolicyResponse -> ShowS

show :: UpdatePolicyResponse -> String

showList :: [UpdatePolicyResponse] -> ShowS

Generic UpdatePolicyResponse

Associated Types

type Rep UpdatePolicyResponse :: * -> *

Methods

from :: UpdatePolicyResponse -> Rep UpdatePolicyResponse x

to :: Rep UpdatePolicyResponse x -> UpdatePolicyResponse

NFData UpdatePolicyResponse

Methods

rnf :: UpdatePolicyResponse -> ()

type Rep UpdatePolicyResponse

type Rep UpdatePolicyResponse = D1 (MetaData "UpdatePolicyResponse" "Network.AWS.Organizations.UpdatePolicy" "amazonka-organizations-1.5.0-9d9i18lsT75IlwObP60hiK" False) (C1 (MetaCons "UpdatePolicyResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_uprsPolicy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Policy))) (S1 (MetaSel (Just Symbol "_uprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

uprsPolicy :: Lens' UpdatePolicyResponse (Maybe Policy)

A structure that contains details about the updated policy, showing the requested changes.

uprsResponseStatus :: Lens' UpdatePolicyResponse Int

• - | The response status code.