register-domain AWS CLI 2.15.39 Command Reference

May 2024 · 26 minute read

Description

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:

Note

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

See also: AWS API Documentation

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] [--billing-contact <value>] [--privacy-protect-billing-contact | --no-privacy-protect-billing-contact] [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton <value>] [--debug] [--endpoint-url <value>] [--no-verify-ssl] [--no-paginate] [--output <value>] [--query <value>] [--profile <value>] [--region <value>] [--version <value>] [--color <value>] [--no-sign-request] [--ca-bundle <value>] [--cli-read-timeout <value>] [--cli-connect-timeout <value>] [--cli-binary-format <value>] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt] 

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:

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 ). Auto renewal 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:

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

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

.es

If ``ES_LEGAL_FORM`` is any value other than ``INDIVIDUAL`` :

If ``ES_LEGAL_FORM`` is ``INDIVIDUAL`` , the value that you specify for ``ES_IDENTIFICATION`` depends on the value of ``ES_IDENTIFICATION_TYPE`` :

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": "AC"|"AD"|"AE"|"AF"|"AG"|"AI"|"AL"|"AM"|"AN"|"AO"|"AQ"|"AR"|"AS"|"AT"|"AU"|"AW"|"AX"|"AZ"|"BA"|"BB"|"BD"|"BE"|"BF"|"BG"|"BH"|"BI"|"BJ"|"BL"|"BM"|"BN"|"BO"|"BQ"|"BR"|"BS"|"BT"|"BV"|"BW"|"BY"|"BZ"|"CA"|"CC"|"CD"|"CF"|"CG"|"CH"|"CI"|"CK"|"CL"|"CM"|"CN"|"CO"|"CR"|"CU"|"CV"|"CW"|"CX"|"CY"|"CZ"|"DE"|"DJ"|"DK"|"DM"|"DO"|"DZ"|"EC"|"EE"|"EG"|"EH"|"ER"|"ES"|"ET"|"FI"|"FJ"|"FK"|"FM"|"FO"|"FR"|"GA"|"GB"|"GD"|"GE"|"GF"|"GG"|"GH"|"GI"|"GL"|"GM"|"GN"|"GP"|"GQ"|"GR"|"GS"|"GT"|"GU"|"GW"|"GY"|"HK"|"HM"|"HN"|"HR"|"HT"|"HU"|"ID"|"IE"|"IL"|"IM"|"IN"|"IO"|"IQ"|"IR"|"IS"|"IT"|"JE"|"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"|"MQ"|"MR"|"MS"|"MT"|"MU"|"MV"|"MW"|"MX"|"MY"|"MZ"|"NA"|"NC"|"NE"|"NF"|"NG"|"NI"|"NL"|"NO"|"NP"|"NR"|"NU"|"NZ"|"OM"|"PA"|"PE"|"PF"|"PG"|"PH"|"PK"|"PL"|"PM"|"PN"|"PR"|"PS"|"PT"|"PW"|"PY"|"QA"|"RE"|"RO"|"RS"|"RU"|"RW"|"SA"|"SB"|"SC"|"SD"|"SE"|"SG"|"SH"|"SI"|"SJ"|"SK"|"SL"|"SM"|"SN"|"SO"|"SR"|"SS"|"ST"|"SV"|"SX"|"SY"|"SZ"|"TC"|"TD"|"TF"|"TG"|"TH"|"TJ"|"TK"|"TL"|"TM"|"TN"|"TO"|"TP"|"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"|"EU_COUNTRY_OF_CITIZENSHIP"|"AU_PRIORITY_TOKEN", "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:

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

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

.es

If ``ES_LEGAL_FORM`` is any value other than ``INDIVIDUAL`` :

If ``ES_LEGAL_FORM`` is ``INDIVIDUAL`` , the value that you specify for ``ES_IDENTIFICATION`` depends on the value of ``ES_IDENTIFICATION_TYPE`` :

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": "AC"|"AD"|"AE"|"AF"|"AG"|"AI"|"AL"|"AM"|"AN"|"AO"|"AQ"|"AR"|"AS"|"AT"|"AU"|"AW"|"AX"|"AZ"|"BA"|"BB"|"BD"|"BE"|"BF"|"BG"|"BH"|"BI"|"BJ"|"BL"|"BM"|"BN"|"BO"|"BQ"|"BR"|"BS"|"BT"|"BV"|"BW"|"BY"|"BZ"|"CA"|"CC"|"CD"|"CF"|"CG"|"CH"|"CI"|"CK"|"CL"|"CM"|"CN"|"CO"|"CR"|"CU"|"CV"|"CW"|"CX"|"CY"|"CZ"|"DE"|"DJ"|"DK"|"DM"|"DO"|"DZ"|"EC"|"EE"|"EG"|"EH"|"ER"|"ES"|"ET"|"FI"|"FJ"|"FK"|"FM"|"FO"|"FR"|"GA"|"GB"|"GD"|"GE"|"GF"|"GG"|"GH"|"GI"|"GL"|"GM"|"GN"|"GP"|"GQ"|"GR"|"GS"|"GT"|"GU"|"GW"|"GY"|"HK"|"HM"|"HN"|"HR"|"HT"|"HU"|"ID"|"IE"|"IL"|"IM"|"IN"|"IO"|"IQ"|"IR"|"IS"|"IT"|"JE"|"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"|"MQ"|"MR"|"MS"|"MT"|"MU"|"MV"|"MW"|"MX"|"MY"|"MZ"|"NA"|"NC"|"NE"|"NF"|"NG"|"NI"|"NL"|"NO"|"NP"|"NR"|"NU"|"NZ"|"OM"|"PA"|"PE"|"PF"|"PG"|"PH"|"PK"|"PL"|"PM"|"PN"|"PR"|"PS"|"PT"|"PW"|"PY"|"QA"|"RE"|"RO"|"RS"|"RU"|"RW"|"SA"|"SB"|"SC"|"SD"|"SE"|"SG"|"SH"|"SI"|"SJ"|"SK"|"SL"|"SM"|"SN"|"SO"|"SR"|"SS"|"ST"|"SV"|"SX"|"SY"|"SZ"|"TC"|"TD"|"TF"|"TG"|"TH"|"TJ"|"TK"|"TL"|"TM"|"TN"|"TO"|"TP"|"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"|"EU_COUNTRY_OF_CITIZENSHIP"|"AU_PRIORITY_TOKEN", "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:

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

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

.es

If ``ES_LEGAL_FORM`` is any value other than ``INDIVIDUAL`` :

If ``ES_LEGAL_FORM`` is ``INDIVIDUAL`` , the value that you specify for ``ES_IDENTIFICATION`` depends on the value of ``ES_IDENTIFICATION_TYPE`` :

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": "AC"|"AD"|"AE"|"AF"|"AG"|"AI"|"AL"|"AM"|"AN"|"AO"|"AQ"|"AR"|"AS"|"AT"|"AU"|"AW"|"AX"|"AZ"|"BA"|"BB"|"BD"|"BE"|"BF"|"BG"|"BH"|"BI"|"BJ"|"BL"|"BM"|"BN"|"BO"|"BQ"|"BR"|"BS"|"BT"|"BV"|"BW"|"BY"|"BZ"|"CA"|"CC"|"CD"|"CF"|"CG"|"CH"|"CI"|"CK"|"CL"|"CM"|"CN"|"CO"|"CR"|"CU"|"CV"|"CW"|"CX"|"CY"|"CZ"|"DE"|"DJ"|"DK"|"DM"|"DO"|"DZ"|"EC"|"EE"|"EG"|"EH"|"ER"|"ES"|"ET"|"FI"|"FJ"|"FK"|"FM"|"FO"|"FR"|"GA"|"GB"|"GD"|"GE"|"GF"|"GG"|"GH"|"GI"|"GL"|"GM"|"GN"|"GP"|"GQ"|"GR"|"GS"|"GT"|"GU"|"GW"|"GY"|"HK"|"HM"|"HN"|"HR"|"HT"|"HU"|"ID"|"IE"|"IL"|"IM"|"IN"|"IO"|"IQ"|"IR"|"IS"|"IT"|"JE"|"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"|"MQ"|"MR"|"MS"|"MT"|"MU"|"MV"|"MW"|"MX"|"MY"|"MZ"|"NA"|"NC"|"NE"|"NF"|"NG"|"NI"|"NL"|"NO"|"NP"|"NR"|"NU"|"NZ"|"OM"|"PA"|"PE"|"PF"|"PG"|"PH"|"PK"|"PL"|"PM"|"PN"|"PR"|"PS"|"PT"|"PW"|"PY"|"QA"|"RE"|"RO"|"RS"|"RU"|"RW"|"SA"|"SB"|"SC"|"SD"|"SE"|"SG"|"SH"|"SI"|"SJ"|"SK"|"SL"|"SM"|"SN"|"SO"|"SR"|"SS"|"ST"|"SV"|"SX"|"SY"|"SZ"|"TC"|"TD"|"TF"|"TG"|"TH"|"TJ"|"TK"|"TL"|"TM"|"TN"|"TO"|"TP"|"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"|"EU_COUNTRY_OF_CITIZENSHIP"|"AU_PRIORITY_TOKEN", "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 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

--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 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

--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 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

--billing-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:

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

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

.es

If ``ES_LEGAL_FORM`` is any value other than ``INDIVIDUAL`` :

If ``ES_LEGAL_FORM`` is ``INDIVIDUAL`` , the value that you specify for ``ES_IDENTIFICATION`` depends on the value of ``ES_IDENTIFICATION_TYPE`` :

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": "AC"|"AD"|"AE"|"AF"|"AG"|"AI"|"AL"|"AM"|"AN"|"AO"|"AQ"|"AR"|"AS"|"AT"|"AU"|"AW"|"AX"|"AZ"|"BA"|"BB"|"BD"|"BE"|"BF"|"BG"|"BH"|"BI"|"BJ"|"BL"|"BM"|"BN"|"BO"|"BQ"|"BR"|"BS"|"BT"|"BV"|"BW"|"BY"|"BZ"|"CA"|"CC"|"CD"|"CF"|"CG"|"CH"|"CI"|"CK"|"CL"|"CM"|"CN"|"CO"|"CR"|"CU"|"CV"|"CW"|"CX"|"CY"|"CZ"|"DE"|"DJ"|"DK"|"DM"|"DO"|"DZ"|"EC"|"EE"|"EG"|"EH"|"ER"|"ES"|"ET"|"FI"|"FJ"|"FK"|"FM"|"FO"|"FR"|"GA"|"GB"|"GD"|"GE"|"GF"|"GG"|"GH"|"GI"|"GL"|"GM"|"GN"|"GP"|"GQ"|"GR"|"GS"|"GT"|"GU"|"GW"|"GY"|"HK"|"HM"|"HN"|"HR"|"HT"|"HU"|"ID"|"IE"|"IL"|"IM"|"IN"|"IO"|"IQ"|"IR"|"IS"|"IT"|"JE"|"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"|"MQ"|"MR"|"MS"|"MT"|"MU"|"MV"|"MW"|"MX"|"MY"|"MZ"|"NA"|"NC"|"NE"|"NF"|"NG"|"NI"|"NL"|"NO"|"NP"|"NR"|"NU"|"NZ"|"OM"|"PA"|"PE"|"PF"|"PG"|"PH"|"PK"|"PL"|"PM"|"PN"|"PR"|"PS"|"PT"|"PW"|"PY"|"QA"|"RE"|"RO"|"RS"|"RU"|"RW"|"SA"|"SB"|"SC"|"SD"|"SE"|"SG"|"SH"|"SI"|"SJ"|"SK"|"SL"|"SM"|"SN"|"SO"|"SR"|"SS"|"ST"|"SV"|"SX"|"SY"|"SZ"|"TC"|"TD"|"TF"|"TG"|"TH"|"TJ"|"TK"|"TL"|"TM"|"TN"|"TO"|"TP"|"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"|"EU_COUNTRY_OF_CITIZENSHIP"|"AU_PRIORITY_TOKEN", "Value": "string" } ... ] } 

--privacy-protect-billing-contact | --no-privacy-protect-billing-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 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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

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 .

ncG1vNJzZmiZp6iwrbWNmqSasp%2Bjrri%2FjZympmemZ3ylu8KupJ6mpJbBqrvNaJipoV%2BhrrWx0q1mq52Wmr%2BmusKeZqunpamydn%2FDqKSaoZ6ofLOxxqKqrZ2iYrGwucCipWegpKK5