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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an existing policy with a new name, description, or content. If you don't supply any parameter, that value remains unchanged. You can't change a policy's type.

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

Synopsis

Creating a Request

data UpdatePolicy Source #

See: newUpdatePolicy smart constructor.

Constructors

UpdatePolicy'

Fields

content :: 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.
name :: 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.
description :: Maybe Text
If provided, the new description for the policy.
policyId :: 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 lowercase or uppercase letters, digits, or the underscore character (_).

Instances

Instances details

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

newUpdatePolicy Source #

Arguments

:: Text	`$sel:policyId:UpdatePolicy'`
-> UpdatePolicy

Create a value of UpdatePolicy 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:content:UpdatePolicy', updatePolicy_content - 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.

$sel:name:UpdatePolicy', updatePolicy_name - 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.

$sel:description:UpdatePolicy', updatePolicy_description - If provided, the new description for the policy.

$sel:policyId:UpdatePolicy', updatePolicy_policyId - 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 lowercase or uppercase letters, digits, or the underscore character (_).

Request Lenses

updatePolicy_content :: Lens' UpdatePolicy (Maybe Text) Source #

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.

updatePolicy_name :: Lens' UpdatePolicy (Maybe Text) Source #

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.

updatePolicy_description :: Lens' UpdatePolicy (Maybe Text) Source #

If provided, the new description for the policy.

updatePolicy_policyId :: Lens' UpdatePolicy Text Source #

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 lowercase or uppercase letters, digits, or the underscore character (_).

Destructuring the Response

data UpdatePolicyResponse Source #

See: newUpdatePolicyResponse smart constructor.

Constructors

UpdatePolicyResponse'
Fields policy :: Maybe Policy A structure that contains details about the updated policy, showing the requested changes. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newUpdatePolicyResponse Source #

Arguments

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

Create a value of UpdatePolicyResponse 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:policy:UpdatePolicyResponse', updatePolicyResponse_policy - A structure that contains details about the updated policy, showing the requested changes.

$sel:httpStatus:UpdatePolicyResponse', updatePolicyResponse_httpStatus - The response's http status code.

Response Lenses

updatePolicyResponse_policy :: Lens' UpdatePolicyResponse (Maybe Policy) Source #

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

updatePolicyResponse_httpStatus :: Lens' UpdatePolicyResponse Int Source #

The response's http status code.