Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . route53domains ]

register-domain

Description

This operation registers a domain. Domains are registered either by Amazon Registrar (for .com, .net, and .org domains) or by our registrar associate, Gandi (for all other domains). 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 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 either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you don't enable privacy protection, WHOIS queries return the information that you entered for the 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 .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  register-domain
--domain-name <value>
[--idn-lang-code <value>]
--duration-in-years <value>
[--auto-renew | --no-auto-renew]
--admin-contact <value>
--registrant-contact <value>
--tech-contact <value>
[--privacy-protect-admin-contact | --no-privacy-protect-admin-contact]
[--privacy-protect-registrant-contact | --no-privacy-protect-registrant-contact]
[--privacy-protect-tech-contact | --no-privacy-protect-tech-contact]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--domain-name (string)

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 .

--idn-lang-code (string)

Reserved for future use.

--duration-in-years (integer)

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

--auto-renew | --no-auto-renew (boolean)

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

Default: true

--admin-contact (structure)

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

FirstName -> (string)

First name of contact.

LastName -> (string)

Last name of contact.

ContactType -> (string)

Indicates whether the contact is a person, company, association, or public organization. Note the following:

  • If you specify a value other than PERSON , you must also specify a value for OrganizationName .
  • For some TLDs, the privacy protection available depends on the value that you specify for Contact Type . For the privacy protection settings for your TLD, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide
  • For .es domains, if you specify PERSON , you must specify INDIVIDUAL for the value of ES_LEGAL_FORM .

OrganizationName -> (string)

Name of the organization for contact types other than PERSON .

AddressLine1 -> (string)

First line of the contact's address.

AddressLine2 -> (string)

Second line of contact's address, if any.

City -> (string)

The city of the contact's address.

State -> (string)

The state or province of the contact's city.

CountryCode -> (string)

Code for the country of the contact's address.

ZipCode -> (string)

The zip or postal code of the contact's address.

PhoneNumber -> (string)

The phone number of the contact.

Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as "+1.1234567890" .

Email -> (string)

Email address of the contact.

Fax -> (string)

Fax number of the contact.

Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as "+1.1234567890" .

ExtraParams -> (list)

A list of name-value pairs for parameters required by certain top-level domains.

(structure)

ExtraParam includes the following elements.

Name -> (string)

The name of an additional parameter that is required by a top-level domain. Here are the top-level domains that require additional parameters and the names of the parameters that they require:

.com.au and .net.au
  • AU_ID_NUMBER

  • AU_ID_TYPE Valid values include the following:

    • ABN (Australian business number)
    • ACN (Australian company number)
    • TM (Trademark number)

    .ca

  • BRAND_NUMBER

  • CA_BUSINESS_ENTITY_TYPE Valid values include the following:

    • BANK (Bank)
    • COMMERCIAL_COMPANY (Commercial company)
    • COMPANY (Company)
    • COOPERATION (Cooperation)
    • COOPERATIVE (Cooperative)
    • COOPRIX (Cooprix)
    • CORP (Corporation)
    • CREDIT_UNION (Credit union)
    • FOMIA (Federation of mutual insurance associations)
    • INC (Incorporated)
    • LTD (Limited)
    • LTEE (Limitée)
    • LLC (Limited liability corporation)
    • LLP (Limited liability partnership)
    • LTE (Lte.)
    • MBA (Mutual benefit association)
    • MIC (Mutual insurance company)
    • NFP (Not-for-profit corporation)
    • SA (S.A.)
    • SAVINGS_COMPANY (Savings company)
    • SAVINGS_UNION (Savings union)
    • SARL (Société à responsabilité limitée)
    • TRUST (Trust)
    • ULC (Unlimited liability corporation)
  • CA_LEGAL_TYPE When ContactType is PERSON , valid values include the following:

    • ABO (Aboriginal Peoples indigenous to Canada)
    • CCT (Canadian citizen)
    • LGR (Legal Representative of a Canadian Citizen or Permanent Resident)
    • RES (Permanent resident of Canada)

When ContactType is a value other than PERSON , valid values include the following:

  • ASS (Canadian unincorporated association)
  • CCO (Canadian corporation)
  • EDU (Canadian educational institution)
  • GOV (Government or government entity in Canada)
  • HOP (Canadian Hospital)
  • INB (Indian Band recognized by the Indian Act of Canada)
  • LAM (Canadian Library, Archive, or Museum)
  • MAJ (Her/His Majesty the Queen/King)
  • OMK (Official mark registered in Canada)
  • PLT (Canadian Political Party)
  • PRT (Partnership Registered in Canada)
  • TDM (Trademark registered in Canada)
  • TRD (Canadian Trade Union)
  • TRS (Trust established in Canada)

.es

  • ES_IDENTIFICATION Specify the applicable value:

    • For contacts inside Spain: Enter your passport ID.
    • For contacts outside of Spain: Enter the VAT identification number for the company.

    Note

    For .es domains, the value of ContactType must be PERSON .

  • ES_IDENTIFICATION_TYPE Valid values include the following:

    • DNI_AND_NIF (For Spanish contacts)
    • NIE (For foreigners with legal residence)
    • OTHER (For contacts outside of Spain)
  • ES_LEGAL_FORM Valid values include the following:

    • ASSOCIATION
    • CENTRAL_GOVERNMENT_BODY
    • CIVIL_SOCIETY
    • COMMUNITY_OF_OWNERS
    • COMMUNITY_PROPERTY
    • CONSULATE
    • COOPERATIVE
    • DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL
    • ECONOMIC_INTEREST_GROUP
    • EMBASSY
    • ENTITY_MANAGING_NATURAL_AREAS
    • FARM_PARTNERSHIP
    • FOUNDATION
    • GENERAL_AND_LIMITED_PARTNERSHIP
    • GENERAL_PARTNERSHIP
    • INDIVIDUAL
    • LIMITED_COMPANY
    • LOCAL_AUTHORITY
    • LOCAL_PUBLIC_ENTITY
    • MUTUAL_INSURANCE_COMPANY
    • NATIONAL_PUBLIC_ENTITY
    • ORDER_OR_RELIGIOUS_INSTITUTION
    • OTHERS (Only for contacts outside of Spain)
    • POLITICAL_PARTY
    • PROFESSIONAL_ASSOCIATION
    • PUBLIC_LAW_ASSOCIATION
    • PUBLIC_LIMITED_COMPANY
    • REGIONAL_GOVERNMENT_BODY
    • REGIONAL_PUBLIC_ENTITY
    • SAVINGS_BANK
    • SPANISH_OFFICE
    • SPORTS_ASSOCIATION
    • SPORTS_FEDERATION
    • SPORTS_LIMITED_COMPANY
    • TEMPORARY_ALLIANCE_OF_ENTERPRISES
    • TRADE_UNION
    • WORKER_OWNED_COMPANY
    • WORKER_OWNED_LIMITED_COMPANY

    .fi

  • BIRTH_DATE_IN_YYYY_MM_DD

  • FI_BUSINESS_NUMBER

  • FI_ID_NUMBER

  • FI_NATIONALITY Valid values include the following:

    • FINNISH
    • NOT_FINNISH
  • FI_ORGANIZATION_TYPE Valid values include the following:

    • COMPANY
    • CORPORATION
    • GOVERNMENT
    • INSTITUTION
    • POLITICAL_PARTY
    • PUBLIC_COMMUNITY
    • TOWNSHIP

    .fr

  • BIRTH_CITY

  • BIRTH_COUNTRY

  • BIRTH_DATE_IN_YYYY_MM_DD

  • BIRTH_DEPARTMENT : Specify the INSEE code that corresponds with the department where the contact was born. If the contact was born somewhere other than France or its overseas departments, specify 99 . For more information, including a list of departments and the corresponding INSEE numbers, see the Wikipedia entry Departments of France .

  • BRAND_NUMBER

    .it

  • IT_NATIONALITY

  • IT_PIN

  • IT_REGISTRANT_ENTITY_TYPE Valid values include the following:

    • FOREIGNERS
    • FREELANCE_WORKERS (Freelance workers and professionals)
    • ITALIAN_COMPANIES (Italian companies and one-person companies)
    • NON_PROFIT_ORGANIZATIONS
    • OTHER_SUBJECTS
    • PUBLIC_ORGANIZATIONS

    .ru

  • BIRTH_DATE_IN_YYYY_MM_DD

  • RU_PASSPORT_DATA

    .se

  • BIRTH_COUNTRY

  • SE_ID_NUMBER

    .sg

  • SG_ID_NUMBER

    .co.uk, .me.uk, and .org.uk

  • UK_CONTACT_TYPE Valid values include the following:

    • CRC (UK Corporation by Royal Charter)
    • FCORP (Non-UK Corporation)
    • FIND (Non-UK Individual, representing self)
    • FOTHER (Non-UK Entity that does not fit into any other category)
    • GOV (UK Government Body)
    • IND (UK Individual (representing self))
    • IP (UK Industrial/Provident Registered Company)
    • LLP (UK Limited Liability Partnership)
    • LTD (UK Limited Company)
    • OTHER (UK Entity that does not fit into any other category)
    • PLC (UK Public Limited Company)
    • PTNR (UK Partnership)
    • RCHAR (UK Registered Charity)
    • SCH (UK School)
    • STAT (UK Statutory Body)
    • STRA (UK Sole Trader)
  • UK_COMPANY_NUMBER

In addition, many TLDs require a VAT_NUMBER .

Value -> (string)

The value that corresponds with the name of an extra parameter.

Shorthand Syntax:

FirstName=string,LastName=string,ContactType=string,OrganizationName=string,AddressLine1=string,AddressLine2=string,City=string,State=string,CountryCode=string,ZipCode=string,PhoneNumber=string,Email=string,Fax=string,ExtraParams=[{Name=string,Value=string},{Name=string,Value=string}]

JSON Syntax:

{
  "FirstName": "string",
  "LastName": "string",
  "ContactType": "PERSON"|"COMPANY"|"ASSOCIATION"|"PUBLIC_BODY"|"RESELLER",
  "OrganizationName": "string",
  "AddressLine1": "string",
  "AddressLine2": "string",
  "City": "string",
  "State": "string",
  "CountryCode": "AD"|"AE"|"AF"|"AG"|"AI"|"AL"|"AM"|"AN"|"AO"|"AQ"|"AR"|"AS"|"AT"|"AU"|"AW"|"AZ"|"BA"|"BB"|"BD"|"BE"|"BF"|"BG"|"BH"|"BI"|"BJ"|"BL"|"BM"|"BN"|"BO"|"BR"|"BS"|"BT"|"BW"|"BY"|"BZ"|"CA"|"CC"|"CD"|"CF"|"CG"|"CH"|"CI"|"CK"|"CL"|"CM"|"CN"|"CO"|"CR"|"CU"|"CV"|"CX"|"CY"|"CZ"|"DE"|"DJ"|"DK"|"DM"|"DO"|"DZ"|"EC"|"EE"|"EG"|"ER"|"ES"|"ET"|"FI"|"FJ"|"FK"|"FM"|"FO"|"FR"|"GA"|"GB"|"GD"|"GE"|"GH"|"GI"|"GL"|"GM"|"GN"|"GQ"|"GR"|"GT"|"GU"|"GW"|"GY"|"HK"|"HN"|"HR"|"HT"|"HU"|"ID"|"IE"|"IL"|"IM"|"IN"|"IQ"|"IR"|"IS"|"IT"|"JM"|"JO"|"JP"|"KE"|"KG"|"KH"|"KI"|"KM"|"KN"|"KP"|"KR"|"KW"|"KY"|"KZ"|"LA"|"LB"|"LC"|"LI"|"LK"|"LR"|"LS"|"LT"|"LU"|"LV"|"LY"|"MA"|"MC"|"MD"|"ME"|"MF"|"MG"|"MH"|"MK"|"ML"|"MM"|"MN"|"MO"|"MP"|"MR"|"MS"|"MT"|"MU"|"MV"|"MW"|"MX"|"MY"|"MZ"|"NA"|"NC"|"NE"|"NG"|"NI"|"NL"|"NO"|"NP"|"NR"|"NU"|"NZ"|"OM"|"PA"|"PE"|"PF"|"PG"|"PH"|"PK"|"PL"|"PM"|"PN"|"PR"|"PT"|"PW"|"PY"|"QA"|"RO"|"RS"|"RU"|"RW"|"SA"|"SB"|"SC"|"SD"|"SE"|"SG"|"SH"|"SI"|"SK"|"SL"|"SM"|"SN"|"SO"|"SR"|"ST"|"SV"|"SY"|"SZ"|"TC"|"TD"|"TG"|"TH"|"TJ"|"TK"|"TL"|"TM"|"TN"|"TO"|"TR"|"TT"|"TV"|"TW"|"TZ"|"UA"|"UG"|"US"|"UY"|"UZ"|"VA"|"VC"|"VE"|"VG"|"VI"|"VN"|"VU"|"WF"|"WS"|"YE"|"YT"|"ZA"|"ZM"|"ZW",
  "ZipCode": "string",
  "PhoneNumber": "string",
  "Email": "string",
  "Fax": "string",
  "ExtraParams": [
    {
      "Name": "DUNS_NUMBER"|"BRAND_NUMBER"|"BIRTH_DEPARTMENT"|"BIRTH_DATE_IN_YYYY_MM_DD"|"BIRTH_COUNTRY"|"BIRTH_CITY"|"DOCUMENT_NUMBER"|"AU_ID_NUMBER"|"AU_ID_TYPE"|"CA_LEGAL_TYPE"|"CA_BUSINESS_ENTITY_TYPE"|"CA_LEGAL_REPRESENTATIVE"|"CA_LEGAL_REPRESENTATIVE_CAPACITY"|"ES_IDENTIFICATION"|"ES_IDENTIFICATION_TYPE"|"ES_LEGAL_FORM"|"FI_BUSINESS_NUMBER"|"FI_ID_NUMBER"|"FI_NATIONALITY"|"FI_ORGANIZATION_TYPE"|"IT_NATIONALITY"|"IT_PIN"|"IT_REGISTRANT_ENTITY_TYPE"|"RU_PASSPORT_DATA"|"SE_ID_NUMBER"|"SG_ID_NUMBER"|"VAT_NUMBER"|"UK_CONTACT_TYPE"|"UK_COMPANY_NUMBER",
      "Value": "string"
    }
    ...
  ]
}

--registrant-contact (structure)

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

FirstName -> (string)

First name of contact.

LastName -> (string)

Last name of contact.

ContactType -> (string)

Indicates whether the contact is a person, company, association, or public organization. Note the following:

  • If you specify a value other than PERSON , you must also specify a value for OrganizationName .
  • For some TLDs, the privacy protection available depends on the value that you specify for Contact Type . For the privacy protection settings for your TLD, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide
  • For .es domains, if you specify PERSON , you must specify INDIVIDUAL for the value of ES_LEGAL_FORM .

OrganizationName -> (string)

Name of the organization for contact types other than PERSON .

AddressLine1 -> (string)

First line of the contact's address.

AddressLine2 -> (string)

Second line of contact's address, if any.

City -> (string)

The city of the contact's address.

State -> (string)

The state or province of the contact's city.

CountryCode -> (string)

Code for the country of the contact's address.

ZipCode -> (string)

The zip or postal code of the contact's address.

PhoneNumber -> (string)

The phone number of the contact.

Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as "+1.1234567890" .

Email -> (string)

Email address of the contact.

Fax -> (string)

Fax number of the contact.

Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as "+1.1234567890" .

ExtraParams -> (list)

A list of name-value pairs for parameters required by certain top-level domains.

(structure)

ExtraParam includes the following elements.

Name -> (string)

The name of an additional parameter that is required by a top-level domain. Here are the top-level domains that require additional parameters and the names of the parameters that they require:

.com.au and .net.au
  • AU_ID_NUMBER

  • AU_ID_TYPE Valid values include the following:

    • ABN (Australian business number)
    • ACN (Australian company number)
    • TM (Trademark number)

    .ca

  • BRAND_NUMBER

  • CA_BUSINESS_ENTITY_TYPE Valid values include the following:

    • BANK (Bank)
    • COMMERCIAL_COMPANY (Commercial company)
    • COMPANY (Company)
    • COOPERATION (Cooperation)
    • COOPERATIVE (Cooperative)
    • COOPRIX (Cooprix)
    • CORP (Corporation)
    • CREDIT_UNION (Credit union)
    • FOMIA (Federation of mutual insurance associations)
    • INC (Incorporated)
    • LTD (Limited)
    • LTEE (Limitée)
    • LLC (Limited liability corporation)
    • LLP (Limited liability partnership)
    • LTE (Lte.)
    • MBA (Mutual benefit association)
    • MIC (Mutual insurance company)
    • NFP (Not-for-profit corporation)
    • SA (S.A.)
    • SAVINGS_COMPANY (Savings company)
    • SAVINGS_UNION (Savings union)
    • SARL (Société à responsabilité limitée)
    • TRUST (Trust)
    • ULC (Unlimited liability corporation)
  • CA_LEGAL_TYPE When ContactType is PERSON , valid values include the following:

    • ABO (Aboriginal Peoples indigenous to Canada)
    • CCT (Canadian citizen)
    • LGR (Legal Representative of a Canadian Citizen or Permanent Resident)
    • RES (Permanent resident of Canada)

When ContactType is a value other than PERSON , valid values include the following:

  • ASS (Canadian unincorporated association)
  • CCO (Canadian corporation)
  • EDU (Canadian educational institution)
  • GOV (Government or government entity in Canada)
  • HOP (Canadian Hospital)
  • INB (Indian Band recognized by the Indian Act of Canada)
  • LAM (Canadian Library, Archive, or Museum)
  • MAJ (Her/His Majesty the Queen/King)
  • OMK (Official mark registered in Canada)
  • PLT (Canadian Political Party)
  • PRT (Partnership Registered in Canada)
  • TDM (Trademark registered in Canada)
  • TRD (Canadian Trade Union)
  • TRS (Trust established in Canada)

.es

  • ES_IDENTIFICATION Specify the applicable value:

    • For contacts inside Spain: Enter your passport ID.
    • For contacts outside of Spain: Enter the VAT identification number for the company.

    Note

    For .es domains, the value of ContactType must be PERSON .

  • ES_IDENTIFICATION_TYPE Valid values include the following:

    • DNI_AND_NIF (For Spanish contacts)
    • NIE (For foreigners with legal residence)
    • OTHER (For contacts outside of Spain)
  • ES_LEGAL_FORM Valid values include the following:

    • ASSOCIATION
    • CENTRAL_GOVERNMENT_BODY
    • CIVIL_SOCIETY
    • COMMUNITY_OF_OWNERS
    • COMMUNITY_PROPERTY
    • CONSULATE
    • COOPERATIVE
    • DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL
    • ECONOMIC_INTEREST_GROUP
    • EMBASSY
    • ENTITY_MANAGING_NATURAL_AREAS
    • FARM_PARTNERSHIP
    • FOUNDATION
    • GENERAL_AND_LIMITED_PARTNERSHIP
    • GENERAL_PARTNERSHIP
    • INDIVIDUAL
    • LIMITED_COMPANY
    • LOCAL_AUTHORITY
    • LOCAL_PUBLIC_ENTITY
    • MUTUAL_INSURANCE_COMPANY
    • NATIONAL_PUBLIC_ENTITY
    • ORDER_OR_RELIGIOUS_INSTITUTION
    • OTHERS (Only for contacts outside of Spain)
    • POLITICAL_PARTY
    • PROFESSIONAL_ASSOCIATION
    • PUBLIC_LAW_ASSOCIATION
    • PUBLIC_LIMITED_COMPANY
    • REGIONAL_GOVERNMENT_BODY
    • REGIONAL_PUBLIC_ENTITY
    • SAVINGS_BANK
    • SPANISH_OFFICE
    • SPORTS_ASSOCIATION
    • SPORTS_FEDERATION
    • SPORTS_LIMITED_COMPANY
    • TEMPORARY_ALLIANCE_OF_ENTERPRISES
    • TRADE_UNION
    • WORKER_OWNED_COMPANY
    • WORKER_OWNED_LIMITED_COMPANY

    .fi

  • BIRTH_DATE_IN_YYYY_MM_DD

  • FI_BUSINESS_NUMBER

  • FI_ID_NUMBER

  • FI_NATIONALITY Valid values include the following:

    • FINNISH
    • NOT_FINNISH
  • FI_ORGANIZATION_TYPE Valid values include the following:

    • COMPANY
    • CORPORATION
    • GOVERNMENT
    • INSTITUTION
    • POLITICAL_PARTY
    • PUBLIC_COMMUNITY
    • TOWNSHIP

    .fr

  • BIRTH_CITY

  • BIRTH_COUNTRY

  • BIRTH_DATE_IN_YYYY_MM_DD

  • BIRTH_DEPARTMENT : Specify the INSEE code that corresponds with the department where the contact was born. If the contact was born somewhere other than France or its overseas departments, specify 99 . For more information, including a list of departments and the corresponding INSEE numbers, see the Wikipedia entry Departments of France .

  • BRAND_NUMBER

    .it

  • IT_NATIONALITY

  • IT_PIN

  • IT_REGISTRANT_ENTITY_TYPE Valid values include the following:

    • FOREIGNERS
    • FREELANCE_WORKERS (Freelance workers and professionals)
    • ITALIAN_COMPANIES (Italian companies and one-person companies)
    • NON_PROFIT_ORGANIZATIONS
    • OTHER_SUBJECTS
    • PUBLIC_ORGANIZATIONS

    .ru

  • BIRTH_DATE_IN_YYYY_MM_DD

  • RU_PASSPORT_DATA

    .se

  • BIRTH_COUNTRY

  • SE_ID_NUMBER

    .sg

  • SG_ID_NUMBER

    .co.uk, .me.uk, and .org.uk

  • UK_CONTACT_TYPE Valid values include the following:

    • CRC (UK Corporation by Royal Charter)
    • FCORP (Non-UK Corporation)
    • FIND (Non-UK Individual, representing self)
    • FOTHER (Non-UK Entity that does not fit into any other category)
    • GOV (UK Government Body)
    • IND (UK Individual (representing self))
    • IP (UK Industrial/Provident Registered Company)
    • LLP (UK Limited Liability Partnership)
    • LTD (UK Limited Company)
    • OTHER (UK Entity that does not fit into any other category)
    • PLC (UK Public Limited Company)
    • PTNR (UK Partnership)
    • RCHAR (UK Registered Charity)
    • SCH (UK School)
    • STAT (UK Statutory Body)
    • STRA (UK Sole Trader)
  • UK_COMPANY_NUMBER

In addition, many TLDs require a VAT_NUMBER .

Value -> (string)

The value that corresponds with the name of an extra parameter.

Shorthand Syntax:

FirstName=string,LastName=string,ContactType=string,OrganizationName=string,AddressLine1=string,AddressLine2=string,City=string,State=string,CountryCode=string,ZipCode=string,PhoneNumber=string,Email=string,Fax=string,ExtraParams=[{Name=string,Value=string},{Name=string,Value=string}]

JSON Syntax:

{
  "FirstName": "string",
  "LastName": "string",
  "ContactType": "PERSON"|"COMPANY"|"ASSOCIATION"|"PUBLIC_BODY"|"RESELLER",
  "OrganizationName": "string",
  "AddressLine1": "string",
  "AddressLine2": "string",
  "City": "string",
  "State": "string",
  "CountryCode": "AD"|"AE"|"AF"|"AG"|"AI"|"AL"|"AM"|"AN"|"AO"|"AQ"|"AR"|"AS"|"AT"|"AU"|"AW"|"AZ"|"BA"|"BB"|"BD"|"BE"|"BF"|"BG"|"BH"|"BI"|"BJ"|"BL"|"BM"|"BN"|"BO"|"BR"|"BS"|"BT"|"BW"|"BY"|"BZ"|"CA"|"CC"|"CD"|"CF"|"CG"|"CH"|"CI"|"CK"|"CL"|"CM"|"CN"|"CO"|"CR"|"CU"|"CV"|"CX"|"CY"|"CZ"|"DE"|"DJ"|"DK"|"DM"|"DO"|"DZ"|"EC"|"EE"|"EG"|"ER"|"ES"|"ET"|"FI"|"FJ"|"FK"|"FM"|"FO"|"FR"|"GA"|"GB"|"GD"|"GE"|"GH"|"GI"|"GL"|"GM"|"GN"|"GQ"|"GR"|"GT"|"GU"|"GW"|"GY"|"HK"|"HN"|"HR"|"HT"|"HU"|"ID"|"IE"|"IL"|"IM"|"IN"|"IQ"|"IR"|"IS"|"IT"|"JM"|"JO"|"JP"|"KE"|"KG"|"KH"|"KI"|"KM"|"KN"|"KP"|"KR"|"KW"|"KY"|"KZ"|"LA"|"LB"|"LC"|"LI"|"LK"|"LR"|"LS"|"LT"|"LU"|"LV"|"LY"|"MA"|"MC"|"MD"|"ME"|"MF"|"MG"|"MH"|"MK"|"ML"|"MM"|"MN"|"MO"|"MP"|"MR"|"MS"|"MT"|"MU"|"MV"|"MW"|"MX"|"MY"|"MZ"|"NA"|"NC"|"NE"|"NG"|"NI"|"NL"|"NO"|"NP"|"NR"|"NU"|"NZ"|"OM"|"PA"|"PE"|"PF"|"PG"|"PH"|"PK"|"PL"|"PM"|"PN"|"PR"|"PT"|"PW"|"PY"|"QA"|"RO"|"RS"|"RU"|"RW"|"SA"|"SB"|"SC"|"SD"|"SE"|"SG"|"SH"|"SI"|"SK"|"SL"|"SM"|"SN"|"SO"|"SR"|"ST"|"SV"|"SY"|"SZ"|"TC"|"TD"|"TG"|"TH"|"TJ"|"TK"|"TL"|"TM"|"TN"|"TO"|"TR"|"TT"|"TV"|"TW"|"TZ"|"UA"|"UG"|"US"|"UY"|"UZ"|"VA"|"VC"|"VE"|"VG"|"VI"|"VN"|"VU"|"WF"|"WS"|"YE"|"YT"|"ZA"|"ZM"|"ZW",
  "ZipCode": "string",
  "PhoneNumber": "string",
  "Email": "string",
  "Fax": "string",
  "ExtraParams": [
    {
      "Name": "DUNS_NUMBER"|"BRAND_NUMBER"|"BIRTH_DEPARTMENT"|"BIRTH_DATE_IN_YYYY_MM_DD"|"BIRTH_COUNTRY"|"BIRTH_CITY"|"DOCUMENT_NUMBER"|"AU_ID_NUMBER"|"AU_ID_TYPE"|"CA_LEGAL_TYPE"|"CA_BUSINESS_ENTITY_TYPE"|"CA_LEGAL_REPRESENTATIVE"|"CA_LEGAL_REPRESENTATIVE_CAPACITY"|"ES_IDENTIFICATION"|"ES_IDENTIFICATION_TYPE"|"ES_LEGAL_FORM"|"FI_BUSINESS_NUMBER"|"FI_ID_NUMBER"|"FI_NATIONALITY"|"FI_ORGANIZATION_TYPE"|"IT_NATIONALITY"|"IT_PIN"|"IT_REGISTRANT_ENTITY_TYPE"|"RU_PASSPORT_DATA"|"SE_ID_NUMBER"|"SG_ID_NUMBER"|"VAT_NUMBER"|"UK_CONTACT_TYPE"|"UK_COMPANY_NUMBER",
      "Value": "string"
    }
    ...
  ]
}

--tech-contact (structure)

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

FirstName -> (string)

First name of contact.

LastName -> (string)

Last name of contact.

ContactType -> (string)

Indicates whether the contact is a person, company, association, or public organization. Note the following:

  • If you specify a value other than PERSON , you must also specify a value for OrganizationName .
  • For some TLDs, the privacy protection available depends on the value that you specify for Contact Type . For the privacy protection settings for your TLD, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide
  • For .es domains, if you specify PERSON , you must specify INDIVIDUAL for the value of ES_LEGAL_FORM .

OrganizationName -> (string)

Name of the organization for contact types other than PERSON .

AddressLine1 -> (string)

First line of the contact's address.

AddressLine2 -> (string)

Second line of contact's address, if any.

City -> (string)

The city of the contact's address.

State -> (string)

The state or province of the contact's city.

CountryCode -> (string)

Code for the country of the contact's address.

ZipCode -> (string)

The zip or postal code of the contact's address.

PhoneNumber -> (string)

The phone number of the contact.

Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as "+1.1234567890" .

Email -> (string)

Email address of the contact.

Fax -> (string)

Fax number of the contact.

Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as "+1.1234567890" .

ExtraParams -> (list)

A list of name-value pairs for parameters required by certain top-level domains.

(structure)

ExtraParam includes the following elements.

Name -> (string)

The name of an additional parameter that is required by a top-level domain. Here are the top-level domains that require additional parameters and the names of the parameters that they require:

.com.au and .net.au
  • AU_ID_NUMBER

  • AU_ID_TYPE Valid values include the following:

    • ABN (Australian business number)
    • ACN (Australian company number)
    • TM (Trademark number)

    .ca

  • BRAND_NUMBER

  • CA_BUSINESS_ENTITY_TYPE Valid values include the following:

    • BANK (Bank)
    • COMMERCIAL_COMPANY (Commercial company)
    • COMPANY (Company)
    • COOPERATION (Cooperation)
    • COOPERATIVE (Cooperative)
    • COOPRIX (Cooprix)
    • CORP (Corporation)
    • CREDIT_UNION (Credit union)
    • FOMIA (Federation of mutual insurance associations)
    • INC (Incorporated)
    • LTD (Limited)
    • LTEE (Limitée)
    • LLC (Limited liability corporation)
    • LLP (Limited liability partnership)
    • LTE (Lte.)
    • MBA (Mutual benefit association)
    • MIC (Mutual insurance company)
    • NFP (Not-for-profit corporation)
    • SA (S.A.)
    • SAVINGS_COMPANY (Savings company)
    • SAVINGS_UNION (Savings union)
    • SARL (Société à responsabilité limitée)
    • TRUST (Trust)
    • ULC (Unlimited liability corporation)
  • CA_LEGAL_TYPE When ContactType is PERSON , valid values include the following:

    • ABO (Aboriginal Peoples indigenous to Canada)
    • CCT (Canadian citizen)
    • LGR (Legal Representative of a Canadian Citizen or Permanent Resident)
    • RES (Permanent resident of Canada)

When ContactType is a value other than PERSON , valid values include the following:

  • ASS (Canadian unincorporated association)
  • CCO (Canadian corporation)
  • EDU (Canadian educational institution)
  • GOV (Government or government entity in Canada)
  • HOP (Canadian Hospital)
  • INB (Indian Band recognized by the Indian Act of Canada)
  • LAM (Canadian Library, Archive, or Museum)
  • MAJ (Her/His Majesty the Queen/King)
  • OMK (Official mark registered in Canada)
  • PLT (Canadian Political Party)
  • PRT (Partnership Registered in Canada)
  • TDM (Trademark registered in Canada)
  • TRD (Canadian Trade Union)
  • TRS (Trust established in Canada)

.es

  • ES_IDENTIFICATION Specify the applicable value:

    • For contacts inside Spain: Enter your passport ID.
    • For contacts outside of Spain: Enter the VAT identification number for the company.

    Note

    For .es domains, the value of ContactType must be PERSON .

  • ES_IDENTIFICATION_TYPE Valid values include the following:

    • DNI_AND_NIF (For Spanish contacts)
    • NIE (For foreigners with legal residence)
    • OTHER (For contacts outside of Spain)
  • ES_LEGAL_FORM Valid values include the following:

    • ASSOCIATION
    • CENTRAL_GOVERNMENT_BODY
    • CIVIL_SOCIETY
    • COMMUNITY_OF_OWNERS
    • COMMUNITY_PROPERTY
    • CONSULATE
    • COOPERATIVE
    • DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL
    • ECONOMIC_INTEREST_GROUP
    • EMBASSY
    • ENTITY_MANAGING_NATURAL_AREAS
    • FARM_PARTNERSHIP
    • FOUNDATION
    • GENERAL_AND_LIMITED_PARTNERSHIP
    • GENERAL_PARTNERSHIP
    • INDIVIDUAL
    • LIMITED_COMPANY
    • LOCAL_AUTHORITY
    • LOCAL_PUBLIC_ENTITY
    • MUTUAL_INSURANCE_COMPANY
    • NATIONAL_PUBLIC_ENTITY
    • ORDER_OR_RELIGIOUS_INSTITUTION
    • OTHERS (Only for contacts outside of Spain)
    • POLITICAL_PARTY
    • PROFESSIONAL_ASSOCIATION
    • PUBLIC_LAW_ASSOCIATION
    • PUBLIC_LIMITED_COMPANY
    • REGIONAL_GOVERNMENT_BODY
    • REGIONAL_PUBLIC_ENTITY
    • SAVINGS_BANK
    • SPANISH_OFFICE
    • SPORTS_ASSOCIATION
    • SPORTS_FEDERATION
    • SPORTS_LIMITED_COMPANY
    • TEMPORARY_ALLIANCE_OF_ENTERPRISES
    • TRADE_UNION
    • WORKER_OWNED_COMPANY
    • WORKER_OWNED_LIMITED_COMPANY

    .fi

  • BIRTH_DATE_IN_YYYY_MM_DD

  • FI_BUSINESS_NUMBER

  • FI_ID_NUMBER

  • FI_NATIONALITY Valid values include the following:

    • FINNISH
    • NOT_FINNISH
  • FI_ORGANIZATION_TYPE Valid values include the following:

    • COMPANY
    • CORPORATION
    • GOVERNMENT
    • INSTITUTION
    • POLITICAL_PARTY
    • PUBLIC_COMMUNITY
    • TOWNSHIP

    .fr

  • BIRTH_CITY

  • BIRTH_COUNTRY

  • BIRTH_DATE_IN_YYYY_MM_DD

  • BIRTH_DEPARTMENT : Specify the INSEE code that corresponds with the department where the contact was born. If the contact was born somewhere other than France or its overseas departments, specify 99 . For more information, including a list of departments and the corresponding INSEE numbers, see the Wikipedia entry Departments of France .

  • BRAND_NUMBER

    .it

  • IT_NATIONALITY

  • IT_PIN

  • IT_REGISTRANT_ENTITY_TYPE Valid values include the following:

    • FOREIGNERS
    • FREELANCE_WORKERS (Freelance workers and professionals)
    • ITALIAN_COMPANIES (Italian companies and one-person companies)
    • NON_PROFIT_ORGANIZATIONS
    • OTHER_SUBJECTS
    • PUBLIC_ORGANIZATIONS

    .ru

  • BIRTH_DATE_IN_YYYY_MM_DD

  • RU_PASSPORT_DATA

    .se

  • BIRTH_COUNTRY

  • SE_ID_NUMBER

    .sg

  • SG_ID_NUMBER

    .co.uk, .me.uk, and .org.uk

  • UK_CONTACT_TYPE Valid values include the following:

    • CRC (UK Corporation by Royal Charter)
    • FCORP (Non-UK Corporation)
    • FIND (Non-UK Individual, representing self)
    • FOTHER (Non-UK Entity that does not fit into any other category)
    • GOV (UK Government Body)
    • IND (UK Individual (representing self))
    • IP (UK Industrial/Provident Registered Company)
    • LLP (UK Limited Liability Partnership)
    • LTD (UK Limited Company)
    • OTHER (UK Entity that does not fit into any other category)
    • PLC (UK Public Limited Company)
    • PTNR (UK Partnership)
    • RCHAR (UK Registered Charity)
    • SCH (UK School)
    • STAT (UK Statutory Body)
    • STRA (UK Sole Trader)
  • UK_COMPANY_NUMBER

In addition, many TLDs require a VAT_NUMBER .

Value -> (string)

The value that corresponds with the name of an extra parameter.

Shorthand Syntax:

FirstName=string,LastName=string,ContactType=string,OrganizationName=string,AddressLine1=string,AddressLine2=string,City=string,State=string,CountryCode=string,ZipCode=string,PhoneNumber=string,Email=string,Fax=string,ExtraParams=[{Name=string,Value=string},{Name=string,Value=string}]

JSON Syntax:

{
  "FirstName": "string",
  "LastName": "string",
  "ContactType": "PERSON"|"COMPANY"|"ASSOCIATION"|"PUBLIC_BODY"|"RESELLER",
  "OrganizationName": "string",
  "AddressLine1": "string",
  "AddressLine2": "string",
  "City": "string",
  "State": "string",
  "CountryCode": "AD"|"AE"|"AF"|"AG"|"AI"|"AL"|"AM"|"AN"|"AO"|"AQ"|"AR"|"AS"|"AT"|"AU"|"AW"|"AZ"|"BA"|"BB"|"BD"|"BE"|"BF"|"BG"|"BH"|"BI"|"BJ"|"BL"|"BM"|"BN"|"BO"|"BR"|"BS"|"BT"|"BW"|"BY"|"BZ"|"CA"|"CC"|"CD"|"CF"|"CG"|"CH"|"CI"|"CK"|"CL"|"CM"|"CN"|"CO"|"CR"|"CU"|"CV"|"CX"|"CY"|"CZ"|"DE"|"DJ"|"DK"|"DM"|"DO"|"DZ"|"EC"|"EE"|"EG"|"ER"|"ES"|"ET"|"FI"|"FJ"|"FK"|"FM"|"FO"|"FR"|"GA"|"GB"|"GD"|"GE"|"GH"|"GI"|"GL"|"GM"|"GN"|"GQ"|"GR"|"GT"|"GU"|"GW"|"GY"|"HK"|"HN"|"HR"|"HT"|"HU"|"ID"|"IE"|"IL"|"IM"|"IN"|"IQ"|"IR"|"IS"|"IT"|"JM"|"JO"|"JP"|"KE"|"KG"|"KH"|"KI"|"KM"|"KN"|"KP"|"KR"|"KW"|"KY"|"KZ"|"LA"|"LB"|"LC"|"LI"|"LK"|"LR"|"LS"|"LT"|"LU"|"LV"|"LY"|"MA"|"MC"|"MD"|"ME"|"MF"|"MG"|"MH"|"MK"|"ML"|"MM"|"MN"|"MO"|"MP"|"MR"|"MS"|"MT"|"MU"|"MV"|"MW"|"MX"|"MY"|"MZ"|"NA"|"NC"|"NE"|"NG"|"NI"|"NL"|"NO"|"NP"|"NR"|"NU"|"NZ"|"OM"|"PA"|"PE"|"PF"|"PG"|"PH"|"PK"|"PL"|"PM"|"PN"|"PR"|"PT"|"PW"|"PY"|"QA"|"RO"|"RS"|"RU"|"RW"|"SA"|"SB"|"SC"|"SD"|"SE"|"SG"|"SH"|"SI"|"SK"|"SL"|"SM"|"SN"|"SO"|"SR"|"ST"|"SV"|"SY"|"SZ"|"TC"|"TD"|"TG"|"TH"|"TJ"|"TK"|"TL"|"TM"|"TN"|"TO"|"TR"|"TT"|"TV"|"TW"|"TZ"|"UA"|"UG"|"US"|"UY"|"UZ"|"VA"|"VC"|"VE"|"VG"|"VI"|"VN"|"VU"|"WF"|"WS"|"YE"|"YT"|"ZA"|"ZM"|"ZW",
  "ZipCode": "string",
  "PhoneNumber": "string",
  "Email": "string",
  "Fax": "string",
  "ExtraParams": [
    {
      "Name": "DUNS_NUMBER"|"BRAND_NUMBER"|"BIRTH_DEPARTMENT"|"BIRTH_DATE_IN_YYYY_MM_DD"|"BIRTH_COUNTRY"|"BIRTH_CITY"|"DOCUMENT_NUMBER"|"AU_ID_NUMBER"|"AU_ID_TYPE"|"CA_LEGAL_TYPE"|"CA_BUSINESS_ENTITY_TYPE"|"CA_LEGAL_REPRESENTATIVE"|"CA_LEGAL_REPRESENTATIVE_CAPACITY"|"ES_IDENTIFICATION"|"ES_IDENTIFICATION_TYPE"|"ES_LEGAL_FORM"|"FI_BUSINESS_NUMBER"|"FI_ID_NUMBER"|"FI_NATIONALITY"|"FI_ORGANIZATION_TYPE"|"IT_NATIONALITY"|"IT_PIN"|"IT_REGISTRANT_ENTITY_TYPE"|"RU_PASSPORT_DATA"|"SE_ID_NUMBER"|"SG_ID_NUMBER"|"VAT_NUMBER"|"UK_CONTACT_TYPE"|"UK_COMPANY_NUMBER",
      "Value": "string"
    }
    ...
  ]
}

--privacy-protect-admin-contact | --no-privacy-protect-admin-contact (boolean)

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 (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false , WHOIS queries return the information that you entered for the admin contact.

Default: true

--privacy-protect-registrant-contact | --no-privacy-protect-registrant-contact (boolean)

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 (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false , WHOIS queries return the information that you entered for the registrant contact (the domain owner).

Default: true

--privacy-protect-tech-contact | --no-privacy-protect-tech-contact (boolean)

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 (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false , WHOIS queries return the information that you entered for the technical contact.

Default: true

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To register a domain

The following register-domain command registers a domain, retrieving all parameter values from a JSON-formatted file.

This command runs only in the us-east-1 Region. If your default region is set to us-east-1, you can omit the region parameter.

aws route53domains register-domain \
    --region us-east-1 \
    --cli-input-json file://register-domain.json

Contents of register-domain.json:

{
    "DomainName": "example.com",
    "DurationInYears": 1,
    "AutoRenew": true,
    "AdminContact": {
        "FirstName": "Martha",
        "LastName": "Rivera",
        "ContactType": "PERSON",
        "OrganizationName": "Example",
        "AddressLine1": "1 Main Street",
        "City": "Anytown",
        "State": "WA",
        "CountryCode": "US",
        "ZipCode": "98101",
        "PhoneNumber": "+1.8005551212",
        "Email": "mrivera@example.com"
    },
    "RegistrantContact": {
        "FirstName": "Li",
        "LastName": "Juan",
        "ContactType": "PERSON",
        "OrganizationName": "Example",
        "AddressLine1": "1 Main Street",
        "City": "Anytown",
        "State": "WA",
        "CountryCode": "US",
        "ZipCode": "98101",
        "PhoneNumber": "+1.8005551212",
        "Email": "ljuan@example.com"
    },
    "TechContact": {
        "FirstName": "Mateo",
        "LastName": "Jackson",
        "ContactType": "PERSON",
        "OrganizationName": "Example",
        "AddressLine1": "1 Main Street",
        "City": "Anytown",
        "State": "WA",
        "CountryCode": "US",
        "ZipCode": "98101",
        "PhoneNumber": "+1.8005551212",
        "Email": "mjackson@example.com"
    },
    "PrivacyProtectAdminContact": true,
    "PrivacyProtectRegistrantContact": true,
    "PrivacyProtectTechContact": true
}

Output:

{
    "OperationId": "b114c44a-9330-47d1-a6e8-a0b11example"
}

To confirm that the operation succeeded, you can run get-operation-detail. For more information, see get-operation-detail .

For more information, see Registering a New Domain in the Amazon Route 53 Developer Guide.

For information about which top-level domains (TLDs) require values for ExtraParams and what the valid values are, see ExtraParam in the Amazon Route 53 API Reference.

Output

OperationId -> (string)

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