Revokes a certificate that was issued inside ACM Private CA. 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 Private CA writes the CRL to an S3 bucket that
you specify. A CRL is typically updated approximately 30 minutes after a
certificate is revoked. If for any reason the CRL update fails, ACM
Private CA attempts makes further attempts every 15 minutes. With Amazon
CloudWatch, you can create alarms for the metrics CRLGenerated and
MisconfiguredCRLBucket. For more information, see Supported CloudWatch Metrics.
Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Configure Access to ACM Private CA.
ACM Private CA also writes revocation information to the audit report.
For more information, see
create_certificate_authority_audit_report.
You cannot revoke a root CA self-signed certificate.
acmpca_revoke_certificate(CertificateAuthorityArn, CertificateSerial,
RevocationReason)An empty list.
[required] Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
[required] Serial number of the certificate to be revoked. This must be in
hexadecimal format. You can retrieve the serial number by calling
get_certificate with the Amazon Resource
Name (ARN) of the certificate you want and the ARN of your private CA.
The GetCertificate action 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 action in the AWS Certificate Manager API Reference.
[required] Specifies why you revoked the certificate.
svc$revoke_certificate(
CertificateAuthorityArn = "string",
CertificateSerial = "string",
RevocationReason = "UNSPECIFIED"|"KEY_COMPROMISE"|"CERTIFICATE_AUTHORITY_COMPROMISE"|"AFFILIATION_CHANGED"|"SUPERSEDED"|"CESSATION_OF_OPERATION"|"PRIVILEGE_WITHDRAWN"|"A_A_COMPROMISE"
)