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.

Classes

NameDescription
Class ASN1Subject

Contains information about the certificate subject. The certificate can be one issued by your private certificate authority (CA) or it can be your private CA certificate. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate. The DN must be unique for each for each entity, but your private CA can issue more than one certificate with the same DN to the same entity.

Class CertificateAuthority

Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate Subject field owns or controls the public key contained in the Subject Public Key Info field. Call the CreateCertificateAuthority function to create your private CA. You must then call the GetCertificateAuthorityCertificate function to retrieve a private CA certificate signing request (CSR). Take the CSR to your on-premises CA and sign it with the root CA certificate or a subordinate certificate. Call the ImportCertificateAuthorityCertificate function to import the signed certificate into AWS Certificate Manager (ACM).

Class CertificateAuthorityConfiguration

Contains configuration information for your private certificate authority (CA). This includes information about the class of public key algorithm and the key pair that your private CA creates when it issues a certificate, the signature algorithm it uses used when issuing certificates, and its X.500 distinguished name. You must specify this information when you call the CreateCertificateAuthority function.

Class CertificateMismatchException

ACMPCA exception

Class ConcurrentModificationException

ACMPCA exception

Class CreateCertificateAuthorityAuditReportRequest

Container for the parameters to the CreateCertificateAuthorityAuditReport operation. Creates an audit report that lists every time that the your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate functions use the private key. You can generate a new report every 30 minutes.

Class CreateCertificateAuthorityAuditReportResponse

This is the response object from the CreateCertificateAuthorityAuditReport operation.

Class CreateCertificateAuthorityRequest

Container for the parameters to the CreateCertificateAuthority operation. Creates a private subordinate certificate authority (CA). You must specify the CA configuration, the revocation configuration, the CA type, and an optional idempotency token. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses to sign, and X.500 subject information. The CRL (certificate revocation list) configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this function returns the Amazon Resource Name (ARN) of the CA.

Class CreateCertificateAuthorityResponse

This is the response object from the CreateCertificateAuthority operation.

Class CrlConfiguration

Contains configuration information for a certificate revocation list (CRL). Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the Enabled parameter to true. Your private CA writes CRLs to an S3 bucket that you specify in the S3BucketName parameter. You can hide the name of your bucket by specifying a value for the CustomCname parameter. Your private CA copies the CNAME or the S3 bucket name to the CRL Distribution Points extension of each certificate it issues. Your S3 bucket policy must give write permission to ACM PCA.

Your private CA uses the value in the ExpirationInDays parameter to calculate the nextUpdate field in the CRL. The CRL is refreshed at 1/2 the age of next update or when a certificate is revoked. When a certificate is revoked, it is recorded in the next CRL that is generated and in the next audit report. Only time valid certificates are listed in the CRL. Expired certificates are not included.

CRLs contain the following fields:

  • Version: The current version number defined in RFC 5280 is V2. The integer value is 0x1.

  • Signature Algorithm: The name of the algorithm used to sign the CRL.

  • Issuer: The X.500 distinguished name of your private CA that issued the CRL.

  • Last Update: The issue date and time of this CRL.

  • Next Update: The day and time by which the next CRL will be issued.

  • Revoked Certificates: List of revoked certificates. Each list item contains the following information.

    • Serial Number: The serial number, in hexadecimal format, of the revoked certificate.

    • Revocation Date: Date and time the certificate was revoked.

    • CRL Entry Extensions: Optional extensions for the CRL entry.

      • X509v3 CRL Reason Code: Reason the certificate was revoked.

  • CRL Extensions: Optional extensions for the CRL.

    • X509v3 Authority Key Identifier: Identifies the public key associated with the private key used to sign the certificate.

    • X509v3 CRL Number:: Decimal sequence number for the CRL.

  • Signature Algorithm: Algorithm used by your private CA to sign the CRL.

  • Signature Value: Signature computed over the CRL.

Certificate revocation lists created by ACM PCA are DER-encoded. You can use the following OpenSSL command to list a CRL.

openssl crl -inform DER -text -in crl_path -noout

Class DeleteCertificateAuthorityRequest

Container for the parameters to the DeleteCertificateAuthority operation. Deletes the private certificate authority (CA) that you created or started to create by calling the CreateCertificateAuthority function. This action requires that you enter an ARN (Amazon Resource Name) for the private CA that you want to delete. You can find the ARN by calling the ListCertificateAuthorities function. You can delete the CA if you are waiting for it to be created (the Status field of the CertificateAuthority is CREATING) or if the CA has been created but you haven't yet imported the signed certificate (the Status is PENDING_CERTIFICATE) into ACM PCA. If you've already imported the certificate, you cannot delete the CA unless it has been disabled for more than 30 days. To disable a CA, call the UpdateCertificateAuthority function and set the CertificateAuthorityStatus argument to DISABLED.

Class DeleteCertificateAuthorityResponse

This is the response object from the DeleteCertificateAuthority operation.

Class DescribeCertificateAuthorityAuditReportRequest

Container for the parameters to the DescribeCertificateAuthorityAuditReport operation. Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport function. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the IssueCertificate function or the RevokeCertificate function.

Class DescribeCertificateAuthorityAuditReportResponse

This is the response object from the DescribeCertificateAuthorityAuditReport operation.

Class DescribeCertificateAuthorityRequest

Container for the parameters to the DescribeCertificateAuthority operation. Lists information about your private certificate authority (CA). You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following:

  • CREATING: ACM PCA is creating your private certificate authority.

  • PENDING_CERTIFICATE: The certificate is pending. You must use your on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA.

  • ACTIVE: Your private CA is active.

  • DISABLED: Your private CA has been disabled.

  • EXPIRED: Your private CA certificate has expired.

  • FAILED: Your private CA has failed. Your CA can fail for problems such a network outage or backend AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA.

Class DescribeCertificateAuthorityResponse

This is the response object from the DescribeCertificateAuthority operation.

Class GetCertificateAuthorityCertificateRequest

Container for the parameters to the GetCertificateAuthorityCertificate operation. Retrieves the certificate and certificate chain for your private certificate authority (CA). Both the certificate and the chain are base64 PEM-encoded. The chain does not include the CA certificate. Each certificate in the chain signs the one before it.

Class GetCertificateAuthorityCertificateResponse

This is the response object from the GetCertificateAuthorityCertificate operation.

Class GetCertificateAuthorityCsrRequest

Container for the parameters to the GetCertificateAuthorityCsr operation. Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the CreateCertificateAuthority function. Take the CSR to your on-premises X.509 infrastructure and sign it by using your root or a subordinate CA. Then import the signed certificate back into ACM PCA by calling the ImportCertificateAuthorityCertificate function. The CSR is returned as a base64 PEM-encoded string.

Class GetCertificateAuthorityCsrResponse

This is the response object from the GetCertificateAuthorityCsr operation.

Class GetCertificateRequest

Container for the parameters to the GetCertificate operation. Retrieves a certificate from your private CA. The ARN of the certificate is returned when you call the IssueCertificate function. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the GetCertificate function. You can retrieve the certificate if it is in the ISSUED state. You can call the CreateCertificateAuthorityAuditReport function to create a report that contains information about all of the certificates issued and revoked by your private CA.

Class GetCertificateResponse

This is the response object from the GetCertificate operation.

Class ImportCertificateAuthorityCertificateRequest

Container for the parameters to the ImportCertificateAuthorityCertificate operation. Imports your signed private CA certificate into ACM PCA. Before you can call this function, you must create the private certificate authority by calling the CreateCertificateAuthority function. You must then generate a certificate signing request (CSR) by calling the GetCertificateAuthorityCsr function. Take the CSR to your on-premises CA and use the root certificate or a subordinate certificate to sign it. Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.

Your certificate chain must not include the private CA certificate that you are importing.

Your on-premises CA certificate must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built.

The chain must be PEM-encoded.

Class ImportCertificateAuthorityCertificateResponse

This is the response object from the ImportCertificateAuthorityCertificate operation.

Class InvalidArgsException

ACMPCA exception

Class InvalidArnException

ACMPCA exception

Class InvalidNextTokenException

ACMPCA exception

Class InvalidPolicyException

ACMPCA exception

Class InvalidStateException

ACMPCA exception

Class InvalidTagException

ACMPCA exception

Class IssueCertificateRequest

Container for the parameters to the IssueCertificate operation. Uses your private certificate authority (CA) to issue a client certificate. This function returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate function and specifying the ARN.

You cannot use the ACM ListCertificateAuthorities function to retrieve the ARNs of the certificates that you issue by using ACM PCA.

Class IssueCertificateResponse

This is the response object from the IssueCertificate operation.

Class LimitExceededException

ACMPCA exception

Class ListCertificateAuthoritiesRequest

Container for the parameters to the ListCertificateAuthorities operation. Lists the private certificate authorities that you created by using the CreateCertificateAuthority function.

Class ListCertificateAuthoritiesResponse

This is the response object from the ListCertificateAuthorities operation.

Class ListTagsRequest

Container for the parameters to the ListTags operation. Lists the tags, if any, that are associated with your private CA. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the TagCertificateAuthority function to add one or more tags to your CA. Call the UntagCertificateAuthority function to remove tags.

Class ListTagsResponse

This is the response object from the ListTags operation.

Class MalformedCertificateException

ACMPCA exception

Class MalformedCSRException

ACMPCA exception

Class RequestAlreadyProcessedException

ACMPCA exception

Class RequestFailedException

ACMPCA exception

Class RequestInProgressException

ACMPCA exception

Class ResourceNotFoundException

ACMPCA exception

Class RevocationConfiguration

Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority functions. Your private certificate authority (CA) can create and maintain a certificate revocation list (CRL). A CRL contains information about certificates revoked by your CA. For more information, see RevokeCertificate.

Class RevokeCertificateRequest

Container for the parameters to the RevokeCertificate operation. 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.

Class RevokeCertificateResponse

This is the response object from the RevokeCertificate operation.

Class Tag

Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the TagCertificateAuthority function. To remove a tag, call the UntagCertificateAuthority function.

Class TagCertificateAuthorityRequest

Container for the parameters to the TagCertificateAuthority operation. Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the UntagCertificateAuthority function. Call the ListTags function to see what tags are associated with your CA.

Class TagCertificateAuthorityResponse

This is the response object from the TagCertificateAuthority operation.

Class TooManyTagsException

ACMPCA exception

Class UntagCertificateAuthorityRequest

Container for the parameters to the UntagCertificateAuthority operation. Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a private CA, use the TagCertificateAuthority. Call the ListTags function to see what tags are associated with your CA.

Class UntagCertificateAuthorityResponse

This is the response object from the UntagCertificateAuthority operation.

Class UpdateCertificateAuthorityRequest

Container for the parameters to the UpdateCertificateAuthority operation. Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the ACTIVE or DISABLED state before you can update it. You can disable a private CA that is in the ACTIVE state or make a CA that is in the DISABLED state active again.

Class UpdateCertificateAuthorityResponse

This is the response object from the UpdateCertificateAuthority operation.

Class Validity

Length of time for which the certificate issued by your private certificate authority (CA), or by the private CA itself, is valid in days, months, or years. You can issue a certificate by calling the IssueCertificate function.