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.

Requests an ACM certificate for use with other Amazon Web Services 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.

ACM behavior differs from the RFC 6125 specification of the certificate validation process. ACM first checks for a Subject Alternative Name, and, if it finds one, ignores the common name (CN).

After successful completion of the RequestCertificate action, there is a delay of several seconds before you can retrieve information about the new 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 BeginRequestCertificate and EndRequestCertificate.

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

Syntax

C#
public abstract Task<RequestCertificateResponse> RequestCertificateAsync(
         String domainName,
         CancellationToken cancellationToken
)

Parameters

domainName
Type: System.String

Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com. In compliance with RFC 5280, the length of the domain name (technically, the Common Name) that you provide cannot exceed 64 octets (characters), including periods. To add a longer domain name, specify it in the Subject Alternative Name field, which supports names up to 253 octets in length.

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 RequestCertificate service method, as returned by CertificateManager.

Exceptions

ExceptionCondition
InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
InvalidDomainValidationOptionsException One or more values in the DomainValidationOption structure is incorrect.
InvalidParameterException An input parameter was invalid.
InvalidTagException One or both of the values that make up the key-value pair is not valid. For example, you cannot specify a tag value that begins with aws:.
LimitExceededException An ACM quota has been exceeded.
TagPolicyException A specified tag did not comply with an existing tag policy and was rejected.
TooManyTagsException The request contains too many tags. Try the request again with fewer tags.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also