amazonka-certificatemanager-pca-1.6.0: Amazon Certificate Manager Private Certificate Authority SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CertificateManagerPCA.RevokeCertificate

Contents

Description

Revokes a certificate that you issued by calling the IssueCertificate function. If you enable a certificate revocation list (CRL) when you create or update your private CA, information about the revoked certificates will be included in the CRL. ACM PCA writes the CRL to an S3 bucket that you specify. For more information about revocation, see the CrlConfiguration structure. ACM PCA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport .

Synopsis

Creating a Request

revokeCertificate Source #

Creates a value of RevokeCertificate with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • rcCertificateAuthorityARN - Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form: arn:aws:acm:region :account :certificate-authority/12345678-1234-1234-1234-123456789012
  • rcCertificateSerial - Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate function retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number. openssl x509 -in file_path -text -noout You can also copy the serial number from the console or use the DescribeCertificate function in the AWS Certificate Manager API Reference .
  • rcRevocationReason - Specifies why you revoked the certificate.

data RevokeCertificate Source #

See: revokeCertificate smart constructor.

Instances

Eq RevokeCertificate Source # 
Data RevokeCertificate Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RevokeCertificate -> c RevokeCertificate #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RevokeCertificate #

toConstr :: RevokeCertificate -> Constr #

dataTypeOf :: RevokeCertificate -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RevokeCertificate) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RevokeCertificate) #

gmapT :: (forall b. Data b => b -> b) -> RevokeCertificate -> RevokeCertificate #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RevokeCertificate -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RevokeCertificate -> r #

gmapQ :: (forall d. Data d => d -> u) -> RevokeCertificate -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> RevokeCertificate -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RevokeCertificate -> m RevokeCertificate #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RevokeCertificate -> m RevokeCertificate #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RevokeCertificate -> m RevokeCertificate #

Read RevokeCertificate Source # 
Show RevokeCertificate Source # 
Generic RevokeCertificate Source # 
Hashable RevokeCertificate Source # 
ToJSON RevokeCertificate Source # 
NFData RevokeCertificate Source # 

Methods

rnf :: RevokeCertificate -> () #

AWSRequest RevokeCertificate Source # 
ToHeaders RevokeCertificate Source # 
ToPath RevokeCertificate Source # 
ToQuery RevokeCertificate Source # 
type Rep RevokeCertificate Source # 
type Rep RevokeCertificate = D1 * (MetaData "RevokeCertificate" "Network.AWS.CertificateManagerPCA.RevokeCertificate" "amazonka-certificatemanager-pca-1.6.0-745TdprsK5d4KxFM63j3hX" False) (C1 * (MetaCons "RevokeCertificate'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_rcCertificateAuthorityARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_rcCertificateSerial") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_rcRevocationReason") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * RevocationReason)))))
type Rs RevokeCertificate Source # 

Request Lenses

rcCertificateAuthorityARN :: Lens' RevokeCertificate Text Source #

Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form: arn:aws:acm:region :account :certificate-authority/12345678-1234-1234-1234-123456789012

rcCertificateSerial :: Lens' RevokeCertificate Text Source #

Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate function retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number. openssl x509 -in file_path -text -noout You can also copy the serial number from the console or use the DescribeCertificate function in the AWS Certificate Manager API Reference .

rcRevocationReason :: Lens' RevokeCertificate RevocationReason Source #

Specifies why you revoked the certificate.

Destructuring the Response

revokeCertificateResponse :: RevokeCertificateResponse Source #

Creates a value of RevokeCertificateResponse with the minimum fields required to make a request.

data RevokeCertificateResponse Source #

See: revokeCertificateResponse smart constructor.

Instances

Eq RevokeCertificateResponse Source # 
Data RevokeCertificateResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RevokeCertificateResponse -> c RevokeCertificateResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RevokeCertificateResponse #

toConstr :: RevokeCertificateResponse -> Constr #

dataTypeOf :: RevokeCertificateResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RevokeCertificateResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RevokeCertificateResponse) #

gmapT :: (forall b. Data b => b -> b) -> RevokeCertificateResponse -> RevokeCertificateResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RevokeCertificateResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RevokeCertificateResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> RevokeCertificateResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> RevokeCertificateResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RevokeCertificateResponse -> m RevokeCertificateResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RevokeCertificateResponse -> m RevokeCertificateResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RevokeCertificateResponse -> m RevokeCertificateResponse #

Read RevokeCertificateResponse Source # 
Show RevokeCertificateResponse Source # 
Generic RevokeCertificateResponse Source # 
NFData RevokeCertificateResponse Source # 
type Rep RevokeCertificateResponse Source # 
type Rep RevokeCertificateResponse = D1 * (MetaData "RevokeCertificateResponse" "Network.AWS.CertificateManagerPCA.RevokeCertificate" "amazonka-certificatemanager-pca-1.6.0-745TdprsK5d4KxFM63j3hX" False) (C1 * (MetaCons "RevokeCertificateResponse'" PrefixI False) (U1 *))