revoke_certificate

ACMPCA.Client.revoke_certificate(**kwargs)

Revokes a certificate that was issued inside Amazon Web Services 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. Amazon Web Services 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, Amazon Web Services 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.

Note

Both Amazon Web Services Private CA 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 Access policies for CRLs in Amazon S3.

Amazon Web Services Private CA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.

Note

You cannot revoke a root CA self-signed certificate.

See also: AWS API Documentation

Request Syntax

response = client.revoke_certificate(
    CertificateAuthorityArn='string',
    CertificateSerial='string',
    RevocationReason='UNSPECIFIED'|'KEY_COMPROMISE'|'CERTIFICATE_AUTHORITY_COMPROMISE'|'AFFILIATION_CHANGED'|'SUPERSEDED'|'CESSATION_OF_OPERATION'|'PRIVILEGE_WITHDRAWN'|'A_A_COMPROMISE'
)

Parameters

• CertificateAuthorityArn (string) --

  [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

• CertificateSerial (string) --

  [REQUIRED]

  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 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 Certificate Manager API Reference .

• RevocationReason (string) --

  [REQUIRED]

  Specifies why you revoked the certificate.

Returns

None

Exceptions

• ACMPCA.Client.exceptions.ConcurrentModificationException
• ACMPCA.Client.exceptions.InvalidArnException
• ACMPCA.Client.exceptions.InvalidRequestException
• ACMPCA.Client.exceptions.InvalidStateException
• ACMPCA.Client.exceptions.LimitExceededException
• ACMPCA.Client.exceptions.ResourceNotFoundException
• ACMPCA.Client.exceptions.RequestAlreadyProcessedException
• ACMPCA.Client.exceptions.RequestInProgressException
• ACMPCA.Client.exceptions.RequestFailedException