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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information about a policy.

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.

Creating a Request

data DescribePolicy Source #

See: newDescribePolicy smart constructor.

Constructors

DescribePolicy'
Fields policyId :: Text The unique identifier (ID) of the policy that you want details about. You can get the ID from the ListPolicies or ListPoliciesForTarget operations. 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 DescribePolicy Source #
Instance details Defined in Amazonka.Organizations.DescribePolicy Methods (==) :: DescribePolicy -> DescribePolicy -> Bool # (/=) :: DescribePolicy -> DescribePolicy -> Bool #
Read DescribePolicy Source #
Instance details Defined in Amazonka.Organizations.DescribePolicy Methods readsPrec :: Int -> ReadS DescribePolicy # readList :: ReadS [DescribePolicy] # readPrec :: ReadPrec DescribePolicy # readListPrec :: ReadPrec [DescribePolicy] #
Show DescribePolicy Source #
Instance details Defined in Amazonka.Organizations.DescribePolicy Methods showsPrec :: Int -> DescribePolicy -> ShowS # show :: DescribePolicy -> String # showList :: [DescribePolicy] -> ShowS #
Generic DescribePolicy Source #
Instance details Defined in Amazonka.Organizations.DescribePolicy Associated Types type Rep DescribePolicy :: Type -> Type # Methods from :: DescribePolicy -> Rep DescribePolicy x # to :: Rep DescribePolicy x -> DescribePolicy #
NFData DescribePolicy Source #
Instance details Defined in Amazonka.Organizations.DescribePolicy Methods rnf :: DescribePolicy -> () #
Hashable DescribePolicy Source #
Instance details Defined in Amazonka.Organizations.DescribePolicy Methods hashWithSalt :: Int -> DescribePolicy -> Int # hash :: DescribePolicy -> Int #
ToJSON DescribePolicy Source #
Instance details Defined in Amazonka.Organizations.DescribePolicy Methods toJSON :: DescribePolicy -> Value # toEncoding :: DescribePolicy -> Encoding # toJSONList :: [DescribePolicy] -> Value # toEncodingList :: [DescribePolicy] -> Encoding #
AWSRequest DescribePolicy Source #
Instance details Defined in Amazonka.Organizations.DescribePolicy Associated Types type AWSResponse DescribePolicy # Methods request :: DescribePolicy -> Request DescribePolicy # response :: MonadResource m => Logger -> Service -> Proxy DescribePolicy -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribePolicy))) #
ToHeaders DescribePolicy Source #
Instance details Defined in Amazonka.Organizations.DescribePolicy Methods toHeaders :: DescribePolicy -> [Header] #
ToPath DescribePolicy Source #
Instance details Defined in Amazonka.Organizations.DescribePolicy Methods toPath :: DescribePolicy -> ByteString #
ToQuery DescribePolicy Source #
Instance details Defined in Amazonka.Organizations.DescribePolicy Methods toQuery :: DescribePolicy -> QueryString #
type Rep DescribePolicy Source #
Instance details Defined in Amazonka.Organizations.DescribePolicy type Rep DescribePolicy = D1 ('MetaData "DescribePolicy" "Amazonka.Organizations.DescribePolicy" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "DescribePolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "policyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribePolicy Source #
Instance details Defined in Amazonka.Organizations.DescribePolicy type AWSResponse DescribePolicy = DescribePolicyResponse

newDescribePolicy Source #

Arguments

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

Create a value of DescribePolicy 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:DescribePolicy', describePolicy_policyId - The unique identifier (ID) of the policy that you want details about. You can get the ID from the ListPolicies or ListPoliciesForTarget operations.

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

describePolicy_policyId :: Lens' DescribePolicy Text Source #

The unique identifier (ID) of the policy that you want details about. You can get the ID from the ListPolicies or ListPoliciesForTarget operations.

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 DescribePolicyResponse Source #

See: newDescribePolicyResponse smart constructor.

Constructors

DescribePolicyResponse'
Fields policy :: Maybe Policy A structure that contains details about the specified policy. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribePolicyResponse Source #

Arguments

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

Create a value of DescribePolicyResponse 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:DescribePolicyResponse', describePolicyResponse_policy - A structure that contains details about the specified policy.

$sel:httpStatus:DescribePolicyResponse', describePolicyResponse_httpStatus - The response's http status code.

Response Lenses

describePolicyResponse_policy :: Lens' DescribePolicyResponse (Maybe Policy) Source #

A structure that contains details about the specified policy.

describePolicyResponse_httpStatus :: Lens' DescribePolicyResponse Int Source #

The response's http status code.