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

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Attaches a policy to a root, an organizational unit (OU), or an individual account. How the policy affects accounts depends on the type of policy. Refer to the AWS Organizations User Guide for information about each policy type:

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

Synopsis

data AttachPolicy = AttachPolicy' {
- policyId :: Text
- targetId :: Text
}
newAttachPolicy :: Text -> Text -> AttachPolicy
attachPolicy_policyId :: Lens' AttachPolicy Text
attachPolicy_targetId :: Lens' AttachPolicy Text
data AttachPolicyResponse = AttachPolicyResponse' {
}
newAttachPolicyResponse :: AttachPolicyResponse

Creating a Request

data AttachPolicy Source #

See: newAttachPolicy smart constructor.

Constructors

AttachPolicy'

Fields

policyId :: Text
The unique identifier (ID) of the policy that you want to attach to the target. You can get the ID for the policy by calling the ListPolicies operation.
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 (_).
targetId :: Text
The unique identifier (ID) of the root, OU, or account that you want to attach the policy to. You can get the ID by calling the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts operations.
The regex pattern for a target ID string requires one of the following:
- Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
- Account - A string that consists of exactly 12 digits.
- Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

Instances

Instances details

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

newAttachPolicy Source #

Arguments

:: Text	`$sel:policyId:AttachPolicy'`
-> Text	`$sel:targetId:AttachPolicy'`
-> AttachPolicy

Create a value of AttachPolicy 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:policyId:AttachPolicy', attachPolicy_policyId - The unique identifier (ID) of the policy that you want to attach to the target. You can get the ID for the policy by calling the ListPolicies operation.

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 (_).

$sel:targetId:AttachPolicy', attachPolicy_targetId - The unique identifier (ID) of the root, OU, or account that you want to attach the policy to. You can get the ID by calling the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts operations.

The regex pattern for a target ID string requires one of the following:

Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
Account - A string that consists of exactly 12 digits.
Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

Request Lenses

attachPolicy_policyId :: Lens' AttachPolicy Text Source #

The unique identifier (ID) of the policy that you want to attach to the target. You can get the ID for the policy by calling the ListPolicies operation.

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 (_).

attachPolicy_targetId :: Lens' AttachPolicy Text Source #

The unique identifier (ID) of the root, OU, or account that you want to attach the policy to. You can get the ID by calling the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts operations.

The regex pattern for a target ID string requires one of the following:

Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
Account - A string that consists of exactly 12 digits.
Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

Destructuring the Response

data AttachPolicyResponse Source #

See: newAttachPolicyResponse smart constructor.

Constructors

AttachPolicyResponse'

Instances

Instances details

Eq AttachPolicyResponse Source #
Instance details Defined in Amazonka.Organizations.AttachPolicy Methods (==) :: AttachPolicyResponse -> AttachPolicyResponse -> Bool # (/=) :: AttachPolicyResponse -> AttachPolicyResponse -> Bool #
Read AttachPolicyResponse Source #
Instance details Defined in Amazonka.Organizations.AttachPolicy Methods readsPrec :: Int -> ReadS AttachPolicyResponse # readList :: ReadS [AttachPolicyResponse] # readPrec :: ReadPrec AttachPolicyResponse # readListPrec :: ReadPrec [AttachPolicyResponse] #
Show AttachPolicyResponse Source #
Instance details Defined in Amazonka.Organizations.AttachPolicy Methods showsPrec :: Int -> AttachPolicyResponse -> ShowS # show :: AttachPolicyResponse -> String # showList :: [AttachPolicyResponse] -> ShowS #
Generic AttachPolicyResponse Source #
Instance details Defined in Amazonka.Organizations.AttachPolicy Associated Types type Rep AttachPolicyResponse :: Type -> Type # Methods from :: AttachPolicyResponse -> Rep AttachPolicyResponse x # to :: Rep AttachPolicyResponse x -> AttachPolicyResponse #
NFData AttachPolicyResponse Source #
Instance details Defined in Amazonka.Organizations.AttachPolicy Methods rnf :: AttachPolicyResponse -> () #
type Rep AttachPolicyResponse Source #
Instance details Defined in Amazonka.Organizations.AttachPolicy type Rep AttachPolicyResponse = D1 ('MetaData "AttachPolicyResponse" "Amazonka.Organizations.AttachPolicy" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "AttachPolicyResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newAttachPolicyResponse :: AttachPolicyResponse Source #

Create a value of AttachPolicyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.