Route53DomainsClient

Amazon Route 53 API actions let you register domain names and perform related operations.

Installation

NPM
npm install @aws-sdk/client-route-53-domains
Yarn
yarn add @aws-sdk/client-route-53-domains
pnpm
pnpm add @aws-sdk/client-route-53-domains

Route53DomainsClient Operations

Command
Summary
AcceptDomainTransferFromAnotherAwsAccountCommand

Accepts the transfer of a domain from another Amazon Web Services account to the currentAmazon Web Services account. You initiate a transfer between Amazon Web Services accounts using TransferDomainToAnotherAwsAccount .

If you use the CLI command at accept-domain-transfer-from-another-aws-account , use JSON format as input instead of text because otherwise CLI will throw an error from domain transfer input that includes single quotes.

Use either ListOperations  or GetOperationDetail  to determine whether the operation succeeded. GetOperationDetail  provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled.

AssociateDelegationSignerToDomainCommand

Creates a delegation signer (DS) record in the registry zone for this domain name.

Note that creating DS record at the registry impacts DNSSEC validation of your DNS records. This action may render your domain name unavailable on the internet if the steps are completed in the wrong order, or with incorrect timing. For more information about DNSSEC signing, see Configuring DNSSEC signing  in the Route 53 developer guide.

CancelDomainTransferToAnotherAwsAccountCommand

Cancels the transfer of a domain from the current Amazon Web Services account to another Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using TransferDomainToAnotherAwsAccount .

You must cancel the transfer before the other Amazon Web Services account accepts the transfer using AcceptDomainTransferFromAnotherAwsAccount .

Use either ListOperations  or GetOperationDetail  to determine whether the operation succeeded. GetOperationDetail  provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled.

CheckDomainAvailabilityCommand

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.

CheckDomainTransferabilityCommand

Checks whether a domain name can be transferred to Amazon Route 53.

DeleteDomainCommand

This operation deletes the specified domain. This action is permanent. For more information, see Deleting a domain name registration .

To transfer the domain registration to another registrar, use the transfer process that’s provided by the registrar to which you want to transfer the registration. Otherwise, the following apply:

  1. You can’t get a refund for the cost of a deleted domain registration.

  2. The registry for the top-level domain might hold the domain name for a brief time before releasing it for other users to register (varies by registry).

  3. When the registration has been deleted, we'll send you a confirmation to the registrant contact. The email will come from noreplydomainnameverification.net or noreplyregistrar.amazon.com.

DeleteTagsForDomainCommand

This operation deletes the specified tags for a domain.

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

DisableDomainAutoRenewCommand

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

DisableDomainTransferLockCommand

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.

DisassociateDelegationSignerFromDomainCommand

Deletes a delegation signer (DS) record in the registry zone for this domain name.

EnableDomainAutoRenewCommand

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 Amazon Web Services account.

The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see Domains That You Can Register with Amazon Route 53  in the Amazon Route 53 Developer Guide. Route 53 requires that you renew before the end of the renewal period so we can complete processing before the deadline.

EnableDomainTransferLockCommand

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.

GetContactReachabilityStatusCommand

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.

GetDomainDetailCommand

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

GetDomainSuggestionsCommand

The GetDomainSuggestions operation returns a list of suggested domain names.

GetOperationDetailCommand

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

ListDomainsCommand

This operation returns all the domain names registered with Amazon Route 53 for the current Amazon Web Services account if no filtering conditions are used.

ListOperationsCommand

Returns information about all of the operations that return an operation ID and that have ever been performed on domains that were registered by the current account.

This command runs only in the us-east-1 Region.

ListPricesCommand

Lists the following prices for either all the TLDs supported by Route 53, or the specified TLD:

  • Registration

  • Transfer

  • Owner change

  • Domain renewal

  • Domain restoration

ListTagsForDomainCommand

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

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

PushDomainCommand

Moves a domain from Amazon Web Services to another registrar.

Supported actions:

  • Changes the IPS tags of a .uk domain, and pushes it to transit. Transit means that the domain is ready to be transferred to another registrar.

RegisterDomainCommand

This operation registers a domain. For some top-level domains (TLDs), this operation requires extra parameters.

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

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

  • Enables auto renew, 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 for the registrar or the phrase "REDACTED FOR PRIVACY", or "On behalf of domain name owner." If you don't enable privacy protection, WHOIS queries return the information that you entered for the administrative, registrant, and technical contacts.

    While some domains may allow different privacy settings per contact, we recommend specifying the same privacy setting for all 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 Amazon Web Services account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing .

RejectDomainTransferFromAnotherAwsAccountCommand

Rejects the transfer of a domain from another Amazon Web Services account to the current Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using TransferDomainToAnotherAwsAccount .

Use either ListOperations  or GetOperationDetail  to determine whether the operation succeeded. GetOperationDetail  provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled.

RenewDomainCommand

This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your Amazon Web Services 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.

ResendContactReachabilityEmailCommand

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.

ResendOperationAuthorizationCommand

Resend the form of authorization email for this operation.

RetrieveDomainAuthCodeCommand

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

TransferDomainCommand

Transfers a domain from another registrar to Amazon Route 53.

For more information about transferring domains, see the following topics:

During the transfer of any country code top-level domains (ccTLDs) to Route 53, except for .cc and .tv, updates to the owner contact are ignored and the owner contact data from the registry is used. You can update the owner contact after the transfer is complete. For more information, see UpdateDomainContact .

If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you transfer your DNS service to 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.

TransferDomainToAnotherAwsAccountCommand

Transfers a domain from the current Amazon Web Services account to another Amazon Web Services account. Note the following:

When you transfer a domain from one Amazon Web Services account to another, Route 53 doesn't transfer the hosted zone that is associated with the domain. DNS resolution isn't affected if the domain and the hosted zone are owned by separate accounts, so transferring the hosted zone is optional. For information about transferring the hosted zone to another Amazon Web Services account, see Migrating a Hosted Zone to a Different Amazon Web Services Account  in the Amazon Route 53 Developer Guide.

Use either ListOperations  or GetOperationDetail  to determine whether the operation succeeded. GetOperationDetail  provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled.

UpdateDomainContactCommand

This operation updates the contact information for a particular domain. You must specify information for at least one contact: registrant, administrator, or technical.

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

UpdateDomainContactPrivacyCommand

This operation updates the specified domain contact's privacy setting. When privacy protection is enabled, your contact information is replaced with contact information for the registrar or with the phrase "REDACTED FOR PRIVACY", or "On behalf of domain name owner."

While some domains may allow different privacy settings per contact, we recommend specifying the same privacy setting for all contacts.

This operation affects only the contact information for the specified contact type (administrative, registrant, or technical). If the request succeeds, Amazon Route 53 returns an operation ID that you can use with GetOperationDetail  to track the progress and completion of the action. If the request doesn't complete successfully, the domain registrant will be notified by email.

By disabling the privacy service via API, you consent to the publication of the contact information provided for this domain via the public WHOIS database. You certify that you are the registrant of this domain name and have the authority to make this decision. You may withdraw your consent at any time by enabling privacy protection using either UpdateDomainContactPrivacy or the Route 53 console. Enabling privacy protection removes the contact information provided for this domain from the WHOIS database. For more information on our privacy practices, see https://aws.amazon.com/privacy/ .

UpdateDomainNameserversCommand

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.

UpdateTagsForDomainCommand

This operation adds or updates tags for a specified domain.

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

ViewBillingCommand

Returns all the domain-related billing records for the current Amazon Web Services account for a specified period

Route53DomainsClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: Route53DomainsClientConfig