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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the resource-based policy attached to a private CA. If either the private CA resource or the policy cannot be found, this action returns a ResourceNotFoundException.

The policy can be attached or updated with PutPolicy and removed with DeletePolicy.

About Policies

A policy grants access on a private CA to an AWS customer account, to AWS Organizations, or to an AWS Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.
A policy permits a user of AWS Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.
For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.
Updates made in AWS Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

Synopsis

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

Creating a Request

data GetPolicy Source #

See: newGetPolicy smart constructor.

Constructors

GetPolicy'
Fields resourceArn :: Text The Amazon Resource Number (ARN) of the private CA that will have its policy retrieved. You can find the CA's ARN by calling the ListCertificateAuthorities action.

Instances

Instances details

Eq GetPolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.GetPolicy Methods (==) :: GetPolicy -> GetPolicy -> Bool # (/=) :: GetPolicy -> GetPolicy -> Bool #
Read GetPolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.GetPolicy Methods readsPrec :: Int -> ReadS GetPolicy # readList :: ReadS [GetPolicy] # readPrec :: ReadPrec GetPolicy # readListPrec :: ReadPrec [GetPolicy] #
Show GetPolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.GetPolicy Methods showsPrec :: Int -> GetPolicy -> ShowS # show :: GetPolicy -> String # showList :: [GetPolicy] -> ShowS #
Generic GetPolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.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.CertificateManagerPCA.GetPolicy Methods rnf :: GetPolicy -> () #
Hashable GetPolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.GetPolicy Methods hashWithSalt :: Int -> GetPolicy -> Int # hash :: GetPolicy -> Int #
ToJSON GetPolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.GetPolicy Methods toJSON :: GetPolicy -> Value # toEncoding :: GetPolicy -> Encoding # toJSONList :: [GetPolicy] -> Value # toEncodingList :: [GetPolicy] -> Encoding #
AWSRequest GetPolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.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.CertificateManagerPCA.GetPolicy Methods toHeaders :: GetPolicy -> [Header] #
ToPath GetPolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.GetPolicy Methods toPath :: GetPolicy -> ByteString #
ToQuery GetPolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.GetPolicy Methods toQuery :: GetPolicy -> QueryString #
type Rep GetPolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.GetPolicy type Rep GetPolicy = D1 ('MetaData "GetPolicy" "Amazonka.CertificateManagerPCA.GetPolicy" "libZSservicesZSamazonka-certificatemanager-pcaZSamazonka-certificatemanager-pca" 'False) (C1 ('MetaCons "GetPolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetPolicy Source #
Instance details Defined in Amazonka.CertificateManagerPCA.GetPolicy type AWSResponse GetPolicy = GetPolicyResponse

newGetPolicy Source #

Arguments

:: Text	`$sel:resourceArn: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:resourceArn:GetPolicy', getPolicy_resourceArn - The Amazon Resource Number (ARN) of the private CA that will have its policy retrieved. You can find the CA's ARN by calling the ListCertificateAuthorities action.

Request Lenses

getPolicy_resourceArn :: Lens' GetPolicy Text Source #

The Amazon Resource Number (ARN) of the private CA that will have its policy retrieved. You can find the CA's ARN by calling the ListCertificateAuthorities action.

Destructuring the Response

data GetPolicyResponse Source #

See: newGetPolicyResponse smart constructor.

Constructors

GetPolicyResponse'
Fields policy :: Maybe Text The policy attached to the private CA as a JSON document. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq GetPolicyResponse Source #
Instance details Defined in Amazonka.CertificateManagerPCA.GetPolicy Methods (==) :: GetPolicyResponse -> GetPolicyResponse -> Bool # (/=) :: GetPolicyResponse -> GetPolicyResponse -> Bool #
Read GetPolicyResponse Source #
Instance details Defined in Amazonka.CertificateManagerPCA.GetPolicy Methods readsPrec :: Int -> ReadS GetPolicyResponse # readList :: ReadS [GetPolicyResponse] # readPrec :: ReadPrec GetPolicyResponse # readListPrec :: ReadPrec [GetPolicyResponse] #
Show GetPolicyResponse Source #
Instance details Defined in Amazonka.CertificateManagerPCA.GetPolicy Methods showsPrec :: Int -> GetPolicyResponse -> ShowS # show :: GetPolicyResponse -> String # showList :: [GetPolicyResponse] -> ShowS #
Generic GetPolicyResponse Source #
Instance details Defined in Amazonka.CertificateManagerPCA.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.CertificateManagerPCA.GetPolicy Methods rnf :: GetPolicyResponse -> () #
type Rep GetPolicyResponse Source #
Instance details Defined in Amazonka.CertificateManagerPCA.GetPolicy type Rep GetPolicyResponse = D1 ('MetaData "GetPolicyResponse" "Amazonka.CertificateManagerPCA.GetPolicy" "libZSservicesZSamazonka-certificatemanager-pcaZSamazonka-certificatemanager-pca" 'False) (C1 ('MetaCons "GetPolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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 - The policy attached to the private CA as a JSON document.

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

Response Lenses

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

The policy attached to the private CA as a JSON document.

getPolicyResponse_httpStatus :: Lens' GetPolicyResponse Int Source #

The response's http status code.