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.

Deletes a private certificate authority (CA). You must provide the Amazon Resource Name (ARN) of the private CA that you want to delete. You can find the ARN by calling the ListCertificateAuthorities action.

Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy.

Before you can delete a CA that you have created and activated, you must disable it. To do this, call the UpdateCertificateAuthority action and set the CertificateAuthorityStatus parameter to DISABLED.

Additionally, you can delete a CA if you are waiting for it to be created (that is, the status of the CA is CREATING). You can also delete it if the CA has been created but you haven't yet imported the signed certificate into Amazon Web Services Private CA (that is, the status of the CA is PENDING_CERTIFICATE).

When you successfully call DeleteCertificateAuthority, the CA's status changes to DELETED. However, the CA won't be permanently deleted until the restoration period has passed. By default, if you do not set the PermanentDeletionTimeInDays parameter, the CA remains restorable for 30 days. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority action returns the time remaining in the restoration window of a private CA in the DELETED state. To restore an eligible CA, call the RestoreCertificateAuthority action.

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 BeginDeleteCertificateAuthority and EndDeleteCertificateAuthority.

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

Syntax

C#
public virtual Task<DeleteCertificateAuthorityResponse> DeleteCertificateAuthorityAsync(
         DeleteCertificateAuthorityRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.ACMPCA.Model.DeleteCertificateAuthorityRequest

Container for the necessary parameters to execute the DeleteCertificateAuthority 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 DeleteCertificateAuthority 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.
InvalidStateException The state of the private CA does not allow this action to occur.
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