AWS Route53 Domains (version v1.*.*)

check_domain_availability#

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.

Parameters

$body#

The CheckDomainAvailability request contains the following elements.

Type: object

{
  "DomainName" : "The name of the domain that you want to get availability for. \nConstraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.",
  "IdnLangCode" : "Reserved for future use."
}

check_domain_transferability#

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

Parameters

$body#

The CheckDomainTransferability request contains the following elements.

Type: object

{
  "AuthCode" : "If the registrar for the top-level domain (TLD) requires an authorization code to transfer the domain, the code that you got from the current registrar for the domain.",
  "DomainName" : "The name of the domain that you want to transfer to Amazon Route 53. \nConstraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported."
}

delete_tags_for_domain#

This operation deletes the specified tags for a domain.
All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.

Parameters

$body#

The DeleteTagsForDomainRequest includes the following elements.

Type: object

{
  "TagsToDelete" : [ "string" ],
  "DomainName" : "The domain for which you want to delete one or more tags."
}

disable_domain_auto_renew#

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

Parameters

$body#

Type: object

{
  "DomainName" : "The name of the domain that you want to disable automatic renewal for."
}

disable_domain_transfer_lock#

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.

Parameters

$body#

The DisableDomainTransferLock request includes the following element.

Type: object

{
  "DomainName" : "The name of the domain that you want to remove the transfer lock for."
}

enable_domain_auto_renew#

This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. The cost of renewing your domain registration is billed to your AWS account.
The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see "Renewal, restoration, and deletion times" on the website for our registrar associate, Gandi. Amazon Route 53 requires that you renew before the end of the renewal period that is listed on the Gandi website so we can complete processing before the deadline.

Parameters

$body#

Type: object

{
  "DomainName" : "The name of the domain that you want to enable automatic renewal for."
}

enable_domain_transfer_lock#

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.

Parameters

$body#

A request to set the transfer lock for the specified domain.

Type: object

{
  "DomainName" : "The name of the domain that you want to set the transfer lock for."
}

get_contact_reachability_status#

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.

Parameters

$body#

Type: object

{
  "domainName" : "The name of the domain for which you want to know whether the registrant contact has confirmed that the email address is valid."
}

get_domain_detail#

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

Parameters

$body#

The GetDomainDetail request includes the following element.

Type: object

{
  "DomainName" : "The name of the domain that you want to get detailed information about."
}

get_domain_suggestions#

The GetDomainSuggestions operation returns a list of suggested domain names given a string, which can either be a domain name or simply a word or phrase (without spaces).

Parameters

$body#

Type: object

{
  "OnlyAvailable" : "If OnlyAvailable is true, Amazon Route 53 returns only domain names that are available. If OnlyAvailable is false, Amazon Route 53 returns domain names without checking whether they're available to be registered. To determine whether the domain is available, you can call checkDomainAvailability for each suggestion.",
  "DomainName" : "A domain name that you want to use as the basis for a list of possible domain names. The domain name must contain a top-level domain (TLD), such as .com, that Amazon Route 53 supports. For a list of TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.",
  "SuggestionCount" : "The number of suggested domain names that you want Amazon Route 53 to return."
}

get_operation_detail#

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

Parameters

$body#

The GetOperationDetail request includes the following element.

Type: object

{
  "OperationId" : "The identifier for the operation for which you want to get the status. Amazon Route 53 returned the identifier in the response to the original request."
}

list_domains#

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

This operation has no parameters

list_operations#

This operation returns the operation IDs of operations that are not yet complete.

Parameters

$body#

The ListOperations request includes the following elements.

Type: object

{
  "SubmittedSince" : "An optional parameter that lets you get information about all the operations that you submitted after a specified date and time. Specify the date and time in Coordinated Universal time (UTC)."
}

list_tags_for_domain#

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.

Parameters

$body#

The ListTagsForDomainRequest includes the following elements.

Type: object

{
  "DomainName" : "The domain for which you want to get a list of tags."
}

register_domain#

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 Amazon Route 53 hosted zone that has the same name as the domain. Amazon Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers.
Enables autorenew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration.
Optionally enables privacy protection, so WHOIS queries return contact information 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.

Parameters

$body#

The RegisterDomain request includes the following elements.

Type: object

{
  "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. \nDefault: 1",
  "DomainName" : "The domain name that you want to register. \nConstraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.",
  "AutoRenew" : "Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged. \nDefault: true ",
  "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 (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. \nDefault: true ",
  "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 (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). \nDefault: true ",
  "AdminContact" : {
    "OrganizationName" : "Name of the organization for contact types other than PERSON.",
    "ContactType" : "Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.",
    "Email" : "Email address of the contact.",
    "FirstName" : "First name of contact.",
    "ZipCode" : "The zip or postal code of the contact's address.",
    "City" : "The city of the contact's address.",
    "AddressLine2" : "Second line of contact's address, if any.",
    "AddressLine1" : "First line of the contact's address.",
    "ExtraParams" : [ {
      "Value" : "Values corresponding to the additional parameter names required by some top-level domains.",
      "Name" : "Name of the additional parameter required by the top-level domain. Here are the top-level domains that require additional parameters and which parameters they require:  \n  .com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE   \n  .ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE   \n  .es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM   \n  .fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, and FI_ORGANIZATION_TYPE   \n  .fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, and BIRTH_CITY   \n  .it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE   \n  .ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA   \n  .se: BIRTH_COUNTRY and SE_ID_NUMBER   \n  .sg: SG_ID_NUMBER   \n  .co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER    \nIn addition, many TLDs require VAT_NUMBER."
    } ],
    "State" : "The state or province of the contact's city.",
    "PhoneNumber" : "The phone number of the contact. \nConstraints: Phone number must be specified in the format \"+[country dialing code].[number including any area code&gt;]\". For example, a US phone number might appear as \"+1.1234567890\".",
    "LastName" : "Last name of contact.",
    "CountryCode" : "Code for the country of the contact's address.",
    "Fax" : "Fax number of the contact. \nConstraints: 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\"."
  },
  "IdnLangCode" : "Reserved for future use.",
  "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 (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. \nDefault: true ",
  "RegistrantContact" : {
    "OrganizationName" : "Name of the organization for contact types other than PERSON.",
    "ContactType" : "Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.",
    "Email" : "Email address of the contact.",
    "FirstName" : "First name of contact.",
    "ZipCode" : "The zip or postal code of the contact's address.",
    "City" : "The city of the contact's address.",
    "AddressLine2" : "Second line of contact's address, if any.",
    "AddressLine1" : "First line of the contact's address.",
    "ExtraParams" : [ {
      "Value" : "Values corresponding to the additional parameter names required by some top-level domains.",
      "Name" : "Name of the additional parameter required by the top-level domain. Here are the top-level domains that require additional parameters and which parameters they require:  \n  .com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE   \n  .ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE   \n  .es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM   \n  .fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, and FI_ORGANIZATION_TYPE   \n  .fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, and BIRTH_CITY   \n  .it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE   \n  .ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA   \n  .se: BIRTH_COUNTRY and SE_ID_NUMBER   \n  .sg: SG_ID_NUMBER   \n  .co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER    \nIn addition, many TLDs require VAT_NUMBER."
    } ],
    "State" : "The state or province of the contact's city.",
    "PhoneNumber" : "The phone number of the contact. \nConstraints: Phone number must be specified in the format \"+[country dialing code].[number including any area code&gt;]\". For example, a US phone number might appear as \"+1.1234567890\".",
    "LastName" : "Last name of contact.",
    "CountryCode" : "Code for the country of the contact's address.",
    "Fax" : "Fax number of the contact. \nConstraints: 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\"."
  },
  "TechContact" : {
    "OrganizationName" : "Name of the organization for contact types other than PERSON.",
    "ContactType" : "Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.",
    "Email" : "Email address of the contact.",
    "FirstName" : "First name of contact.",
    "ZipCode" : "The zip or postal code of the contact's address.",
    "City" : "The city of the contact's address.",
    "AddressLine2" : "Second line of contact's address, if any.",
    "AddressLine1" : "First line of the contact's address.",
    "ExtraParams" : [ {
      "Value" : "Values corresponding to the additional parameter names required by some top-level domains.",
      "Name" : "Name of the additional parameter required by the top-level domain. Here are the top-level domains that require additional parameters and which parameters they require:  \n  .com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE   \n  .ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE   \n  .es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM   \n  .fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, and FI_ORGANIZATION_TYPE   \n  .fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, and BIRTH_CITY   \n  .it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE   \n  .ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA   \n  .se: BIRTH_COUNTRY and SE_ID_NUMBER   \n  .sg: SG_ID_NUMBER   \n  .co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER    \nIn addition, many TLDs require VAT_NUMBER."
    } ],
    "State" : "The state or province of the contact's city.",
    "PhoneNumber" : "The phone number of the contact. \nConstraints: Phone number must be specified in the format \"+[country dialing code].[number including any area code&gt;]\". For example, a US phone number might appear as \"+1.1234567890\".",
    "LastName" : "Last name of contact.",
    "CountryCode" : "Code for the country of the contact's address.",
    "Fax" : "Fax number of the contact. \nConstraints: 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\"."
  }
}

renew_domain#

This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your AWS account.
We recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the expiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see Renewing Registration for a Domain in the Amazon Route 53 Developer Guide.

Parameters

$body#

A RenewDomain request includes the number of years that you want to renew for and the current expiration year.

Type: object

{
  "DurationInYears" : "The number of years that you want to renew the domain for. The maximum number of years 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. \nDefault: 1",
  "CurrentExpiryYear" : "The year when the registration for the domain is set to expire. This value must match the current expiration date for the domain.",
  "DomainName" : "The name of the domain that you want to renew."
}

resend_contact_reachability_email#

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.

Parameters

$body#

Type: object

{
  "domainName" : "The name of the domain for which you want Amazon Route 53 to resend a confirmation email to the registrant contact."
}

retrieve_domain_auth_code#

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

Parameters

$body#

A request for the authorization code for the specified domain. To transfer a domain to another registrar, you provide this value to the new registrar.

Type: object

{
  "DomainName" : "The name of the domain that you want to get an authorization code for."
}

transfer_domain#

This operation transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered either with Amazon Registrar (for .com, .net, and .org domains) or with our registrar associate, Gandi (for all other TLDs).
For transfer requirements, a detailed procedure, and information about viewing the status of a domain transfer, see Transferring Registration for a Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.
If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you consider transferring your DNS service to Amazon Route 53 or to another DNS service provider before you transfer your registration. Some registrars provide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar will not renew your domain registration and could end your DNS service at any time.
If the registrar for your domain is also the DNS service provider for the domain and you don't transfer DNS service to another provider, your website, email, and the web applications associated with the domain might become unavailable.
If the transfer is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email.

Parameters

$body#

The TransferDomain request includes the following elements.

Type: object

{
  "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. \nDefault: 1",
  "AuthCode" : "The authorization code for the domain. You get this value from the current registrar.",
  "DomainName" : "The name of the domain that you want to transfer to Amazon Route 53. \nConstraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.",
  "Nameservers" : [ {
    "GlueIps" : [ "string" ],
    "Name" : "The fully qualified host name of the name server. \nConstraint: Maximum 255 characters"
  } ],
  "AutoRenew" : "Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged. \nDefault: true",
  "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 (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. \nDefault: true ",
  "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 (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 (domain owner). \nDefault: true ",
  "AdminContact" : {
    "OrganizationName" : "Name of the organization for contact types other than PERSON.",
    "ContactType" : "Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.",
    "Email" : "Email address of the contact.",
    "FirstName" : "First name of contact.",
    "ZipCode" : "The zip or postal code of the contact's address.",
    "City" : "The city of the contact's address.",
    "AddressLine2" : "Second line of contact's address, if any.",
    "AddressLine1" : "First line of the contact's address.",
    "ExtraParams" : [ {
      "Value" : "Values corresponding to the additional parameter names required by some top-level domains.",
      "Name" : "Name of the additional parameter required by the top-level domain. Here are the top-level domains that require additional parameters and which parameters they require:  \n  .com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE   \n  .ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE   \n  .es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM   \n  .fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, and FI_ORGANIZATION_TYPE   \n  .fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, and BIRTH_CITY   \n  .it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE   \n  .ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA   \n  .se: BIRTH_COUNTRY and SE_ID_NUMBER   \n  .sg: SG_ID_NUMBER   \n  .co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER    \nIn addition, many TLDs require VAT_NUMBER."
    } ],
    "State" : "The state or province of the contact's city.",
    "PhoneNumber" : "The phone number of the contact. \nConstraints: Phone number must be specified in the format \"+[country dialing code].[number including any area code&gt;]\". For example, a US phone number might appear as \"+1.1234567890\".",
    "LastName" : "Last name of contact.",
    "CountryCode" : "Code for the country of the contact's address.",
    "Fax" : "Fax number of the contact. \nConstraints: 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\"."
  },
  "IdnLangCode" : "Reserved for future use.",
  "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 (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. \nDefault: true ",
  "RegistrantContact" : {
    "OrganizationName" : "Name of the organization for contact types other than PERSON.",
    "ContactType" : "Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.",
    "Email" : "Email address of the contact.",
    "FirstName" : "First name of contact.",
    "ZipCode" : "The zip or postal code of the contact's address.",
    "City" : "The city of the contact's address.",
    "AddressLine2" : "Second line of contact's address, if any.",
    "AddressLine1" : "First line of the contact's address.",
    "ExtraParams" : [ {
      "Value" : "Values corresponding to the additional parameter names required by some top-level domains.",
      "Name" : "Name of the additional parameter required by the top-level domain. Here are the top-level domains that require additional parameters and which parameters they require:  \n  .com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE   \n  .ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE   \n  .es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM   \n  .fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, and FI_ORGANIZATION_TYPE   \n  .fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, and BIRTH_CITY   \n  .it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE   \n  .ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA   \n  .se: BIRTH_COUNTRY and SE_ID_NUMBER   \n  .sg: SG_ID_NUMBER   \n  .co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER    \nIn addition, many TLDs require VAT_NUMBER."
    } ],
    "State" : "The state or province of the contact's city.",
    "PhoneNumber" : "The phone number of the contact. \nConstraints: Phone number must be specified in the format \"+[country dialing code].[number including any area code&gt;]\". For example, a US phone number might appear as \"+1.1234567890\".",
    "LastName" : "Last name of contact.",
    "CountryCode" : "Code for the country of the contact's address.",
    "Fax" : "Fax number of the contact. \nConstraints: 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\"."
  },
  "TechContact" : {
    "OrganizationName" : "Name of the organization for contact types other than PERSON.",
    "ContactType" : "Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.",
    "Email" : "Email address of the contact.",
    "FirstName" : "First name of contact.",
    "ZipCode" : "The zip or postal code of the contact's address.",
    "City" : "The city of the contact's address.",
    "AddressLine2" : "Second line of contact's address, if any.",
    "AddressLine1" : "First line of the contact's address.",
    "ExtraParams" : [ {
      "Value" : "Values corresponding to the additional parameter names required by some top-level domains.",
      "Name" : "Name of the additional parameter required by the top-level domain. Here are the top-level domains that require additional parameters and which parameters they require:  \n  .com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE   \n  .ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE   \n  .es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM   \n  .fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, and FI_ORGANIZATION_TYPE   \n  .fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, and BIRTH_CITY   \n  .it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE   \n  .ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA   \n  .se: BIRTH_COUNTRY and SE_ID_NUMBER   \n  .sg: SG_ID_NUMBER   \n  .co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER    \nIn addition, many TLDs require VAT_NUMBER."
    } ],
    "State" : "The state or province of the contact's city.",
    "PhoneNumber" : "The phone number of the contact. \nConstraints: Phone number must be specified in the format \"+[country dialing code].[number including any area code&gt;]\". For example, a US phone number might appear as \"+1.1234567890\".",
    "LastName" : "Last name of contact.",
    "CountryCode" : "Code for the country of the contact's address.",
    "Fax" : "Fax number of the contact. \nConstraints: 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\"."
  }
}

update_domain_contact#

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 action. If the request is not completed successfully, the domain registrant will be notified by email.

Parameters

$body#

The UpdateDomainContact request includes the following elements.

Type: object

{
  "DomainName" : "The name of the domain that you want to update contact information for.",
  "AdminContact" : {
    "OrganizationName" : "Name of the organization for contact types other than PERSON.",
    "ContactType" : "Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.",
    "Email" : "Email address of the contact.",
    "FirstName" : "First name of contact.",
    "ZipCode" : "The zip or postal code of the contact's address.",
    "City" : "The city of the contact's address.",
    "AddressLine2" : "Second line of contact's address, if any.",
    "AddressLine1" : "First line of the contact's address.",
    "ExtraParams" : [ {
      "Value" : "Values corresponding to the additional parameter names required by some top-level domains.",
      "Name" : "Name of the additional parameter required by the top-level domain. Here are the top-level domains that require additional parameters and which parameters they require:  \n  .com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE   \n  .ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE   \n  .es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM   \n  .fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, and FI_ORGANIZATION_TYPE   \n  .fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, and BIRTH_CITY   \n  .it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE   \n  .ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA   \n  .se: BIRTH_COUNTRY and SE_ID_NUMBER   \n  .sg: SG_ID_NUMBER   \n  .co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER    \nIn addition, many TLDs require VAT_NUMBER."
    } ],
    "State" : "The state or province of the contact's city.",
    "PhoneNumber" : "The phone number of the contact. \nConstraints: Phone number must be specified in the format \"+[country dialing code].[number including any area code&gt;]\". For example, a US phone number might appear as \"+1.1234567890\".",
    "LastName" : "Last name of contact.",
    "CountryCode" : "Code for the country of the contact's address.",
    "Fax" : "Fax number of the contact. \nConstraints: 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\"."
  },
  "RegistrantContact" : {
    "OrganizationName" : "Name of the organization for contact types other than PERSON.",
    "ContactType" : "Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.",
    "Email" : "Email address of the contact.",
    "FirstName" : "First name of contact.",
    "ZipCode" : "The zip or postal code of the contact's address.",
    "City" : "The city of the contact's address.",
    "AddressLine2" : "Second line of contact's address, if any.",
    "AddressLine1" : "First line of the contact's address.",
    "ExtraParams" : [ {
      "Value" : "Values corresponding to the additional parameter names required by some top-level domains.",
      "Name" : "Name of the additional parameter required by the top-level domain. Here are the top-level domains that require additional parameters and which parameters they require:  \n  .com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE   \n  .ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE   \n  .es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM   \n  .fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, and FI_ORGANIZATION_TYPE   \n  .fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, and BIRTH_CITY   \n  .it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE   \n  .ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA   \n  .se: BIRTH_COUNTRY and SE_ID_NUMBER   \n  .sg: SG_ID_NUMBER   \n  .co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER    \nIn addition, many TLDs require VAT_NUMBER."
    } ],
    "State" : "The state or province of the contact's city.",
    "PhoneNumber" : "The phone number of the contact. \nConstraints: Phone number must be specified in the format \"+[country dialing code].[number including any area code&gt;]\". For example, a US phone number might appear as \"+1.1234567890\".",
    "LastName" : "Last name of contact.",
    "CountryCode" : "Code for the country of the contact's address.",
    "Fax" : "Fax number of the contact. \nConstraints: 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\"."
  },
  "TechContact" : {
    "OrganizationName" : "Name of the organization for contact types other than PERSON.",
    "ContactType" : "Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.",
    "Email" : "Email address of the contact.",
    "FirstName" : "First name of contact.",
    "ZipCode" : "The zip or postal code of the contact's address.",
    "City" : "The city of the contact's address.",
    "AddressLine2" : "Second line of contact's address, if any.",
    "AddressLine1" : "First line of the contact's address.",
    "ExtraParams" : [ {
      "Value" : "Values corresponding to the additional parameter names required by some top-level domains.",
      "Name" : "Name of the additional parameter required by the top-level domain. Here are the top-level domains that require additional parameters and which parameters they require:  \n  .com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE   \n  .ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE   \n  .es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM   \n  .fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, and FI_ORGANIZATION_TYPE   \n  .fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, and BIRTH_CITY   \n  .it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE   \n  .ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA   \n  .se: BIRTH_COUNTRY and SE_ID_NUMBER   \n  .sg: SG_ID_NUMBER   \n  .co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER    \nIn addition, many TLDs require VAT_NUMBER."
    } ],
    "State" : "The state or province of the contact's city.",
    "PhoneNumber" : "The phone number of the contact. \nConstraints: Phone number must be specified in the format \"+[country dialing code].[number including any area code&gt;]\". For example, a US phone number might appear as \"+1.1234567890\".",
    "LastName" : "Last name of contact.",
    "CountryCode" : "Code for the country of the contact's address.",
    "Fax" : "Fax number of the contact. \nConstraints: 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\"."
  }
}

update_domain_contact_privacy#

This operation updates the specified domain contact's privacy setting. When privacy protection is enabled, contact information such as email address is replaced either with contact information for Amazon Registrar (for .com, .net, and .org domains) or with contact information for our registrar associate, Gandi.
This operation affects only the contact information for the specified contact type (registrant, administrator, or tech). 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.

Parameters

$body#

The UpdateDomainContactPrivacy request includes the following elements.

Type: object

{
  "DomainName" : "The name of the domain that you want to update the privacy setting for.",
  "RegistrantPrivacy" : "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 (domain owner).",
  "AdminPrivacy" : "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.",
  "TechPrivacy" : "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."
}

update_domain_nameservers#

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.

Parameters

$body#

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.

Type: object

{
  "DomainName" : "The name of the domain that you want to change name servers for.",
  "Nameservers" : [ {
    "GlueIps" : [ "string" ],
    "Name" : "The fully qualified host name of the name server. \nConstraint: Maximum 255 characters"
  } ],
  "FIAuthKey" : "The authorization key for .fi domains"
}

update_tags_for_domain#

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.

Parameters

$body#

The UpdateTagsForDomainRequest includes the following elements.

Type: object

{
  "DomainName" : "The domain for which you want to add or update tags.",
  "TagsToUpdate" : [ {
    "Value" : "The value of a tag. \nValid values: A-Z, a-z, 0-9, space, \".:/=+\\-@\" \nConstraints: Each value can be 0-256 characters long.",
    "Key" : "The key (name) of a tag. \nValid values: A-Z, a-z, 0-9, space, \".:/=+\\-@\" \nConstraints: Each key can be 1-128 characters long."
  } ]
}

view_billing#

Returns all the domain-related billing records for the current AWS account for a specified period

Parameters

$body#

The ViewBilling request includes the following elements.

Type: object

{
  "Start" : "The beginning date and time for the time period for which you want a list of billing records. Specify the date and time in Coordinated Universal time (UTC).",
  "End" : "The end date and time for the time period for which you want a list of billing records. Specify the date and time in Coordinated Universal time (UTC)."
}