Class: AWS.Route53Domains

var params = {
  DomainName: 'STRING_VALUE', /* required */
  SigningAttributes: { /* required */
    Algorithm: 'NUMBER_VALUE',
    Flags: 'NUMBER_VALUE',
    PublicKey: 'STRING_VALUE'
  }
};
route53domains.associateDelegationSignerToDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DomainName — (String)

    The name of the domain.

  • SigningAttributes — (map)

    The information about a key, including the algorithm, public key-value, and flags.

    • Algorithm — (Integer)

      Algorithm which was used to generate the digest from the public key.

    • Flags — (Integer)

      Defines the type of key. It can be either a KSK (key-signing-key, value 257) or ZSK (zone-signing-key, value 256). Using KSK is always encouraged. Only use ZSK if your DNS provider isn't Route 53 and you don’t have KSK available.

      If you have KSK and ZSK keys, always use KSK to create a delegations signer (DS) record. If you have ZSK keys only – use ZSK to create a DS record.

    • PublicKey — (String)

      The base64-encoded public key part of the key pair that is passed to the registry.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • OperationId — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
route53domains.cancelDomainTransferToAnotherAwsAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DomainName — (String)

    The name of the domain for which you want to cancel the transfer to another Amazon Web Services account.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • OperationId — (String)

      The identifier that TransferDomainToAnotherAwsAccount returned to track the progress of the request. Because the transfer request was canceled, the value is no longer valid, and you can't use GetOperationDetail to query the operation status.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DomainName: 'STRING_VALUE', /* required */
  IdnLangCode: 'STRING_VALUE'
};
route53domains.checkDomainAvailability(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DomainName — (String)

    The name of the domain that you want to get availability for. 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.

  • IdnLangCode — (String)

    Reserved for future use.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Availability — (String)

      Whether the domain name is available for registering.

      Note: You can register only domains designated as AVAILABLE.

      Valid values:

      AVAILABLE

      The domain name is available.

      AVAILABLE_RESERVED

      The domain name is reserved under specific conditions.

      AVAILABLE_PREORDER

      The domain name is available and can be preordered.

      DONT_KNOW

      The TLD registry didn't reply with a definitive answer about whether the domain name is available. Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later.

      INVALID_NAME_FOR_TLD

      The TLD isn't valid. For example, it can contain characters that aren't allowed.

      PENDING

      The TLD registry didn't return a response in the expected amount of time. When the response is delayed, it usually takes just a few extra seconds. You can resubmit the request immediately.

      RESERVED

      The domain name has been reserved for another person or organization.

      UNAVAILABLE

      The domain name is not available.

      UNAVAILABLE_PREMIUM

      The domain name is not available.

      UNAVAILABLE_RESTRICTED

      The domain name is forbidden.

      Possible values include:
      • "AVAILABLE"
      • "AVAILABLE_RESERVED"
      • "AVAILABLE_PREORDER"
      • "UNAVAILABLE"
      • "UNAVAILABLE_PREMIUM"
      • "UNAVAILABLE_RESTRICTED"
      • "RESERVED"
      • "DONT_KNOW"
      • "INVALID_NAME_FOR_TLD"
      • "PENDING"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DomainName: 'STRING_VALUE', /* required */
  AuthCode: 'STRING_VALUE'
};
route53domains.checkDomainTransferability(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DomainName — (String)

    The name of the domain that you want to transfer to Route 53. 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.

  • AuthCode — (String)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Transferability — (map)

      A complex type that contains information about whether the specified domain can be transferred to Route 53.

      • Transferable — (String)

        Whether the domain name can be transferred to Route 53.

        Note: You can transfer only domains that have a value of TRANSFERABLE or Transferable.

        Valid values:

        TRANSFERABLE

        The domain name can be transferred to Route 53.

        UNTRANSFERRABLE

        The domain name can't be transferred to Route 53.

        DONT_KNOW

        Reserved for future use.

        DOMAIN_IN_OWN_ACCOUNT

        The domain already exists in the current Amazon Web Services account.

        DOMAIN_IN_ANOTHER_ACCOUNT

        The domain exists in another Amazon Web Services account.

        PREMIUM_DOMAIN

        Premium domain transfer is not supported.

        Possible values include:
        • "TRANSFERABLE"
        • "UNTRANSFERABLE"
        • "DONT_KNOW"
        • "DOMAIN_IN_OWN_ACCOUNT"
        • "DOMAIN_IN_ANOTHER_ACCOUNT"
        • "PREMIUM_DOMAIN"
    • Message — (String)

      Provides an explanation for when a domain can't be transferred.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
route53domains.deleteDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DomainName — (String)

    Name of the domain to be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • OperationId — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DomainName: 'STRING_VALUE', /* required */
  TagsToDelete: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
route53domains.deleteTagsForDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DomainName — (String)

    The domain for which you want to delete one or more tags.

  • TagsToDelete — (Array<String>)

    A list of tag keys to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
route53domains.disableDomainAutoRenew(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DomainName — (String)

    The name of the domain that you want to disable automatic renewal for.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
route53domains.disableDomainTransferLock(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DomainName — (String)

    The name of the domain that you want to remove the transfer lock for.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • OperationId — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DomainName: 'STRING_VALUE', /* required */
  Id: 'STRING_VALUE' /* required */
};
route53domains.disassociateDelegationSignerFromDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DomainName — (String)

    Name of the domain.

  • Id — (String)

    An internal identification number assigned to each DS record after it’s created. You can retrieve it as part of DNSSEC information returned by GetDomainDetail.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • OperationId — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
route53domains.enableDomainAutoRenew(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DomainName — (String)

    The name of the domain that you want to enable automatic renewal for.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
route53domains.enableDomainTransferLock(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DomainName — (String)

    The name of the domain that you want to set the transfer lock for.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • OperationId — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domainName: 'STRING_VALUE'
};
route53domains.getContactReachabilityStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domainName — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • domainName — (String)

      The domain name for which you requested the reachability status.

    • status — (String)

      Whether the registrant contact has responded. Values include the following:

      PENDING

      We sent the confirmation email and haven't received a response yet.

      DONE

      We sent the email and got confirmation from the registrant contact.

      EXPIRED

      The time limit expired before the registrant contact responded.

      Possible values include:
      • "PENDING"
      • "DONE"
      • "EXPIRED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
route53domains.getDomainDetail(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DomainName — (String)

    The name of the domain that you want to get detailed information about.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • DomainName — (String)

      The name of a domain.

    • Nameservers — (Array<map>)

      The name servers of the domain.

      • Name — required — (String)

        The fully qualified host name of the name server.

        Constraint: Maximum 255 characters

      • GlueIps — (Array<String>)

        Glue IP address of a name server entry. Glue IP addresses are required only when the name of the name server is a subdomain of the domain. For example, if your domain is example.com and the name server for the domain is ns.example.com, you need to specify the IP address for ns.example.com.

        Constraints: The list can contain only one IPv4 and one IPv6 address.

    • AutoRenew — (Boolean)

      Specifies whether the domain registration is set to renew automatically.

    • AdminContact — (map)

      Provides details about the domain administrative contact.

      • 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, the value of ContactType must be PERSON for all three contacts.

        Possible values include:
        • "PERSON"
        • "COMPANY"
        • "ASSOCIATION"
        • "PUBLIC_BODY"
        • "RESELLER"
      • 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.

        Possible values include:
        • "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)

        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 — (Array<map>)

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

        • Name — required — (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

            The value of ES_IDENTIFICATION depends on the following values:

            • The value of ES_LEGAL_FORM

            • The value of ES_IDENTIFICATION_TYPE

            If ES_LEGAL_FORM is any value other than INDIVIDUAL:

            • Specify 1 letter + 8 numbers (CIF [Certificado de Identificación Fiscal])

            • Example: B12345678

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

            • If ES_IDENTIFICATION_TYPE is DNI_AND_NIF (for Spanish contacts):

              • Specify 8 numbers + 1 letter (DNI [Documento Nacional de Identidad], NIF [Número de Identificación Fiscal])

              • Example: 12345678M

            • If ES_IDENTIFICATION_TYPE is NIE (for foreigners with legal residence):

              • Specify 1 letter + 7 numbers + 1 letter ( NIE [Número de Identidad de Extranjero])

              • Example: Y1234567X

            • If ES_IDENTIFICATION_TYPE is OTHER (for contacts outside of Spain):

              • Specify a passport number, drivers license number, or national identity card number

          • 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

          .eu

          • EU_COUNTRY_OF_CITIZENSHIP

          .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

          .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

          .uk, .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.

          Possible values include:
          • "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 — required — (String)

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

    • RegistrantContact — (map)

      Provides details about the domain registrant.

      • 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, the value of ContactType must be PERSON for all three contacts.

        Possible values include:
        • "PERSON"
        • "COMPANY"
        • "ASSOCIATION"
        • "PUBLIC_BODY"
        • "RESELLER"
      • 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.

        Possible values include:
        • "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)

        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 — (Array<map>)

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

        • Name — required — (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

            The value of ES_IDENTIFICATION depends on the following values:

            • The value of ES_LEGAL_FORM

            • The value of ES_IDENTIFICATION_TYPE

            If ES_LEGAL_FORM is any value other than INDIVIDUAL:

            • Specify 1 letter + 8 numbers (CIF [Certificado de Identificación Fiscal])

            • Example: B12345678

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

            • If ES_IDENTIFICATION_TYPE is DNI_AND_NIF (for Spanish contacts):

              • Specify 8 numbers + 1 letter (DNI [Documento Nacional de Identidad], NIF [Número de Identificación Fiscal])

              • Example: 12345678M

            • If ES_IDENTIFICATION_TYPE is NIE (for foreigners with legal residence):

              • Specify 1 letter + 7 numbers + 1 letter ( NIE [Número de Identidad de Extranjero])

              • Example: Y1234567X

            • If ES_IDENTIFICATION_TYPE is OTHER (for contacts outside of Spain):

              • Specify a passport number, drivers license number, or national identity card number

          • 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

          .eu

          • EU_COUNTRY_OF_CITIZENSHIP

          .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

          .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

          .uk, .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.

          Possible values include: