Network.AWS.CertificateManagerPCA.RevokeCertificate

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 .

Creating a Request

revokeCertificate

Arguments

:: Text

rcCertificateAuthorityARN

-> Text

rcCertificateSerial

-> RevocationReason

rcRevocationReason

-> RevokeCertificate

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

See: revokeCertificate smart constructor.

Instances

Eq RevokeCertificate

Defined in Network.AWS.CertificateManagerPCA.RevokeCertificate

Methods

(==) :: RevokeCertificate -> RevokeCertificate -> Bool

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

Data RevokeCertificate

Defined in Network.AWS.CertificateManagerPCA.RevokeCertificate

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

Defined in Network.AWS.CertificateManagerPCA.RevokeCertificate

Methods

readsPrec :: Int -> ReadS RevokeCertificate

readList :: ReadS [RevokeCertificate]

readPrec :: ReadPrec RevokeCertificate

readListPrec :: ReadPrec [RevokeCertificate]

Show RevokeCertificate

Defined in Network.AWS.CertificateManagerPCA.RevokeCertificate

Methods

showsPrec :: Int -> RevokeCertificate -> ShowS

show :: RevokeCertificate -> String

showList :: [RevokeCertificate] -> ShowS

Generic RevokeCertificate

Defined in Network.AWS.CertificateManagerPCA.RevokeCertificate

Associated Types

type Rep RevokeCertificate :: Type -> Type

Methods

from :: RevokeCertificate -> Rep RevokeCertificate x

to :: Rep RevokeCertificate x -> RevokeCertificate

Hashable RevokeCertificate

Defined in Network.AWS.CertificateManagerPCA.RevokeCertificate

Methods

hashWithSalt :: Int -> RevokeCertificate -> Int

hash :: RevokeCertificate -> Int

ToJSON RevokeCertificate

Defined in Network.AWS.CertificateManagerPCA.RevokeCertificate

Methods

toJSON :: RevokeCertificate -> Value

toEncoding :: RevokeCertificate -> Encoding

toJSONList :: [RevokeCertificate] -> Value

toEncodingList :: [RevokeCertificate] -> Encoding

AWSRequest RevokeCertificate

Defined in Network.AWS.CertificateManagerPCA.RevokeCertificate

Associated Types

type Rs RevokeCertificate :: Type

Methods

request :: RevokeCertificate -> Request RevokeCertificate

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy RevokeCertificate -> ClientResponse -> m (Response RevokeCertificate)

ToHeaders RevokeCertificate

Defined in Network.AWS.CertificateManagerPCA.RevokeCertificate

Methods

toHeaders :: RevokeCertificate -> [Header]

ToPath RevokeCertificate

Defined in Network.AWS.CertificateManagerPCA.RevokeCertificate

Methods

toPath :: RevokeCertificate -> ByteString

ToQuery RevokeCertificate

Defined in Network.AWS.CertificateManagerPCA.RevokeCertificate

Methods

toQuery :: RevokeCertificate -> QueryString

NFData RevokeCertificate

Defined in Network.AWS.CertificateManagerPCA.RevokeCertificate

Methods

rnf :: RevokeCertificate -> ()

type Rep RevokeCertificate

Defined in Network.AWS.CertificateManagerPCA.RevokeCertificate

type Rep RevokeCertificate = D1 (MetaData "RevokeCertificate" "Network.AWS.CertificateManagerPCA.RevokeCertificate" "amazonka-certificatemanager-pca-1.6.1-HitWzcqvY41EzhTFciBw3m" False) (C1 (MetaCons "RevokeCertificate'" PrefixI True) (S1 (MetaSel (Just "_rcCertificateAuthorityARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_rcCertificateSerial") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_rcRevocationReason") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 RevocationReason))))

type Rs RevokeCertificate

Defined in Network.AWS.CertificateManagerPCA.RevokeCertificate

type Rs RevokeCertificate = RevokeCertificateResponse

Request Lenses

rcCertificateAuthorityARN :: Lens' RevokeCertificate Text

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

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

Specifies why you revoked the certificate.

Destructuring the Response

revokeCertificateResponse :: RevokeCertificateResponse

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

data RevokeCertificateResponse

See: revokeCertificateResponse smart constructor.

Instances

Eq RevokeCertificateResponse

Defined in Network.AWS.CertificateManagerPCA.RevokeCertificate

Methods

(==) :: RevokeCertificateResponse -> RevokeCertificateResponse -> Bool

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

Data RevokeCertificateResponse

Defined in Network.AWS.CertificateManagerPCA.RevokeCertificate

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

Defined in Network.AWS.CertificateManagerPCA.RevokeCertificate

Methods

readsPrec :: Int -> ReadS RevokeCertificateResponse

readList :: ReadS [RevokeCertificateResponse]

readPrec :: ReadPrec RevokeCertificateResponse

readListPrec :: ReadPrec [RevokeCertificateResponse]

Show RevokeCertificateResponse

Defined in Network.AWS.CertificateManagerPCA.RevokeCertificate

Methods

showsPrec :: Int -> RevokeCertificateResponse -> ShowS

show :: RevokeCertificateResponse -> String

showList :: [RevokeCertificateResponse] -> ShowS

Generic RevokeCertificateResponse

Defined in Network.AWS.CertificateManagerPCA.RevokeCertificate

Associated Types

type Rep RevokeCertificateResponse :: Type -> Type

Methods

from :: RevokeCertificateResponse -> Rep RevokeCertificateResponse x

to :: Rep RevokeCertificateResponse x -> RevokeCertificateResponse

NFData RevokeCertificateResponse

Defined in Network.AWS.CertificateManagerPCA.RevokeCertificate

Methods

rnf :: RevokeCertificateResponse -> ()

type Rep RevokeCertificateResponse

Defined in Network.AWS.CertificateManagerPCA.RevokeCertificate

type Rep RevokeCertificateResponse = D1 (MetaData "RevokeCertificateResponse" "Network.AWS.CertificateManagerPCA.RevokeCertificate" "amazonka-certificatemanager-pca-1.6.1-HitWzcqvY41EzhTFciBw3m" False) (C1 (MetaCons "RevokeCertificateResponse'" PrefixI False) (U1 :: Type -> Type))