Module Smaws_Client_Route53Domains.Types

type nonrec zip_code = string
type nonrec page_marker = string
type nonrec domain_name = string
type nonrec operation_type =
  1. | RESTORE_DOMAIN
  2. | TRANSFER_ON_RENEW
  3. | RELEASE_TO_GANDI
  4. | INTERNAL_TRANSFER_IN_DOMAIN
  5. | INTERNAL_TRANSFER_OUT_DOMAIN
  6. | PUSH_DOMAIN
  7. | RENEW_DOMAIN
  8. | CHANGE_DOMAIN_OWNER
  9. | TRANSFER_OUT_DOMAIN
  10. | EXPIRE_DOMAIN
  11. | REMOVE_DNSSEC
  12. | ADD_DNSSEC
  13. | DISABLE_AUTORENEW
  14. | ENABLE_AUTORENEW
  15. | DOMAIN_LOCK
  16. | CHANGE_PRIVACY_PROTECTION
  17. | UPDATE_NAMESERVER
  18. | UPDATE_DOMAIN_CONTACT
  19. | TRANSFER_IN_DOMAIN
  20. | DELETE_DOMAIN
  21. | REGISTER_DOMAIN
type nonrec invoice_id = string
type nonrec timestamp = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec price = float
type nonrec billing_record = {
  1. price : price option;
    (*

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

    Example value: 12.0

    *)
  2. bill_date : timestamp option;
    (*

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

    *)
  3. invoice_id : invoice_id option;
    (*

    Deprecated property. This field is retained in report structure for backwards compatibility, but will appear blank.

    *)
  4. operation : operation_type option;
    (*

    The operation that you were charged for.

    *)
  5. domain_name : domain_name option;
    (*

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

    *)
}

Information for one billing record.

type nonrec billing_records = billing_record list
type nonrec view_billing_response = {
  1. billing_records : billing_records option;
    (*

    A summary of billing records.

    *)
  2. next_page_marker : page_marker option;
    (*

    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.

    *)
}

The ViewBilling response includes the following elements.

type nonrec page_max_items = int
type nonrec view_billing_request = {
  1. max_items : page_max_items option;
    (*

    The number of billing records to be returned.

    Default: 20

    *)
  2. marker : page_marker option;
    (*

    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 Amazon Web Services 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.

    *)
  3. end_ : timestamp option;
    (*

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

    *)
  4. start : timestamp option;
    (*

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

    *)
}

The ViewBilling request includes the following elements.

type nonrec error_message = string
type nonrec invalid_input = {
  1. message : error_message option;
    (*

    The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.

    *)
}

The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

type nonrec value = string
type nonrec values = value list
type nonrec update_tags_for_domain_response = unit
type nonrec tag_key = string
type nonrec tag_value = string
type nonrec tag = {
  1. value : tag_value option;
    (*

    The value of a tag.

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

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

    *)
  2. key : tag_key option;
    (*

    The key (name) of a tag.

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

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

    *)
}

Each tag includes the following elements.

type nonrec tag_list = tag list
type nonrec update_tags_for_domain_request = {
  1. tags_to_update : tag_list option;
    (*

    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.

    *)
  2. domain_name : domain_name;
    (*

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

    *)
}

The UpdateTagsForDomainRequest includes the following elements.

type nonrec unsupported_tl_d = {
  1. message : error_message option;
    (*

    Amazon Route 53 does not support this top-level domain (TLD).

    *)
}

Amazon Route 53 does not support this top-level domain (TLD).

type nonrec operation_limit_exceeded = {
  1. message : error_message option;
    (*

    The number of operations or jobs running exceeded the allowed threshold for the account.

    *)
}

The number of operations or jobs running exceeded the allowed threshold for the account.

type nonrec operation_id = string
type nonrec update_domain_nameservers_response = {
  1. operation_id : operation_id option;
    (*

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

    *)
}

The UpdateDomainNameservers response includes the following element.

type nonrec fi_auth_key = string
type nonrec host_name = string
type nonrec glue_ip = string
type nonrec glue_ip_list = glue_ip list
type nonrec nameserver = {
  1. glue_ips : glue_ip_list option;
    (*

    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.

    *)
  2. name : host_name;
    (*

    The fully qualified host name of the name server.

    Constraint: Maximum 255 characters

    *)
}

Name server includes the following elements.

type nonrec nameserver_list = nameserver list
type nonrec update_domain_nameservers_request = {
  1. nameservers : nameserver_list;
    (*

    A list of new name servers for the domain.

    *)
  2. fi_auth_key : fi_auth_key option;
    (*

    The authorization key for .fi domains

    *)
  3. domain_name : domain_name;
    (*

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

    *)
}

Replaces the current set of name servers for the domain with the specified set of name servers. If you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain.

If successful, this operation returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

type nonrec tld_rules_violation = {
  1. message : error_message option;
    (*

    The top-level domain does not support this operation.

    *)
}

The top-level domain does not support this operation.

type nonrec request_id = string
type nonrec duplicate_request = {
  1. message : error_message option;
    (*

    The request is already in progress for the domain.

    *)
  2. request_id : request_id option;
    (*

    ID of the request operation.

    *)
}

The request is already in progress for the domain.

type nonrec update_domain_contact_response = {
  1. operation_id : operation_id option;
    (*

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

    *)
}

The UpdateDomainContact response includes the following element.

type nonrec contact_name = string
type nonrec contact_type =
  1. | RESELLER
  2. | PUBLIC_BODY
  3. | ASSOCIATION
  4. | COMPANY
  5. | PERSON
type nonrec address_line = string
type nonrec city = string
type nonrec state = string
type nonrec country_code =
  1. | ZW
  2. | ZM
  3. | ZA
  4. | YT
  5. | YE
  6. | WS
  7. | WF
  8. | VU
  9. | VN
  10. | VI
  11. | VG
  12. | VE
  13. | VC
  14. | VA
  15. | UZ
  16. | UY
  17. | US
  18. | UG
  19. | UA
  20. | TZ
  21. | TW
  22. | TV
  23. | TT
  24. | TR
  25. | TP
  26. | TO
  27. | TN
  28. | TM
  29. | TL
  30. | TK
  31. | TJ
  32. | TH
  33. | TG
  34. | TF
  35. | TD
  36. | TC
  37. | SZ
  38. | SY
  39. | SX
  40. | SV
  41. | ST
  42. | SS
  43. | SR
  44. | SO
  45. | SN
  46. | SM
  47. | SL
  48. | SK
  49. | SJ
  50. | SI
  51. | SH
  52. | SG
  53. | SE
  54. | SD
  55. | SC
  56. | SB
  57. | SA
  58. | RW
  59. | RU
  60. | RS
  61. | RO
  62. | RE
  63. | QA
  64. | PY
  65. | PW
  66. | PT
  67. | PS
  68. | PR
  69. | PN
  70. | PM
  71. | PL
  72. | PK
  73. | PH
  74. | PG
  75. | PF
  76. | PE
  77. | PA
  78. | OM
  79. | NZ
  80. | NU
  81. | NR
  82. | NP
  83. | NO
  84. | NL
  85. | NI
  86. | NG
  87. | NF
  88. | NE
  89. | NC
  90. | NA
  91. | MZ
  92. | MY
  93. | MX
  94. | MW
  95. | MV
  96. | MU
  97. | MT
  98. | MS
  99. | MR
  100. | MQ
  101. | MP
  102. | MO
  103. | MN
  104. | MM
  105. | ML
  106. | MK
  107. | MH
  108. | MG
  109. | MF
  110. | ME
  111. | MD
  112. | MC
  113. | MA
  114. | LY
  115. | LV
  116. | LU
  117. | LT
  118. | LS
  119. | LR
  120. | LK
  121. | LI
  122. | LC
  123. | LB
  124. | LA
  125. | KZ
  126. | KY
  127. | KW
  128. | KR
  129. | KP
  130. | KN
  131. | KM
  132. | KI
  133. | KH
  134. | KG
  135. | KE
  136. | JP
  137. | JO
  138. | JM
  139. | JE
  140. | IT
  141. | IS
  142. | IR
  143. | IQ
  144. | IO
  145. | IN
  146. | IM
  147. | IL
  148. | IE
  149. | ID
  150. | HU
  151. | HT
  152. | HR
  153. | HN
  154. | HM
  155. | HK
  156. | GY
  157. | GW
  158. | GU
  159. | GT
  160. | GS
  161. | GR
  162. | GQ
  163. | GP
  164. | GN
  165. | GM
  166. | GL
  167. | GI
  168. | GH
  169. | GG
  170. | GF
  171. | GE
  172. | GD
  173. | GB
  174. | GA
  175. | FR
  176. | FO
  177. | FM
  178. | FK
  179. | FJ
  180. | FI
  181. | ET
  182. | ES
  183. | ER
  184. | EH
  185. | EG
  186. | EE
  187. | EC
  188. | DZ
  189. | DO
  190. | DM
  191. | DK
  192. | DJ
  193. | DE
  194. | CZ
  195. | CY
  196. | CX
  197. | CW
  198. | CV
  199. | CU
  200. | CR
  201. | CO
  202. | CN
  203. | CM
  204. | CL
  205. | CK
  206. | CI
  207. | CH
  208. | CG
  209. | CF
  210. | CD
  211. | CC
  212. | CA
  213. | BZ
  214. | BY
  215. | BW
  216. | BV
  217. | BT
  218. | BS
  219. | BR
  220. | BQ
  221. | BO
  222. | BN
  223. | BM
  224. | BL
  225. | BJ
  226. | BI
  227. | BH
  228. | BG
  229. | BF
  230. | BE
  231. | BD
  232. | BB
  233. | BA
  234. | AZ
  235. | AX
  236. | AW
  237. | AU
  238. | AT
  239. | AS
  240. | AR
  241. | AQ
  242. | AO
  243. | AN
  244. | AM
  245. | AL
  246. | AI
  247. | AG
  248. | AF
  249. | AE
  250. | AD
  251. | AC
type nonrec contact_number = string
type nonrec email = string
type nonrec extra_param_name =
  1. | AU_REGISTRANT_NAME
  2. | AU_POLICY_REASON
  3. | AU_ELIGIBILITY_TYPE
  4. | AU_PRIORITY_TOKEN
  5. | EU_COUNTRY_OF_CITIZENSHIP
  6. | UK_COMPANY_NUMBER
  7. | UK_CONTACT_TYPE
  8. | VAT_NUMBER
  9. | SG_ID_NUMBER
  10. | SE_ID_NUMBER
  11. | RU_PASSPORT_DATA
  12. | IT_REGISTRANT_ENTITY_TYPE
  13. | IT_PIN
  14. | IT_NATIONALITY
  15. | FI_ORGANIZATION_TYPE
  16. | FI_NATIONALITY
  17. | ONWER_FI_ID_NUMBER
  18. | FI_BUSINESS_NUMBER
  19. | ES_IDENTIFICATION_TYPE
  20. | ES_IDENTIFICATION
  21. | CA_BUSINESS_ENTITY_TYPE
  22. | AU_ID_TYPE
  23. | AU_ID_NUMBER
  24. | DOCUMENT_NUMBER
  25. | BIRTH_CITY
  26. | BIRTH_COUNTRY
  27. | BIRTH_DATE_IN_YYYY_MM_DD
  28. | BIRTH_DEPARTMENT
  29. | BRAND_NUMBER
  30. | DUNS_NUMBER
type nonrec extra_param_value = string
type nonrec extra_param = {
  1. value : extra_param_value;
    (*

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

    *)
  2. name : extra_param_name;
    (*

    The name of an additional parameter that is required by a top-level domain. Here are the top-level domains that require additional parameters and the names of the parameters that they require:

    .au, .com.au, and .net.au

    • AU_REGISTRANT_NAME
    • AU_ID_NUMBER
    • AU_ID_TYPE

      Valid values include the following:

      • ABN (Australian business number)
      • ACN (Australian company number)
      • TM (Trademark number)
    • AU_ELIGIBILITY_TYPE

      Valid values include the following:

      • CHARITABLE_TRUST (Charitable trust)
      • CHARITY (Charity)
      • CHILD_CARE_CENTRE (Child care centre)
      • CLUB (Club)
      • COMMERCIAL_STATUTORY_BODY (Commercial statutory body)
      • COMMONWEALTH_ENTITY (Commonwealth entity)
      • COMPANY (Company)
      • COMPANY_LIMITED_BY_GUARANTEE (Company limited by guarantee)
      • EDUCATIONAL_INSTITUTION (Educational institution)
      • GOVERNMENT_SCHOOL (Government school)
      • HIGHER_EDUCATION_INSTITUTION (Higher education institution)
      • INCORPORATED_ASSOCIATION (Incorporated association)
      • INDIGENOUS_CORPORATION (Indigenous corporation)
      • INDUSTRY_BODY (Industry body)
      • INDUSTRY_ORGANISATION (Industry association)
      • NATIONAL_BODY (National body)
      • NON_DISTRIBUTING_COOPERATIVE (Non-distributing cooperative)
      • NON_GOVERNMENT_SCHOOL (Non-government school)
      • NON_PROFIT_ORGANISATION (Non-profit organisation)
      • NON_TRADING_COOPERATIVE (Non-trading cooperative)
      • NOT_FOR_PROFIT_COMMUNITY_GROUP (Not-for-profit community group)
      • PARTNERSHIP (Partnership)
      • PEAK_STATE_TERRITORY_BODY (Peak state/territory body)
      • PENDING_TM_OWNER (Pending TM owner)
      • POLITICAL_PARTY (Political party)
      • PRESCHOOL (Pre-school)
      • PUBLIC_PRIVATE_ANCILLARY_FUND (Public/private ancillary fund)
      • REGISTERED_BUSINESS (Registered business)
      • REGISTERED_ORGANISATION (Registered organisation)
      • REGISTRABLE_BODY (Registrable body)
      • RESEARCH_ORGANISATION (Research organisation)
      • STATUTORY_BODY (Statutory body)
      • TRADE_UNION (Trade union)
      • TRADEMARK_OWNER (Trademark owner)
      • TRADING_COOPERATIVE (Trading cooperative)
      • TRAINING_ORGANISATION (Training organisation)
      • TRUST (Trust)
      • UNINCORPORATED_ASSOCIATION (Unincorporated association)
      • EDUCATION_AND_CARE_SERVICES_CHILDCARE (Education and care services (child care))
      • GOVERNMENT_BODY (Government body)
      • PROVIDER_OF_NON_ACCREDITED_TRAINING (Provider of non-accredited training)
      • RELIGIOUS_CHURCH_GROUP (Religious/church group)
      • SOLE_TRADER (Sole trader)
    • AU_POLICY_REASON

      Valid values include the following:

      • POLICY_REASON_1

        POLICY_REASON_2

    .ca

    • BRAND_NUMBER
    • CA_BUSINESS_ENTITY_TYPE

      Valid values include the following:

      • BANK (Bank)
      • COMMERCIAL_COMPANY (Commercial company)
      • COMPANY (Company)
      • COOPERATION (Cooperation)
      • COOPERATIVE (Cooperative)
      • COOPRIX (Cooprix)
      • CORP (Corporation)
      • CREDIT_UNION (Credit union)
      • FOMIA (Federation of mutual insurance associations)
      • INC (Incorporated)
      • LTD (Limited)
      • LTEE (Limitée)
      • LLC (Limited liability corporation)
      • LLP (Limited liability partnership)
      • LTE (Lte.)
      • MBA (Mutual benefit association)
      • MIC (Mutual insurance company)
      • NFP (Not-for-profit corporation)
      • SA (S.A.)
      • SAVINGS_COMPANY (Savings company)
      • SAVINGS_UNION (Savings union)
      • SARL (Société à responsabilité limitée)
      • TRUST (Trust)
      • ULC (Unlimited liability corporation)
    • CA_LEGAL_TYPE

      When ContactType is PERSON, valid values include the following:

      • ABO (Aboriginal Peoples indigenous to Canada)
      • CCT (Canadian citizen)
      • LGR (Legal Representative of a Canadian Citizen or Permanent Resident)
      • RES (Permanent resident of Canada)

      When ContactType is a value other than PERSON, valid values include the following:

      • ASS (Canadian unincorporated association)
      • CCO (Canadian corporation)
      • EDU (Canadian educational institution)
      • GOV (Government or government entity in Canada)
      • HOP (Canadian Hospital)
      • INB (Indian Band recognized by the Indian Act of Canada)
      • LAM (Canadian Library, Archive, or Museum)
      • MAJ (Her/His Majesty the Queen/King)
      • OMK (Official mark registered in Canada)
      • PLT (Canadian Political Party)
      • PRT (Partnership Registered in Canada)
      • TDM (Trademark registered in Canada)
      • TRD (Canadian Trade Union)
      • TRS (Trust established in Canada)

    .es

    • ES_IDENTIFICATION

      The value of ES_IDENTIFICATION depends on the following values:

      • The value of ES_LEGAL_FORM
      • The value of ES_IDENTIFICATION_TYPE

      If ES_LEGAL_FORM is any value other than INDIVIDUAL:

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

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

      • If ES_IDENTIFICATION_TYPE is DNI_AND_NIF (for Spanish contacts):

        • Specify 8 numbers + 1 letter (DNI [Documento Nacional de Identidad], NIF [Número de Identificación Fiscal])
        • Example: 12345678M
      • If ES_IDENTIFICATION_TYPE is NIE (for foreigners with legal residence):

        • Specify 1 letter + 7 numbers + 1 letter ( NIE [Número de Identidad de Extranjero])
        • Example: Y1234567X
      • If ES_IDENTIFICATION_TYPE is OTHER (for contacts outside of Spain):

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

      Valid values include the following:

      • DNI_AND_NIF (For Spanish contacts)
      • NIE (For foreigners with legal residence)
      • OTHER (For contacts outside of Spain)
    • ES_LEGAL_FORM

      Valid values include the following:

      • ASSOCIATION
      • CENTRAL_GOVERNMENT_BODY
      • CIVIL_SOCIETY
      • COMMUNITY_OF_OWNERS
      • COMMUNITY_PROPERTY
      • CONSULATE
      • COOPERATIVE
      • DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL
      • ECONOMIC_INTEREST_GROUP
      • EMBASSY
      • ENTITY_MANAGING_NATURAL_AREAS
      • FARM_PARTNERSHIP
      • FOUNDATION
      • GENERAL_AND_LIMITED_PARTNERSHIP
      • GENERAL_PARTNERSHIP
      • INDIVIDUAL
      • LIMITED_COMPANY
      • LOCAL_AUTHORITY
      • LOCAL_PUBLIC_ENTITY
      • MUTUAL_INSURANCE_COMPANY
      • NATIONAL_PUBLIC_ENTITY
      • ORDER_OR_RELIGIOUS_INSTITUTION
      • OTHERS (Only for contacts outside of Spain)
      • POLITICAL_PARTY
      • PROFESSIONAL_ASSOCIATION
      • PUBLIC_LAW_ASSOCIATION
      • PUBLIC_LIMITED_COMPANY
      • REGIONAL_GOVERNMENT_BODY
      • REGIONAL_PUBLIC_ENTITY
      • SAVINGS_BANK
      • SPANISH_OFFICE
      • SPORTS_ASSOCIATION
      • SPORTS_FEDERATION
      • SPORTS_LIMITED_COMPANY
      • TEMPORARY_ALLIANCE_OF_ENTERPRISES
      • TRADE_UNION
      • WORKER_OWNED_COMPANY
      • WORKER_OWNED_LIMITED_COMPANY

    .eu

    • EU_COUNTRY_OF_CITIZENSHIP

    .fi

    • BIRTH_DATE_IN_YYYY_MM_DD
    • FI_BUSINESS_NUMBER
    • FI_ID_NUMBER
    • FI_NATIONALITY

      Valid values include the following:

      • FINNISH
      • NOT_FINNISH
    • FI_ORGANIZATION_TYPE

      Valid values include the following:

      • COMPANY
      • CORPORATION
      • GOVERNMENT
      • INSTITUTION
      • POLITICAL_PARTY
      • PUBLIC_COMMUNITY
      • TOWNSHIP

    .it

    • IT_NATIONALITY
    • IT_PIN
    • IT_REGISTRANT_ENTITY_TYPE

      Valid values include the following:

      • FOREIGNERS
      • FREELANCE_WORKERS (Freelance workers and professionals)
      • ITALIAN_COMPANIES (Italian companies and one-person companies)
      • NON_PROFIT_ORGANIZATIONS
      • OTHER_SUBJECTS
      • PUBLIC_ORGANIZATIONS

    .ru

    • BIRTH_DATE_IN_YYYY_MM_DD
    • RU_PASSPORT_DATA

    .se

    • BIRTH_COUNTRY
    • SE_ID_NUMBER

    .sg

    • SG_ID_NUMBER

    .uk, .co.uk, .me.uk, and .org.uk

    • UK_CONTACT_TYPE

      Valid values include the following:

      • CRC (UK Corporation by Royal Charter)
      • FCORP (Non-UK Corporation)
      • FIND (Non-UK Individual, representing self)
      • FOTHER (Non-UK Entity that does not fit into any other category)
      • GOV (UK Government Body)
      • IND (UK Individual (representing self))
      • IP (UK Industrial/Provident Registered Company)
      • LLP (UK Limited Liability Partnership)
      • LTD (UK Limited Company)
      • OTHER (UK Entity that does not fit into any other category)
      • PLC (UK Public Limited Company)
      • PTNR (UK Partnership)
      • RCHAR (UK Registered Charity)
      • SCH (UK School)
      • STAT (UK Statutory Body)
      • STRA (UK Sole Trader)
    • UK_COMPANY_NUMBER

    In addition, many TLDs require a VAT_NUMBER.

    *)
}

ExtraParam includes the following elements.

type nonrec extra_param_list = extra_param list
type nonrec contact_detail = {
  1. extra_params : extra_param_list option;
    (*

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

    *)
  2. fax : contact_number option;
    (*

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

    *)
  3. email : email option;
    (*

    Email address of the contact.

    *)
  4. phone_number : contact_number option;
    (*

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

    *)
  5. zip_code : zip_code option;
    (*

    The zip or postal code of the contact's address.

    *)
  6. country_code : country_code option;
    (*

    Code for the country of the contact's address.

    *)
  7. state : state option;
    (*

    The state or province of the contact's city.

    *)
  8. city : city option;
    (*

    The city of the contact's address.

    *)
  9. address_line2 : address_line option;
    (*

    Second line of contact's address, if any.

    *)
  10. address_line1 : address_line option;
    (*

    First line of the contact's address.

    *)
  11. organization_name : contact_name option;
    (*

    Name of the organization for contact types other than PERSON.

    *)
  12. contact_type : contact_type option;
    (*

    Indicates whether the contact is a person, company, association, or public organization. Note the following:

    • If you specify a value other than PERSON, you must also specify a value for OrganizationName.
    • For some TLDs, the privacy protection available depends on the value that you specify for Contact Type. For the privacy protection settings for your TLD, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide
    • For .es domains, the value of ContactType must be PERSON for all three contacts.
    *)
  13. last_name : contact_name option;
    (*

    Last name of contact.

    *)
  14. first_name : contact_name option;
    (*

    First name of contact.

    *)
}

ContactDetail includes the following elements.

type nonrec currency = string

Customer's consent for the owner change request.

type nonrec update_domain_contact_request = {
  1. billing_contact : contact_detail option;
    (*

    Provides detailed contact information.

    *)
  2. consent : consent option;
    (*

    Customer's consent for the owner change request. Required if the domain is not free (consent price is more than $0.00).

    *)
  3. tech_contact : contact_detail option;
    (*

    Provides detailed contact information.

    *)
  4. registrant_contact : contact_detail option;
    (*

    Provides detailed contact information.

    *)
  5. admin_contact : contact_detail option;
    (*

    Provides detailed contact information.

    *)
  6. domain_name : domain_name;
    (*

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

    *)
}

The UpdateDomainContact request includes the following elements.

type nonrec update_domain_contact_privacy_response = {
  1. operation_id : operation_id option;
    (*

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

    *)
}

The UpdateDomainContactPrivacy response includes the following element.

type nonrec boolean_ = bool
type nonrec update_domain_contact_privacy_request = {
  1. billing_privacy : boolean_ option;
    (*

    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 or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the billing contact.

    You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts.

    *)
  2. tech_privacy : boolean_ option;
    (*

    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 or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the technical contact.

    You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts.

    *)
  3. registrant_privacy : boolean_ option;
    (*

    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 or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the registrant contact (domain owner).

    You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts.

    *)
  4. admin_privacy : boolean_ option;
    (*

    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 or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the admin contact.

    You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts.

    *)
  5. domain_name : domain_name;
    (*

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

    *)
}

The UpdateDomainContactPrivacy request includes the following elements.

type nonrec transferable =
  1. | PREMIUM_DOMAIN
  2. | DOMAIN_IN_ANOTHER_ACCOUNT
  3. | DOMAIN_IN_OWN_ACCOUNT
  4. | DONT_KNOW
  5. | UNTRANSFERABLE
  6. | TRANSFERABLE

Whether the domain name can be transferred to Route 53.

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

Valid values:

TRANSFERABLE The domain name can be transferred to Route 53.

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

DONT_KNOW The TLD registry didn't respond in time or didn't provide a definitive answer about domain transferability, which can occur due to registry maintenance or temporary delays.

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

DOMAIN_IN_ANOTHER_ACCOUNT The domain exists in another Amazon Web Services account.

PREMIUM_DOMAIN Premium domain transfer is not supported.

type nonrec password = string
type nonrec transfer_domain_to_another_aws_account_response = {
  1. password : password option;
    (*

    To finish transferring a domain to another Amazon Web Services account, the account that the domain is being transferred to must submit an AcceptDomainTransferFromAnotherAwsAccount request. The request must include the value of the Password element that was returned in the TransferDomainToAnotherAwsAccount response.

    *)
  2. operation_id : operation_id option;
    (*

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

    *)
}

The TransferDomainToAnotherAwsAccount response includes the following elements.

type nonrec account_id = string
type nonrec transfer_domain_to_another_aws_account_request = {
  1. account_id : account_id;
    (*

    The account ID of the Amazon Web Services account that you want to transfer the domain to, for example, 111122223333.

    *)
  2. domain_name : domain_name;
    (*

    The name of the domain that you want to transfer from the current Amazon Web Services account to another account.

    *)
}

The TransferDomainToAnotherAwsAccount request includes the following elements.

type nonrec transfer_domain_response = {
  1. operation_id : operation_id option;
    (*

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

    *)
}

The TransferDomain response includes the following element.

type nonrec lang_code = string
type nonrec duration_in_years = int
type nonrec domain_auth_code = string
type nonrec transfer_domain_request = {
  1. privacy_protect_billing_contact : boolean_ option;
    (*

    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 or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the billing contact.

    You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts.

    *)
  2. billing_contact : contact_detail option;
    (*

    Provides detailed contact information.

    *)
  3. privacy_protect_tech_contact : boolean_ option;
    (*

    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 or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the technical contact.

    You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts.

    Default: true

    *)
  4. privacy_protect_registrant_contact : boolean_ option;
    (*

    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 or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the registrant contact (domain owner).

    You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts.

    Default: true

    *)
  5. privacy_protect_admin_contact : boolean_ option;
    (*

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries return contact information for the registrar, the phrase "REDACTED FOR PRIVACY", or "On behalf of owner.".

    While some domains may allow different privacy settings per contact, we recommend specifying the same privacy setting for all contacts.

    Default: true

    *)
  6. tech_contact : contact_detail;
    (*

    Provides detailed contact information.

    *)
  7. registrant_contact : contact_detail;
    (*

    Provides detailed contact information.

    *)
  8. admin_contact : contact_detail;
    (*

    Provides detailed contact information.

    *)
  9. auto_renew : boolean_ option;
    (*

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

    Default: true

    *)
  10. auth_code : domain_auth_code option;
    (*

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

    *)
  11. nameservers : nameserver_list option;
    (*

    Contains details for the host and glue IP addresses.

    *)
  12. duration_in_years : duration_in_years option;
    (*

    Reserved for future use.

    Currently, the effect of a domain transfer on the registration period varies by TLD. For information about how transferring a domain affects the expiration date, see the Transfer Term column in the pricing information at Amazon Route 53 Pricing.

    Default: 1

    *)
  13. idn_lang_code : lang_code option;
    (*

    Reserved for future use.

    *)
  14. domain_name : domain_name;
    (*

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

The TransferDomain request includes the following elements.

type nonrec domain_limit_exceeded = {
  1. message : error_message option;
    (*

    The number of domains has exceeded the allowed threshold for the account.

    *)
}

The number of domains has exceeded the allowed threshold for the account.

type nonrec tld_name = string
type nonrec tag_key_list = tag_key list
type nonrec tld_in_maintenance = {
  1. tld : tld_name option;
    (*

    The top-level domain that is currently undergoing maintenance.

    *)
  2. message : error_message option;
    (*

    The top-level domain is currently undergoing maintenance and the request cannot be processed. Try again later.

    *)
}

The top-level domain is currently undergoing maintenance and the request cannot be processed. Try again later.

type nonrec string_ = string
type nonrec status_flag =
  1. | PENDING_SUPPORT_CASE
  2. | PENDING_PAYMENT_VERIFICATION
  3. | PENDING_AUTHORIZATION
  4. | PENDING_CUSTOMER_ACTION
  5. | PENDING_ACCEPTANCE
type nonrec sort_order =
  1. | DESC
  2. | ASC
type nonrec list_domains_attribute_name =
  1. | Expiry
  2. | DomainName
type nonrec sort_condition = {
  1. sort_order : sort_order;
    (*

    The sort order for a list of domains. Either ascending (ASC) or descending (DES).

    *)
  2. name : list_domains_attribute_name;
    (*

    Field to be used for sorting the list of domains. It can be either the name or the expiration for a domain. Note that if filterCondition is used in the same ListDomains call, the field used for sorting has to be the same as the field used for filtering.

    *)
}

Information for sorting a list of domains.

type nonrec retrieve_domain_auth_code_response = {
  1. auth_code : domain_auth_code option;
    (*

    The authorization code for the domain.

    *)
}

The RetrieveDomainAuthCode response includes the following element.

type nonrec retrieve_domain_auth_code_request = {
  1. domain_name : domain_name;
    (*

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

    *)
}

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

type nonrec resend_operation_authorization_request = {
  1. operation_id : operation_id;
    (*

    Operation ID.

    *)
}
type nonrec resend_contact_reachability_email_response = {
  1. is_already_verified : boolean_ option;
    (*

    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.

    *)
  2. email_address : email option;
    (*

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

    *)
  3. domain_name : domain_name option;
    (*

    The domain name for which you requested a confirmation email.

    *)
}
type nonrec resend_contact_reachability_email_request = {
  1. domain_name : domain_name option;
    (*

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

    *)
}
type nonrec renew_domain_response = {
  1. operation_id : operation_id option;
    (*

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

    *)
}
type nonrec current_expiry_year = int
type nonrec renew_domain_request = {
  1. current_expiry_year : current_expiry_year;
    (*

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

    *)
  2. duration_in_years : duration_in_years option;
    (*

    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

    *)
  3. domain_name : domain_name;
    (*

    The name of the domain that you want to renew.

    *)
}

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

type nonrec reject_domain_transfer_from_another_aws_account_response = {
  1. operation_id : operation_id option;
    (*

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

    *)
}

The RejectDomainTransferFromAnotherAwsAccount response includes the following element.

type nonrec reject_domain_transfer_from_another_aws_account_request = {
  1. domain_name : domain_name;
    (*

    The name of the domain that was specified when another Amazon Web Services account submitted a TransferDomainToAnotherAwsAccount request.

    *)
}

The RejectDomainTransferFromAnotherAwsAccount request includes the following element.

type nonrec register_domain_response = {
  1. operation_id : operation_id option;
    (*

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

    *)
}

The RegisterDomain response includes the following element.

type nonrec register_domain_request = {
  1. privacy_protect_billing_contact : boolean_ option;
    (*

    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 or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the billing contact.

    You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts.

    *)
  2. billing_contact : contact_detail option;
    (*

    Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.

    *)
  3. privacy_protect_tech_contact : boolean_ option;
    (*

    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 or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the technical contact.

    You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts.

    Default: true

    *)
  4. privacy_protect_registrant_contact : boolean_ option;
    (*

    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 or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the registrant contact (the domain owner).

    You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts.

    Default: true

    *)
  5. privacy_protect_admin_contact : boolean_ option;
    (*

    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 or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the admin contact.

    You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts.

    Default: true

    *)
  6. tech_contact : contact_detail;
    (*

    Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.

    *)
  7. registrant_contact : contact_detail;
    (*

    Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.

    *)
  8. admin_contact : contact_detail;
    (*

    Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.

    *)
  9. auto_renew : boolean_ option;
    (*

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

    Default: true

    *)
  10. duration_in_years : duration_in_years;
    (*

    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

    *)
  11. idn_lang_code : lang_code option;
    (*

    Reserved for future use.

    *)
  12. domain_name : domain_name;
    (*

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

    The domain name can contain only the following characters:

    • Letters a through z. Domain names are not case sensitive.
    • Numbers 0 through 9.
    • Hyphen (-). You can't specify a hyphen at the beginning or end of a label.
    • Period (.) to separate the labels in the name, such as the . in example.com.

    Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports internationalized domain names, see Domains that You Can Register with Amazon Route 53. For more information, see Formatting Internationalized Domain Names.

    *)
}

The RegisterDomain request includes the following elements.

type nonrec label = string
type nonrec push_domain_request = {
  1. target : label;
    (*

    New IPS tag for the domain.

    *)
  2. domain_name : domain_name;
    (*

    Name of the domain.

    *)
}
type nonrec list_tags_for_domain_response = {
  1. tag_list : tag_list option;
    (*

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

    *)
}

The ListTagsForDomain response includes the following elements.

type nonrec list_tags_for_domain_request = {
  1. domain_name : domain_name;
    (*

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

    *)
}

The ListTagsForDomainRequest includes the following elements.

type nonrec domain_price_name = string
type nonrec price_with_currency = {
  1. currency : currency;
    (*

    The currency specifier.

    *)
  2. price : price;
    (*

    The price of a domain, in a specific currency.

    *)
}

Currency-specific price information.

type nonrec domain_price = {
  1. restoration_price : price_with_currency option;
    (*

    The price for restoring the domain with Route 53.

    *)
  2. change_ownership_price : price_with_currency option;
    (*

    The price for changing domain ownership.

    *)
  3. renewal_price : price_with_currency option;
    (*

    The price for renewing domain registration with Route 53.

    *)
  4. transfer_price : price_with_currency option;
    (*

    The price for transferring the domain registration to Route 53.

    *)
  5. registration_price : price_with_currency option;
    (*

    The price for domain registration with Route 53.

    *)
  6. name : domain_price_name option;
    (*

    The name of the TLD for which the prices apply.

    *)
}

Information about the domain price associated with a TLD.

type nonrec domain_price_list = domain_price list
type nonrec list_prices_response = {
  1. next_page_marker : page_marker option;
    (*

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

    Used only for all TLDs. If you specify a TLD, don't specify a NextPageMarker.

    *)
  2. prices : domain_price_list option;
    (*

    A complex type that includes all the pricing information. If you specify a TLD, this array contains only the pricing for that TLD.

    *)
}
type nonrec list_prices_page_max_items = int
type nonrec list_prices_request = {
  1. max_items : list_prices_page_max_items option;
    (*

    Number of Prices to be returned.

    Used only for all TLDs. If you specify a TLD, don't specify a MaxItems.

    *)
  2. marker : page_marker option;
    (*

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

    Used only for all TLDs. If you specify a TLD, don't specify a Marker.

    *)
  3. tld : tld_name option;
    (*

    The TLD for which you want to receive the pricing information. For example. .net.

    If a Tld value is not provided, a list of prices for all TLDs supported by Route 53 is returned.

    *)
}
type nonrec operation_status =
  1. | FAILED
  2. | SUCCESSFUL
  3. | ERROR
  4. | IN_PROGRESS
  5. | SUBMITTED
type nonrec operation_summary = {
  1. last_updated_date : timestamp option;
    (*

    The date when the last change was made in Unix time format and Coordinated Universal Time (UTC).

    *)
  2. status_flag : status_flag option;
    (*

    Automatically checks whether there are no outstanding operations on domains that need customer attention.

    Valid values are:

    • PENDING_ACCEPTANCE: The operation is waiting for acceptance from the account that is receiving the domain.
    • PENDING_CUSTOMER_ACTION: The operation is waiting for customer action, for example, returning an email.
    • PENDING_AUTHORIZATION: The operation is waiting for the form of authorization. For more information, see ResendOperationAuthorization.
    • PENDING_PAYMENT_VERIFICATION: The operation is waiting for the payment method to validate.
    • PENDING_SUPPORT_CASE: The operation includes a support case and is waiting for its resolution.
    *)
  3. message : error_message option;
    (*

    Message about the operation.

    *)
  4. domain_name : domain_name option;
    (*

    Name of the domain.

    *)
  5. submitted_date : timestamp option;
    (*

    The date when the request was submitted.

    *)
  6. type_ : operation_type option;
    (*

    Type of the action requested.

    *)
  7. status : operation_status option;
    (*

    The current status of the requested operation in the system.

    *)
  8. operation_id : operation_id option;
    (*

    Identifier returned to track the requested action.

    *)
}

OperationSummary includes the following elements.

type nonrec operation_summary_list = operation_summary list
type nonrec list_operations_response = {
  1. next_page_marker : page_marker option;
    (*

    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.

    *)
  2. operations : operation_summary_list option;
    (*

    Lists summaries of the operations.

    *)
}

The ListOperations response includes the following elements.

type nonrec operation_status_list = operation_status list
type nonrec operation_type_list = operation_type list
type nonrec list_operations_sort_attribute_name =
  1. | SubmittedDate
type nonrec list_operations_request = {
  1. sort_order : sort_order option;
    (*

    The sort order for returned values, either ascending or descending.

    *)
  2. sort_by : list_operations_sort_attribute_name option;
    (*

    The sort type for returned values.

    *)
  3. type_ : operation_type_list option;
    (*

    An arrays of the domains operation types.

    *)
  4. status : operation_status_list option;
    (*

    The status of the operations.

    *)
  5. max_items : page_max_items option;
    (*

    Number of domains to be returned.

    Default: 20

    *)
  6. marker : page_marker option;
    (*

    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.

    *)
  7. submitted_since : timestamp option;
    (*

    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 Unix time format and Coordinated Universal time (UTC).

    *)
}

The ListOperations request includes the following elements.

type nonrec domain_summary = {
  1. expiry : timestamp option;
    (*

    Expiration date of the domain in Unix time format and Coordinated Universal Time (UTC).

    *)
  2. transfer_lock : boolean_ option;
    (*

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

    *)
  3. auto_renew : boolean_ option;
    (*

    Indicates whether the domain is automatically renewed upon expiration.

    *)
  4. domain_name : domain_name option;
    (*

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

    *)
}

Summary information about one domain.

type nonrec domain_summary_list = domain_summary list
type nonrec list_domains_response = {
  1. next_page_marker : page_marker option;
    (*

    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.

    *)
  2. domains : domain_summary_list option;
    (*

    A list of domains.

    *)
}

The ListDomains response includes the following elements.

type nonrec operator =
  1. | BEGINS_WITH
  2. | GE
  3. | LE
type nonrec filter_condition = {
  1. values : values;
    (*

    An array of strings presenting values to compare. Only 1 item in the list is currently supported.

    *)
  2. operator : operator;
    (*

    The operator values for filtering domain names. The values can be:

    • LE: Less than, or equal to
    • GE: Greater than, or equal to
    • BEGINS_WITH: Begins with
    *)
  3. name : list_domains_attribute_name;
    (*

    Name of the field which should be used for filtering the list of domains.

    *)
}

Information for the filtering of a list of domains returned by ListDomains.

type nonrec filter_conditions = filter_condition list
type nonrec list_domains_request = {
  1. max_items : page_max_items option;
    (*

    Number of domains to be returned.

    Default: 20

    *)
  2. marker : page_marker option;
    (*

    For an initial request for a list of domains, omit this element. If the number of domains that are associated with the current Amazon Web Services 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.

    *)
  3. sort_condition : sort_condition option;
    (*

    A complex type that contains information about the requested ordering of domains in the returned list.

    *)
  4. filter_conditions : filter_conditions option;
    (*

    A complex type that contains information about the filters applied during the ListDomains request. The filter conditions can include domain name and domain expiration.

    *)
}

The ListDomains request includes the following elements.

type nonrec get_operation_detail_response = {
  1. status_flag : status_flag option;
    (*

    Lists any outstanding operations that require customer action. Valid values are:

    • PENDING_ACCEPTANCE: The operation is waiting for acceptance from the account that is receiving the domain.
    • PENDING_CUSTOMER_ACTION: The operation is waiting for customer action, for example, returning an email.
    • PENDING_AUTHORIZATION: The operation is waiting for the form of authorization. For more information, see ResendOperationAuthorization.
    • PENDING_PAYMENT_VERIFICATION: The operation is waiting for the payment method to validate.
    • PENDING_SUPPORT_CASE: The operation includes a support case and is waiting for its resolution.
    *)
  2. last_updated_date : timestamp option;
    (*

    The date when the operation was last updated.

    *)
  3. submitted_date : timestamp option;
    (*

    The date when the request was submitted.

    *)
  4. type_ : operation_type option;
    (*

    The type of operation that was requested.

    *)
  5. domain_name : domain_name option;
    (*

    The name of a domain.

    *)
  6. message : error_message option;
    (*

    Detailed information on the status including possible errors.

    *)
  7. status : operation_status option;
    (*

    The current status of the requested operation in the system.

    *)
  8. operation_id : operation_id option;
    (*

    The identifier for the operation.

    *)
}

The GetOperationDetail response includes the following elements.

type nonrec get_operation_detail_request = {
  1. operation_id : operation_id;
    (*

    The identifier for the operation for which you want to get the status. Route 53 returned the identifier in the response to the original request.

    *)
}

The GetOperationDetail request includes the following element.

type nonrec domain_suggestion = {
  1. availability : string_ option;
    (*

    Whether the domain name is available for registering.

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

    *)
  2. domain_name : domain_name option;
    (*

    A suggested domain name.

    *)
}

Information about one suggested domain name.

type nonrec domain_suggestions_list = domain_suggestion list
type nonrec get_domain_suggestions_response = {
  1. suggestions_list : domain_suggestions_list option;
    (*

    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.

    *)
}
type nonrec integer = int
type nonrec get_domain_suggestions_request = {
  1. only_available : boolean_;
    (*

    If OnlyAvailable is true, Route 53 returns only domain names that are available. If OnlyAvailable is false, 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.

    *)
  2. suggestion_count : integer;
    (*

    The number of suggested domain names that you want Route 53 to return. Specify a value between 1 and 50. Note that fewer than the requested number might be returned.

    *)
  3. domain_name : domain_name;
    (*

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

    The domain name can contain only the following characters:

    • Letters a through z. Domain names are not case sensitive.
    • Numbers 0 through 9.
    • Hyphen (-). You can't specify a hyphen at the beginning or end of a label.
    • Period (.) to separate the labels in the name, such as the . in example.com.

    Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports internationalized domain names, see Domains that You Can Register with Amazon Route 53.

    *)
}
type nonrec registrar_name = string
type nonrec registrar_who_is_server = string
type nonrec registrar_url = string
type nonrec registry_domain_id = string
type nonrec reseller = string
type nonrec dns_sec = string
type nonrec domain_status = string
type nonrec domain_status_list = domain_status list
type nonrec nullable_integer = int
type nonrec dnssec_public_key = string
type nonrec dnssec_key = {
  1. id : string_ option;
    (*

    An ID assigned to each DS record created by AssociateDelegationSignerToDomain.

    *)
  2. key_tag : nullable_integer option;
    (*

    A numeric identification of the DNSKEY record referred to by this DS record.

    *)
  3. digest : string_ option;
    (*

    The delegation signer digest.

    Digest is calculated from the public key provided using specified digest algorithm and this digest is the actual value returned from the registry nameservers as the value of DS records.

    *)
  4. digest_type : nullable_integer option;
    (*

    The number of the DS digest algorithm according to an IANA assignment.

    For more information, see IANA for DNSSEC Delegation Signer (DS) Resource Record (RR) Type Digest Algorithms.

    *)
  5. public_key : dnssec_public_key option;
    (*

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

    *)
  6. flags : nullable_integer option;
    (*

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

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

    *)
  7. algorithm : nullable_integer option;
    (*

    The number of the public key’s cryptographic algorithm according to an IANA assignment.

    If Route 53 is your DNS service, set this to 13.

    For more information about enabling DNSSEC signing, see Enabling DNSSEC signing and establishing a chain of trust.

    *)
}

Information about the DNSSEC key.

You get this from your DNS provider and then give it to Route 53 (by using AssociateDelegationSignerToDomain) to pass it to the registry to establish the chain of trust.

type nonrec dnssec_key_list = dnssec_key list
type nonrec get_domain_detail_response = {
  1. billing_privacy : boolean_ option;
    (*

    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 or for our registrar associate, Gandi. If the value is false, WHOIS queries return the information that you entered for the billing contact.

    *)
  2. billing_contact : contact_detail option;
    (*

    Provides details about the domain billing contact.

    *)
  3. dnssec_keys : dnssec_key_list option;
    (*

    A complex type that contains information about the DNSSEC configuration.

    *)
  4. status_list : domain_status_list option;
    (*

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

    *)
  5. dns_sec : dns_sec option;
    (*

    Deprecated.

    *)
  6. reseller : reseller option;
    (*

    Reserved for future use.

    *)
  7. expiration_date : timestamp option;
    (*

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

    *)
  8. updated_date : timestamp option;
    (*

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

    *)
  9. creation_date : timestamp option;
    (*

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

    *)
  10. registry_domain_id : registry_domain_id option;
    (*

    Reserved for future use.

    *)
  11. abuse_contact_phone : contact_number option;
    (*

    Phone number for reporting abuse.

    *)
  12. abuse_contact_email : email option;
    (*

    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.

    *)
  13. registrar_url : registrar_url option;
    (*

    Web address of the registrar.

    *)
  14. who_is_server : registrar_who_is_server option;
    (*

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

    *)
  15. registrar_name : registrar_name option;
    (*

    Name of the registrar of the domain as identified in the registry.

    *)
  16. tech_privacy : boolean_ option;
    (*

    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 or for our registrar associate, Gandi. If the value is false, WHOIS queries return the information that you entered for the technical contact.

    *)
  17. registrant_privacy : boolean_ option;
    (*

    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 or for our registrar associate, Gandi. If the value is false, WHOIS queries return the information that you entered for the registrant contact (domain owner).

    *)
  18. admin_privacy : boolean_ option;
    (*

    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 or for our registrar associate, Gandi. If the value is false, WHOIS queries return the information that you entered for the admin contact.

    *)
  19. tech_contact : contact_detail option;
    (*

    Provides details about the domain technical contact.

    *)
  20. registrant_contact : contact_detail option;
    (*

    Provides details about the domain registrant.

    *)
  21. admin_contact : contact_detail option;
    (*

    Provides details about the domain administrative contact.

    *)
  22. auto_renew : boolean_ option;
    (*

    Specifies whether the domain registration is set to renew automatically.

    *)
  23. nameservers : nameserver_list option;
    (*

    The name servers of the domain.

    *)
  24. domain_name : domain_name option;
    (*

    The name of a domain.

    *)
}

The GetDomainDetail response includes the following elements.

type nonrec get_domain_detail_request = {
  1. domain_name : domain_name;
    (*

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

    *)
}

The GetDomainDetail request includes the following element.

type nonrec reachability_status =
  1. | EXPIRED
  2. | DONE
  3. | PENDING
type nonrec get_contact_reachability_status_response = {
  1. status : reachability_status option;
    (*

    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.

    *)
  2. domain_name : domain_name option;
    (*

    The domain name for which you requested the reachability status.

    *)
}
type nonrec get_contact_reachability_status_request = {
  1. domain_name : domain_name option;
    (*

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

    *)
}
type nonrec enable_domain_transfer_lock_response = {
  1. operation_id : operation_id option;
    (*

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

    *)
}

The EnableDomainTransferLock response includes the following elements.

type nonrec enable_domain_transfer_lock_request = {
  1. domain_name : domain_name;
    (*

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

    *)
}

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

type nonrec enable_domain_auto_renew_response = unit
type nonrec enable_domain_auto_renew_request = {
  1. domain_name : domain_name;
    (*

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

    *)
}
type nonrec disassociate_delegation_signer_from_domain_response = {
  1. operation_id : operation_id option;
    (*

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

    *)
}
type nonrec disassociate_delegation_signer_from_domain_request = {
  1. id : string_;
    (*

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

    *)
  2. domain_name : domain_name;
    (*

    Name of the domain.

    *)
}
type nonrec disable_domain_transfer_lock_response = {
  1. operation_id : operation_id option;
    (*

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

    *)
}

The DisableDomainTransferLock response includes the following element.

type nonrec disable_domain_transfer_lock_request = {
  1. domain_name : domain_name;
    (*

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

    *)
}

The DisableDomainTransferLock request includes the following element.

type nonrec disable_domain_auto_renew_response = unit
type nonrec disable_domain_auto_renew_request = {
  1. domain_name : domain_name;
    (*

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

    *)
}
type nonrec delete_tags_for_domain_response = unit
type nonrec delete_tags_for_domain_request = {
  1. tags_to_delete : tag_key_list;
    (*

    A list of tag keys to delete.

    *)
  2. domain_name : domain_name;
    (*

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

    *)
}

The DeleteTagsForDomainRequest includes the following elements.

type nonrec delete_domain_response = {
  1. operation_id : operation_id option;
    (*

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

    *)
}
type nonrec delete_domain_request = {
  1. domain_name : domain_name;
    (*

    Name of the domain to be deleted.

    *)
}
type nonrec domain_transferability = {
  1. transferable : transferable option;
}

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

type nonrec message = string
type nonrec check_domain_transferability_response = {
  1. message : message option;
    (*

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

    *)
  2. transferability : domain_transferability option;
    (*

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

    *)
}

The CheckDomainTransferability response includes the following elements.

type nonrec check_domain_transferability_request = {
  1. auth_code : domain_auth_code option;
    (*

    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.

    *)
  2. domain_name : domain_name;
    (*

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

The CheckDomainTransferability request contains the following elements.

type nonrec domain_availability =
  1. | PENDING
  2. | INVALID_NAME_FOR_TLD
  3. | DONT_KNOW
  4. | RESERVED
  5. | UNAVAILABLE_RESTRICTED
  6. | UNAVAILABLE_PREMIUM
  7. | UNAVAILABLE
  8. | AVAILABLE_PREORDER
  9. | AVAILABLE_RESERVED
  10. | AVAILABLE
type nonrec check_domain_availability_response = {
  1. availability : domain_availability option;
    (*

    Whether the domain name is available for registering.

    You can register only domains designated as AVAILABLE.

    Valid values:

    AVAILABLE The domain name is available.

    AVAILABLE_RESERVED The domain name is reserved under specific conditions.

    AVAILABLE_PREORDER The domain name is available and can be preordered.

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

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

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

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

    UNAVAILABLE The domain name is not available.

    UNAVAILABLE_PREMIUM The domain name is not available.

    UNAVAILABLE_RESTRICTED The domain name is forbidden.

    *)
}

The CheckDomainAvailability response includes the following elements.

type nonrec check_domain_availability_request = {
  1. idn_lang_code : lang_code option;
    (*

    Reserved for future use.

    *)
  2. domain_name : domain_name;
    (*

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

    The domain name can contain only the following characters:

    • Letters a through z. Domain names are not case sensitive.
    • Numbers 0 through 9.
    • Hyphen (-). You can't specify a hyphen at the beginning or end of a label.
    • Period (.) to separate the labels in the name, such as the . in example.com.

    Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports internationalized domain names, see Domains that You Can Register with Amazon Route 53. For more information, see Formatting Internationalized Domain Names.

    *)
}

The CheckDomainAvailability request contains the following elements.

type nonrec cancel_domain_transfer_to_another_aws_account_response = {
  1. operation_id : operation_id option;
    (*

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

    *)
}

The CancelDomainTransferToAnotherAwsAccount response includes the following element.

type nonrec cancel_domain_transfer_to_another_aws_account_request = {
  1. domain_name : domain_name;
    (*

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

    *)
}

The CancelDomainTransferToAnotherAwsAccount request includes the following element.

type nonrec dnssec_limit_exceeded = {
  1. message : error_message option;
}

This error is returned if you call AssociateDelegationSignerToDomain when the specified domain has reached the maximum number of DS records. You can't add any additional DS records unless you delete an existing one first.

type nonrec associate_delegation_signer_to_domain_response = {
  1. operation_id : operation_id option;
    (*

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

    *)
}
type nonrec dnssec_signing_attributes = {
  1. public_key : dnssec_public_key option;
    (*

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

    *)
  2. flags : nullable_integer option;
    (*

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

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

    *)
  3. algorithm : nullable_integer option;
    (*

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

    *)
}

Information about a delegation signer (DS) record that was created in the registry by AssociateDelegationSignerToDomain.

type nonrec associate_delegation_signer_to_domain_request = {
  1. signing_attributes : dnssec_signing_attributes;
    (*

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

    *)
  2. domain_name : domain_name;
    (*

    The name of the domain.

    *)
}
type nonrec accept_domain_transfer_from_another_aws_account_response = {
  1. operation_id : operation_id option;
    (*

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

    *)
}

The AcceptDomainTransferFromAnotherAwsAccount response includes the following element.

type nonrec accept_domain_transfer_from_another_aws_account_request = {
  1. password : password;
    (*

    The password that was returned by the TransferDomainToAnotherAwsAccount request.

    *)
  2. domain_name : domain_name;
    (*

    The name of the domain that was specified when another Amazon Web Services account submitted a TransferDomainToAnotherAwsAccount request.

    *)
}

The AcceptDomainTransferFromAnotherAwsAccount request includes the following elements.