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.IAM.GetPolicy

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the list of the specific users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy. This operation returns metadata about the policy. To retrieve the actual policy document for a specific version of the policy, use GetPolicyVersion.

This operation retrieves information about managed policies. To retrieve information about an inline policy that is embedded with an IAM user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.

For more information about policies, see Managed policies and inline policies in the IAM User Guide.

Synopsis

data GetPolicy = GetPolicy' {
- policyArn :: Text
}
newGetPolicy :: Text -> GetPolicy
getPolicy_policyArn :: Lens' GetPolicy Text
data GetPolicyResponse = GetPolicyResponse' {
- policy :: Maybe Policy
- httpStatus :: Int
}
newGetPolicyResponse :: Int -> GetPolicyResponse
getPolicyResponse_policy :: Lens' GetPolicyResponse (Maybe Policy)
getPolicyResponse_httpStatus :: Lens' GetPolicyResponse Int

Creating a Request

data GetPolicy Source #

See: newGetPolicy smart constructor.

Constructors

GetPolicy'
Fields policyArn :: Text The Amazon Resource Name (ARN) of the managed policy that you want information about. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Instances

Instances details

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

newGetPolicy Source #

Arguments

:: Text	`$sel:policyArn:GetPolicy'`
-> GetPolicy

Create a value of GetPolicy 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:policyArn:GetPolicy', getPolicy_policyArn - The Amazon Resource Name (ARN) of the managed policy that you want information about.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Request Lenses

getPolicy_policyArn :: Lens' GetPolicy Text Source #

The Amazon Resource Name (ARN) of the managed policy that you want information about.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Destructuring the Response

data GetPolicyResponse Source #

Contains the response to a successful GetPolicy request.

See: newGetPolicyResponse smart constructor.

Constructors

GetPolicyResponse'
Fields policy :: Maybe Policy A structure containing details about the policy. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetPolicyResponse Source #

Arguments

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

Create a value of GetPolicyResponse 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:GetPolicyResponse', getPolicyResponse_policy - A structure containing details about the policy.

$sel:httpStatus:GetPolicyResponse', getPolicyResponse_httpStatus - The response's http status code.

Response Lenses

getPolicyResponse_policy :: Lens' GetPolicyResponse (Maybe Policy) Source #

A structure containing details about the policy.

getPolicyResponse_httpStatus :: Lens' GetPolicyResponse Int Source #

The response's http status code.