amazonka-organizations-2.0: Amazon Organizations SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Organizations.DescribePolicy

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

Synopsis

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
ToJSON DescribePolicy Source # 
Instance details

Defined in Amazonka.Organizations.DescribePolicy

ToHeaders DescribePolicy Source # 
Instance details

Defined in Amazonka.Organizations.DescribePolicy

ToPath DescribePolicy Source # 
Instance details

Defined in Amazonka.Organizations.DescribePolicy

ToQuery DescribePolicy Source # 
Instance details

Defined in Amazonka.Organizations.DescribePolicy

AWSRequest DescribePolicy Source # 
Instance details

Defined in Amazonka.Organizations.DescribePolicy

Associated Types

type AWSResponse DescribePolicy #

Generic DescribePolicy Source # 
Instance details

Defined in Amazonka.Organizations.DescribePolicy

Associated Types

type Rep DescribePolicy :: Type -> Type #

Read DescribePolicy Source # 
Instance details

Defined in Amazonka.Organizations.DescribePolicy

Show DescribePolicy Source # 
Instance details

Defined in Amazonka.Organizations.DescribePolicy

NFData DescribePolicy Source # 
Instance details

Defined in Amazonka.Organizations.DescribePolicy

Methods

rnf :: DescribePolicy -> () #

Eq DescribePolicy Source # 
Instance details

Defined in Amazonka.Organizations.DescribePolicy

Hashable DescribePolicy Source # 
Instance details

Defined in Amazonka.Organizations.DescribePolicy

type AWSResponse DescribePolicy Source # 
Instance details

Defined in Amazonka.Organizations.DescribePolicy

type Rep DescribePolicy Source # 
Instance details

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

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

Instances

Instances details
Generic DescribePolicyResponse Source # 
Instance details

Defined in Amazonka.Organizations.DescribePolicy

Associated Types

type Rep DescribePolicyResponse :: Type -> Type #

Read DescribePolicyResponse Source # 
Instance details

Defined in Amazonka.Organizations.DescribePolicy

Show DescribePolicyResponse Source # 
Instance details

Defined in Amazonka.Organizations.DescribePolicy

NFData DescribePolicyResponse Source # 
Instance details

Defined in Amazonka.Organizations.DescribePolicy

Methods

rnf :: DescribePolicyResponse -> () #

Eq DescribePolicyResponse Source # 
Instance details

Defined in Amazonka.Organizations.DescribePolicy

type Rep DescribePolicyResponse Source # 
Instance details

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

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.