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 AddTagsToCertificateRequest

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

Class AddTagsToCertificateResponse

This is the response object from the AddTagsToCertificate operation.

Class CertificateDetail

Contains metadata about an ACM certificate. This structure is returned in the response to a DescribeCertificate request.

Class CertificateSummary

This structure is returned in the response object of ListCertificates action.

Class DeleteCertificateRequest

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

Class DeleteCertificateResponse

This is the response object from the DeleteCertificate operation.

Class DescribeCertificateRequest

Container for the parameters to the DescribeCertificate operation. Returns detailed metadata about the specified ACM Certificate.

Class DescribeCertificateResponse

This is the response object from the DescribeCertificate operation.

Class DomainValidation

Contains information about the validation of each domain name in the certificate.

Class DomainValidationOption

Contains information about the domain names that you want ACM to use to send you emails that enable you to validate domain ownership.

Class ExtendedKeyUsage

The Extended Key Usage X.509 v3 extension defines one or more purposes for which the public key can be used. This is in addition to or in place of the basic purposes specified by the Key Usage extension.

Class Filters

This structure can be used in the ListCertificates action to filter the output of the certificate list.

Class GetCertificateRequest

Container for the parameters to the GetCertificate operation. Retrieves a certificate specified by an ARN and its certificate chain . The chain is an ordered list of certificates that contains the end entity ertificate, 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.

Class GetCertificateResponse

This is the response object from the GetCertificate operation.

Class ImportCertificateRequest

Container for the parameters to the ImportCertificate operation. Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM. For more information, see Integrated Services.

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

For more information about importing certificates into ACM, including the differences between certificates that you import and those that ACM provides, see Importing Certificates in the AWS Certificate Manager User Guide.

In general, you can import almost any valid certificate. However, services integrated with ACM allow only certificate types they support to be associated with their resources. The following guidelines are also important:

  • 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 must not exceed 1000 characters.

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

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

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

Class ImportCertificateResponse

This is the response object from the ImportCertificate operation.

Class InvalidArnException

CertificateManager exception

Class InvalidDomainValidationOptionsException

CertificateManager exception

Class InvalidStateException

CertificateManager exception

Class InvalidTagException

CertificateManager exception

Class KeyUsage

The Key Usage X.509 v3 extension defines the purpose of the public key contained in the certificate.

Class LimitExceededException

CertificateManager exception

Class ListCertificatesRequest

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

Class ListCertificatesResponse

This is the response object from the ListCertificates operation.

Class ListTagsForCertificateRequest

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

Class ListTagsForCertificateResponse

This is the response object from the ListTagsForCertificate operation.

Class RemoveTagsFromCertificateRequest

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

Class RemoveTagsFromCertificateResponse

This is the response object from the RemoveTagsFromCertificate operation.

Class RenewalSummary

Contains information about the status of ACM's managed renewal for the certificate. This structure exists only when the certificate type is AMAZON_ISSUED.

Class RequestCertificateRequest

Container for the parameters to the RequestCertificate operation. Requests an ACM Certificate for use with other AWS services. To request an ACM Certificate, you must specify the fully qualified domain name (FQDN) for your site in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter if users can reach your site by using other names.

For each domain name you specify, email is sent to the domain owner to request approval to issue the certificate. Email is sent to three registered contact addresses in the WHOIS database and to five common system administration addresses formed from the DomainName you enter or the optional ValidationDomain parameter. For more information, see Validate Domain Ownership.

After receiving approval from the domain owner, the ACM Certificate is issued. For more information, see the AWS Certificate Manager User Guide.

Class RequestCertificateResponse

This is the response object from the RequestCertificate operation.

Class RequestInProgressException

CertificateManager exception

Class ResendValidationEmailRequest

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

Class ResendValidationEmailResponse

This is the response object from the ResendValidationEmail operation.

Class ResourceInUseException

CertificateManager exception

Class ResourceNotFoundException

CertificateManager exception

Class ResourceRecord

Contains a DNS record value that you can use to can use to validate ownership or control of a domain. This is used by the DescribeCertificate action.

Class Tag

A key-value pair that identifies or specifies metadata about an ACM resource.

Class TooManyTagsException

CertificateManager exception