Amazonka.Organizations.DescribePolicy

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 Amazon Web Services service.

Creating a Request

data DescribePolicy

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

ToJSON DescribePolicy

Defined in Amazonka.Organizations.DescribePolicy

Methods

toJSON :: DescribePolicy -> Value

toEncoding :: DescribePolicy -> Encoding

toJSONList :: [DescribePolicy] -> Value

toEncodingList :: [DescribePolicy] -> Encoding

ToHeaders DescribePolicy

Defined in Amazonka.Organizations.DescribePolicy

Methods

toHeaders :: DescribePolicy -> [Header]

ToPath DescribePolicy

Defined in Amazonka.Organizations.DescribePolicy

Methods

toPath :: DescribePolicy -> ByteString

ToQuery DescribePolicy

Defined in Amazonka.Organizations.DescribePolicy

Methods

toQuery :: DescribePolicy -> QueryString

AWSRequest DescribePolicy

Defined in Amazonka.Organizations.DescribePolicy

Associated Types

type AWSResponse DescribePolicy

Methods

request :: (Service -> Service) -> DescribePolicy -> Request DescribePolicy

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribePolicy -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribePolicy)))

Generic DescribePolicy

Defined in Amazonka.Organizations.DescribePolicy

Associated Types

type Rep DescribePolicy :: Type -> Type

Methods

from :: DescribePolicy -> Rep DescribePolicy x

to :: Rep DescribePolicy x -> DescribePolicy

Read DescribePolicy

Defined in Amazonka.Organizations.DescribePolicy

Methods

readsPrec :: Int -> ReadS DescribePolicy

readList :: ReadS [DescribePolicy]

readPrec :: ReadPrec DescribePolicy

readListPrec :: ReadPrec [DescribePolicy]

Show DescribePolicy

Defined in Amazonka.Organizations.DescribePolicy

Methods

showsPrec :: Int -> DescribePolicy -> ShowS

show :: DescribePolicy -> String

showList :: [DescribePolicy] -> ShowS

NFData DescribePolicy

Defined in Amazonka.Organizations.DescribePolicy

Methods

rnf :: DescribePolicy -> ()

Eq DescribePolicy

Defined in Amazonka.Organizations.DescribePolicy

Methods

(==) :: DescribePolicy -> DescribePolicy -> Bool

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

Hashable DescribePolicy

Defined in Amazonka.Organizations.DescribePolicy

Methods

hashWithSalt :: Int -> DescribePolicy -> Int

hash :: DescribePolicy -> Int

type AWSResponse DescribePolicy

Defined in Amazonka.Organizations.DescribePolicy

type AWSResponse DescribePolicy = DescribePolicyResponse

type Rep DescribePolicy

Defined in Amazonka.Organizations.DescribePolicy

type Rep DescribePolicy = D1 ('MetaData "DescribePolicy" "Amazonka.Organizations.DescribePolicy" "amazonka-organizations-2.0-JONpdX4PtttLcKxQshpOlA" 'False) (C1 ('MetaCons "DescribePolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "policyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribePolicy

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

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

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

Generic DescribePolicyResponse

Defined in Amazonka.Organizations.DescribePolicy

Associated Types

type Rep DescribePolicyResponse :: Type -> Type

Methods

from :: DescribePolicyResponse -> Rep DescribePolicyResponse x

to :: Rep DescribePolicyResponse x -> DescribePolicyResponse

Read DescribePolicyResponse

Defined in Amazonka.Organizations.DescribePolicy

Methods

readsPrec :: Int -> ReadS DescribePolicyResponse

readList :: ReadS [DescribePolicyResponse]

readPrec :: ReadPrec DescribePolicyResponse

readListPrec :: ReadPrec [DescribePolicyResponse]

Show DescribePolicyResponse

Defined in Amazonka.Organizations.DescribePolicy

Methods

showsPrec :: Int -> DescribePolicyResponse -> ShowS

show :: DescribePolicyResponse -> String

showList :: [DescribePolicyResponse] -> ShowS

NFData DescribePolicyResponse

Defined in Amazonka.Organizations.DescribePolicy

Methods

rnf :: DescribePolicyResponse -> ()

Eq DescribePolicyResponse

Defined in Amazonka.Organizations.DescribePolicy

Methods

(==) :: DescribePolicyResponse -> DescribePolicyResponse -> Bool

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

type Rep DescribePolicyResponse

Defined in Amazonka.Organizations.DescribePolicy

type Rep DescribePolicyResponse = D1 ('MetaData "DescribePolicyResponse" "Amazonka.Organizations.DescribePolicy" "amazonka-organizations-2.0-JONpdX4PtttLcKxQshpOlA" '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

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)

A structure that contains details about the specified policy.

describePolicyResponse_httpStatus :: Lens' DescribePolicyResponse Int

The response's http status code.