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 BillingRecord

Information for one billing record.

Class CheckDomainAvailabilityRequest

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

Class CheckDomainAvailabilityResponse

The CheckDomainAvailability response includes the following elements.

Class ContactDetail

ContactDetail includes the following elements.

Class DeleteTagsForDomainRequest

Container for the parameters to the DeleteTagsForDomain operation. This operation deletes the specified tags for a domain.

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

Class DeleteTagsForDomainResponse

This is the response object from the DeleteTagsForDomain operation.

Class DisableDomainAutoRenewRequest

Container for the parameters to the DisableDomainAutoRenew operation. This operation disables automatic renewal of domain registration for the specified domain.

Class DisableDomainAutoRenewResponse

This is the response object from the DisableDomainAutoRenew operation.

Class DisableDomainTransferLockRequest

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

Class DisableDomainTransferLockResponse

The DisableDomainTransferLock response includes the following element.

Class DomainLimitExceededException

Route53Domains exception

Class DomainSuggestion

Information about one suggested domain name.

Class DomainSummary

Summary information about one domain.

Class DuplicateRequestException

Route53Domains exception

Class EnableDomainAutoRenewRequest

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

Class EnableDomainAutoRenewResponse

This is the response object from the EnableDomainAutoRenew operation.

Class EnableDomainTransferLockRequest

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

Class EnableDomainTransferLockResponse

The EnableDomainTransferLock response includes the following elements.

Class ExtraParam

ExtraParam includes the following elements.

Class GetContactReachabilityStatusRequest

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

Class GetContactReachabilityStatusResponse

This is the response object from the GetContactReachabilityStatus operation.

Class GetDomainDetailRequest

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

Class GetDomainDetailResponse

The GetDomainDetail response includes the following elements.

Class GetDomainSuggestionsRequest

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

Class GetDomainSuggestionsResponse

This is the response object from the GetDomainSuggestions operation.

Class GetOperationDetailRequest

Container for the parameters to the GetOperationDetail operation. This operation returns the current status of an operation that is not completed.

Class GetOperationDetailResponse

The GetOperationDetail response includes the following elements.

Class InvalidInputException

Route53Domains exception

Class ListDomainsRequest

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

Class ListDomainsResponse

The ListDomains response includes the following elements.

Class ListOperationsRequest

Container for the parameters to the ListOperations operation. This operation returns the operation IDs of operations that are not yet complete.

Class ListOperationsResponse

The ListOperations response includes the following elements.

Class ListTagsForDomainRequest

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

Class ListTagsForDomainResponse

The ListTagsForDomain response includes the following elements.

Class Nameserver

Nameserver includes the following elements.

Class OperationLimitExceededException

Route53Domains exception

Class OperationSummary

OperationSummary includes the following elements.

Class RegisterDomainRequest

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

Class RegisterDomainResponse

The RegisterDomain response includes the following element.

Class RenewDomainRequest

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

Class RenewDomainResponse

This is the response object from the RenewDomain operation.

Class ResendContactReachabilityEmailRequest

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

Class ResendContactReachabilityEmailResponse

This is the response object from the ResendContactReachabilityEmail operation.

Class RetrieveDomainAuthCodeRequest

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

Class RetrieveDomainAuthCodeResponse

The RetrieveDomainAuthCode response includes the following element.

Class Tag

Each tag includes the following elements.

Class TLDRulesViolationException

Route53Domains exception

Class TransferDomainRequest

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

Class TransferDomainResponse

The TranserDomain response includes the following element.

Class UnsupportedTLDException

Route53Domains exception

Class UpdateDomainContactPrivacyRequest

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

Class UpdateDomainContactPrivacyResponse

The UpdateDomainContactPrivacy response includes the following element.

Class UpdateDomainContactRequest

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

Class UpdateDomainContactResponse

The UpdateDomainContact response includes the following element.

Class UpdateDomainNameserversRequest

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

Class UpdateDomainNameserversResponse

The UpdateDomainNameservers response includes the following element.

Class UpdateTagsForDomainRequest

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

Class UpdateTagsForDomainResponse

This is the response object from the UpdateTagsForDomain operation.

Class ViewBillingRequest

Container for the parameters to the ViewBilling operation. Returns all the domain-related billing records for the current AWS account for a specified period

Class ViewBillingResponse

The ViewBilling response includes the following elements.