| 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.DescribeEffectivePolicy
Description
Returns the contents of the effective policy for specified policy type and account. The effective policy is the aggregation of any policies of the specified type that the account inherits, plus any policy of that type that is directly attached to the account.
This operation applies only to policy types other than service control policies (SCPs).
For more information about policy inheritance, see How Policy Inheritance Works in the AWS Organizations User Guide.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.
Synopsis
- data DescribeEffectivePolicy = DescribeEffectivePolicy' {}
- newDescribeEffectivePolicy :: EffectivePolicyType -> DescribeEffectivePolicy
- describeEffectivePolicy_targetId :: Lens' DescribeEffectivePolicy (Maybe Text)
- describeEffectivePolicy_policyType :: Lens' DescribeEffectivePolicy EffectivePolicyType
- data DescribeEffectivePolicyResponse = DescribeEffectivePolicyResponse' {}
- newDescribeEffectivePolicyResponse :: Int -> DescribeEffectivePolicyResponse
- describeEffectivePolicyResponse_effectivePolicy :: Lens' DescribeEffectivePolicyResponse (Maybe EffectivePolicy)
- describeEffectivePolicyResponse_httpStatus :: Lens' DescribeEffectivePolicyResponse Int
Creating a Request
data DescribeEffectivePolicy Source #
See: newDescribeEffectivePolicy smart constructor.
Constructors
| DescribeEffectivePolicy' | |
Fields
| |
Instances
newDescribeEffectivePolicy Source #
Create a value of DescribeEffectivePolicy 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:targetId:DescribeEffectivePolicy', describeEffectivePolicy_targetId - When you're signed in as the management account, specify the ID of the
account that you want details about. Specifying an organization root or
organizational unit (OU) as the target is not supported.
$sel:policyType:DescribeEffectivePolicy', describeEffectivePolicy_policyType - The type of policy that you want information about. You can specify one
of the following values:
Request Lenses
describeEffectivePolicy_targetId :: Lens' DescribeEffectivePolicy (Maybe Text) Source #
When you're signed in as the management account, specify the ID of the account that you want details about. Specifying an organization root or organizational unit (OU) as the target is not supported.
describeEffectivePolicy_policyType :: Lens' DescribeEffectivePolicy EffectivePolicyType Source #
The type of policy that you want information about. You can specify one of the following values:
Destructuring the Response
data DescribeEffectivePolicyResponse Source #
See: newDescribeEffectivePolicyResponse smart constructor.
Constructors
| DescribeEffectivePolicyResponse' | |
Fields
| |
Instances
newDescribeEffectivePolicyResponse Source #
Create a value of DescribeEffectivePolicyResponse 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:effectivePolicy:DescribeEffectivePolicyResponse', describeEffectivePolicyResponse_effectivePolicy - The contents of the effective policy.
$sel:httpStatus:DescribeEffectivePolicyResponse', describeEffectivePolicyResponse_httpStatus - The response's http status code.
Response Lenses
describeEffectivePolicyResponse_effectivePolicy :: Lens' DescribeEffectivePolicyResponse (Maybe EffectivePolicy) Source #
The contents of the effective policy.
describeEffectivePolicyResponse_httpStatus :: Lens' DescribeEffectivePolicyResponse Int Source #
The response's http status code.