Class: AWS.Route53Domains

Inherits:
AWS.Service show all
Identifier:
route53domains
API Version:
2014-05-15
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon Route 53 API actions let you register domain names and perform related operations.

Sending a Request Using Route53Domains

var route53domains = new AWS.Route53Domains();
route53domains.checkDomainAvailability(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Route53Domains object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var route53domains = new AWS.Route53Domains({apiVersion: '2014-05-15'});

You can also set the API version globally in AWS.config.apiVersions using the route53domains service identifier:

AWS.config.apiVersions = {
  route53domains: '2014-05-15',
  // other service API versions
};

var route53domains = new AWS.Route53Domains();

Version:

  • 2014-05-15

Constructor Summary

Property Summary

Properties inherited from AWS.Service

apiVersions

Method Summary

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Route53Domains(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Route53Domains object

var route53domains = new AWS.Route53Domains({apiVersion: '2014-05-15'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.Route53Domains.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.Route53Domains.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.Route53Domains.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean) —

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

checkDomainAvailability(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the checkDomainAvailability operation

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.

      Constraints: 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 — (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. Amazon Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later.

        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"

Returns:

  • (AWS.Request) —

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

checkDomainTransferability(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the checkDomainTransferability operation

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 Amazon Route 53.

      Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

    • 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 Amazon Route 53.

        • Transferable — (String)

          Whether the domain name can be transferred to Amazon Route 53.

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

          Valid values:

          TRANSFERABLE

          The domain name can be transferred to Amazon Route 53.

          UNTRANSFERRABLE

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

          DONT_KNOW

          Reserved for future use.

          Possible values include:
          • "TRANSFERABLE"
          • "UNTRANSFERABLE"
          • "DONT_KNOW"

Returns:

  • (AWS.Request) —

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

deleteTagsForDomain(params = {}, callback) ⇒ AWS.Request

This operation deletes the specified tags for a domain.

All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.

Service Reference:

Examples:

Calling the deleteTagsForDomain operation

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.

disableDomainAutoRenew(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the disableDomainAutoRenew operation

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.

disableDomainTransferLock(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the disableDomainTransferLock operation

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 use this ID to query the operation status, use GetOperationDetail.

Returns:

  • (AWS.Request) —

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

enableDomainAutoRenew(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the enableDomainAutoRenew operation

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.

enableDomainTransferLock(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the enableDomainTransferLock operation

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.

getContactReachabilityStatus(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getContactReachabilityStatus operation

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.

getDomainDetail(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getDomainDetail operation

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 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. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

          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:
          • "AD"
          • "AE"
          • "AF"
          • "AG"
          • "AI"
          • "AL"
          • "AM"
          • "AN"
          • "AO"
          • "AQ"
          • "AR"
          • "AS"
          • "AT"
          • "AU"
          • "AW"
          • "AZ"
          • "BA"
          • "BB"
          • "BD"
          • "BE"
          • "BF"
          • "BG"
          • "BH"
          • "BI"
          • "BJ"
          • "BL"
          • "BM"
          • "BN"
          • "BO"
          • "BR"
          • "BS"
          • "BT"
          • "BW"
          • "BY"
          • "BZ"
          • "CA"
          • "CC"
          • "CD"
          • "CF"
          • "CG"
          • "CH"
          • "CI"
          • "CK"
          • "CL"
          • "CM"
          • "CN"
          • "CO"
          • "CR"
          • "CU"
          • "CV"
          • "CX"
          • "CY"
          • "CZ"
          • "DE"
          • "DJ"
          • "DK"
          • "DM"
          • "DO"
          • "DZ"
          • "EC"
          • "EE"
          • "EG"
          • "ER"
          • "ES"
          • "ET"
          • "FI"
          • "FJ"
          • "FK"
          • "FM"
          • "FO"
          • "FR"
          • "GA"
          • "GB"
          • "GD"
          • "GE"
          • "GH"
          • "GI"
          • "GL"
          • "GM"
          • "GN"
          • "GQ"
          • "GR"
          • "GT"
          • "GU"
          • "GW"
          • "GY"
          • "HK"
          • "HN"
          • "HR"
          • "HT"
          • "HU"
          • "ID"
          • "IE"
          • "IL"
          • "IM"
          • "IN"
          • "IQ"
          • "IR"
          • "IS"
          • "IT"
          • "JM"
          • "JO"
          • "JP"
          • "KE"
          • "KG"
          • "KH"
          • "KI"
          • "KM"
          • "KN"
          • "KP"
          • "KR"
          • "KW"
          • "KY"
          • "KZ"
          • "LA"
          • "LB"
          • "LC"
          • "LI"
          • "LK"
          • "LR"
          • "LS"
          • "LT"
          • "LU"
          • "LV"
          • "LY"
          • "MA"
          • "MC"
          • "MD"
          • "ME"
          • "MF"
          • "MG"
          • "MH"
          • "MK"
          • "ML"
          • "MM"
          • "MN"
          • "MO"
          • "MP"
          • "MR"
          • "MS"
          • "MT"
          • "MU"
          • "MV"
          • "MW"
          • "MX"
          • "MY"
          • "MZ"
          • "NA"
          • "NC"
          • "NE"
          • "NG"
          • "NI"
          • "NL"
          • "NO"
          • "NP"
          • "NR"
          • "NU"
          • "NZ"
          • "OM"
          • "PA"
          • "PE"
          • "PF"
          • "PG"
          • "PH"
          • "PK"
          • "PL"
          • "PM"
          • "PN"
          • "PR"
          • "PT"
          • "PW"
          • "PY"
          • "QA"
          • "RO"
          • "RS"
          • "RU"
          • "RW"
          • "SA"
          • "SB"
          • "SC"
          • "SD"
          • "SE"
          • "SG"
          • "SH"
          • "SI"
          • "SK"
          • "SL"
          • "SM"
          • "SN"
          • "SO"
          • "SR"
          • "ST"
          • "SV"
          • "SY"
          • "SZ"
          • "TC"
          • "TD"
          • "TG"
          • "TH"
          • "TJ"
          • "TK"
          • "TL"
          • "TM"
          • "TN"
          • "TO"
          • "TR"
          • "TT"
          • "TV"
          • "TW"
          • "TZ"
          • "UA"
          • "UG"
          • "US"
          • "UY"
          • "UZ"
          • "VA"
          • "VC"
          • "VE"
          • "VG"
          • "VI"
          • "VN"
          • "VU"
          • "WF"
          • "WS"
          • "YE"
          • "YT"
          • "ZA"
          • "ZM"
          • "ZW"
        • ZipCode — (String)

          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)

            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:

            • .com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE

            • .ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE

            • .es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM

            • .fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, and FI_ORGANIZATION_TYPE

            • .fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, and BIRTH_CITY

            • .it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE

            • .ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA

            • .se: BIRTH_COUNTRY and SE_ID_NUMBER

            • .sg: SG_ID_NUMBER

            • .co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER

            In addition, many TLDs require 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"
            • "ES_IDENTIFICATION"
            • "ES_IDENTIFICATION_TYPE"
            • "ES_LEGAL_FORM"
            • "FI_BUSINESS_NUMBER"
            • "FI_ID_NUMBER"
            • "FI_NATIONALITY"
            • "FI_ORGANIZATION_TYPE"
            • "IT_PIN"
            • "IT_REGISTRANT_ENTITY_TYPE"
            • "RU_PASSPORT_DATA"
            • "SE_ID_NUMBER"
            • "SG_ID_NUMBER"
            • "VAT_NUMBER"
            • "UK_CONTACT_TYPE"
            • "UK_COMPANY_NUMBER"
          • Value — required — (String)

            Values corresponding to the additional parameter names required by some top-level domains.

      • 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. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

          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:
          • "AD"
          • "AE"
          • "AF"
          • "AG"
          • "AI"
          • "AL"
          • "AM"
          • "AN"
          • "AO"
          • "AQ"
          • "AR"
          • "AS"
          • "AT"
          • "AU"
          • "AW"
          • "AZ"
          • "BA"
          • "BB"
          • "BD"
          • "BE"
          • "BF"
          • "BG"
          • "BH"
          • "BI"
          • "BJ"
          • "BL"
          • "BM"
          • "BN"
          • "BO"
          • "BR"
          • "BS"
          • "BT"
          • "BW"
          • "BY"
          • "BZ"
          • "CA"
          • "CC"
          • "CD"
          • "CF"
          • "CG"
          • "CH"
          • "CI"
          • "CK"
          • "CL"
          • "CM"
          • "CN"
          • "CO"
          • "CR"
          • "CU"
          • "CV"
          • "CX"
          • "CY"
          • "CZ"
          • "DE"
          • "DJ"
          • "DK"
          • "DM"
          • "DO"
          • "DZ"
          • "EC"
          • "EE"
          • "EG"
          • "ER"
          • "ES"
          • "ET"
          • "FI"
          • "FJ"
          • "FK"
          • "FM"
          • "FO"
          • "FR"
          • "GA"
          • "GB"
          • "GD"
          • "GE"
          • "GH"
          • "GI"
          • "GL"
          • "GM"
          • "GN"
          • "GQ"
          • "GR"
          • "GT"
          • "GU"
          • "GW"
          • "GY"
          • "HK"
          • "HN"
          • "HR"
          • "HT"
          • "HU"
          • "ID"
          • "IE"
          • "IL"
          • "IM"
          • "IN"
          • "IQ"
          • "IR"
          • "IS"
          • "IT"
          • "JM"
          • "JO"
          • "JP"
          • "KE"
          • "KG"
          • "KH"
          • "KI"
          • "KM"
          • "KN"
          • "KP"
          • "KR"
          • "KW"
          • "KY"
          • "KZ"
          • "LA"
          • "LB"
          • "LC"
          • "LI"
          • "LK"
          • "LR"
          • "LS"
          • "LT"
          • "LU"
          • "LV"
          • "LY"
          • "MA"
          • "MC"
          • "MD"
          • "ME"
          • "MF"
          • "MG"
          • "MH"
          • "MK"
          • "ML"
          • "MM"
          • "MN"
          • "MO"
          • "MP"
          • "MR"
          • "MS"
          • "MT"
          • "MU"
          • "MV"
          • "MW"
          • "MX"
          • "MY"
          • "MZ"
          • "NA"
          • "NC"
          • "NE"
          • "NG"
          • "NI"
          • "NL"
          • "NO"
          • "NP"
          • "NR"
          • "NU"
          • "NZ"
          • "OM"
          • "PA"
          • "PE"
          • "PF"
          • "PG"
          • "PH"
          • "PK"
          • "PL"
          • "PM"
          • "PN"
          • "PR"
          • "PT"
          • "PW"
          • "PY"
          • "QA"
          • "RO"
          • "RS"
          • "RU"
          • "RW"
          • "SA"
          • "SB"
          • "SC"
          • "SD"
          • "SE"
          • "SG"
          • "SH"
          • "SI"
          • "SK"
          • "SL"
          • "SM"
          • "SN"
          • "SO"
          • "SR"
          • "ST"
          • "SV"
          • "SY"
          • "SZ"
          • "TC"
          • "TD"
          • "TG"
          • "TH"
          • "TJ"
          • "TK"
          • "TL"
          • "TM"
          • "TN"
          • "TO"
          • "TR"
          • "TT"
          • "TV"
          • "TW"
          • "TZ"
          • "UA"
          • "UG"
          • "US"
          • "UY"
          • "UZ"
          • "VA"
          • "VC"
          • "VE"
          • "VG"
          • "VI"
          • "VN"
          • "VU"
          • "WF"
          • "WS"
          • "YE"
          • "YT"
          • "ZA"
          • "ZM"
          • "ZW"
        • ZipCode — (String)

          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)

            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:

            • .com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE

            • .ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE

            • .es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM

            • .fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, and FI_ORGANIZATION_TYPE

            • .fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, and BIRTH_CITY

            • .it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE

            • .ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA

            • .se: BIRTH_COUNTRY and SE_ID_NUMBER

            • .sg: SG_ID_NUMBER

            • .co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER

            In addition, many TLDs require 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"
            • "ES_IDENTIFICATION"
            • "ES_IDENTIFICATION_TYPE"
            • "ES_LEGAL_FORM"
            • "FI_BUSINESS_NUMBER"
            • "FI_ID_NUMBER"
            • "FI_NATIONALITY"
            • "FI_ORGANIZATION_TYPE"
            • "IT_PIN"
            • "IT_REGISTRANT_ENTITY_TYPE"
            • "RU_PASSPORT_DATA"
            • "SE_ID_NUMBER"
            • "SG_ID_NUMBER"
            • "VAT_NUMBER"
            • "UK_CONTACT_TYPE"
            • "UK_COMPANY_NUMBER"
          • Value — required — (String)

            Values corresponding to the additional parameter names required by some top-level domains.

      • TechContact — (map)

        Provides details about the domain technical 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. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

          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:
          • "AD"
          • "AE"
          • "AF"
          • "AG"
          • "AI"
          • "AL"
          • "AM"
          • "AN"
          • "AO"
          • "AQ"
          • "AR"
          • "AS"
          • "AT"
          • "AU"
          • "AW"
          • "AZ"
          • "BA"
          • "BB"
          • "BD"
          • "BE"
          • "BF"
          • "BG"
          • "BH"
          • "BI"
          • "BJ"
          • "BL"
          • "BM"
          • "BN"
          • "BO"
          • "BR"
          • "BS"
          • "BT"
          • "BW"
          • "BY"
          • "BZ"
          • "CA"
          • "CC"
          • "CD"
          • "CF"
          • "CG"
          • "CH"
          • "CI"
          • "CK"
          • "CL"
          • "CM"
          • "CN"
          • "CO"
          • "CR"
          • "CU"
          • "CV"
          • "CX"
          • "CY"
          • "CZ"
          • "DE"
          • "DJ"
          • "DK"
          • "DM"
          • "DO"
          • "DZ"
          • "EC"
          • "EE"
          • "EG"
          • "ER"
          • "ES"
          • "ET"
          • "FI"
          • "FJ"
          • "FK"
          • "FM"
          • "FO"
          • "FR"
          • "GA"
          • "GB"
          • "GD"
          • "GE"
          • "GH"
          • "GI"
          • "GL"
          • "GM"
          • "GN"
          • "GQ"
          • "GR"
          • "GT"
          • "GU"
          • "GW"
          • "GY"
          • "HK"
          • "HN"
          • "HR"
          • "HT"
          • "HU"
          • "ID"
          • "IE"
          • "IL"
          • "IM"
          • "IN"
          • "IQ"
          • "IR"
          • "IS"
          • "IT"
          • "JM"
          • "JO"
          • "JP"
          • "KE"
          • "KG"
          • "KH"
          • "KI"
          • "KM"
          • "KN"
          • "KP"
          • "KR"
          • "KW"
          • "KY"
          • "KZ"
          • "LA"
          • "LB"
          • "LC"
          • "LI"
          • "LK"
          • "LR"
          • "LS"
          • "LT"
          • "LU"
          • "LV"
          • "LY"
          • "MA"
          • "MC"
          • "MD"
          • "ME"
          • "MF"
          • "MG"
          • "MH"
          • "MK"
          • "ML"
          • "MM"
          • "MN"
          • "MO"
          • "MP"
          • "MR"
          • "MS"
          • "MT"
          • "MU"
          • "MV"
          • "MW"
          • "MX"
          • "MY"
          • "MZ"
          • "NA"
          • "NC"
          • "NE"
          • "NG"
          • "NI"
          • "NL"
          • "NO"
          • "NP"
          • "NR"
          • "NU"
          • "NZ"
          • "OM"
          • "PA"
          • "PE"
          • "PF"
          • "PG"
          • "PH"
          • "PK"
          • "PL"
          • "PM"
          • "PN"
          • "PR"
          • "PT"
          • "PW"
          • "PY"
          • "QA"
          • "RO"
          • "RS"
          • "RU"
          • "RW"
          • "SA"
          • "SB"
          • "SC"
          • "SD"
          • "SE"
          • "SG"
          • "SH"
          • "SI"
          • "SK"
          • "SL"
          • "SM"
          • "SN"
          • "SO"
          • "SR"
          • "ST"
          • "SV"
          • "SY"
          • "SZ"
          • "TC"
          • "TD"
          • "TG"
          • "TH"
          • "TJ"
          • "TK"
          • "TL"
          • "TM"
          • "TN"
          • "TO"
          • "TR"
          • "TT"
          • "TV"
          • "TW"
          • "TZ"
          • "UA"
          • "UG"
          • "US"
          • "UY"
          • "UZ"
          • "VA"
          • "VC"
          • "VE"
          • "VG"
          • "VI"
          • "VN"
          • "VU"
          • "WF"
          • "WS"
          • "YE"
          • "YT"
          • "ZA"
          • "ZM"
          • "ZW"
        • ZipCode — (String)

          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)

            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:

            • .com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE

            • .ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE

            • .es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM

            • .fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, and FI_ORGANIZATION_TYPE

            • .fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, and BIRTH_CITY

            • .it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE

            • .ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA

            • .se: BIRTH_COUNTRY and SE_ID_NUMBER

            • .sg: SG_ID_NUMBER

            • .co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER

            In addition, many TLDs require 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"
            • "ES_IDENTIFICATION"
            • "ES_IDENTIFICATION_TYPE"
            • "ES_LEGAL_FORM"
            • "FI_BUSINESS_NUMBER"
            • "FI_ID_NUMBER"
            • "FI_NATIONALITY"
            • "FI_ORGANIZATION_TYPE"
            • "IT_PIN"
            • "IT_REGISTRANT_ENTITY_TYPE"
            • "RU_PASSPORT_DATA"
            • "SE_ID_NUMBER"
            • "SG_ID_NUMBER"
            • "VAT_NUMBER"
            • "UK_CONTACT_TYPE"
            • "UK_COMPANY_NUMBER"
          • Value — required — (String)

            Values corresponding to the additional parameter names required by some top-level domains.

      • AdminPrivacy — (Boolean)

        Specifies whether contact information is concealed from WHOIS queries. If the value is 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 the value is false, WHOIS queries return the information that you entered for the admin contact.

      • RegistrantPrivacy — (Boolean)

        Specifies whether contact information is concealed from WHOIS queries. If the value is 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 the value is false, WHOIS queries return the information that you entered for the registrant contact (domain owner).

      • TechPrivacy — (Boolean)

        Specifies whether contact information is concealed from WHOIS queries. If the value is 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 the value is false, WHOIS queries return the information that you entered for the technical contact.

      • RegistrarName — (String)

        Name of the registrar of the domain as identified in the registry. Domains with a .com, .net, or .org TLD are registered by Amazon Registrar. All other domains are registered by our registrar associate, Gandi. The value for domains that are registered by Gandi is "GANDI SAS".

      • WhoIsServer — (String)

        The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.

      • RegistrarUrl — (String)

        Web address of the registrar.

      • AbuseContactEmail — (String)

        Email address to contact to report incorrect contact information for a domain, to report that the domain is being used to send spam, to report that someone is cybersquatting on a domain name, or report some other type of abuse.

      • AbuseContactPhone — (String)

        Phone number for reporting abuse.

      • RegistryDomainId — (String)

        Reserved for future use.

      • CreationDate — (Date)

        The date when the domain was created as found in the response to a WHOIS query. The date and time is in Coordinated Universal time (UTC).

      • UpdatedDate — (Date)

        The last updated date of the domain as found in the response to a WHOIS query. The date and time is in Coordinated Universal time (UTC).

      • ExpirationDate — (Date)

        The date when the registration for the domain is set to expire. The date and time is in Coordinated Universal time (UTC).

      • Reseller — (String)

        Reseller of the domain. Domains registered or transferred using Amazon Route 53 domains will have "Amazon" as the reseller.

      • DnsSec — (String)

        Reserved for future use.

      • StatusList — (Array<String>)

        An array of domain name status codes, also known as Extensible Provisioning Protocol (EPP) status codes.

        ICANN, the organization that maintains a central database of domain names, has developed a set of domain name status codes that tell you the status of a variety of operations on a domain name, for example, registering a domain name, transferring a domain name to another registrar, renewing the registration for a domain name, and so on. All registrars use this same set of status codes.

        For a current list of domain name status codes and an explanation of what each code means, go to the ICANN website and search for epp status codes. (Search on the ICANN website; web searches sometimes return an old version of the document.)

Returns:

  • (AWS.Request) —

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

getDomainSuggestions(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getDomainSuggestions operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  OnlyAvailable: true || false, /* required */
  SuggestionCount: 'NUMBER_VALUE' /* required */
};
route53domains.getDomainSuggestions(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)

      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 — (Integer)

      The number of suggested domain names that you want Amazon Route 53 to return.

    • OnlyAvailable — (Boolean)

      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.

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:

      • SuggestionsList — (Array<map>)

        A list of possible domain names. If you specified true for OnlyAvailable in the request, the list contains only domains that are available for registration.

        • DomainName — (String)

          A suggested domain name.

        • Availability — (String)

          Whether the domain name is available for registering.

          Note: You can register only the domains that are 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. Amazon Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later.

          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.

Returns:

  • (AWS.Request) —

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

getOperationDetail(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getOperationDetail operation

var params = {
  OperationId: 'STRING_VALUE' /* required */
};
route53domains.getOperationDetail(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: {}) —
    • OperationId — (String)

      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.

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 the operation.

      • Status — (String)

        The current status of the requested operation in the system.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "ERROR"
        • "SUCCESSFUL"
        • "FAILED"
      • Message — (String)

        Detailed information on the status including possible errors.

      • DomainName — (String)

        The name of a domain.

      • Type — (String)

        The type of operation that was requested.

        Possible values include:
        • "REGISTER_DOMAIN"
        • "DELETE_DOMAIN"
        • "TRANSFER_IN_DOMAIN"
        • "UPDATE_DOMAIN_CONTACT"
        • "UPDATE_NAMESERVER"
        • "CHANGE_PRIVACY_PROTECTION"
        • "DOMAIN_LOCK"
        • "ENABLE_AUTORENEW"
        • "DISABLE_AUTORENEW"
        • "ADD_DNSSEC"
        • "REMOVE_DNSSEC"
        • "EXPIRE_DOMAIN"
        • "TRANSFER_OUT_DOMAIN"
        • "CHANGE_DOMAIN_OWNER"
        • "RENEW_DOMAIN"
        • "PUSH_DOMAIN"
      • SubmittedDate — (Date)

        The date when the request was submitted.

Returns:

  • (AWS.Request) —

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

listDomains(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listDomains operation

var params = {
  Marker: 'STRING_VALUE',
  MaxItems: 'NUMBER_VALUE'
};
route53domains.listDomains(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: {}) —
    • Marker — (String)

      For an initial request for a list of domains, omit this element. If the number of domains that are associated with the current AWS account is greater than the value that you specified for MaxItems, you can use Marker to return additional domains. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

      Constraints: The marker must match the value specified in the previous request.

    • MaxItems — (Integer)

      Number of domains to be returned.

      Default: 20

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:

      • Domains — (Array<map>)

        A summary of domains.

        • DomainName — required — (String)

          The name of the domain that the summary information applies to.

        • AutoRenew — (Boolean)

          Indicates whether the domain is automatically renewed upon expiration.

        • TransferLock — (Boolean)

          Indicates whether a domain is locked from unauthorized transfer to another party.

        • Expiry — (Date)

          Expiration date of the domain in Coordinated Universal Time (UTC).

      • NextPageMarker — (String)

        If there are more domains than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker.

Returns:

  • (AWS.Request) —

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

listOperations(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listOperations operation

var params = {
  Marker: 'STRING_VALUE',
  MaxItems: 'NUMBER_VALUE',
  SubmittedSince: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
route53domains.listOperations(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: {}) —
    • SubmittedSince — (Date)

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

    • Marker — (String)

      For an initial request for a list of operations, omit this element. If the number of operations that are not yet complete is greater than the value that you specified for MaxItems, you can use Marker to return additional operations. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

    • MaxItems — (Integer)

      Number of domains to be returned.

      Default: 20

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:

      • Operations — (Array<map>)

        Lists summaries of the operations.

        • OperationId — required — (String)

          Identifier returned to track the requested action.

        • Status — required — (String)

          The current status of the requested operation in the system.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "ERROR"
          • "SUCCESSFUL"
          • "FAILED"
        • Type — required — (String)

          Type of the action requested.

          Possible values include:
          • "REGISTER_DOMAIN"
          • "DELETE_DOMAIN"
          • "TRANSFER_IN_DOMAIN"
          • "UPDATE_DOMAIN_CONTACT"
          • "UPDATE_NAMESERVER"
          • "CHANGE_PRIVACY_PROTECTION"
          • "DOMAIN_LOCK"
          • "ENABLE_AUTORENEW"
          • "DISABLE_AUTORENEW"
          • "ADD_DNSSEC"
          • "REMOVE_DNSSEC"
          • "EXPIRE_DOMAIN"
          • "TRANSFER_OUT_DOMAIN"
          • "CHANGE_DOMAIN_OWNER"
          • "RENEW_DOMAIN"
          • "PUSH_DOMAIN"
        • SubmittedDate — required — (Date)

          The date when the request was submitted.

      • NextPageMarker — (String)

        If there are more operations than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker.

Returns:

  • (AWS.Request) —

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

listTagsForDomain(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listTagsForDomain operation

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
route53domains.listTagsForDomain(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 get a list of tags.

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:

      • TagList — (Array<map>)

        A list of the tags that are associated with the specified domain.

        • Key — (String)

          The key (name) of a tag.

          Valid values: A-Z, a-z, 0-9, space, ".:/=+-@"

          Constraints: Each key can be 1-128 characters long.

        • Value — (String)

          The value of a tag.

          Valid values: A-Z, a-z, 0-9, space, ".:/=+-@"

          Constraints: Each value can be 0-256 characters long.

Returns:

  • (AWS.Request) —

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

registerDomain(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the registerDomain operation

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

      Constraints: 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 — (String)

      Reserved for future use.

    • DurationInYears — (Integer)

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

      Default: 1

    • AutoRenew — (Boolean)

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

      Default: true

    • AdminContact — (map)

      Provides detailed contact information.

      • 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. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

        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:
        • "AD"
        • "AE"
        • "AF"
        • "AG"
        • "AI"
        • "AL"
        • "AM"
        • "AN"
        • "AO"
        • "AQ"
        • "AR"
        • "AS"
        • "AT"
        • "AU"
        • "AW"
        • "AZ"
        • "BA"
        • "BB"
        • "BD"
        • "BE"
        • "BF"
        • "BG"
        • "BH"
        • "BI"
        • "BJ"
        • "BL"
        • "BM"
        • "BN"
        • "BO"
        • "BR"
        • "BS"
        • "BT"
        • "BW"
        • "BY"
        • "BZ"
        • "CA"
        • "CC"
        • "CD"
        • "CF"
        • "CG"
        • "CH"
        • "CI"
        • "CK"
        • "CL"
        • "CM"
        • "CN"
        • "CO"
        • "CR"
        • "CU"
        • "CV"
        • "CX"
        • "CY"
        • "CZ"
        • "DE"
        • "DJ"
        • "DK"
        • "DM"
        • "DO"
        • "DZ"
        • "EC"
        • "EE"
        • "EG"
        • "ER"
        • "ES"
        • "ET"
        • "FI"
        • "FJ"
        • "FK"
        • "FM"
        • "FO"
        • "FR"
        • "GA"
        • "GB"
        • "GD"
        • "GE"
        • "GH"
        • "GI"
        • "GL"
        • "GM"
        • "GN"
        • "GQ"
        • "GR"
        • "GT"
        • "GU"
        • "GW"
        • "GY"
        • "HK"
        • "HN"
        • "HR"
        • "HT"
        • "HU"
        • "ID"
        • "IE"
        • "IL"
        • "IM"
        • "IN"
        • "IQ"
        • "IR"
        • "IS"
        • "IT"
        • "JM"
        • "JO"
        • "JP"
        • "KE"
        • "KG"
        • "KH"
        • "KI"
        • "KM"
        • "KN"
        • "KP"
        • "KR"
        • "KW"
        • "KY"
        • "KZ"
        • "LA"
        • "LB"
        • "LC"
        • "LI"
        • "LK"
        • "LR"
        • "LS"
        • "LT"
        • "LU"
        • "LV"
        • "LY"
        • "MA"
        • "MC"
        • "MD"
        • "ME"
        • "MF"
        • "MG"
        • "MH"
        • "MK"
        • "ML"
        • "MM"
        • "MN"
        • "MO"
        • "MP"
        • "MR"
        • "MS"
        • "MT"
        • "MU"
        • "MV"
        • "MW"
        • "MX"
        • "MY"
        • "MZ"
        • "NA"
        • "NC"
        • "NE"
        • "NG"
        • "NI"
        • "NL"
        • "NO"
        • "NP"
        • "NR"
        • "NU"
        • "NZ"
        • "OM"
        • "PA"
        • "PE"
        • "PF"
        • "PG"
        • "PH"
        • "PK"
        • "PL"
        • "PM"
        • "PN"
        • "PR"
        • "PT"
        • "PW"
        • "PY"
        • "QA"
        • "RO"
        • "RS"
        • "RU"
        • "RW"
        • "SA"
        • "SB"
        • "SC"
        • "SD"
        • "SE"
        • "SG"
        • "SH"
        • "SI"
        • "SK"
        • "SL"
        • "SM"
        • "SN"
        • "SO"
        • "SR"
        • "ST"
        • "SV"
        • "SY"
        • "SZ"
        • "TC"
        • "TD"
        • "TG"
        • "TH"
        • "TJ"
        • "TK"
        • "TL"
        • "TM"
        • "TN"
        • "TO"
        • "TR"
        • "TT"
        • "TV"
        • "TW"
        • "TZ"
        • "UA"
        • "UG"
        • "US"
        • "UY"
        • "UZ"
        • "VA"
        • "VC"
        • "VE"
        • "VG"
        • "VI"
        • "VN"
        • "VU"
        • "WF"
        • "WS"
        • "YE"
        • "YT"
        • "ZA"
        • "ZM"
        • "ZW"
      • ZipCode — (String)

        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)

          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:

          • .com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE

          • .ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE

          • .es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM

          • .fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, and FI_ORGANIZATION_TYPE

          • .fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, and BIRTH_CITY

          • .it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE

          • .ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA

          • .se: BIRTH_COUNTRY and SE_ID_NUMBER

          • .sg: SG_ID_NUMBER

          • .co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER

          In addition, many TLDs require 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"
          • "ES_IDENTIFICATION"
          • "ES_IDENTIFICATION_TYPE"
          • "ES_LEGAL_FORM"
          • "FI_BUSINESS_NUMBER"
          • "FI_ID_NUMBER"
          • "FI_NATIONALITY"
          • "FI_ORGANIZATION_TYPE"
          • "IT_PIN"
          • "IT_REGISTRANT_ENTITY_TYPE"
          • "RU_PASSPORT_DATA"
          • "SE_ID_NUMBER"
          • "SG_ID_NUMBER"
          • "VAT_NUMBER"
          • "UK_CONTACT_TYPE"
          • "UK_COMPANY_NUMBER"
        • Value — required — (String)

          Values corresponding to the additional parameter names required by some top-level domains.

    • RegistrantContact — (map)

      Provides detailed contact information.

      • 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. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

        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:
        • "AD"
        • "AE"
        • "AF"
        • "AG"
        • "AI"
        • "AL"
        • "AM"
        • "AN"
        • "AO"
        • "AQ"
        • "AR"
        • "AS"
        • "AT"
        • "AU"
        • "AW"
        • "AZ"
        • "BA"
        • "BB"
        • "BD"
        • "BE"
        • "BF"
        • "BG"
        • "BH"
        • "BI"
        • "BJ"
        • "BL"
        • "BM"
        • "BN"
        • "BO"
        • "BR"
        • "BS"
        • "BT"
        • "BW"
        • "BY"
        • "BZ"
        • "CA"
        • "CC"
        • "CD"
        • "CF"
        • "CG"
        • "CH"
        • "CI"
        • "CK"
        • "CL"
        • "CM"
        • "CN"
        • "CO"
        • "CR"
        • "CU"
        • "CV"
        • "CX"
        • "CY"
        • "CZ"
        • "DE"
        • "DJ"
        • "DK"
        • "DM"
        • "DO"
        • "DZ"
        • "EC"
        • "EE"
        • "EG"
        • "ER"
        • "ES"
        • "ET"
        • "FI"
        • "FJ"
        • "FK"
        • "FM"
        • "FO"
        • "FR"
        • "GA"
        • "GB"
        • "GD"
        • "GE"
        • "GH"
        • "GI"
        • "GL"
        • "GM"
        • "GN"
        • "GQ"
        • "GR"
        • "GT"
        • "GU"
        • "GW"
        • "GY"
        • "HK"
        • "HN"
        • "HR"
        • "HT"
        • "HU"
        • "ID"
        • "IE"
        • "IL"
        • "IM"
        • "IN"
        • "IQ"
        • "IR"
        • "IS"
        • "IT"
        • "JM"
        • "JO"
        • "JP"
        • "KE"
        • "KG"
        • "KH"
        • "KI"
        • "KM"
        • "KN"
        • "KP"
        • "KR"
        • "KW"
        • "KY"
        • "KZ"
        • "LA"
        • "LB"
        • "LC"
        • "LI"
        • "LK"
        • "LR"
        • "LS"
        • "LT"
        • "LU"
        • "LV"
        • "LY"
        • "MA"
        • "MC"
        • "MD"
        • "ME"
        • "MF"
        • "MG"
        • "MH"
        • "MK"
        • "ML"
        • "MM"
        • "MN"
        • "MO"
        • "MP"
        • "MR"
        • "MS"
        • "MT"
        • "MU"
        • "MV"
        • "MW"
        • "MX"
        • "MY"
        • "MZ"
        • "NA"
        • "NC"
        • "NE"
        • "NG"
        • "NI"
        • "NL"
        • "NO"
        • "NP"
        • "NR"
        • "NU"
        • "NZ"
        • "OM"
        • "PA"
        • "PE"
        • "PF"
        • "PG"
        • "PH"
        • "PK"
        • "PL"
        • "PM"
        • "PN"
        • "PR"
        • "PT"
        • "PW"
        • "PY"
        • "QA"
        • "RO"
        • "RS"
        • "RU"
        • "RW"
        • "SA"
        • "SB"
        • "SC"
        • "SD"
        • "SE"
        • "SG"
        • "SH"
        • "SI"
        • "SK"
        • "SL"
        • "SM"
        • "SN"
        • "SO"
        • "SR"
        • "ST"
        • "SV"
        • "SY"
        • "SZ"
        • "TC"
        • "TD"
        • "TG"
        • "TH"
        • "TJ"
        • "TK"
        • "TL"
        • "TM"
        • "TN"
        • "TO"
        • "TR"
        • "TT"
        • "TV"
        • "TW"
        • "TZ"
        • "UA"
        • "UG"
        • "US"
        • "UY"
        • "UZ"
        • "VA"
        • "VC"
        • "VE"
        • "VG"
        • "VI"
        • "VN"
        • "VU"
        • "WF"
        • "WS"
        • "YE"
        • "YT"
        • "ZA"
        • "ZM"
        • "ZW"
      • ZipCode — (String)

        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)

          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:

          • .com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE

          • .ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE

          • .es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM

          • .fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, and FI_ORGANIZATION_TYPE

          • .fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, and BIRTH_CITY

          • .it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE

          • .ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA

          • .se: BIRTH_COUNTRY and SE_ID_NUMBER

          • .sg: SG_ID_NUMBER

          • .co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER

          In addition, many TLDs require 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"
          • "ES_IDENTIFICATION"
          • "ES_IDENTIFICATION_TYPE"
          • "ES_LEGAL_FORM"
          • "FI_BUSINESS_NUMBER"
          • "FI_ID_NUMBER"
          • "FI_NATIONALITY"
          • "FI_ORGANIZATION_TYPE"
          • "IT_PIN"
          • "IT_REGISTRANT_ENTITY_TYPE"
          • "RU_PASSPORT_DATA"
          • "SE_ID_NUMBER"
          • "SG_ID_NUMBER"
          • "VAT_NUMBER"
          • "UK_CONTACT_TYPE"
          • "UK_COMPANY_NUMBER"
        • Value — required — (String)

          Values corresponding to the additional parameter names required by some top-level domains.

    • TechContact — (map)

      Provides detailed contact information.

      • 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. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

        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:
        • "AD"
        • "AE"
        • "AF"
        • "AG"
        • "AI"
        • "AL"
        • "AM"
        • "AN"
        • "AO"
        • "AQ"
        • "AR"
        • "AS"
        • "AT"
        • "AU"
        • "AW"
        • "AZ"
        • "BA"
        • "BB"
        • "BD"
        • "BE"
        • "BF"
        • "BG"
        • "BH"
        • "BI"
        • "BJ"
        • "BL"
        • "BM"
        • "BN"
        • "BO"
        • "BR"
        • "BS"
        • "BT"
        • "BW"
        • "BY"
        • "BZ"
        • "CA"
        • "CC"
        • "CD"
        • "CF"
        • "CG"
        • "CH"
        • "CI"
        • "CK"
        • "CL"
        • "CM"
        • "CN"
        • "CO"
        • "CR"
        • "CU"
        • "CV"
        • "CX"
        • "CY"
        • "CZ"
        • "DE"
        • "DJ"
        • "DK"
        • "DM"
        • "DO"
        • "DZ"
        • "EC"
        • "EE"
        • "EG"
        • "ER"
        • "ES"
        • "ET"
        • "FI"
        • "FJ"
        • "FK"
        • "FM"
        • "FO"
        • "FR"
        • "GA"
        • "GB"
        • "GD"
        • "GE"
        • "GH"
        • "GI"
        • "GL"
        • "GM"
        • "GN"
        • "GQ"
        • "GR"
        • "GT"
        • "GU"
        • "GW"
        • "GY"
        • "HK"
        • "HN"
        • "HR"
        • "HT"
        • "HU"
        • "ID"
        • "IE"
        • "IL"
        • "IM"
        • "IN"
        • "IQ"
        • "IR"
        • "IS"
        • "IT"
        • "JM"
        • "JO"
        • "JP"
        • "KE"
        • "KG"
        • "KH"
        • "KI"
        • "KM"
        • "KN"
        • "KP"
        • "KR"
        • "KW"
        • "KY"
        • "KZ"
        • "LA"
        • "LB"
        • "LC"
        • "LI"
        • "LK"
        • "LR"
        • "LS"
        • "LT"
        • "LU"
        • "LV"
        • "LY"
        • "MA"
        • "MC"
        • "MD"
        • "ME"
        • "MF"
        • "MG"
        • "MH"
        • "MK"
        • "ML"
        • "MM"
        • "MN"
        • "MO"
        • "MP"
        • "MR"
        • "MS"
        • "MT"
        • "MU"
        • "MV"
        • "MW"
        • "MX"
        • "MY"
        • "MZ"
        • "NA"
        • "NC"
        • "NE"
        • "NG"
        • "NI"
        • "NL"
        • "NO"
        • "NP"
        • "NR"
        • "NU"
        • "NZ"
        • "OM"
        • "PA"
        • "PE"
        • "PF"
        • "PG"
        • "PH"
        • "PK"
        • "PL"
        • "PM"
        • "PN"
        • "PR"
        • "PT"
        • "PW"
        • "PY"
        • "QA"
        • "RO"
        • "RS"
        • "RU"
        • "RW"
        • "SA"
        • "SB"
        • "SC"
        • "SD"
        • "SE"
        • "SG"
        • "SH"
        • "SI"
        • "SK"
        • "SL"
        • "SM"
        • "SN"
        • "SO"
        • "SR"
        • "ST"
        • "SV"
        • "SY"
        • "SZ"
        • "TC"
        • "TD"
        • "TG"
        • "TH"
        • "TJ"
        • "TK"
        • "TL"
        • "TM"
        • "TN"
        • "TO"
        • "TR"
        • "TT"
        • "TV"
        • "TW"
        • "TZ"
        • "UA"
        • "UG"
        • "US"
        • "UY"
        • "UZ"
        • "VA"
        • "VC"
        • "VE"
        • "VG"
        • "VI"
        • "VN"
        • "VU"
        • "WF"
        • "WS"
        • "YE"
        • "YT"
        • "ZA"
        • "ZM"
        • "ZW"
      • ZipCode — (String)

        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)

          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:

          • .com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE

          • .ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE

          • .es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM

          • .fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, and FI_ORGANIZATION_TYPE

          • .fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, and BIRTH_CITY

          • .it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE

          • .ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA

          • .se: BIRTH_COUNTRY and SE_ID_NUMBER

          • .sg: SG_ID_NUMBER

          • .co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER

          In addition, many TLDs require 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"
          • "ES_IDENTIFICATION"
          • "ES_IDENTIFICATION_TYPE"
          • "ES_LEGAL_FORM"
          • "FI_BUSINESS_NUMBER"
          • "FI_ID_NUMBER"
          • "FI_NATIONALITY"
          • "FI_ORGANIZATION_TYPE"
          • "IT_PIN"
          • "IT_REGISTRANT_ENTITY_TYPE"
          • "RU_PASSPORT_DATA"
          • "SE_ID_NUMBER"
          • "SG_ID_NUMBER"
          • "VAT_NUMBER"
          • "UK_CONTACT_TYPE"
          • "UK_COMPANY_NUMBER"
        • Value — required — (String)

          Values corresponding to the additional parameter names required by some top-level domains.

    • PrivacyProtectAdminContact — (Boolean)

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

      Default: true

    • PrivacyProtectRegistrantContact — (Boolean)

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

      Default: true

    • PrivacyProtectTechContact — (Boolean)

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

      Default: true

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.

renewDomain(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the renewDomain operation

var params = {
  CurrentExpiryYear: 'NUMBER_VALUE', /* required */
  DomainName: 'STRING_VALUE', /* required */
  DurationInYears: 'NUMBER_VALUE'
};
route53domains.renewDomain(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 renew.

    • DurationInYears — (Integer)

      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.

      Default: 1

    • CurrentExpiryYear — (Integer)

      The year when the registration for the domain is set to expire. This value must match the current expiration date 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:

      • OperationId — (String)

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

resendContactReachabilityEmail(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the resendContactReachabilityEmail operation

var params = {
  domainName: 'STRING_VALUE'
};
route53domains.resendContactReachabilityEmail(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 Amazon Route 53 to resend a confirmation email to the registrant contact.

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 a confirmation email.

      • emailAddress — (String)

        The email address for the registrant contact at the time that we sent the verification email.

      • isAlreadyVerified — (Boolean)

        True if the email address for the registrant contact has already been verified, and false otherwise. If the email address has already been verified, we don't send another confirmation email.

Returns:

  • (AWS.Request) —

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

retrieveDomainAuthCode(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the retrieveDomainAuthCode operation

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
route53domains.retrieveDomainAuthCode(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 an authorization code 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:

      • AuthCode — (String)

        The authorization code for the domain.

Returns:

  • (AWS.Request) —

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

transferDomain(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the transferDomain operation

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

      Constraints: 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 — (String)

      Reserved for future use.

    • DurationInYears — (Integer)

      The number of years that you want to register the domain for. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.

      Default: 1

    • Nameservers — (Array<map>)

      Contains details for the host and glue IP addresses.

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

    • AuthCode — (String)

      The authorization code for the domain. You get this value from the current registrar.

    • AutoRenew — (Boolean)

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

      Default: true

    • AdminContact — (map)

      Provides detailed contact information.

      • 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. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

        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:
        • "AD"
        • "AE"
        • "AF"
        • "AG"
        • "AI"
        • "AL"
        • "AM"
        • "AN"
        • "AO"
        • "AQ"
        • "AR"
        • "AS"
        • "AT"
        • "AU"
        • "AW"
        • "AZ"
        • "BA"
        • "BB"
        • "BD"
        • "BE"
        • "BF"
        • "BG"
        • "BH"
        • "BI"
        • "BJ"
        • "BL"
        • "BM"
        • "BN"
        • "BO"
        • "BR"
        • "BS"
        • "BT"
        • "BW"
        • "BY"
        • "BZ"
        • "CA"
        • "CC"
        • "CD"
        • "CF"
        • "CG"
        • "CH"
        • "CI"
        • "CK"
        • "CL"
        • "CM"
        • "CN"
        • "CO"
        • "CR"
        • "CU"
        • "CV"
        • "CX"
        • "CY"
        • "CZ"
        • "DE"
        • "DJ"
        • "DK"
        • "DM"
        • "DO"
        • "DZ"
        • "EC"
        • "EE"
        • "EG"
        • "ER"
        • "ES"
        • "ET"
        • "FI"
        • "FJ"
        • "FK"
        • "FM"
        • "FO"
        • "FR"
        • "GA"
        • "GB"
        • "GD"
        • "GE"
        • "GH"
        • "GI"
        • "GL"
        • "GM"
        • "GN"
        • "GQ"
        • "GR"
        • "GT"
        • "GU"
        • "GW"
        • "GY"
        • "HK"
        • "HN"
        • "HR"
        • "HT"
        • "HU"
        • "ID"
        • "IE"
        • "IL"
        • "IM"
        • "IN"
        • "IQ"
        • "IR"
        • "IS"
        • "IT"
        • "JM"
        • "JO"
        • "JP"
        • "KE"
        • "KG"
        • "KH"
        • "KI"
        • "KM"
        • "KN"
        • "KP"
        • "KR"
        • "KW"
        • "KY"
        • "KZ"
        • "LA"
        • "LB"
        • "LC"
        • "LI"
        • "LK"
        • "LR"
        • "LS"
        • "LT"
        • "LU"
        • "LV"
        • "LY"
        • "MA"
        • "MC"
        • "MD"
        • "ME"
        • "MF"
        • "MG"
        • "MH"
        • "MK"
        • "ML"
        • "MM"
        • "MN"
        • "MO"
        • "MP"
        • "MR"
        • "MS"
        • "MT"
        • "MU"
        • "MV"
        • "MW"
        • "MX"
        • "MY"
        • "MZ"
        • "NA"
        • "NC"
        • "NE"
        • "NG"
        • "NI"
        • "NL"
        • "NO"
        • "NP"
        • "NR"
        • "NU"
        • "NZ"
        • "OM"
        • "PA"
        • "PE"
        • "PF"
        • "PG"
        • "PH"
        • "PK"
        • "PL"
        • "PM"
        • "PN"
        • "PR"
        • "PT"
        • "PW"
        • "PY"
        • "QA"
        • "RO"
        • "RS"
        • "RU"
        • "RW"
        • "SA"
        • "SB"
        • "SC"
        • "SD"
        • "SE"
        • "SG"
        • "SH"
        • "SI"
        • "SK"
        • "SL"
        • "SM"
        • "SN"
        • "SO"
        • "SR"
        • "ST"
        • "SV"
        • "SY"
        • "SZ"
        • "TC"
        • "TD"
        • "TG"
        • "TH"
        • "TJ"
        • "TK"
        • "TL"
        • "TM"
        • "TN"
        • "TO"
        • "TR"
        • "TT"
        • "TV"
        • "TW"
        • "TZ"
        • "UA"
        • "UG"
        • "US"
        • "UY"
        • "UZ"
        • "VA"
        • "VC"
        • "VE"
        • "VG"
        • "VI"
        • "VN"
        • "VU"
        • "WF"
        • "WS"
        • "YE"
        • "YT"
        • "ZA"
        • "ZM"
        • "ZW"
      • ZipCode — (String)

        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)

          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:

          • .com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE

          • .ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE

          • .es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM

          • .fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, and FI_ORGANIZATION_TYPE

          • .fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, and BIRTH_CITY

          • .it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE

          • .ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA

          • .se: BIRTH_COUNTRY and SE_ID_NUMBER

          • .sg: SG_ID_NUMBER

          • .co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER

          In addition, many TLDs require 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"
          • "ES_IDENTIFICATION"
          • "ES_IDENTIFICATION_TYPE"
          • "ES_LEGAL_FORM"
          • "FI_BUSINESS_NUMBER"
          • "FI_ID_NUMBER"
          • "FI_NATIONALITY"
          • "FI_ORGANIZATION_TYPE"
          • "IT_PIN"
          • "IT_REGISTRANT_ENTITY_TYPE"
          • "RU_PASSPORT_DATA"
          • "SE_ID_NUMBER"
          • "SG_ID_NUMBER"
          • "VAT_NUMBER"
          • "UK_CONTACT_TYPE"
          • "UK_COMPANY_NUMBER"
        • Value — required — (String)

          Values corresponding to the additional parameter names required by some top-level domains.

    • RegistrantContact — (map)

      Provides detailed contact information.

      • 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. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

        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:
        • "AD"
        • "AE"
        • "AF"
        • "AG"
        • "AI"
        • "AL"
        • "AM"
        • "AN"
        • "AO"
        • "AQ"
        • "AR"
        • "AS"
        • "AT"
        • "AU"
        • "AW"
        • "AZ"
        • "BA"
        • "BB"
        • "BD"
        • "BE"
        • "BF"
        • "BG"
        • "BH"
        • "BI"
        • "BJ"
        • "BL"
        • "BM"
        • "BN"
        • "BO"
        • "BR"
        • "BS"
        • "BT"
        • "BW"
        • "BY"
        • "BZ"
        • "CA"
        • "CC"
        • "CD"
        • "CF"
        • "CG"
        • "CH"
        • "CI"
        • "CK"
        • "CL"
        • "CM"
        • "CN"
        • "CO"
        • "CR"
        • "CU"
        • "CV"
        • "CX"
        • "CY"
        • "CZ"
        • "DE"
        • "DJ"
        • "DK"
        • "DM"
        • "DO"
        • "DZ"
        • "EC"
        • "EE"
        • "EG"
        • "ER"
        • "ES"
        • "ET"
        • "FI"
        • "FJ"
        • "FK"
        • "FM"
        • "FO"
        • "FR"
        • "GA"
        • "GB"
        • "GD"
        • "GE"
        • "GH"
        • "GI"
        • "GL"
        • "GM"
        • "GN"
        • "GQ"
        • "GR"
        • "GT"
        • "GU"
        • "GW"
        • "GY"
        • "HK"
        • "HN"
        • "HR"
        • "HT"
        • "HU"
        • "ID"
        • "IE"
        • "IL"
        • "IM"
        • "IN"
        • "IQ"
        • "IR"
        • "IS"
        • "IT"
        • "JM"
        • "JO"
        • "JP"
        • "KE"
        • "KG"
        • "KH"
        • "KI"
        • "KM"
        • "KN"
        • "KP"
        • "KR"
        • "KW"
        • "KY"
        • "KZ"
        • "LA"
        • "LB"
        • "LC"
        • "LI"
        • "LK"
        • "LR"
        • "LS"
        • "LT"
        • "LU"
        • "LV"
        • "LY"
        • "MA"
        • "MC"
        • "MD"
        • "ME"
        • "MF"
        • "MG"
        • "MH"
        • "MK"
        • "ML"
        • "MM"
        • "MN"
        • "MO"
        • "MP"
        • "MR"
        • "MS"
        • "MT"
        • "MU"
        • "MV"
        • "MW"
        • "MX"
        • "MY"
        • "MZ"
        • "NA"
        • "NC"
        • "NE"
        • "NG"
        • "NI"
        • "NL"
        • "NO"
        • "NP"
        • "NR"
        • "NU"
        • "NZ"
        • "OM"
        • "PA"
        • "PE"
        • "PF"
        • "PG"
        • "PH"
        • "PK"
        • "PL"
        • "PM"
        • "PN"
        • "PR"
        • "PT"
        • "PW"
        • "PY"
        • "QA"
        • "RO"
        • "RS"
        • "RU"
        • "RW"
        • "SA"
        • "SB"
        • "SC"
        • "SD"
        • "SE"
        • "SG"
        • "SH"
        • "SI"
        • "SK"
        • "SL"
        • "SM"
        • "SN"
        • "SO"
        • "SR"
        • "ST"
        • "SV"
        • "SY"
        • "SZ"
        • "TC"
        • "TD"
        • "TG"
        • "TH"
        • "TJ"
        • "TK"
        • "TL"
        • "TM"
        • "TN"
        • "TO"
        • "TR"
        • "TT"
        • "TV"
        • "TW"
        • "TZ"
        • "UA"
        • "UG"
        • "US"
        • "UY"
        • "UZ"
        • "VA"
        • "VC"
        • "VE"
        • "VG"
        • "VI"
        • "VN"
        • "VU"
        • "WF"
        • "WS"
        • "YE"
        • "YT"
        • "ZA"
        • "ZM"
        • "ZW"
      • ZipCode — (String)

        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)

          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:

          • .com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE

          • .ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE

          • .es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM

          • .fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, and FI_ORGANIZATION_TYPE

          • .fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, and BIRTH_CITY

          • .it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE

          • .ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA

          • .se: BIRTH_COUNTRY and SE_ID_NUMBER

          • .sg: SG_ID_NUMBER

          • .co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER

          In addition, many TLDs require 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"
          • "ES_IDENTIFICATION"
          • "ES_IDENTIFICATION_TYPE"
          • "ES_LEGAL_FORM"
          • "FI_BUSINESS_NUMBER"
          • "FI_ID_NUMBER"
          • "FI_NATIONALITY"
          • "FI_ORGANIZATION_TYPE"
          • "IT_PIN"
          • "IT_REGISTRANT_ENTITY_TYPE"
          • "RU_PASSPORT_DATA"
          • "SE_ID_NUMBER"
          • "SG_ID_NUMBER"
          • "VAT_NUMBER"
          • "UK_CONTACT_TYPE"
          • "UK_COMPANY_NUMBER"
        • Value — required — (String)

          Values corresponding to the additional parameter names required by some top-level domains.

    • TechContact — (map)

      Provides detailed contact information.

      • 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. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

        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:
        • "AD"
        • "AE"
        • "AF"
        • "AG"
        • "AI"
        • "AL"
        • "AM"
        • "AN"
        • "AO"
        • "AQ"
        • "AR"
        • "AS"
        • "AT"
        • "AU"
        • "AW"
        • "AZ"
        • "BA"
        • "BB"
        • "BD"
        • "BE"
        • "BF"
        • "BG"
        • "BH"
        • "BI"
        • "BJ"
        • "BL"
        • "BM"
        • "BN"
        • "BO"
        • "BR"
        • "BS"
        • "BT"
        • "BW"
        • "BY"
        • "BZ"
        • "CA"
        • "CC"
        • "CD"
        • "CF"
        • "CG"
        • "CH"
        • "CI"
        • "CK"
        • "CL"
        • "CM"
        • "CN"
        • "CO"
        • "CR"
        • "CU"
        • "CV"
        • "CX"
        • "CY"
        • "CZ"
        • "DE"
        • "DJ"
        • "DK"
        • "DM"
        • "DO"
        • "DZ"
        • "EC"
        • "EE"
        • "EG"
        • "ER"
        • "ES"
        • "ET"
        • "FI"
        • "FJ"
        • "FK"
        • "FM"
        • "FO"
        • "FR"
        • "GA"
        • "GB"
        • "GD"
        • "GE"
        • "GH"
        • "GI"
        • "GL"
        • "GM"
        • "GN"
        • "GQ"
        • "GR"
        • "GT"
        • "GU"
        • "GW"
        • "GY"
        • "HK"
        • "HN"
        • "HR"
        • "HT"
        • "HU"
        • "ID"
        • "IE"
        • "IL"
        • "IM"
        • "IN"
        • "IQ"
        • "IR"
        • "IS"
        • "IT"
        • "JM"
        • "JO"
        • "JP"
        • "KE"
        • "KG"
        • "KH"
        • "KI"
        • "KM"
        • "KN"
        • "KP"
        • "KR"
        • "KW"
        • "KY"
        • "KZ"
        • "LA"
        • "LB"
        • "LC"
        • "LI"
        • "LK"
        • "LR"
        • "LS"
        • "LT"
        • "LU"
        • "LV"
        • "LY"
        • "MA"
        • "MC"
        • "MD"
        • "ME"
        • "MF"
        • "MG"
        • "MH"
        • "MK"
        • "ML"
        • "MM"
        • "MN"
        • "MO"
        • "MP"
        • "MR"
        • "MS"
        • "MT"
        • "MU"
        • "MV"
        • "MW"
        • "MX"
        • "MY"
        • "MZ"
        • "NA"
        • "NC"
        • "NE"
        • "NG"
        • "NI"
        • "NL"
        • "NO"
        • "NP"
        • "NR"
        • "NU"
        • "NZ"
        • "OM"
        • "PA"
        • "PE"
        • "PF"
        • "PG"
        • "PH"
        • "PK"
        • "PL"
        • "PM"
        • "PN"
        • "PR"
        • "PT"
        • "PW"
        • "PY"
        • "QA"
        • "RO"
        • "RS"
        • "RU"
        • "RW"
        • "SA"
        • "SB"
        • "SC"
        • "SD"
        • "SE"
        • "SG"
        • "SH"
        • "SI"
        • "SK"
        • "SL"
        • "SM"
        • "SN"
        • "SO"
        • "SR"
        • "ST"
        • "SV"
        • "SY"
        • "SZ"
        • "TC"
        • "TD"
        • "TG"
        • "TH"
        • "TJ"
        • "TK"
        • "TL"
        • "TM"
        • "TN"
        • "TO"
        • "TR"
        • "TT"
        • "TV"
        • "TW"
        • "TZ"
        • "UA"
        • "UG"
        • "US"
        • "UY"
        • "UZ"
        • "VA"
        • "VC"
        • "VE"
        • "VG"
        • "VI"
        • "VN"
        • "VU"
        • "WF"
        • "WS"
        • "YE"
        • "YT"
        • "ZA"
        • "ZM"
        • "ZW"
      • ZipCode — (String)

        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)

          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:

          • .com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE

          • .ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE

          • .es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM

          • .fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, and FI_ORGANIZATION_TYPE

          • .fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, and BIRTH_CITY

          • .it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE

          • .ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA

          • .se: BIRTH_COUNTRY and SE_ID_NUMBER

          • .sg: SG_ID_NUMBER

          • .co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER

          In addition, many TLDs require 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"
          • "ES_IDENTIFICATION"
          • "ES_IDENTIFICATION_TYPE"
          • "ES_LEGAL_FORM"
          • "FI_BUSINESS_NUMBER"
          • "FI_ID_NUMBER"
          • "FI_NATIONALITY"
          • "FI_ORGANIZATION_TYPE"
          • "IT_PIN"
          • "IT_REGISTRANT_ENTITY_TYPE"
          • "RU_PASSPORT_DATA"
          • "SE_ID_NUMBER"
          • "SG_ID_NUMBER"
          • "VAT_NUMBER"
          • "UK_CONTACT_TYPE"
          • "UK_COMPANY_NUMBER"
        • Value — required — (String)

          Values corresponding to the additional parameter names required by some top-level domains.

    • PrivacyProtectAdminContact — (Boolean)

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

      Default: true

    • PrivacyProtectRegistrantContact — (Boolean)

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

      Default: true

    • PrivacyProtectTechContact — (Boolean)

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

      Default: true

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.

updateDomainContact(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the updateDomainContact operation

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

    • AdminContact — (map)

      Provides detailed contact information.

      • 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. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

        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:
        • "AD"
        • "AE"
        • "AF"
        • "AG"
        • "AI"
        • "AL"
        • "AM"
        • "AN"
        • "AO"
        • "AQ"
        • "AR"
        • "AS"
        • "AT"
        • "AU"
        • "AW"
        • "AZ"
        • "BA"
        • "BB"
        • "BD"
        • "BE"
        • "BF"
        • "BG"
        • "BH"
        • "BI"
        • "BJ"
        • "BL"
        • "BM"
        • "BN"
        • "BO"
        • "BR"
        • "BS"
        • "BT"
        • "BW"
        • "BY"
        • "BZ"
        • "CA"
        • "CC"
        • "CD"
        • "CF"
        • "CG"
        • "CH"
        • "CI"
        • "CK"
        • "CL"
        • "CM"
        • "CN"
        • "CO"
        • "CR"
        • "CU"
        • "CV"
        • "CX"
        • "CY"
        • "CZ"
        • "DE"
        • "DJ"
        • "DK"
        • "DM"
        • "DO"
        • "DZ"
        • "EC"
        • "EE"
        • "EG"
        • "ER"
        • "ES"
        • "ET"
        • "FI"
        • "FJ"
        • "FK"
        • "FM"
        • "FO"
        • "FR"
        • "GA"
        • "GB"
        • "GD"
        • "GE"
        • "GH"
        • "GI"
        • "GL"
        • "GM"
        • "GN"
        • "GQ"
        • "GR"
        • "GT"
        • "GU"
        • "GW"
        • "GY"
        • "HK"
        • "HN"
        • "HR"
        • "HT"
        • "HU"
        • "ID"
        • "IE"
        • "IL"
        • "IM"
        • "IN"
        • "IQ"
        • "IR"
        • "IS"
        • "IT"
        • "JM"
        • "JO"
        • "JP"
        • "KE"
        • "KG"
        • "KH"
        • "KI"
        • "KM"
        • "KN"
        • "KP"
        • "KR"
        • "KW"
        • "KY"
        • "KZ"
        • "LA"
        • "LB"
        • "LC"
        • "LI"
        • "LK"
        • "LR"
        • "LS"
        • "LT"
        • "LU"
        • "LV"
        • "LY"
        • "MA"
        • "MC"
        • "MD"
        • "ME"
        • "MF"
        • "MG"
        • "MH"
        • "MK"
        • "ML"
        • "MM"
        • "MN"
        • "MO"
        • "MP"
        • "MR"
        • "MS"
        • "MT"
        • "MU"
        • "MV"
        • "MW"
        • "MX"
        • "MY"
        • "MZ"
        • "NA"
        • "NC"
        • "NE"
        • "NG"
        • "NI"
        • "NL"
        • "NO"
        • "NP"
        • "NR"
        • "NU"
        • "NZ"
        • "OM"
        • "PA"
        • "PE"
        • "PF"
        • "PG"
        • "PH"
        • "PK"
        • "PL"
        • "PM"
        • "PN"
        • "PR"
        • "PT"
        • "PW"
        • "PY"
        • "QA"
        • "RO"
        • "RS"
        • "RU"
        • "RW"
        • "SA"
        • "SB"
        • "SC"
        • "SD"
        • "SE"
        • "SG"
        • "SH"
        • "SI"
        • "SK"
        • "SL"
        • "SM"
        • "SN"
        • "SO"
        • "SR"
        • "ST"
        • "SV"
        • "SY"
        • "SZ"
        • "TC"
        • "TD"
        • "TG"
        • "TH"
        • "TJ"
        • "TK"
        • "TL"
        • "TM"
        • "TN"
        • "TO"
        • "TR"
        • "TT"
        • "TV"
        • "TW"
        • "TZ"
        • "UA"
        • "UG"
        • "US"
        • "UY"
        • "UZ"
        • "VA"
        • "VC"
        • "VE"
        • "VG"
        • "VI"
        • "VN"
        • "VU"
        • "WF"
        • "WS"
        • "YE"
        • "YT"
        • "ZA"
        • "ZM"
        • "ZW"
      • ZipCode — (String)

        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)

          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:

          • .com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE

          • .ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE

          • .es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM

          • .fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, and FI_ORGANIZATION_TYPE

          • .fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, and BIRTH_CITY

          • .it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE

          • .ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA

          • .se: BIRTH_COUNTRY and SE_ID_NUMBER

          • .sg: SG_ID_NUMBER

          • .co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER

          In addition, many TLDs require 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"
          • "ES_IDENTIFICATION"
          • "ES_IDENTIFICATION_TYPE"
          • "ES_LEGAL_FORM"
          • "FI_BUSINESS_NUMBER"
          • "FI_ID_NUMBER"
          • "FI_NATIONALITY"
          • "FI_ORGANIZATION_TYPE"
          • "IT_PIN"
          • "IT_REGISTRANT_ENTITY_TYPE"
          • "RU_PASSPORT_DATA"
          • "SE_ID_NUMBER"
          • "SG_ID_NUMBER"
          • "VAT_NUMBER"
          • "UK_CONTACT_TYPE"
          • "UK_COMPANY_NUMBER"
        • Value — required — (String)

          Values corresponding to the additional parameter names required by some top-level domains.

    • RegistrantContact — (map)

      Provides detailed contact information.

      • 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. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

        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:
        • "AD"
        • "AE"
        • "AF"
        • "AG"
        • "AI"
        • "AL"
        • "AM"
        • "AN"
        • "AO"
        • "AQ"
        • "AR"
        • "AS"
        • "AT"
        • "AU"
        • "AW"
        • "AZ"
        • "BA"
        • "BB"
        • "BD"
        • "BE"
        • "BF"
        • "BG"
        • "BH"
        • "BI"
        • "BJ"
        • "BL"
        • "BM"
        • "BN"
        • "BO"
        • "BR"
        • "BS"
        • "BT"
        • "BW"
        • "BY"
        • "BZ"
        • "CA"
        • "CC"
        • "CD"
        • "CF"
        • "CG"
        • "CH"
        • "CI"
        • "CK"
        • "CL"
        • "CM"
        • "CN"
        • "CO"
        • "CR"
        • "CU"
        • "CV"
        • "CX"
        • "CY"
        • "CZ"
        • "DE"
        • "DJ"
        • "DK"
        • "DM"
        • "DO"
        • "DZ"
        • "EC"
        • "EE"
        • "EG"
        • "ER"
        • "ES"
        • "ET"
        • "FI"
        • "FJ"
        • "FK"
        • "FM"
        • "FO"
        • "FR"
        • "GA"
        • "GB"
        • "GD"
        • "GE"
        • "GH"
        • "GI"
        • "GL"
        • "GM"
        • "GN"
        • "GQ"
        • "GR"
        • "GT"
        • "GU"
        • "GW"
        • "GY"
        • "HK"
        • "HN"
        • "HR"
        • "HT"
        • "HU"
        • "ID"
        • "IE"
        • "IL"
        • "IM"
        • "IN"
        • "IQ"
        • "IR"
        • "IS"
        • "IT"
        • "JM"
        • "JO"
        • "JP"
        • "KE"
        • "KG"
        • "KH"
        • "KI"
        • "KM"
        • "KN"
        • "KP"
        • "KR"
        • "KW"
        • "KY"
        • "KZ"
        • "LA"
        • "LB"
        • "LC"
        • "LI"
        • "LK"
        • "LR"
        • "LS"
        • "LT"
        • "LU"
        • "LV"
        • "LY"
        • "MA"
        • "MC"
        • "MD"
        • "ME"
        • "MF"
        • "MG"
        • "MH"
        • "MK"
        • "ML"
        • "MM"
        • "MN"
        • "MO"
        • "MP"
        • "MR"
        • "MS"
        • "MT"
        • "MU"
        • "MV"
        • "MW"
        • "MX"
        • "MY"
        • "MZ"
        • "NA"
        • "NC"
        • "NE"
        • "NG"
        • "NI"
        • "NL"
        • "NO"
        • "NP"
        • "NR"
        • "NU"
        • "NZ"
        • "OM"
        • "PA"
        • "PE"
        • "PF"
        • "PG"
        • "PH"
        • "PK"
        • "PL"
        • "PM"
        • "PN"
        • "PR"
        • "PT"
        • "PW"
        • "PY"
        • "QA"
        • "RO"
        • "RS"
        • "RU"
        • "RW"
        • "SA"
        • "SB"
        • "SC"
        • "SD"
        • "SE"
        • "SG"
        • "SH"
        • "SI"
        • "SK"
        • "SL"
        • "SM"
        • "SN"
        • "SO"
        • "SR"
        • "ST"
        • "SV"
        • "SY"
        • "SZ"
        • "TC"
        • "TD"
        • "TG"
        • "TH"
        • "TJ"
        • "TK"
        • "TL"
        • "TM"
        • "TN"
        • "TO"
        • "TR"
        • "TT"
        • "TV"
        • "TW"
        • "TZ"
        • "UA"
        • "UG"
        • "US"
        • "UY"
        • "UZ"
        • "VA"
        • "VC"
        • "VE"
        • "VG"
        • "VI"
        • "VN"
        • "VU"
        • "WF"
        • "WS"
        • "YE"
        • "YT"
        • "ZA"
        • "ZM"
        • "ZW"
      • ZipCode — (String)

        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)

          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:

          • .com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE

          • .ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE

          • .es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM

          • .fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, and FI_ORGANIZATION_TYPE

          • .fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, and BIRTH_CITY

          • .it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE

          • .ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA

          • .se: BIRTH_COUNTRY and SE_ID_NUMBER

          • .sg: SG_ID_NUMBER

          • .co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER

          In addition, many TLDs require 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"
          • "ES_IDENTIFICATION"
          • "ES_IDENTIFICATION_TYPE"
          • "ES_LEGAL_FORM"
          • "FI_BUSINESS_NUMBER"
          • "FI_ID_NUMBER"
          • "FI_NATIONALITY"
          • "FI_ORGANIZATION_TYPE"
          • "IT_PIN"
          • "IT_REGISTRANT_ENTITY_TYPE"
          • "RU_PASSPORT_DATA"
          • "SE_ID_NUMBER"
          • "SG_ID_NUMBER"
          • "VAT_NUMBER"
          • "UK_CONTACT_TYPE"
          • "UK_COMPANY_NUMBER"
        • Value — required — (String)

          Values corresponding to the additional parameter names required by some top-level domains.

    • TechContact — (map)

      Provides detailed contact information.

      • 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. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

        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:
        • "AD"
        • "AE"
        • "AF"
        • "AG"
        • "AI"
        • "AL"
        • "AM"
        • "AN"
        • "AO"
        • "AQ"
        • "AR"
        • "AS"
        • "AT"
        • "AU"
        • "AW"
        • "AZ"
        • "BA"
        • "BB"
        • "BD"
        • "BE"
        • "BF"
        • "BG"
        • "BH"
        • "BI"
        • "BJ"
        • "BL"
        • "BM"
        • "BN"
        • "BO"
        • "BR"
        • "BS"
        • "BT"
        • "BW"
        • "BY"
        • "BZ"
        • "CA"
        • "CC"
        • "CD"
        • "CF"
        • "CG"
        • "CH"
        • "CI"
        • "CK"
        • "CL"
        • "CM"
        • "CN"
        • "CO"
        • "CR"
        • "CU"
        • "CV"
        • "CX"
        • "CY"
        • "CZ"
        • "DE"
        • "DJ"
        • "DK"
        • "DM"
        • "DO"
        • "DZ"
        • "EC"
        • "EE"
        • "EG"
        • "ER"
        • "ES"
        • "ET"
        • "FI"
        • "FJ"
        • "FK"
        • "FM"
        • "FO"
        • "FR"
        • "GA"
        • "GB"
        • "GD"
        • "GE"
        • "GH"
        • "GI"
        • "GL"
        • "GM"
        • "GN"
        • "GQ"
        • "GR"
        • "GT"
        • "GU"
        • "GW"
        • "GY"
        • "HK"
        • "HN"
        • "HR"
        • "HT"
        • "HU"
        • "ID"
        • "IE"
        • "IL"
        • "IM"
        • "IN"
        • "IQ"
        • "IR"
        • "IS"
        • "IT"
        • "JM"
        • "JO"
        • "JP"
        • "KE"
        • "KG"
        • "KH"
        • "KI"
        • "KM"
        • "KN"
        • "KP"
        • "KR"
        • "KW"
        • "KY"
        • "KZ"
        • "LA"
        • "LB"
        • "LC"
        • "LI"
        • "LK"
        • "LR"
        • "LS"
        • "LT"
        • "LU"
        • "LV"
        • "LY"
        • "MA"
        • "MC"
        • "MD"
        • "ME"
        • "MF"
        • "MG"
        • "MH"
        • "MK"
        • "ML"
        • "MM"
        • "MN"
        • "MO"
        • "MP"
        • "MR"
        • "MS"
        • "MT"
        • "MU"
        • "MV"
        • "MW"
        • "MX"
        • "MY"
        • "MZ"
        • "NA"
        • "NC"
        • "NE"
        • "NG"
        • "NI"
        • "NL"
        • "NO"
        • "NP"
        • "NR"
        • "NU"
        • "NZ"
        • "OM"
        • "PA"
        • "PE"
        • "PF"
        • "PG"
        • "PH"
        • "PK"
        • "PL"
        • "PM"
        • "PN"
        • "PR"
        • "PT"
        • "PW"
        • "PY"
        • "QA"
        • "RO"
        • "RS"
        • "RU"
        • "RW"
        • "SA"
        • "SB"
        • "SC"
        • "SD"
        • "SE"
        • "SG"
        • "SH"
        • "SI"
        • "SK"
        • "SL"
        • "SM"
        • "SN"
        • "SO"
        • "SR"
        • "ST"
        • "SV"
        • "SY"
        • "SZ"
        • "TC"
        • "TD"
        • "TG"
        • "TH"
        • "TJ"
        • "TK"
        • "TL"
        • "TM"
        • "TN"
        • "TO"
        • "TR"
        • "TT"
        • "TV"
        • "TW"
        • "TZ"
        • "UA"
        • "UG"
        • "US"
        • "UY"
        • "UZ"
        • "VA"
        • "VC"
        • "VE"
        • "VG"
        • "VI"
        • "VN"
        • "VU"
        • "WF"
        • "WS"
        • "YE"
        • "YT"
        • "ZA"
        • "ZM"
        • "ZW"
      • ZipCode — (String)

        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)

          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:

          • .com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE

          • .ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE

          • .es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM

          • .fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, and FI_ORGANIZATION_TYPE

          • .fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, and BIRTH_CITY

          • .it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE

          • .ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA

          • .se: BIRTH_COUNTRY and SE_ID_NUMBER

          • .sg: SG_ID_NUMBER

          • .co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER

          In addition, many TLDs require 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"
          • "ES_IDENTIFICATION"
          • "ES_IDENTIFICATION_TYPE"
          • "ES_LEGAL_FORM"
          • "FI_BUSINESS_NUMBER"
          • "FI_ID_NUMBER"
          • "FI_NATIONALITY"
          • "FI_ORGANIZATION_TYPE"
          • "IT_PIN"
          • "IT_REGISTRANT_ENTITY_TYPE"
          • "RU_PASSPORT_DATA"
          • "SE_ID_NUMBER"
          • "SG_ID_NUMBER"
          • "VAT_NUMBER"
          • "UK_CONTACT_TYPE"
          • "UK_COMPANY_NUMBER"
        • Value — required — (String)

          Values corresponding to the additional parameter names required by some top-level domains.

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.

updateDomainContactPrivacy(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the updateDomainContactPrivacy operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  AdminPrivacy: true || false,
  RegistrantPrivacy: true || false,
  TechPrivacy: true || false
};
route53domains.updateDomainContactPrivacy(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 update the privacy setting for.

    • AdminPrivacy — (Boolean)

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

    • RegistrantPrivacy — (Boolean)

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

    • TechPrivacy — (Boolean)

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

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.

updateDomainNameservers(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the updateDomainNameservers operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  Nameservers: [ /* required */
    {
      Name: 'STRING_VALUE', /* required */
      GlueIps: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  FIAuthKey: 'STRING_VALUE'
};
route53domains.updateDomainNameservers(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 change name servers for.

    • FIAuthKey — (String)

      The authorization key for .fi domains

    • Nameservers — (Array<map>)

      A list of new name servers for 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.

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.

updateTagsForDomain(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the updateTagsForDomain operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  TagsToUpdate: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
route53domains.updateTagsForDomain(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 add or update tags.

    • TagsToUpdate — (Array<map>)

      A list of the tag keys and values that you want to add or update. If you specify a key that already exists, the corresponding value will be replaced.

      • Key — (String)

        The key (name) of a tag.

        Valid values: A-Z, a-z, 0-9, space, ".:/=+-@"

        Constraints: Each key can be 1-128 characters long.

      • Value — (String)

        The value of a tag.

        Valid values: A-Z, a-z, 0-9, space, ".:/=+-@"

        Constraints: Each value can be 0-256 characters long.

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.

viewBilling(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the viewBilling operation

var params = {
  End: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  Marker: 'STRING_VALUE',
  MaxItems: 'NUMBER_VALUE',
  Start: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
route53domains.viewBilling(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: {}) —
    • Start — (Date)

      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 — (Date)

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

    • Marker — (String)

      For an initial request for a list of billing records, omit this element. If the number of billing records that are associated with the current AWS account during the specified period is greater than the value that you specified for MaxItems, you can use Marker to return additional billing records. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

      Constraints: The marker must match the value of NextPageMarker that was returned in the previous response.

    • MaxItems — (Integer)

      The number of billing records to be returned.

      Default: 20

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:

      • NextPageMarker — (String)

        If there are more billing records than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker.

      • BillingRecords — (Array<map>)

        A summary of billing records.

        • DomainName — (String)

          The name of the domain that the billing record applies to. If the domain name contains characters other than a-z, 0-9, and - (hyphen), such as an internationalized domain name, then this value is in Punycode. For more information, see DNS Domain Name Format in the Amazon Route 53 Developer Guidezzz.

        • Operation — (String)

          The operation that you were charged for.

          Possible values include:
          • "REGISTER_DOMAIN"
          • "DELETE_DOMAIN"
          • "TRANSFER_IN_DOMAIN"
          • "UPDATE_DOMAIN_CONTACT"
          • "UPDATE_NAMESERVER"
          • "CHANGE_PRIVACY_PROTECTION"
          • "DOMAIN_LOCK"
          • "ENABLE_AUTORENEW"
          • "DISABLE_AUTORENEW"
          • "ADD_DNSSEC"
          • "REMOVE_DNSSEC"
          • "EXPIRE_DOMAIN"
          • "TRANSFER_OUT_DOMAIN"
          • "CHANGE_DOMAIN_OWNER"
          • "RENEW_DOMAIN"
          • "PUSH_DOMAIN"
        • InvoiceId — (String)

          The ID of the invoice that is associated with the billing record.

        • BillDate — (Date)

          The date that the operation was billed, in Unix format.

        • Price — (Float)

          The price that you were charged for the operation, in US dollars.

          Example value: 12.0

Returns:

  • (AWS.Request) —

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