You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Route53Domains::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(*args) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

    a customizable set of options



152
153
154
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 152

def initialize(*args)
  super
end

Instance Method Details

#check_domain_availability(params = {}) ⇒ Types::CheckDomainAvailabilityResponse

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.

Examples:

Request syntax with placeholder values


resp = client.check_domain_availability({
  domain_name: "DomainName", # required
  idn_lang_code: "LangCode",
})

Response structure


resp.availability #=> String, one of "AVAILABLE", "AVAILABLE_RESERVED", "AVAILABLE_PREORDER", "UNAVAILABLE", "UNAVAILABLE_PREMIUM", "UNAVAILABLE_RESTRICTED", "RESERVED", "DONT_KNOW"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_name (required, 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.

  • :idn_lang_code (String)

    Reserved for future use.

Returns:

See Also:



191
192
193
194
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 191

def check_domain_availability(params = {}, options = {})
  req = build_request(:check_domain_availability, params)
  req.send_request(options)
end

#delete_tags_for_domain(params = {}) ⇒ Struct

This operation deletes the specified tags for a domain.

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

Examples:

Request syntax with placeholder values


resp = client.delete_tags_for_domain({
  domain_name: "DomainName", # required
  tags_to_delete: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_name (required, String)

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

  • :tags_to_delete (required, Array<String>)

    A list of tag keys to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



220
221
222
223
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 220

def delete_tags_for_domain(params = {}, options = {})
  req = build_request(:delete_tags_for_domain, params)
  req.send_request(options)
end

#disable_domain_auto_renew(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.disable_domain_auto_renew({
  domain_name: "DomainName", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_name (required, String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



243
244
245
246
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 243

def disable_domain_auto_renew(params = {}, options = {})
  req = build_request(:disable_domain_auto_renew, params)
  req.send_request(options)
end

#disable_domain_transfer_lock(params = {}) ⇒ Types::DisableDomainTransferLockResponse

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.

Examples:

Request syntax with placeholder values


resp = client.disable_domain_transfer_lock({
  domain_name: "DomainName", # required
})

Response structure


resp.operation_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_name (required, String)

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

Returns:

See Also:



277
278
279
280
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 277

def disable_domain_transfer_lock(params = {}, options = {})
  req = build_request(:disable_domain_transfer_lock, params)
  req.send_request(options)
end

#enable_domain_auto_renew(params = {}) ⇒ Struct

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 partner, Gandi. 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.

Examples:

Request syntax with placeholder values


resp = client.enable_domain_auto_renew({
  domain_name: "DomainName", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_name (required, String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



312
313
314
315
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 312

def enable_domain_auto_renew(params = {}, options = {})
  req = build_request(:enable_domain_auto_renew, params)
  req.send_request(options)
end

#enable_domain_transfer_lock(params = {}) ⇒ Types::EnableDomainTransferLockResponse

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.

Examples:

Request syntax with placeholder values


resp = client.enable_domain_transfer_lock({
  domain_name: "DomainName", # required
})

Response structure


resp.operation_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_name (required, String)

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

Returns:

See Also:



345
346
347
348
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 345

def enable_domain_transfer_lock(params = {}, options = {})
  req = build_request(:enable_domain_transfer_lock, params)
  req.send_request(options)
end

#get_contact_reachability_status(params = {}) ⇒ Types::GetContactReachabilityStatusResponse

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.

Examples:

Request syntax with placeholder values


resp = client.get_contact_reachability_status({
  domain_name: "DomainName",
})

Response structure


resp.domain_name #=> String
resp.status #=> String, one of "PENDING", "DONE", "EXPIRED"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_name (String)

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

Returns:

See Also:



382
383
384
385
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 382

def get_contact_reachability_status(params = {}, options = {})
  req = build_request(:get_contact_reachability_status, params)
  req.send_request(options)
end

#get_domain_detail(params = {}) ⇒ Types::GetDomainDetailResponse

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.

Examples:

Request syntax with placeholder values


resp = client.get_domain_detail({
  domain_name: "DomainName", # required
})

Response structure


resp.domain_name #=> String
resp.nameservers #=> Array
resp.nameservers[0].name #=> String
resp.nameservers[0].glue_ips #=> Array
resp.nameservers[0].glue_ips[0] #=> String
resp.auto_renew #=> Boolean
resp.admin_contact.first_name #=> String
resp.admin_contact.last_name #=> String
resp.admin_contact.contact_type #=> String, one of "PERSON", "COMPANY", "ASSOCIATION", "PUBLIC_BODY", "RESELLER"
resp.admin_contact.organization_name #=> String
resp.admin_contact.address_line_1 #=> String
resp.admin_contact.address_line_2 #=> String
resp.admin_contact.city #=> String
resp.admin_contact.state #=> String
resp.admin_contact.country_code #=> String, one of "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"
resp.admin_contact.zip_code #=> String
resp.admin_contact.phone_number #=> String
resp.admin_contact.email #=> String
resp.admin_contact.fax #=> String
resp.admin_contact.extra_params #=> Array
resp.admin_contact.extra_params[0].name #=> String, one of "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", "IT_PIN", "RU_PASSPORT_DATA", "SE_ID_NUMBER", "SG_ID_NUMBER", "VAT_NUMBER"
resp.admin_contact.extra_params[0].value #=> String
resp.registrant_contact.first_name #=> String
resp.registrant_contact.last_name #=> String
resp.registrant_contact.contact_type #=> String, one of "PERSON", "COMPANY", "ASSOCIATION", "PUBLIC_BODY", "RESELLER"
resp.registrant_contact.organization_name #=> String
resp.registrant_contact.address_line_1 #=> String
resp.registrant_contact.address_line_2 #=> String
resp.registrant_contact.city #=> String
resp.registrant_contact.state #=> String
resp.registrant_contact.country_code #=> String, one of "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"
resp.registrant_contact.zip_code #=> String
resp.registrant_contact.phone_number #=> String
resp.registrant_contact.email #=> String
resp.registrant_contact.fax #=> String
resp.registrant_contact.extra_params #=> Array
resp.registrant_contact.extra_params[0].name #=> String, one of "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", "IT_PIN", "RU_PASSPORT_DATA", "SE_ID_NUMBER", "SG_ID_NUMBER", "VAT_NUMBER"
resp.registrant_contact.extra_params[0].value #=> String
resp.tech_contact.first_name #=> String
resp.tech_contact.last_name #=> String
resp.tech_contact.contact_type #=> String, one of "PERSON", "COMPANY", "ASSOCIATION", "PUBLIC_BODY", "RESELLER"
resp.tech_contact.organization_name #=> String
resp.tech_contact.address_line_1 #=> String
resp.tech_contact.address_line_2 #=> String
resp.tech_contact.city #=> String
resp.tech_contact.state #=> String
resp.tech_contact.country_code #=> String, one of "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"
resp.tech_contact.zip_code #=> String
resp.tech_contact.phone_number #=> String
resp.tech_contact.email #=> String
resp.tech_contact.fax #=> String
resp.tech_contact.extra_params #=> Array
resp.tech_contact.extra_params[0].name #=> String, one of "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", "IT_PIN", "RU_PASSPORT_DATA", "SE_ID_NUMBER", "SG_ID_NUMBER", "VAT_NUMBER"
resp.tech_contact.extra_params[0].value #=> String
resp.admin_privacy #=> Boolean
resp.registrant_privacy #=> Boolean
resp.tech_privacy #=> Boolean
resp.registrar_name #=> String
resp.who_is_server #=> String
resp.registrar_url #=> String
resp.abuse_contact_email #=> String
resp.abuse_contact_phone #=> String
resp.registry_domain_id #=> String
resp.creation_date #=> Time
resp.updated_date #=> Time
resp.expiration_date #=> Time
resp.reseller #=> String
resp.dns_sec #=> String
resp.status_list #=> Array
resp.status_list[0] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_name (required, String)

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

Returns:

See Also:



502
503
504
505
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 502

def get_domain_detail(params = {}, options = {})
  req = build_request(:get_domain_detail, params)
  req.send_request(options)
end

#get_domain_suggestions(params = {}) ⇒ Types::GetDomainSuggestionsResponse

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

Examples:

Request syntax with placeholder values


resp = client.get_domain_suggestions({
  domain_name: "DomainName", # required
  suggestion_count: 1, # required
  only_available: false, # required
})

Response structure


resp.suggestions_list #=> Array
resp.suggestions_list[0].domain_name #=> String
resp.suggestions_list[0].availability #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_name (required, 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.

  • :suggestion_count (required, Integer)

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

  • :only_available (required, 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.

Returns:

See Also:



555
556
557
558
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 555

def get_domain_suggestions(params = {}, options = {})
  req = build_request(:get_domain_suggestions, params)
  req.send_request(options)
end

#get_operation_detail(params = {}) ⇒ Types::GetOperationDetailResponse

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

Examples:

Request syntax with placeholder values


resp = client.get_operation_detail({
  operation_id: "OperationId", # required
})

Response structure


resp.operation_id #=> String
resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "ERROR", "SUCCESSFUL", "FAILED"
resp.message #=> String
resp.domain_name #=> String
resp.type #=> String, one of "REGISTER_DOMAIN", "DELETE_DOMAIN", "TRANSFER_IN_DOMAIN", "UPDATE_DOMAIN_CONTACT", "UPDATE_NAMESERVER", "CHANGE_PRIVACY_PROTECTION", "DOMAIN_LOCK"
resp. #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :operation_id (required, 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.

Returns:

See Also:



596
597
598
599
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 596

def get_operation_detail(params = {}, options = {})
  req = build_request(:get_operation_detail, params)
  req.send_request(options)
end

#list_domains(params = {}) ⇒ Types::ListDomainsResponse

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

Examples:

Request syntax with placeholder values


resp = client.list_domains({
  marker: "PageMarker",
  max_items: 1,
})

Response structure


resp.domains #=> Array
resp.domains[0].domain_name #=> String
resp.domains[0].auto_renew #=> Boolean
resp.domains[0].transfer_lock #=> Boolean
resp.domains[0].expiry #=> Time
resp.next_page_marker #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

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

  • :max_items (Integer)

    Number of domains to be returned.

    Default: 20

Returns:

See Also:



646
647
648
649
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 646

def list_domains(params = {}, options = {})
  req = build_request(:list_domains, params)
  req.send_request(options)
end

#list_operations(params = {}) ⇒ Types::ListOperationsResponse

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

Examples:

Request syntax with placeholder values


resp = client.list_operations({
  marker: "PageMarker",
  max_items: 1,
})

Response structure


resp.operations #=> Array
resp.operations[0].operation_id #=> String
resp.operations[0].status #=> String, one of "SUBMITTED", "IN_PROGRESS", "ERROR", "SUCCESSFUL", "FAILED"
resp.operations[0].type #=> String, one of "REGISTER_DOMAIN", "DELETE_DOMAIN", "TRANSFER_IN_DOMAIN", "UPDATE_DOMAIN_CONTACT", "UPDATE_NAMESERVER", "CHANGE_PRIVACY_PROTECTION", "DOMAIN_LOCK"
resp.operations[0]. #=> Time
resp.next_page_marker #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

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

  • :max_items (Integer)

    Number of domains to be returned.

    Default: 20

Returns:

See Also:



692
693
694
695
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 692

def list_operations(params = {}, options = {})
  req = build_request(:list_operations, params)
  req.send_request(options)
end

#list_tags_for_domain(params = {}) ⇒ Types::ListTagsForDomainResponse

This operation returns all of the tags that are associated with the specified domain.

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

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_domain({
  domain_name: "DomainName", # required
})

Response structure


resp.tag_list #=> Array
resp.tag_list[0].key #=> String
resp.tag_list[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_name (required, String)

    The domain for which you want to get a list of tags.

Returns:

See Also:



726
727
728
729
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 726

def list_tags_for_domain(params = {}, options = {})
  req = build_request(:list_tags_for_domain, params)
  req.send_request(options)
end

#register_domain(params = {}) ⇒ Types::RegisterDomainResponse

This operation registers a domain. Domains are registered by the AWS registrar partner, Gandi. 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 for our registrar partner, Gandi, instead of the information you entered for 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.

Examples:

Request syntax with placeholder values


resp = client.register_domain({
  domain_name: "DomainName", # required
  idn_lang_code: "LangCode",
  duration_in_years: 1, # required
  auto_renew: false,
  admin_contact: { # required
    first_name: "ContactName",
    last_name: "ContactName",
    contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER
    organization_name: "ContactName",
    address_line_1: "AddressLine",
    address_line_2: "AddressLine",
    city: "City",
    state: "State",
    country_code: "AD", # accepts 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
    zip_code: "ZipCode",
    phone_number: "ContactNumber",
    email: "Email",
    fax: "ContactNumber",
    extra_params: [
      {
        name: "DUNS_NUMBER", # required, accepts 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, IT_PIN, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER
        value: "ExtraParamValue", # required
      },
    ],
  },
  registrant_contact: { # required
    first_name: "ContactName",
    last_name: "ContactName",
    contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER
    organization_name: "ContactName",
    address_line_1: "AddressLine",
    address_line_2: "AddressLine",
    city: "City",
    state: "State",
    country_code: "AD", # accepts 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
    zip_code: "ZipCode",
    phone_number: "ContactNumber",
    email: "Email",
    fax: "ContactNumber",
    extra_params: [
      {
        name: "DUNS_NUMBER", # required, accepts 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, IT_PIN, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER
        value: "ExtraParamValue", # required
      },
    ],
  },
  tech_contact: { # required
    first_name: "ContactName",
    last_name: "ContactName",
    contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER
    organization_name: "ContactName",
    address_line_1: "AddressLine",
    address_line_2: "AddressLine",
    city: "City",
    state: "State",
    country_code: "AD", # accepts 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
    zip_code: "ZipCode",
    phone_number: "ContactNumber",
    email: "Email",
    fax: "ContactNumber",
    extra_params: [
      {
        name: "DUNS_NUMBER", # required, accepts 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, IT_PIN, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER
        value: "ExtraParamValue", # required
      },
    ],
  },
  privacy_protect_admin_contact: false,
  privacy_protect_registrant_contact: false,
  privacy_protect_tech_contact: false,
})

Response structure


resp.operation_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_name (required, 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.

  • :idn_lang_code (String)

    Reserved for future use.

  • :duration_in_years (required, Integer)

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

    Default: 1

  • :auto_renew (Boolean)

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

    Default: true

  • :admin_contact (required, Types::ContactDetail)

    Provides detailed contact information.

  • :registrant_contact (required, Types::ContactDetail)

    Provides detailed contact information.

  • :tech_contact (required, Types::ContactDetail)

    Provides detailed contact information.

  • :privacy_protect_admin_contact (Boolean)

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

    Default: true

  • :privacy_protect_registrant_contact (Boolean)

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

    Default: true

  • :privacy_protect_tech_contact (Boolean)

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

    Default: true

Returns:

See Also:



912
913
914
915
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 912

def register_domain(params = {}, options = {})
  req = build_request(:register_domain, params)
  req.send_request(options)
end

#renew_domain(params = {}) ⇒ Types::RenewDomainResponse

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.

Examples:

Request syntax with placeholder values


resp = client.renew_domain({
  domain_name: "DomainName", # required
  duration_in_years: 1,
  current_expiry_year: 1, # required
})

Response structure


resp.operation_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_name (required, String)

    The name of the domain that you want to renew.

  • :duration_in_years (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

  • :current_expiry_year (required, Integer)

    The year when the registration for the domain is set to expire. This value must match the current expiration date for the domain.

Returns:

See Also:



969
970
971
972
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 969

def renew_domain(params = {}, options = {})
  req = build_request(:renew_domain, params)
  req.send_request(options)
end

#resend_contact_reachability_email(params = {}) ⇒ Types::ResendContactReachabilityEmailResponse

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.

Examples:

Request syntax with placeholder values


resp = client.resend_contact_reachability_email({
  domain_name: "DomainName",
})

Response structure


resp.domain_name #=> String
resp.email_address #=> String
resp.is_already_verified #=> Boolean

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_name (String)

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

Returns:

See Also:



1005
1006
1007
1008
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 1005

def resend_contact_reachability_email(params = {}, options = {})
  req = build_request(:resend_contact_reachability_email, params)
  req.send_request(options)
end

#retrieve_domain_auth_code(params = {}) ⇒ Types::RetrieveDomainAuthCodeResponse

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

Examples:

Request syntax with placeholder values


resp = client.retrieve_domain_auth_code({
  domain_name: "DomainName", # required
})

Response structure


resp.auth_code #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_name (required, String)

    The name of the domain that you want to get an authorization code for.

Returns:

See Also:



1035
1036
1037
1038
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 1035

def retrieve_domain_auth_code(params = {}, options = {})
  req = build_request(:retrieve_domain_auth_code, params)
  req.send_request(options)
end

#transfer_domain(params = {}) ⇒ Types::TransferDomainResponse

This operation transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered with the AWS registrar partner, Gandi.

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.

Examples:

Request syntax with placeholder values


resp = client.transfer_domain({
  domain_name: "DomainName", # required
  idn_lang_code: "LangCode",
  duration_in_years: 1, # required
  nameservers: [
    {
      name: "HostName", # required
      glue_ips: ["GlueIp"],
    },
  ],
  auth_code: "DomainAuthCode",
  auto_renew: false,
  admin_contact: { # required
    first_name: "ContactName",
    last_name: "ContactName",
    contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER
    organization_name: "ContactName",
    address_line_1: "AddressLine",
    address_line_2: "AddressLine",
    city: "City",
    state: "State",
    country_code: "AD", # accepts 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
    zip_code: "ZipCode",
    phone_number: "ContactNumber",
    email: "Email",
    fax: "ContactNumber",
    extra_params: [
      {
        name: "DUNS_NUMBER", # required, accepts 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, IT_PIN, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER
        value: "ExtraParamValue", # required
      },
    ],
  },
  registrant_contact: { # required
    first_name: "ContactName",
    last_name: "ContactName",
    contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER
    organization_name: "ContactName",
    address_line_1: "AddressLine",
    address_line_2: "AddressLine",
    city: "City",
    state: "State",
    country_code: "AD", # accepts 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
    zip_code: "ZipCode",
    phone_number: "ContactNumber",
    email: "Email",
    fax: "ContactNumber",
    extra_params: [
      {
        name: "DUNS_NUMBER", # required, accepts 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, IT_PIN, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER
        value: "ExtraParamValue", # required
      },
    ],
  },
  tech_contact: { # required
    first_name: "ContactName",
    last_name: "ContactName",
    contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER
    organization_name: "ContactName",
    address_line_1: "AddressLine",
    address_line_2: "AddressLine",
    city: "City",
    state: "State",
    country_code: "AD", # accepts 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
    zip_code: "ZipCode",
    phone_number: "ContactNumber",
    email: "Email",
    fax: "ContactNumber",
    extra_params: [
      {
        name: "DUNS_NUMBER", # required, accepts 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, IT_PIN, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER
        value: "ExtraParamValue", # required
      },
    ],
  },
  privacy_protect_admin_contact: false,
  privacy_protect_registrant_contact: false,
  privacy_protect_tech_contact: false,
})

Response structure


resp.operation_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_name (required, 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.

  • :idn_lang_code (String)

    Reserved for future use.

  • :duration_in_years (required, 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<Types::Nameserver>)

    Contains details for the host and glue IP addresses.

  • :auth_code (String)

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

  • :auto_renew (Boolean)

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

    Default: true

  • :admin_contact (required, Types::ContactDetail)

    Provides detailed contact information.

  • :registrant_contact (required, Types::ContactDetail)

    Provides detailed contact information.

  • :tech_contact (required, Types::ContactDetail)

    Provides detailed contact information.

  • :privacy_protect_admin_contact (Boolean)

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

    Default: true

  • :privacy_protect_registrant_contact (Boolean)

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

    Default: true

  • :privacy_protect_tech_contact (Boolean)

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

    Default: true

Returns:

See Also:



1229
1230
1231
1232
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 1229

def transfer_domain(params = {}, options = {})
  req = build_request(:transfer_domain, params)
  req.send_request(options)
end

#update_domain_contact(params = {}) ⇒ Types::UpdateDomainContactResponse

This operation updates the contact information for a particular domain. Information for at least one contact (registrant, administrator, or technical) must be supplied for update.

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.

Examples:

Request syntax with placeholder values


resp = client.update_domain_contact({
  domain_name: "DomainName", # required
  admin_contact: {
    first_name: "ContactName",
    last_name: "ContactName",
    contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER
    organization_name: "ContactName",
    address_line_1: "AddressLine",
    address_line_2: "AddressLine",
    city: "City",
    state: "State",
    country_code: "AD", # accepts 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
    zip_code: "ZipCode",
    phone_number: "ContactNumber",
    email: "Email",
    fax: "ContactNumber",
    extra_params: [
      {
        name: "DUNS_NUMBER", # required, accepts 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, IT_PIN, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER
        value: "ExtraParamValue", # required
      },
    ],
  },
  registrant_contact: {
    first_name: "ContactName",
    last_name: "ContactName",
    contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER
    organization_name: "ContactName",
    address_line_1: "AddressLine",
    address_line_2: "AddressLine",
    city: "City",
    state: "State",
    country_code: "AD", # accepts 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
    zip_code: "ZipCode",
    phone_number: "ContactNumber",
    email: "Email",
    fax: "ContactNumber",
    extra_params: [
      {
        name: "DUNS_NUMBER", # required, accepts 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, IT_PIN, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER
        value: "ExtraParamValue", # required
      },
    ],
  },
  tech_contact: {
    first_name: "ContactName",
    last_name: "ContactName",
    contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER
    organization_name: "ContactName",
    address_line_1: "AddressLine",
    address_line_2: "AddressLine",
    city: "City",
    state: "State",
    country_code: "AD", # accepts 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
    zip_code: "ZipCode",
    phone_number: "ContactNumber",
    email: "Email",
    fax: "ContactNumber",
    extra_params: [
      {
        name: "DUNS_NUMBER", # required, accepts 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, IT_PIN, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER
        value: "ExtraParamValue", # required
      },
    ],
  },
})

Response structure


resp.operation_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_name (required, String)

    The name of the domain that you want to update contact information for.

  • :admin_contact (Types::ContactDetail)

    Provides detailed contact information.

  • :registrant_contact (Types::ContactDetail)

    Provides detailed contact information.

  • :tech_contact (Types::ContactDetail)

    Provides detailed contact information.

Returns:

See Also:



1337
1338
1339
1340
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 1337

def update_domain_contact(params = {}, options = {})
  req = build_request(:update_domain_contact, params)
  req.send_request(options)
end

#update_domain_contact_privacy(params = {}) ⇒ Types::UpdateDomainContactPrivacyResponse

This operation updates the specified domain contact's privacy setting. When the privacy option is enabled, personal information such as postal or email address is hidden from the results of a public WHOIS query. The privacy services are provided by the AWS registrar, Gandi. For more information, see the Gandi privacy features.

This operation only affects the privacy of the specified contact type (registrant, administrator, or tech). Successful acceptance returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

Examples:

Request syntax with placeholder values


resp = client.update_domain_contact_privacy({
  domain_name: "DomainName", # required
  admin_privacy: false,
  registrant_privacy: false,
  tech_privacy: false,
})

Response structure


resp.operation_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_name (required, String)

    The name of the domain that you want to update the privacy setting for.

  • :admin_privacy (Boolean)

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

  • :registrant_privacy (Boolean)

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

  • :tech_privacy (Boolean)

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Returns:

See Also:



1401
1402
1403
1404
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 1401

def update_domain_contact_privacy(params = {}, options = {})
  req = build_request(:update_domain_contact_privacy, params)
  req.send_request(options)
end

#update_domain_nameservers(params = {}) ⇒ Types::UpdateDomainNameserversResponse

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.

Examples:

Request syntax with placeholder values


resp = client.update_domain_nameservers({
  domain_name: "DomainName", # required
  fi_auth_key: "FIAuthKey",
  nameservers: [ # required
    {
      name: "HostName", # required
      glue_ips: ["GlueIp"],
    },
  ],
})

Response structure


resp.operation_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_name (required, String)

    The name of the domain that you want to change name servers for.

  • :fi_auth_key (String)

    The authorization key for .fi domains

  • :nameservers (required, Array<Types::Nameserver>)

    A list of new name servers for the domain.

Returns:

See Also:



1450
1451
1452
1453
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 1450

def update_domain_nameservers(params = {}, options = {})
  req = build_request(:update_domain_nameservers, params)
  req.send_request(options)
end

#update_tags_for_domain(params = {}) ⇒ Struct

This operation adds or updates tags for a specified domain.

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

Examples:

Request syntax with placeholder values


resp = client.update_tags_for_domain({
  domain_name: "DomainName", # required
  tags_to_update: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_name (required, String)

    The domain for which you want to add or update tags.

  • :tags_to_update (Array<Types::Tag>)

    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.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1486
1487
1488
1489
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 1486

def update_tags_for_domain(params = {}, options = {})
  req = build_request(:update_tags_for_domain, params)
  req.send_request(options)
end

#view_billing(params = {}) ⇒ Types::ViewBillingResponse

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

Examples:

Request syntax with placeholder values


resp = client.view_billing({
  start: Time.now,
  end: Time.now,
  marker: "PageMarker",
  max_items: 1,
})

Response structure


resp.next_page_marker #=> String
resp.billing_records #=> Array
resp.billing_records[0].domain_name #=> String
resp.billing_records[0].operation #=> String, one of "REGISTER_DOMAIN", "DELETE_DOMAIN", "TRANSFER_IN_DOMAIN", "UPDATE_DOMAIN_CONTACT", "UPDATE_NAMESERVER", "CHANGE_PRIVACY_PROTECTION", "DOMAIN_LOCK"
resp.billing_records[0].invoice_id #=> String
resp.billing_records[0].bill_date #=> Time
resp.billing_records[0].price #=> Float

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :start (Time, DateTime, Date, Integer, String)

    The beginning date and time for the time period for which you want a list of billing records. Specify the date in Unix time format.

  • :end (Time, DateTime, Date, Integer, String)

    The end date and time for the time period for which you want a list of billing records. Specify the date in Unix time format.

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

  • :max_items (Integer)

    The number of billing records to be returned.

    Default: 20

Returns:

See Also:



1547
1548
1549
1550
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 1547

def view_billing(params = {}, options = {})
  req = build_request(:view_billing, params)
  req.send_request(options)
end