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.

Implementation for accessing CertificateManager AWS Certificate Manager

Welcome to the AWS Certificate Manager (ACM) API documentation.

You can use ACM to manage SSL/TLS certificates for your AWS-based websites and applications. For general information about using ACM, see the AWS Certificate Manager User Guide .

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.CertificateManager.AmazonCertificateManagerClient

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

Syntax

C#
public class AmazonCertificateManagerClient : AmazonServiceClient
         IAmazonCertificateManager, IAmazonService, IDisposable

The AmazonCertificateManagerClient type exposes the following members

Constructors

NameDescription
Public Method AmazonCertificateManagerClient()

Constructs AmazonCertificateManagerClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonCertificateManagerClient(RegionEndpoint)

Constructs AmazonCertificateManagerClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonCertificateManagerClient(AmazonCertificateManagerConfig)

Constructs AmazonCertificateManagerClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonCertificateManagerClient(AWSCredentials)

Constructs AmazonCertificateManagerClient with AWS Credentials

Public Method AmazonCertificateManagerClient(AWSCredentials, RegionEndpoint)

Constructs AmazonCertificateManagerClient with AWS Credentials

Public Method AmazonCertificateManagerClient(AWSCredentials, AmazonCertificateManagerConfig)

Constructs AmazonCertificateManagerClient with AWS Credentials and an AmazonCertificateManagerClient Configuration object.

Public Method AmazonCertificateManagerClient(string, string)

Constructs AmazonCertificateManagerClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCertificateManagerClient(string, string, RegionEndpoint)

Constructs AmazonCertificateManagerClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCertificateManagerClient(string, string, AmazonCertificateManagerConfig)

Constructs AmazonCertificateManagerClient with AWS Access Key ID, AWS Secret Key and an AmazonCertificateManagerClient Configuration object.

Public Method AmazonCertificateManagerClient(string, string, string)

Constructs AmazonCertificateManagerClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCertificateManagerClient(string, string, string, RegionEndpoint)

Constructs AmazonCertificateManagerClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCertificateManagerClient(string, string, string, AmazonCertificateManagerConfig)

Constructs AmazonCertificateManagerClient with AWS Access Key ID, AWS Secret Key and an AmazonCertificateManagerClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AddTagsToCertificate(AddTagsToCertificateRequest)

Adds one or more tags to an ACM certificate. 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 certificate 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 certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM certificates.

To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.

Public Method AddTagsToCertificateAsync(AddTagsToCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the AddTagsToCertificate operation.

Public Method DeleteCertificate(string)

Deletes a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by AWS services integrated with ACM.

You cannot delete an ACM certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.

Public Method DeleteCertificate(DeleteCertificateRequest)

Deletes a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by AWS services integrated with ACM.

You cannot delete an ACM certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.

Public Method DeleteCertificateAsync(string, CancellationToken)

Deletes a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by AWS services integrated with ACM.

You cannot delete an ACM certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.

Public Method DeleteCertificateAsync(DeleteCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteCertificate operation.

Public Method DescribeCertificate(string)

Returns detailed metadata about the specified ACM certificate.

Public Method DescribeCertificate(DescribeCertificateRequest)

Returns detailed metadata about the specified ACM certificate.

Public Method DescribeCertificateAsync(string, CancellationToken)

Returns detailed metadata about the specified ACM certificate.

Public Method DescribeCertificateAsync(DescribeCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeCertificate operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method ExportCertificate(ExportCertificateRequest)

Exports a private certificate issued by a private certificate authority (CA) for use anywhere. You can export the certificate, the certificate chain, and the encrypted private key associated with the public key embedded in the certificate. You must store the private key securely. The private key is a 2048 bit RSA key. You must provide a passphrase for the private key when exporting it. You can use the following OpenSSL command to decrypt it later. Provide the passphrase when prompted.

openssl rsa -in encrypted_key.pem -out decrypted_key.pem

Public Method ExportCertificateAsync(ExportCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the ExportCertificate operation.

Public Method GetCertificate(string)

Retrieves a certificate specified by an ARN and its certificate chain . The chain is an ordered list of certificates that contains the end entity certificate, intermediate certificates of subordinate CAs, and the root certificate in that order. The certificate and certificate chain are base64 encoded. If you want to decode the certificate to see the individual fields, you can use OpenSSL.

Public Method GetCertificate(GetCertificateRequest)

Retrieves a certificate specified by an ARN and its certificate chain . The chain is an ordered list of certificates that contains the end entity certificate, intermediate certificates of subordinate CAs, and the root certificate in that order. The certificate and certificate chain are base64 encoded. If you want to decode the certificate to see the individual fields, you can use OpenSSL.

Public Method GetCertificateAsync(string, CancellationToken)

Retrieves a certificate specified by an ARN and its certificate chain . The chain is an ordered list of certificates that contains the end entity certificate, intermediate certificates of subordinate CAs, and the root certificate in that order. The certificate and certificate chain are base64 encoded. If you want to decode the certificate to see the individual fields, you can use OpenSSL.

Public Method GetCertificateAsync(GetCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the GetCertificate operation.

Public Method ImportCertificate(ImportCertificateRequest)

Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the AWS Certificate Manager User Guide.

ACM does not provide managed renewal for certificates that you import.

Note the following guidelines when importing third party certificates:

  • You must enter the private key that matches the certificate you are importing.

  • The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.

  • If the certificate you are importing is not self-signed, you must enter its certificate chain.

  • If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain.

  • The certificate, private key, and certificate chain must be PEM-encoded.

  • The current time must be between the Not Before and Not After certificate fields.

  • The Issuer field must not be empty.

  • The OCSP authority URL, if present, must not exceed 1000 characters.

  • To import a new certificate, omit the CertificateArn argument. Include this argument only when you want to replace a previously imported certificate.

  • When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by file://. For example, you can specify a certificate saved in the C:\temp folder as file://C:\temp\certificate_to_import.pem. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs.

  • When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using.

This operation returns the Amazon Resource Name (ARN) of the imported certificate.

Public Method ImportCertificateAsync(ImportCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the ImportCertificate operation.

Public Method ListCertificates()

Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate.

Public Method ListCertificates(ListCertificatesRequest)

Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate.

Public Method ListCertificatesAsync(CancellationToken)

Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate.

Public Method ListCertificatesAsync(ListCertificatesRequest, CancellationToken)

Initiates the asynchronous execution of the ListCertificates operation.

Public Method ListTagsForCertificate(ListTagsForCertificateRequest)

Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action.

Public Method ListTagsForCertificateAsync(ListTagsForCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the ListTagsForCertificate operation.

Public Method RemoveTagsFromCertificate(RemoveTagsFromCertificateRequest)

Remove one or more tags from an ACM certificate. 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 certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action.

Public Method RemoveTagsFromCertificateAsync(RemoveTagsFromCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the RemoveTagsFromCertificate operation.

Public Method RequestCertificate(string)

Requests an ACM certificate for use with other AWS services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter.

If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation. ACM issues public certificates after receiving approval from the domain owner.

Public Method RequestCertificate(RequestCertificateRequest)

Requests an ACM certificate for use with other AWS services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter.

If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation. ACM issues public certificates after receiving approval from the domain owner.

Public Method RequestCertificateAsync(string, CancellationToken)

Requests an ACM certificate for use with other AWS services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter.

If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation. ACM issues public certificates after receiving approval from the domain owner.

Public Method RequestCertificateAsync(RequestCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the RequestCertificate operation.

Public Method ResendValidationEmail(ResendValidationEmailRequest)

Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking I Approve. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate. For more information about setting up your contact email addresses, see Configure Email for your Domain.

Public Method ResendValidationEmailAsync(ResendValidationEmailRequest, CancellationToken)

Initiates the asynchronous execution of the ResendValidationEmail operation.

Public Method UpdateCertificateOptions(UpdateCertificateOptionsRequest)

Updates a certificate. Currently, you can use this function to specify whether to opt in to or out of recording your certificate in a certificate transparency log. For more information, see Opting Out of Certificate Transparency Logging.

Public Method UpdateCertificateOptionsAsync(UpdateCertificateOptionsRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateCertificateOptions operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms