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 Route53Domains Amazon Route 53 API actions let you register domain names and perform related operations.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.Route53Domains.AmazonRoute53DomainsClient

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

Syntax

C#
public class AmazonRoute53DomainsClient : AmazonServiceClient
         IAmazonRoute53Domains, IAmazonService, IDisposable

The AmazonRoute53DomainsClient type exposes the following members

Constructors

NameDescription
Public Method AmazonRoute53DomainsClient()

Constructs AmazonRoute53DomainsClient 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 AmazonRoute53DomainsClient(RegionEndpoint)

Constructs AmazonRoute53DomainsClient 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 AmazonRoute53DomainsClient(AmazonRoute53DomainsConfig)

Constructs AmazonRoute53DomainsClient 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 AmazonRoute53DomainsClient(AWSCredentials)

Constructs AmazonRoute53DomainsClient with AWS Credentials

Public Method AmazonRoute53DomainsClient(AWSCredentials, RegionEndpoint)

Constructs AmazonRoute53DomainsClient with AWS Credentials

Public Method AmazonRoute53DomainsClient(AWSCredentials, AmazonRoute53DomainsConfig)

Constructs AmazonRoute53DomainsClient with AWS Credentials and an AmazonRoute53DomainsClient Configuration object.

Public Method AmazonRoute53DomainsClient(string, string)

Constructs AmazonRoute53DomainsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonRoute53DomainsClient(string, string, RegionEndpoint)

Constructs AmazonRoute53DomainsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonRoute53DomainsClient(string, string, AmazonRoute53DomainsConfig)

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

Public Method AmazonRoute53DomainsClient(string, string, string)

Constructs AmazonRoute53DomainsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonRoute53DomainsClient(string, string, string, RegionEndpoint)

Constructs AmazonRoute53DomainsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonRoute53DomainsClient(string, string, string, AmazonRoute53DomainsConfig)

Constructs AmazonRoute53DomainsClient with AWS Access Key ID, AWS Secret Key and an AmazonRoute53DomainsClient 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 CheckDomainAvailability(CheckDomainAvailabilityRequest)

This operation checks the availability of one domain name. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name.

Public Method CheckDomainAvailabilityAsync(CheckDomainAvailabilityRequest, CancellationToken)

Initiates the asynchronous execution of the CheckDomainAvailability operation.

Public Method DeleteTagsForDomain(string, List<String>)

This operation deletes the specified tags for a domain.

All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations.

Public Method DeleteTagsForDomain(DeleteTagsForDomainRequest)

This operation deletes the specified tags for a domain.

All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations.

Public Method DeleteTagsForDomainAsync(string, List<String>, CancellationToken)

This operation deletes the specified tags for a domain.

All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations.

Public Method DeleteTagsForDomainAsync(DeleteTagsForDomainRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteTagsForDomain operation.

Public Method DisableDomainAutoRenew(DisableDomainAutoRenewRequest)

This operation disables automatic renewal of domain registration for the specified domain.

Public Method DisableDomainAutoRenewAsync(DisableDomainAutoRenewRequest, CancellationToken)

Initiates the asynchronous execution of the DisableDomainAutoRenew operation.

Public Method DisableDomainTransferLock(DisableDomainTransferLockRequest)

This operation removes the transfer lock on the domain (specifically the clientTransferProhibited status) to allow domain transfers. We recommend you refrain from performing this action unless you intend to transfer the domain to a different registrar. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

Public Method DisableDomainTransferLockAsync(DisableDomainTransferLockRequest, CancellationToken)

Initiates the asynchronous execution of the DisableDomainTransferLock operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method EnableDomainAutoRenew(EnableDomainAutoRenewRequest)

This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. The cost of renewing your domain registration is billed to your AWS account.

The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see "Renewal, restoration, and deletion times" on the website for our registrar partner, Gandi. Route 53 requires that you renew before the end of the renewal period that is listed on the Gandi website so we can complete processing before the deadline.

Public Method EnableDomainAutoRenewAsync(EnableDomainAutoRenewRequest, CancellationToken)

Initiates the asynchronous execution of the EnableDomainAutoRenew operation.

Public Method EnableDomainTransferLock(EnableDomainTransferLockRequest)

This operation sets the transfer lock on the domain (specifically the clientTransferProhibited status) to prevent domain transfers. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

Public Method EnableDomainTransferLockAsync(EnableDomainTransferLockRequest, CancellationToken)

Initiates the asynchronous execution of the EnableDomainTransferLock operation.

Public Method GetContactReachabilityStatus(GetContactReachabilityStatusRequest)

For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation returns information about whether the registrant contact has responded.

If you want us to resend the email, use the ResendContactReachabilityEmail operation.

Public Method GetContactReachabilityStatusAsync(GetContactReachabilityStatusRequest, CancellationToken)

Initiates the asynchronous execution of the GetContactReachabilityStatus operation.

Public Method GetDomainDetail(GetDomainDetailRequest)

This operation returns detailed information about a specified domain that is associated with the current AWS account. Contact information for the domain is also returned as part of the output.

Public Method GetDomainDetailAsync(GetDomainDetailRequest, CancellationToken)

Initiates the asynchronous execution of the GetDomainDetail operation.

Public Method GetDomainSuggestions(GetDomainSuggestionsRequest)

The GetDomainSuggestions operation returns a list of suggested domain names given a string, which can either be a domain name or simply a word or phrase (without spaces).

Public Method GetDomainSuggestionsAsync(GetDomainSuggestionsRequest, CancellationToken)

Initiates the asynchronous execution of the GetDomainSuggestions operation.

Public Method GetOperationDetail(GetOperationDetailRequest)

This operation returns the current status of an operation that is not completed.

Public Method GetOperationDetailAsync(GetOperationDetailRequest, CancellationToken)

Initiates the asynchronous execution of the GetOperationDetail operation.

Public Method ListDomains()

This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.

Public Method ListDomains(ListDomainsRequest)

This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.

Public Method ListDomainsAsync(CancellationToken)

This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.

Public Method ListDomainsAsync(ListDomainsRequest, CancellationToken)

Initiates the asynchronous execution of the ListDomains operation.

Public Method ListOperations()

This operation returns the operation IDs of operations that are not yet complete.

Public Method ListOperations(ListOperationsRequest)

This operation returns the operation IDs of operations that are not yet complete.

Public Method ListOperationsAsync(CancellationToken)

This operation returns the operation IDs of operations that are not yet complete.

Public Method ListOperationsAsync(ListOperationsRequest, CancellationToken)

Initiates the asynchronous execution of the ListOperations operation.

Public Method ListTagsForDomain(string)

This operation returns all of the tags that are associated with the specified domain.

All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations.

Public Method ListTagsForDomain(ListTagsForDomainRequest)

This operation returns all of the tags that are associated with the specified domain.

All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations.

Public Method ListTagsForDomainAsync(string, CancellationToken)

This operation returns all of the tags that are associated with the specified domain.

All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations.

Public Method ListTagsForDomainAsync(ListTagsForDomainRequest, CancellationToken)

Initiates the asynchronous execution of the ListTagsForDomain operation.

Public Method RegisterDomain(RegisterDomainRequest)

This operation registers a domain. Domains are registered by the AWS registrar partner, Gandi. For some top-level domains (TLDs), this operation requires extra parameters.

When you register a domain, Amazon Route 53 does the following:

  • Creates a Amazon Route 53 hosted zone that has the same name as the domain. Amazon Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers.

  • Enables autorenew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration.

  • Optionally enables privacy protection, so WHOIS queries return contact information for our registrar partner, Gandi, instead of the information you entered for registrant, admin, and tech contacts.

  • If registration is successful, returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant is notified by email.

  • Charges your AWS account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing.

Public Method RegisterDomainAsync(RegisterDomainRequest, CancellationToken)

Initiates the asynchronous execution of the RegisterDomain operation.

Public Method RenewDomain(RenewDomainRequest)

This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your AWS account.

We recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the expiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see Renewing Registration for a Domain in the Amazon Route 53 Developer Guide.

Public Method RenewDomainAsync(RenewDomainRequest, CancellationToken)

Initiates the asynchronous execution of the RenewDomain operation.

Public Method ResendContactReachabilityEmail(ResendContactReachabilityEmailRequest)

For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation resends the confirmation email to the current email address for the registrant contact.

Public Method ResendContactReachabilityEmailAsync(ResendContactReachabilityEmailRequest, CancellationToken)

Initiates the asynchronous execution of the ResendContactReachabilityEmail operation.

Public Method RetrieveDomainAuthCode(RetrieveDomainAuthCodeRequest)

This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.

Public Method RetrieveDomainAuthCodeAsync(RetrieveDomainAuthCodeRequest, CancellationToken)

Initiates the asynchronous execution of the RetrieveDomainAuthCode operation.

Public Method TransferDomain(TransferDomainRequest)

This operation transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered with the AWS registrar partner, Gandi.

For transfer requirements, a detailed procedure, and information about viewing the status of a domain transfer, see Transferring Registration for a Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.

If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you consider transferring your DNS service to Amazon Route 53 or to another DNS service provider before you transfer your registration. Some registrars provide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar will not renew your domain registration and could end your DNS service at any time.

If the registrar for your domain is also the DNS service provider for the domain and you don't transfer DNS service to another provider, your website, email, and the web applications associated with the domain might become unavailable.

If the transfer is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email.

Public Method TransferDomainAsync(TransferDomainRequest, CancellationToken)

Initiates the asynchronous execution of the TransferDomain operation.

Public Method UpdateDomainContact(UpdateDomainContactRequest)

This operation updates the contact information for a particular domain. Information for at least one contact (registrant, administrator, or technical) must be supplied for update.

If the update is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

Public Method UpdateDomainContactAsync(UpdateDomainContactRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateDomainContact operation.

Public Method UpdateDomainContactPrivacy(UpdateDomainContactPrivacyRequest)

This operation updates the specified domain contact's privacy setting. When the privacy option is enabled, personal information such as postal or email address is hidden from the results of a public WHOIS query. The privacy services are provided by the AWS registrar, Gandi. For more information, see the Gandi privacy features.

This operation only affects the privacy of the specified contact type (registrant, administrator, or tech). Successful acceptance returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

Public Method UpdateDomainContactPrivacyAsync(UpdateDomainContactPrivacyRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateDomainContactPrivacy operation.

Public Method UpdateDomainNameservers(UpdateDomainNameserversRequest)

This operation replaces the current set of name servers for the domain with the specified set of name servers. If you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain.

If successful, this operation returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

Public Method UpdateDomainNameserversAsync(UpdateDomainNameserversRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateDomainNameservers operation.

Public Method UpdateTagsForDomain(string, List<Tag>)

This operation adds or updates tags for a specified domain.

All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations.

Public Method UpdateTagsForDomain(UpdateTagsForDomainRequest)

This operation adds or updates tags for a specified domain.

All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations.

Public Method UpdateTagsForDomainAsync(string, List<Tag>, CancellationToken)

This operation adds or updates tags for a specified domain.

All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations.

Public Method UpdateTagsForDomainAsync(UpdateTagsForDomainRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateTagsForDomain operation.

Public Method ViewBilling(ViewBillingRequest)

Returns all the domain-related billing records for the current AWS account for a specified period

Public Method ViewBillingAsync(ViewBillingRequest, CancellationToken)

Initiates the asynchronous execution of the ViewBilling 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