AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

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.

You cannot revoke a root CA self-signed certificate.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginRevokeCertificate and EndRevokeCertificate.

Namespace: Amazon.ACMPCA
Assembly: AWSSDK.ACMPCA.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<RevokeCertificateResponse> RevokeCertificateAsync(
         RevokeCertificateRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.ACMPCA.Model.RevokeCertificateRequest

Container for the necessary parameters to execute the RevokeCertificate service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the RevokeCertificate service method, as returned by ACMPCA.

Exceptions

ExceptionCondition
ConcurrentModificationException A previous update to your private CA is still ongoing.
InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
InvalidRequestException The request action cannot be performed or is prohibited.
InvalidStateException The state of the private CA does not allow this action to occur.
LimitExceededException An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to determine the quota that was exceeded.
RequestAlreadyProcessedException Your request has already been completed.
RequestFailedException The request has failed for an unspecified reason.
RequestInProgressException Your request is already in progress.
ResourceNotFoundException A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also