RegisterDomain - Amazon Route 53

RegisterDomain

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.

    Note

    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 AWS account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing.

Request Syntax

{ "AdminContact": { "AddressLine1": "string", "AddressLine2": "string", "City": "string", "ContactType": "string", "CountryCode": "string", "Email": "string", "ExtraParams": [ { "Name": "string", "Value": "string" } ], "Fax": "string", "FirstName": "string", "LastName": "string", "OrganizationName": "string", "PhoneNumber": "string", "State": "string", "ZipCode": "string" }, "AutoRenew": boolean, "BillingContact": { "AddressLine1": "string", "AddressLine2": "string", "City": "string", "ContactType": "string", "CountryCode": "string", "Email": "string", "ExtraParams": [ { "Name": "string", "Value": "string" } ], "Fax": "string", "FirstName": "string", "LastName": "string", "OrganizationName": "string", "PhoneNumber": "string", "State": "string", "ZipCode": "string" }, "DomainName": "string", "DurationInYears": number, "IdnLangCode": "string", "PrivacyProtectAdminContact": boolean, "PrivacyProtectBillingContact": boolean, "PrivacyProtectRegistrantContact": boolean, "PrivacyProtectTechContact": boolean, "RegistrantContact": { "AddressLine1": "string", "AddressLine2": "string", "City": "string", "ContactType": "string", "CountryCode": "string", "Email": "string", "ExtraParams": [ { "Name": "string", "Value": "string" } ], "Fax": "string", "FirstName": "string", "LastName": "string", "OrganizationName": "string", "PhoneNumber": "string", "State": "string", "ZipCode": "string" }, "TechContact": { "AddressLine1": "string", "AddressLine2": "string", "City": "string", "ContactType": "string", "CountryCode": "string", "Email": "string", "ExtraParams": [ { "Name": "string", "Value": "string" } ], "Fax": "string", "FirstName": "string", "LastName": "string", "OrganizationName": "string", "PhoneNumber": "string", "State": "string", "ZipCode": "string" } }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AdminContact

Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.

Type: ContactDetail object

Required: Yes

AutoRenew

Indicates whether the domain will be automatically renewed (true) or not (false). Auto renewal only takes effect after the account is charged.

Default: true

Type: Boolean

Required: No

BillingContact

Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.

Type: ContactDetail object

Required: No

DomainName

The domain name that you want to register. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.

The domain name can contain only the following characters:

  • Letters a through z. Domain names are not case sensitive.

  • Numbers 0 through 9.

  • Hyphen (-). You can't specify a hyphen at the beginning or end of a label.

  • Period (.) to separate the labels in the name, such as the . in example.com.

Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports internationalized domain names, see Domains that You Can Register with Amazon Route 53. For more information, see Formatting Internationalized Domain Names.

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

DurationInYears

The number of years that you want to register the domain for. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain. For the range of valid values for your domain, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.

Default: 1

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 10.

Required: Yes

IdnLangCode

Reserved for future use.

Type: String

Length Constraints: Maximum length of 3.

Required: No

PrivacyProtectAdminContact

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries return contact information either for Amazon Registrar or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the admin contact.

Note

You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts.

Default: true

Type: Boolean

Required: No

PrivacyProtectBillingContact

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries return contact information either for Amazon Registrar or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the billing contact.

Note

You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts.

Type: Boolean

Required: No

PrivacyProtectRegistrantContact

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries return contact information either for Amazon Registrar or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the registrant contact (the domain owner).

Note

You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts.

Default: true

Type: Boolean

Required: No

PrivacyProtectTechContact

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries return contact information either for Amazon Registrar or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the technical contact.

Note

You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts.

Default: true

Type: Boolean

Required: No

RegistrantContact

Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.

Type: ContactDetail object

Required: Yes

TechContact

Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.

Type: ContactDetail object

Required: Yes

Response Syntax

{ "OperationId": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

OperationId

Identifier for tracking the progress of the request. To query the operation status, use GetOperationDetail.

Type: String

Length Constraints: Maximum length of 255.

Errors

For information about the errors that are common to all actions, see Common Errors.

DomainLimitExceeded

The number of domains has exceeded the allowed threshold for the account.

HTTP Status Code: 400

DuplicateRequest

The request is already in progress for the domain.

HTTP Status Code: 400

InvalidInput

The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

HTTP Status Code: 400

OperationLimitExceeded

The number of operations or jobs running exceeded the allowed threshold for the account.

HTTP Status Code: 400

TLDRulesViolation

The top-level domain does not support this operation.

HTTP Status Code: 400

UnsupportedTLD

Amazon Route 53 does not support this top-level domain (TLD).

HTTP Status Code: 400

Examples

RegisterDomain Example

This example illustrates one usage of RegisterDomain.

Sample Request

POST / HTTP/1.1 host:route53domains.us-east-1.amazonaws.com x-amz-date:20140711T205230Z authorization:AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target, Signature=[calculated-signature] x-amz-target:Route53Domains_v20140515.RegisterDomain user-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60 content-type:application/x-amz-json-1.1 content-length:[number of characters in the JSON string] { "DomainName":"example.com", "DurationInYears":1, "AutoRenew":true, "AdminContact":{ "FirstName":"John", "MiddleName":"Richard", "LastName":"Doe", "ContactType":"PERSON", "OrganizationName":"", "AddressLine1":"123 Any Street", "AddressLine2":"", "City":"Any Town", "State":"WA", "CountryCode":"US", "ZipCode":"98101", "PhoneNumber":"+2065550100", "Email":"john@example.com", "Fax":"+2065550101" }, "RegistrantContact":{ "FirstName":"John", "MiddleName":"Richard", "LastName":"Doe", "ContactType":"PERSON", "OrganizationName":"", "AddressLine1":"123 Any Street", "AddressLine2":"", "City":"Any Town", "State":"WA", "CountryCode":"US", "ZipCode":"98101", "PhoneNumber":"+2065550100", "Email":"john@example.com", "Fax":"+2065550101" }, "TechContact":{ "FirstName":"John", "MiddleName":"Richard", "LastName":"Doe", "ContactType":"PERSON", "OrganizationName":"", "AddressLine1":"123 Any Street", "AddressLine2":"", "City":"Any Town", "State":"WA", "CountryCode":"US", "ZipCode":"98101", "PhoneNumber":"+2065550100", "Email":"john@example.com", "Fax":"+2065550101" }, "PrivacyProtectAdminContact":true, "PrivacyProtectRegistrantContact":true, "PrivacyProtectTechContact":true }

Sample Response

HTTP/1.1 200 Content-Length:[number of characters in the JSON string] { "OperationId":"308c56712-faa4-40fe-94c8-b423069de3f6" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: