Class: Aws::Route53Domains::Types::TransferDomainRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/types.rb

Overview

Note:

When making an API call, you may pass TransferDomainRequest data as a hash:

{
  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, CA_LEGAL_REPRESENTATIVE, CA_LEGAL_REPRESENTATIVE_CAPACITY, ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, ES_LEGAL_FORM, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, FI_ORGANIZATION_TYPE, IT_NATIONALITY, IT_PIN, IT_REGISTRANT_ENTITY_TYPE, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER, UK_CONTACT_TYPE, UK_COMPANY_NUMBER
        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, CA_LEGAL_REPRESENTATIVE, CA_LEGAL_REPRESENTATIVE_CAPACITY, ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, ES_LEGAL_FORM, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, FI_ORGANIZATION_TYPE, IT_NATIONALITY, IT_PIN, IT_REGISTRANT_ENTITY_TYPE, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER, UK_CONTACT_TYPE, UK_COMPANY_NUMBER
        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, CA_LEGAL_REPRESENTATIVE, CA_LEGAL_REPRESENTATIVE_CAPACITY, ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, ES_LEGAL_FORM, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, FI_ORGANIZATION_TYPE, IT_NATIONALITY, IT_PIN, IT_REGISTRANT_ENTITY_TYPE, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER, UK_CONTACT_TYPE, UK_COMPANY_NUMBER
        value: "ExtraParamValue", # required
      },
    ],
  },
  privacy_protect_admin_contact: false,
  privacy_protect_registrant_contact: false,
  privacy_protect_tech_contact: false,
}

The TransferDomain request includes the following elements.

Constant Summary collapse

SENSITIVE =
[:auth_code, :admin_contact, :registrant_contact, :tech_contact]

Instance Attribute Summary collapse

Instance Attribute Details

#admin_contactTypes::ContactDetail

Provides detailed contact information.



2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/types.rb', line 2459

class TransferDomainRequest < Struct.new(
  :domain_name,
  :idn_lang_code,
  :duration_in_years,
  :nameservers,
  :auth_code,
  :auto_renew,
  :admin_contact,
  :registrant_contact,
  :tech_contact,
  :privacy_protect_admin_contact,
  :privacy_protect_registrant_contact,
  :privacy_protect_tech_contact)
  SENSITIVE = [:auth_code, :admin_contact, :registrant_contact, :tech_contact]
  include Aws::Structure
end

#auth_codeString

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

Returns:

  • (String)


2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/types.rb', line 2459

class TransferDomainRequest < Struct.new(
  :domain_name,
  :idn_lang_code,
  :duration_in_years,
  :nameservers,
  :auth_code,
  :auto_renew,
  :admin_contact,
  :registrant_contact,
  :tech_contact,
  :privacy_protect_admin_contact,
  :privacy_protect_registrant_contact,
  :privacy_protect_tech_contact)
  SENSITIVE = [:auth_code, :admin_contact, :registrant_contact, :tech_contact]
  include Aws::Structure
end

#auto_renewBoolean

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

Default: true

Returns:

  • (Boolean)


2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/types.rb', line 2459

class TransferDomainRequest < Struct.new(
  :domain_name,
  :idn_lang_code,
  :duration_in_years,
  :nameservers,
  :auth_code,
  :auto_renew,
  :admin_contact,
  :registrant_contact,
  :tech_contact,
  :privacy_protect_admin_contact,
  :privacy_protect_registrant_contact,
  :privacy_protect_tech_contact)
  SENSITIVE = [:auth_code, :admin_contact, :registrant_contact, :tech_contact]
  include Aws::Structure
end

#domain_nameString

The name of the domain that you want to transfer to Route 53. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.

The domain name can contain only the following characters:

  • Letters a through z. Domain names are not case sensitive.

  • Numbers 0 through 9.

  • Hyphen (-). You can't specify a hyphen at the beginning or end of a label.

  • Period (.) to separate the labels in the name, such as the . in example.com.

Returns:

  • (String)


2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/types.rb', line 2459

class TransferDomainRequest < Struct.new(
  :domain_name,
  :idn_lang_code,
  :duration_in_years,
  :nameservers,
  :auth_code,
  :auto_renew,
  :admin_contact,
  :registrant_contact,
  :tech_contact,
  :privacy_protect_admin_contact,
  :privacy_protect_registrant_contact,
  :privacy_protect_tech_contact)
  SENSITIVE = [:auth_code, :admin_contact, :registrant_contact, :tech_contact]
  include Aws::Structure
end

#duration_in_yearsInteger

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

Returns:

  • (Integer)


2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/types.rb', line 2459

class TransferDomainRequest < Struct.new(
  :domain_name,
  :idn_lang_code,
  :duration_in_years,
  :nameservers,
  :auth_code,
  :auto_renew,
  :admin_contact,
  :registrant_contact,
  :tech_contact,
  :privacy_protect_admin_contact,
  :privacy_protect_registrant_contact,
  :privacy_protect_tech_contact)
  SENSITIVE = [:auth_code, :admin_contact, :registrant_contact, :tech_contact]
  include Aws::Structure
end

#idn_lang_codeString

Reserved for future use.

Returns:

  • (String)


2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/types.rb', line 2459

class TransferDomainRequest < Struct.new(
  :domain_name,
  :idn_lang_code,
  :duration_in_years,
  :nameservers,
  :auth_code,
  :auto_renew,
  :admin_contact,
  :registrant_contact,
  :tech_contact,
  :privacy_protect_admin_contact,
  :privacy_protect_registrant_contact,
  :privacy_protect_tech_contact)
  SENSITIVE = [:auth_code, :admin_contact, :registrant_contact, :tech_contact]
  include Aws::Structure
end

#nameserversArray<Types::Nameserver>

Contains details for the host and glue IP addresses.

Returns:



2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/types.rb', line 2459

class TransferDomainRequest < Struct.new(
  :domain_name,
  :idn_lang_code,
  :duration_in_years,
  :nameservers,
  :auth_code,
  :auto_renew,
  :admin_contact,
  :registrant_contact,
  :tech_contact,
  :privacy_protect_admin_contact,
  :privacy_protect_registrant_contact,
  :privacy_protect_tech_contact)
  SENSITIVE = [:auth_code, :admin_contact, :registrant_contact, :tech_contact]
  include Aws::Structure
end

#privacy_protect_admin_contactBoolean

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

Returns:

  • (Boolean)


2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/types.rb', line 2459

class TransferDomainRequest < Struct.new(
  :domain_name,
  :idn_lang_code,
  :duration_in_years,
  :nameservers,
  :auth_code,
  :auto_renew,
  :admin_contact,
  :registrant_contact,
  :tech_contact,
  :privacy_protect_admin_contact,
  :privacy_protect_registrant_contact,
  :privacy_protect_tech_contact)
  SENSITIVE = [:auth_code, :admin_contact, :registrant_contact, :tech_contact]
  include Aws::Structure
end

#privacy_protect_registrant_contactBoolean

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

Returns:

  • (Boolean)


2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/types.rb', line 2459

class TransferDomainRequest < Struct.new(
  :domain_name,
  :idn_lang_code,
  :duration_in_years,
  :nameservers,
  :auth_code,
  :auto_renew,
  :admin_contact,
  :registrant_contact,
  :tech_contact,
  :privacy_protect_admin_contact,
  :privacy_protect_registrant_contact,
  :privacy_protect_tech_contact)
  SENSITIVE = [:auth_code, :admin_contact, :registrant_contact, :tech_contact]
  include Aws::Structure
end

#privacy_protect_tech_contactBoolean

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

Returns:

  • (Boolean)


2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/types.rb', line 2459

class TransferDomainRequest < Struct.new(
  :domain_name,
  :idn_lang_code,
  :duration_in_years,
  :nameservers,
  :auth_code,
  :auto_renew,
  :admin_contact,
  :registrant_contact,
  :tech_contact,
  :privacy_protect_admin_contact,
  :privacy_protect_registrant_contact,
  :privacy_protect_tech_contact)
  SENSITIVE = [:auth_code, :admin_contact, :registrant_contact, :tech_contact]
  include Aws::Structure
end

#registrant_contactTypes::ContactDetail

Provides detailed contact information.



2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/types.rb', line 2459

class TransferDomainRequest < Struct.new(
  :domain_name,
  :idn_lang_code,
  :duration_in_years,
  :nameservers,
  :auth_code,
  :auto_renew,
  :admin_contact,
  :registrant_contact,
  :tech_contact,
  :privacy_protect_admin_contact,
  :privacy_protect_registrant_contact,
  :privacy_protect_tech_contact)
  SENSITIVE = [:auth_code, :admin_contact, :registrant_contact, :tech_contact]
  include Aws::Structure
end

#tech_contactTypes::ContactDetail

Provides detailed contact information.



2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/types.rb', line 2459

class TransferDomainRequest < Struct.new(
  :domain_name,
  :idn_lang_code,
  :duration_in_years,
  :nameservers,
  :auth_code,
  :auto_renew,
  :admin_contact,
  :registrant_contact,
  :tech_contact,
  :privacy_protect_admin_contact,
  :privacy_protect_registrant_contact,
  :privacy_protect_tech_contact)
  SENSITIVE = [:auth_code, :admin_contact, :registrant_contact, :tech_contact]
  include Aws::Structure
end