route53domains.d.ts 108 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452
  1. import {Request} from '../lib/request';
  2. import {Response} from '../lib/response';
  3. import {AWSError} from '../lib/error';
  4. import {Service} from '../lib/service';
  5. import {ServiceConfigurationOptions} from '../lib/service';
  6. import {ConfigBase as Config} from '../lib/config-base';
  7. interface Blob {}
  8. declare class Route53Domains extends Service {
  9. /**
  10. * Constructs a service object. This object has one method for each API operation.
  11. */
  12. constructor(options?: Route53Domains.Types.ClientConfiguration)
  13. config: Config & Route53Domains.Types.ClientConfiguration;
  14. /**
  15. * Accepts the transfer of a domain from another Amazon Web Services account to the currentAmazon Web Services account. You initiate a transfer between Amazon Web Services accounts using TransferDomainToAnotherAwsAccount. If you use the CLI command at accept-domain-transfer-from-another-aws-account, use JSON format as input instead of text because otherwise CLI will throw an error from domain transfer input that includes single quotes. Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled.
  16. */
  17. acceptDomainTransferFromAnotherAwsAccount(params: Route53Domains.Types.AcceptDomainTransferFromAnotherAwsAccountRequest, callback?: (err: AWSError, data: Route53Domains.Types.AcceptDomainTransferFromAnotherAwsAccountResponse) => void): Request<Route53Domains.Types.AcceptDomainTransferFromAnotherAwsAccountResponse, AWSError>;
  18. /**
  19. * Accepts the transfer of a domain from another Amazon Web Services account to the currentAmazon Web Services account. You initiate a transfer between Amazon Web Services accounts using TransferDomainToAnotherAwsAccount. If you use the CLI command at accept-domain-transfer-from-another-aws-account, use JSON format as input instead of text because otherwise CLI will throw an error from domain transfer input that includes single quotes. Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled.
  20. */
  21. acceptDomainTransferFromAnotherAwsAccount(callback?: (err: AWSError, data: Route53Domains.Types.AcceptDomainTransferFromAnotherAwsAccountResponse) => void): Request<Route53Domains.Types.AcceptDomainTransferFromAnotherAwsAccountResponse, AWSError>;
  22. /**
  23. * Creates a delegation signer (DS) record in the registry zone for this domain name. Note that creating DS record at the registry impacts DNSSEC validation of your DNS records. This action may render your domain name unavailable on the internet if the steps are completed in the wrong order, or with incorrect timing. For more information about DNSSEC signing, see Configuring DNSSEC signing in the Route 53 developer guide.
  24. */
  25. associateDelegationSignerToDomain(params: Route53Domains.Types.AssociateDelegationSignerToDomainRequest, callback?: (err: AWSError, data: Route53Domains.Types.AssociateDelegationSignerToDomainResponse) => void): Request<Route53Domains.Types.AssociateDelegationSignerToDomainResponse, AWSError>;
  26. /**
  27. * Creates a delegation signer (DS) record in the registry zone for this domain name. Note that creating DS record at the registry impacts DNSSEC validation of your DNS records. This action may render your domain name unavailable on the internet if the steps are completed in the wrong order, or with incorrect timing. For more information about DNSSEC signing, see Configuring DNSSEC signing in the Route 53 developer guide.
  28. */
  29. associateDelegationSignerToDomain(callback?: (err: AWSError, data: Route53Domains.Types.AssociateDelegationSignerToDomainResponse) => void): Request<Route53Domains.Types.AssociateDelegationSignerToDomainResponse, AWSError>;
  30. /**
  31. * Cancels the transfer of a domain from the current Amazon Web Services account to another Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using TransferDomainToAnotherAwsAccount. You must cancel the transfer before the other Amazon Web Services account accepts the transfer using AcceptDomainTransferFromAnotherAwsAccount. Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled.
  32. */
  33. cancelDomainTransferToAnotherAwsAccount(params: Route53Domains.Types.CancelDomainTransferToAnotherAwsAccountRequest, callback?: (err: AWSError, data: Route53Domains.Types.CancelDomainTransferToAnotherAwsAccountResponse) => void): Request<Route53Domains.Types.CancelDomainTransferToAnotherAwsAccountResponse, AWSError>;
  34. /**
  35. * Cancels the transfer of a domain from the current Amazon Web Services account to another Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using TransferDomainToAnotherAwsAccount. You must cancel the transfer before the other Amazon Web Services account accepts the transfer using AcceptDomainTransferFromAnotherAwsAccount. Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled.
  36. */
  37. cancelDomainTransferToAnotherAwsAccount(callback?: (err: AWSError, data: Route53Domains.Types.CancelDomainTransferToAnotherAwsAccountResponse) => void): Request<Route53Domains.Types.CancelDomainTransferToAnotherAwsAccountResponse, AWSError>;
  38. /**
  39. * This operation checks the availability of one domain name. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name.
  40. */
  41. checkDomainAvailability(params: Route53Domains.Types.CheckDomainAvailabilityRequest, callback?: (err: AWSError, data: Route53Domains.Types.CheckDomainAvailabilityResponse) => void): Request<Route53Domains.Types.CheckDomainAvailabilityResponse, AWSError>;
  42. /**
  43. * This operation checks the availability of one domain name. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name.
  44. */
  45. checkDomainAvailability(callback?: (err: AWSError, data: Route53Domains.Types.CheckDomainAvailabilityResponse) => void): Request<Route53Domains.Types.CheckDomainAvailabilityResponse, AWSError>;
  46. /**
  47. * Checks whether a domain name can be transferred to Amazon Route 53.
  48. */
  49. checkDomainTransferability(params: Route53Domains.Types.CheckDomainTransferabilityRequest, callback?: (err: AWSError, data: Route53Domains.Types.CheckDomainTransferabilityResponse) => void): Request<Route53Domains.Types.CheckDomainTransferabilityResponse, AWSError>;
  50. /**
  51. * Checks whether a domain name can be transferred to Amazon Route 53.
  52. */
  53. checkDomainTransferability(callback?: (err: AWSError, data: Route53Domains.Types.CheckDomainTransferabilityResponse) => void): Request<Route53Domains.Types.CheckDomainTransferabilityResponse, AWSError>;
  54. /**
  55. * This operation deletes the specified domain. This action is permanent. For more information, see Deleting a domain name registration. To transfer the domain registration to another registrar, use the transfer process that’s provided by the registrar to which you want to transfer the registration. Otherwise, the following apply: You can’t get a refund for the cost of a deleted domain registration. The registry for the top-level domain might hold the domain name for a brief time before releasing it for other users to register (varies by registry). When the registration has been deleted, we'll send you a confirmation to the registrant contact. The email will come from noreply@domainnameverification.net or noreply@registrar.amazon.com.
  56. */
  57. deleteDomain(params: Route53Domains.Types.DeleteDomainRequest, callback?: (err: AWSError, data: Route53Domains.Types.DeleteDomainResponse) => void): Request<Route53Domains.Types.DeleteDomainResponse, AWSError>;
  58. /**
  59. * This operation deletes the specified domain. This action is permanent. For more information, see Deleting a domain name registration. To transfer the domain registration to another registrar, use the transfer process that’s provided by the registrar to which you want to transfer the registration. Otherwise, the following apply: You can’t get a refund for the cost of a deleted domain registration. The registry for the top-level domain might hold the domain name for a brief time before releasing it for other users to register (varies by registry). When the registration has been deleted, we'll send you a confirmation to the registrant contact. The email will come from noreply@domainnameverification.net or noreply@registrar.amazon.com.
  60. */
  61. deleteDomain(callback?: (err: AWSError, data: Route53Domains.Types.DeleteDomainResponse) => void): Request<Route53Domains.Types.DeleteDomainResponse, AWSError>;
  62. /**
  63. * This operation deletes the specified tags for a domain. All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.
  64. */
  65. deleteTagsForDomain(params: Route53Domains.Types.DeleteTagsForDomainRequest, callback?: (err: AWSError, data: Route53Domains.Types.DeleteTagsForDomainResponse) => void): Request<Route53Domains.Types.DeleteTagsForDomainResponse, AWSError>;
  66. /**
  67. * This operation deletes the specified tags for a domain. All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.
  68. */
  69. deleteTagsForDomain(callback?: (err: AWSError, data: Route53Domains.Types.DeleteTagsForDomainResponse) => void): Request<Route53Domains.Types.DeleteTagsForDomainResponse, AWSError>;
  70. /**
  71. * This operation disables automatic renewal of domain registration for the specified domain.
  72. */
  73. disableDomainAutoRenew(params: Route53Domains.Types.DisableDomainAutoRenewRequest, callback?: (err: AWSError, data: Route53Domains.Types.DisableDomainAutoRenewResponse) => void): Request<Route53Domains.Types.DisableDomainAutoRenewResponse, AWSError>;
  74. /**
  75. * This operation disables automatic renewal of domain registration for the specified domain.
  76. */
  77. disableDomainAutoRenew(callback?: (err: AWSError, data: Route53Domains.Types.DisableDomainAutoRenewResponse) => void): Request<Route53Domains.Types.DisableDomainAutoRenewResponse, AWSError>;
  78. /**
  79. * This operation removes the transfer lock on the domain (specifically the clientTransferProhibited status) to allow domain transfers. We recommend you refrain from performing this action unless you intend to transfer the domain to a different registrar. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
  80. */
  81. disableDomainTransferLock(params: Route53Domains.Types.DisableDomainTransferLockRequest, callback?: (err: AWSError, data: Route53Domains.Types.DisableDomainTransferLockResponse) => void): Request<Route53Domains.Types.DisableDomainTransferLockResponse, AWSError>;
  82. /**
  83. * This operation removes the transfer lock on the domain (specifically the clientTransferProhibited status) to allow domain transfers. We recommend you refrain from performing this action unless you intend to transfer the domain to a different registrar. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
  84. */
  85. disableDomainTransferLock(callback?: (err: AWSError, data: Route53Domains.Types.DisableDomainTransferLockResponse) => void): Request<Route53Domains.Types.DisableDomainTransferLockResponse, AWSError>;
  86. /**
  87. * Deletes a delegation signer (DS) record in the registry zone for this domain name.
  88. */
  89. disassociateDelegationSignerFromDomain(params: Route53Domains.Types.DisassociateDelegationSignerFromDomainRequest, callback?: (err: AWSError, data: Route53Domains.Types.DisassociateDelegationSignerFromDomainResponse) => void): Request<Route53Domains.Types.DisassociateDelegationSignerFromDomainResponse, AWSError>;
  90. /**
  91. * Deletes a delegation signer (DS) record in the registry zone for this domain name.
  92. */
  93. disassociateDelegationSignerFromDomain(callback?: (err: AWSError, data: Route53Domains.Types.DisassociateDelegationSignerFromDomainResponse) => void): Request<Route53Domains.Types.DisassociateDelegationSignerFromDomainResponse, AWSError>;
  94. /**
  95. * This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. The cost of renewing your domain registration is billed to your Amazon Web Services account. The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see Domains That You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide. Route 53 requires that you renew before the end of the renewal period so we can complete processing before the deadline.
  96. */
  97. enableDomainAutoRenew(params: Route53Domains.Types.EnableDomainAutoRenewRequest, callback?: (err: AWSError, data: Route53Domains.Types.EnableDomainAutoRenewResponse) => void): Request<Route53Domains.Types.EnableDomainAutoRenewResponse, AWSError>;
  98. /**
  99. * This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. The cost of renewing your domain registration is billed to your Amazon Web Services account. The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see Domains That You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide. Route 53 requires that you renew before the end of the renewal period so we can complete processing before the deadline.
  100. */
  101. enableDomainAutoRenew(callback?: (err: AWSError, data: Route53Domains.Types.EnableDomainAutoRenewResponse) => void): Request<Route53Domains.Types.EnableDomainAutoRenewResponse, AWSError>;
  102. /**
  103. * This operation sets the transfer lock on the domain (specifically the clientTransferProhibited status) to prevent domain transfers. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
  104. */
  105. enableDomainTransferLock(params: Route53Domains.Types.EnableDomainTransferLockRequest, callback?: (err: AWSError, data: Route53Domains.Types.EnableDomainTransferLockResponse) => void): Request<Route53Domains.Types.EnableDomainTransferLockResponse, AWSError>;
  106. /**
  107. * This operation sets the transfer lock on the domain (specifically the clientTransferProhibited status) to prevent domain transfers. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
  108. */
  109. enableDomainTransferLock(callback?: (err: AWSError, data: Route53Domains.Types.EnableDomainTransferLockResponse) => void): Request<Route53Domains.Types.EnableDomainTransferLockResponse, AWSError>;
  110. /**
  111. * For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation returns information about whether the registrant contact has responded. If you want us to resend the email, use the ResendContactReachabilityEmail operation.
  112. */
  113. getContactReachabilityStatus(params: Route53Domains.Types.GetContactReachabilityStatusRequest, callback?: (err: AWSError, data: Route53Domains.Types.GetContactReachabilityStatusResponse) => void): Request<Route53Domains.Types.GetContactReachabilityStatusResponse, AWSError>;
  114. /**
  115. * For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation returns information about whether the registrant contact has responded. If you want us to resend the email, use the ResendContactReachabilityEmail operation.
  116. */
  117. getContactReachabilityStatus(callback?: (err: AWSError, data: Route53Domains.Types.GetContactReachabilityStatusResponse) => void): Request<Route53Domains.Types.GetContactReachabilityStatusResponse, AWSError>;
  118. /**
  119. * This operation returns detailed information about a specified domain that is associated with the current Amazon Web Services account. Contact information for the domain is also returned as part of the output.
  120. */
  121. getDomainDetail(params: Route53Domains.Types.GetDomainDetailRequest, callback?: (err: AWSError, data: Route53Domains.Types.GetDomainDetailResponse) => void): Request<Route53Domains.Types.GetDomainDetailResponse, AWSError>;
  122. /**
  123. * This operation returns detailed information about a specified domain that is associated with the current Amazon Web Services account. Contact information for the domain is also returned as part of the output.
  124. */
  125. getDomainDetail(callback?: (err: AWSError, data: Route53Domains.Types.GetDomainDetailResponse) => void): Request<Route53Domains.Types.GetDomainDetailResponse, AWSError>;
  126. /**
  127. * The GetDomainSuggestions operation returns a list of suggested domain names.
  128. */
  129. getDomainSuggestions(params: Route53Domains.Types.GetDomainSuggestionsRequest, callback?: (err: AWSError, data: Route53Domains.Types.GetDomainSuggestionsResponse) => void): Request<Route53Domains.Types.GetDomainSuggestionsResponse, AWSError>;
  130. /**
  131. * The GetDomainSuggestions operation returns a list of suggested domain names.
  132. */
  133. getDomainSuggestions(callback?: (err: AWSError, data: Route53Domains.Types.GetDomainSuggestionsResponse) => void): Request<Route53Domains.Types.GetDomainSuggestionsResponse, AWSError>;
  134. /**
  135. * This operation returns the current status of an operation that is not completed.
  136. */
  137. getOperationDetail(params: Route53Domains.Types.GetOperationDetailRequest, callback?: (err: AWSError, data: Route53Domains.Types.GetOperationDetailResponse) => void): Request<Route53Domains.Types.GetOperationDetailResponse, AWSError>;
  138. /**
  139. * This operation returns the current status of an operation that is not completed.
  140. */
  141. getOperationDetail(callback?: (err: AWSError, data: Route53Domains.Types.GetOperationDetailResponse) => void): Request<Route53Domains.Types.GetOperationDetailResponse, AWSError>;
  142. /**
  143. * This operation returns all the domain names registered with Amazon Route 53 for the current Amazon Web Services account if no filtering conditions are used.
  144. */
  145. listDomains(params: Route53Domains.Types.ListDomainsRequest, callback?: (err: AWSError, data: Route53Domains.Types.ListDomainsResponse) => void): Request<Route53Domains.Types.ListDomainsResponse, AWSError>;
  146. /**
  147. * This operation returns all the domain names registered with Amazon Route 53 for the current Amazon Web Services account if no filtering conditions are used.
  148. */
  149. listDomains(callback?: (err: AWSError, data: Route53Domains.Types.ListDomainsResponse) => void): Request<Route53Domains.Types.ListDomainsResponse, AWSError>;
  150. /**
  151. * Returns information about all of the operations that return an operation ID and that have ever been performed on domains that were registered by the current account. This command runs only in the us-east-1 Region.
  152. */
  153. listOperations(params: Route53Domains.Types.ListOperationsRequest, callback?: (err: AWSError, data: Route53Domains.Types.ListOperationsResponse) => void): Request<Route53Domains.Types.ListOperationsResponse, AWSError>;
  154. /**
  155. * Returns information about all of the operations that return an operation ID and that have ever been performed on domains that were registered by the current account. This command runs only in the us-east-1 Region.
  156. */
  157. listOperations(callback?: (err: AWSError, data: Route53Domains.Types.ListOperationsResponse) => void): Request<Route53Domains.Types.ListOperationsResponse, AWSError>;
  158. /**
  159. * Lists the following prices for either all the TLDs supported by Route 53, or the specified TLD: Registration Transfer Owner change Domain renewal Domain restoration
  160. */
  161. listPrices(params: Route53Domains.Types.ListPricesRequest, callback?: (err: AWSError, data: Route53Domains.Types.ListPricesResponse) => void): Request<Route53Domains.Types.ListPricesResponse, AWSError>;
  162. /**
  163. * Lists the following prices for either all the TLDs supported by Route 53, or the specified TLD: Registration Transfer Owner change Domain renewal Domain restoration
  164. */
  165. listPrices(callback?: (err: AWSError, data: Route53Domains.Types.ListPricesResponse) => void): Request<Route53Domains.Types.ListPricesResponse, AWSError>;
  166. /**
  167. * This operation returns all of the tags that are associated with the specified domain. All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.
  168. */
  169. listTagsForDomain(params: Route53Domains.Types.ListTagsForDomainRequest, callback?: (err: AWSError, data: Route53Domains.Types.ListTagsForDomainResponse) => void): Request<Route53Domains.Types.ListTagsForDomainResponse, AWSError>;
  170. /**
  171. * This operation returns all of the tags that are associated with the specified domain. All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.
  172. */
  173. listTagsForDomain(callback?: (err: AWSError, data: Route53Domains.Types.ListTagsForDomainResponse) => void): Request<Route53Domains.Types.ListTagsForDomainResponse, AWSError>;
  174. /**
  175. * Moves a domain from Amazon Web Services to another registrar. Supported actions: Changes the IPS tags of a .uk domain, and pushes it to transit. Transit means that the domain is ready to be transferred to another registrar.
  176. */
  177. pushDomain(params: Route53Domains.Types.PushDomainRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  178. /**
  179. * Moves a domain from Amazon Web Services to another registrar. Supported actions: Changes the IPS tags of a .uk domain, and pushes it to transit. Transit means that the domain is ready to be transferred to another registrar.
  180. */
  181. pushDomain(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  182. /**
  183. * This operation registers a domain. For some top-level domains (TLDs), this operation requires extra parameters. When you register a domain, Amazon Route 53 does the following: Creates a Route 53 hosted zone that has the same name as the domain. Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers. Enables auto renew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration. Optionally enables privacy protection, so WHOIS queries return contact for the registrar or the phrase "REDACTED FOR PRIVACY", or "On behalf of &lt;domain name&gt; owner." If you don't enable privacy protection, WHOIS queries return the information that you entered for the administrative, registrant, and technical contacts. While some domains may allow different privacy settings per contact, we recommend specifying the same privacy setting for all contacts. If registration is successful, returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant is notified by email. Charges your Amazon Web Services account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing.
  184. */
  185. registerDomain(params: Route53Domains.Types.RegisterDomainRequest, callback?: (err: AWSError, data: Route53Domains.Types.RegisterDomainResponse) => void): Request<Route53Domains.Types.RegisterDomainResponse, AWSError>;
  186. /**
  187. * This operation registers a domain. For some top-level domains (TLDs), this operation requires extra parameters. When you register a domain, Amazon Route 53 does the following: Creates a Route 53 hosted zone that has the same name as the domain. Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers. Enables auto renew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration. Optionally enables privacy protection, so WHOIS queries return contact for the registrar or the phrase "REDACTED FOR PRIVACY", or "On behalf of &lt;domain name&gt; owner." If you don't enable privacy protection, WHOIS queries return the information that you entered for the administrative, registrant, and technical contacts. While some domains may allow different privacy settings per contact, we recommend specifying the same privacy setting for all contacts. If registration is successful, returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant is notified by email. Charges your Amazon Web Services account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing.
  188. */
  189. registerDomain(callback?: (err: AWSError, data: Route53Domains.Types.RegisterDomainResponse) => void): Request<Route53Domains.Types.RegisterDomainResponse, AWSError>;
  190. /**
  191. * Rejects the transfer of a domain from another Amazon Web Services account to the current Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using TransferDomainToAnotherAwsAccount. Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled.
  192. */
  193. rejectDomainTransferFromAnotherAwsAccount(params: Route53Domains.Types.RejectDomainTransferFromAnotherAwsAccountRequest, callback?: (err: AWSError, data: Route53Domains.Types.RejectDomainTransferFromAnotherAwsAccountResponse) => void): Request<Route53Domains.Types.RejectDomainTransferFromAnotherAwsAccountResponse, AWSError>;
  194. /**
  195. * Rejects the transfer of a domain from another Amazon Web Services account to the current Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using TransferDomainToAnotherAwsAccount. Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled.
  196. */
  197. rejectDomainTransferFromAnotherAwsAccount(callback?: (err: AWSError, data: Route53Domains.Types.RejectDomainTransferFromAnotherAwsAccountResponse) => void): Request<Route53Domains.Types.RejectDomainTransferFromAnotherAwsAccountResponse, AWSError>;
  198. /**
  199. * This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your Amazon Web Services account. We recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the expiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see Renewing Registration for a Domain in the Amazon Route 53 Developer Guide.
  200. */
  201. renewDomain(params: Route53Domains.Types.RenewDomainRequest, callback?: (err: AWSError, data: Route53Domains.Types.RenewDomainResponse) => void): Request<Route53Domains.Types.RenewDomainResponse, AWSError>;
  202. /**
  203. * This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your Amazon Web Services account. We recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the expiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see Renewing Registration for a Domain in the Amazon Route 53 Developer Guide.
  204. */
  205. renewDomain(callback?: (err: AWSError, data: Route53Domains.Types.RenewDomainResponse) => void): Request<Route53Domains.Types.RenewDomainResponse, AWSError>;
  206. /**
  207. * For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation resends the confirmation email to the current email address for the registrant contact.
  208. */
  209. resendContactReachabilityEmail(params: Route53Domains.Types.ResendContactReachabilityEmailRequest, callback?: (err: AWSError, data: Route53Domains.Types.ResendContactReachabilityEmailResponse) => void): Request<Route53Domains.Types.ResendContactReachabilityEmailResponse, AWSError>;
  210. /**
  211. * For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation resends the confirmation email to the current email address for the registrant contact.
  212. */
  213. resendContactReachabilityEmail(callback?: (err: AWSError, data: Route53Domains.Types.ResendContactReachabilityEmailResponse) => void): Request<Route53Domains.Types.ResendContactReachabilityEmailResponse, AWSError>;
  214. /**
  215. * Resend the form of authorization email for this operation.
  216. */
  217. resendOperationAuthorization(params: Route53Domains.Types.ResendOperationAuthorizationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  218. /**
  219. * Resend the form of authorization email for this operation.
  220. */
  221. resendOperationAuthorization(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  222. /**
  223. * This operation returns the authorization code for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.
  224. */
  225. retrieveDomainAuthCode(params: Route53Domains.Types.RetrieveDomainAuthCodeRequest, callback?: (err: AWSError, data: Route53Domains.Types.RetrieveDomainAuthCodeResponse) => void): Request<Route53Domains.Types.RetrieveDomainAuthCodeResponse, AWSError>;
  226. /**
  227. * This operation returns the authorization code for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.
  228. */
  229. retrieveDomainAuthCode(callback?: (err: AWSError, data: Route53Domains.Types.RetrieveDomainAuthCodeResponse) => void): Request<Route53Domains.Types.RetrieveDomainAuthCodeResponse, AWSError>;
  230. /**
  231. * Transfers a domain from another registrar to Amazon Route 53. For more information about transferring domains, see the following topics: For transfer requirements, a detailed procedure, and information about viewing the status of a domain that you're transferring to Route 53, see Transferring Registration for a Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide. For information about how to transfer a domain from one Amazon Web Services account to another, see TransferDomainToAnotherAwsAccount. For information about how to transfer a domain to another domain registrar, see Transferring a Domain from Amazon Route 53 to Another Registrar in the Amazon Route 53 Developer Guide. During the transfer of any country code top-level domains (ccTLDs) to Route 53, except for .cc and .tv, updates to the owner contact are ignored and the owner contact data from the registry is used. You can update the owner contact after the transfer is complete. For more information, see UpdateDomainContact. If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you transfer your DNS service to Route 53 or to another DNS service provider before you transfer your registration. Some registrars provide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar will not renew your domain registration and could end your DNS service at any time. If the registrar for your domain is also the DNS service provider for the domain and you don't transfer DNS service to another provider, your website, email, and the web applications associated with the domain might become unavailable. If the transfer is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email.
  232. */
  233. transferDomain(params: Route53Domains.Types.TransferDomainRequest, callback?: (err: AWSError, data: Route53Domains.Types.TransferDomainResponse) => void): Request<Route53Domains.Types.TransferDomainResponse, AWSError>;
  234. /**
  235. * Transfers a domain from another registrar to Amazon Route 53. For more information about transferring domains, see the following topics: For transfer requirements, a detailed procedure, and information about viewing the status of a domain that you're transferring to Route 53, see Transferring Registration for a Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide. For information about how to transfer a domain from one Amazon Web Services account to another, see TransferDomainToAnotherAwsAccount. For information about how to transfer a domain to another domain registrar, see Transferring a Domain from Amazon Route 53 to Another Registrar in the Amazon Route 53 Developer Guide. During the transfer of any country code top-level domains (ccTLDs) to Route 53, except for .cc and .tv, updates to the owner contact are ignored and the owner contact data from the registry is used. You can update the owner contact after the transfer is complete. For more information, see UpdateDomainContact. If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you transfer your DNS service to Route 53 or to another DNS service provider before you transfer your registration. Some registrars provide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar will not renew your domain registration and could end your DNS service at any time. If the registrar for your domain is also the DNS service provider for the domain and you don't transfer DNS service to another provider, your website, email, and the web applications associated with the domain might become unavailable. If the transfer is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email.
  236. */
  237. transferDomain(callback?: (err: AWSError, data: Route53Domains.Types.TransferDomainResponse) => void): Request<Route53Domains.Types.TransferDomainResponse, AWSError>;
  238. /**
  239. * Transfers a domain from the current Amazon Web Services account to another Amazon Web Services account. Note the following: The Amazon Web Services account that you're transferring the domain to must accept the transfer. If the other account doesn't accept the transfer within 3 days, we cancel the transfer. See AcceptDomainTransferFromAnotherAwsAccount. You can cancel the transfer before the other account accepts it. See CancelDomainTransferToAnotherAwsAccount. The other account can reject the transfer. See RejectDomainTransferFromAnotherAwsAccount. When you transfer a domain from one Amazon Web Services account to another, Route 53 doesn't transfer the hosted zone that is associated with the domain. DNS resolution isn't affected if the domain and the hosted zone are owned by separate accounts, so transferring the hosted zone is optional. For information about transferring the hosted zone to another Amazon Web Services account, see Migrating a Hosted Zone to a Different Amazon Web Services Account in the Amazon Route 53 Developer Guide. Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled.
  240. */
  241. transferDomainToAnotherAwsAccount(params: Route53Domains.Types.TransferDomainToAnotherAwsAccountRequest, callback?: (err: AWSError, data: Route53Domains.Types.TransferDomainToAnotherAwsAccountResponse) => void): Request<Route53Domains.Types.TransferDomainToAnotherAwsAccountResponse, AWSError>;
  242. /**
  243. * Transfers a domain from the current Amazon Web Services account to another Amazon Web Services account. Note the following: The Amazon Web Services account that you're transferring the domain to must accept the transfer. If the other account doesn't accept the transfer within 3 days, we cancel the transfer. See AcceptDomainTransferFromAnotherAwsAccount. You can cancel the transfer before the other account accepts it. See CancelDomainTransferToAnotherAwsAccount. The other account can reject the transfer. See RejectDomainTransferFromAnotherAwsAccount. When you transfer a domain from one Amazon Web Services account to another, Route 53 doesn't transfer the hosted zone that is associated with the domain. DNS resolution isn't affected if the domain and the hosted zone are owned by separate accounts, so transferring the hosted zone is optional. For information about transferring the hosted zone to another Amazon Web Services account, see Migrating a Hosted Zone to a Different Amazon Web Services Account in the Amazon Route 53 Developer Guide. Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled.
  244. */
  245. transferDomainToAnotherAwsAccount(callback?: (err: AWSError, data: Route53Domains.Types.TransferDomainToAnotherAwsAccountResponse) => void): Request<Route53Domains.Types.TransferDomainToAnotherAwsAccountResponse, AWSError>;
  246. /**
  247. * This operation updates the contact information for a particular domain. You must specify information for at least one contact: registrant, administrator, or technical. If the update is successful, this method returns an operation ID that you can use to track the progress and completion of the operation. If the request is not completed successfully, the domain registrant will be notified by email.
  248. */
  249. updateDomainContact(params: Route53Domains.Types.UpdateDomainContactRequest, callback?: (err: AWSError, data: Route53Domains.Types.UpdateDomainContactResponse) => void): Request<Route53Domains.Types.UpdateDomainContactResponse, AWSError>;
  250. /**
  251. * This operation updates the contact information for a particular domain. You must specify information for at least one contact: registrant, administrator, or technical. If the update is successful, this method returns an operation ID that you can use to track the progress and completion of the operation. If the request is not completed successfully, the domain registrant will be notified by email.
  252. */
  253. updateDomainContact(callback?: (err: AWSError, data: Route53Domains.Types.UpdateDomainContactResponse) => void): Request<Route53Domains.Types.UpdateDomainContactResponse, AWSError>;
  254. /**
  255. * This operation updates the specified domain contact's privacy setting. When privacy protection is enabled, your contact information is replaced with contact information for the registrar or with the phrase "REDACTED FOR PRIVACY", or "On behalf of &lt;domain name&gt; owner." While some domains may allow different privacy settings per contact, we recommend specifying the same privacy setting for all contacts. This operation affects only the contact information for the specified contact type (administrative, registrant, or technical). If the request succeeds, Amazon Route 53 returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request doesn't complete successfully, the domain registrant will be notified by email. By disabling the privacy service via API, you consent to the publication of the contact information provided for this domain via the public WHOIS database. You certify that you are the registrant of this domain name and have the authority to make this decision. You may withdraw your consent at any time by enabling privacy protection using either UpdateDomainContactPrivacy or the Route 53 console. Enabling privacy protection removes the contact information provided for this domain from the WHOIS database. For more information on our privacy practices, see https://aws.amazon.com/privacy/.
  256. */
  257. updateDomainContactPrivacy(params: Route53Domains.Types.UpdateDomainContactPrivacyRequest, callback?: (err: AWSError, data: Route53Domains.Types.UpdateDomainContactPrivacyResponse) => void): Request<Route53Domains.Types.UpdateDomainContactPrivacyResponse, AWSError>;
  258. /**
  259. * This operation updates the specified domain contact's privacy setting. When privacy protection is enabled, your contact information is replaced with contact information for the registrar or with the phrase "REDACTED FOR PRIVACY", or "On behalf of &lt;domain name&gt; owner." While some domains may allow different privacy settings per contact, we recommend specifying the same privacy setting for all contacts. This operation affects only the contact information for the specified contact type (administrative, registrant, or technical). If the request succeeds, Amazon Route 53 returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request doesn't complete successfully, the domain registrant will be notified by email. By disabling the privacy service via API, you consent to the publication of the contact information provided for this domain via the public WHOIS database. You certify that you are the registrant of this domain name and have the authority to make this decision. You may withdraw your consent at any time by enabling privacy protection using either UpdateDomainContactPrivacy or the Route 53 console. Enabling privacy protection removes the contact information provided for this domain from the WHOIS database. For more information on our privacy practices, see https://aws.amazon.com/privacy/.
  260. */
  261. updateDomainContactPrivacy(callback?: (err: AWSError, data: Route53Domains.Types.UpdateDomainContactPrivacyResponse) => void): Request<Route53Domains.Types.UpdateDomainContactPrivacyResponse, AWSError>;
  262. /**
  263. * This operation replaces the current set of name servers for the domain with the specified set of name servers. If you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain. If successful, this operation returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
  264. */
  265. updateDomainNameservers(params: Route53Domains.Types.UpdateDomainNameserversRequest, callback?: (err: AWSError, data: Route53Domains.Types.UpdateDomainNameserversResponse) => void): Request<Route53Domains.Types.UpdateDomainNameserversResponse, AWSError>;
  266. /**
  267. * This operation replaces the current set of name servers for the domain with the specified set of name servers. If you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain. If successful, this operation returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
  268. */
  269. updateDomainNameservers(callback?: (err: AWSError, data: Route53Domains.Types.UpdateDomainNameserversResponse) => void): Request<Route53Domains.Types.UpdateDomainNameserversResponse, AWSError>;
  270. /**
  271. * This operation adds or updates tags for a specified domain. All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.
  272. */
  273. updateTagsForDomain(params: Route53Domains.Types.UpdateTagsForDomainRequest, callback?: (err: AWSError, data: Route53Domains.Types.UpdateTagsForDomainResponse) => void): Request<Route53Domains.Types.UpdateTagsForDomainResponse, AWSError>;
  274. /**
  275. * This operation adds or updates tags for a specified domain. All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.
  276. */
  277. updateTagsForDomain(callback?: (err: AWSError, data: Route53Domains.Types.UpdateTagsForDomainResponse) => void): Request<Route53Domains.Types.UpdateTagsForDomainResponse, AWSError>;
  278. /**
  279. * Returns all the domain-related billing records for the current Amazon Web Services account for a specified period
  280. */
  281. viewBilling(params: Route53Domains.Types.ViewBillingRequest, callback?: (err: AWSError, data: Route53Domains.Types.ViewBillingResponse) => void): Request<Route53Domains.Types.ViewBillingResponse, AWSError>;
  282. /**
  283. * Returns all the domain-related billing records for the current Amazon Web Services account for a specified period
  284. */
  285. viewBilling(callback?: (err: AWSError, data: Route53Domains.Types.ViewBillingResponse) => void): Request<Route53Domains.Types.ViewBillingResponse, AWSError>;
  286. }
  287. declare namespace Route53Domains {
  288. export interface AcceptDomainTransferFromAnotherAwsAccountRequest {
  289. /**
  290. * The name of the domain that was specified when another Amazon Web Services account submitted a TransferDomainToAnotherAwsAccount request.
  291. */
  292. DomainName: DomainName;
  293. /**
  294. * The password that was returned by the TransferDomainToAnotherAwsAccount request.
  295. */
  296. Password: Password;
  297. }
  298. export interface AcceptDomainTransferFromAnotherAwsAccountResponse {
  299. /**
  300. * Identifier for tracking the progress of the request. To query the operation status, use GetOperationDetail.
  301. */
  302. OperationId?: OperationId;
  303. }
  304. export type AccountId = string;
  305. export type AddressLine = string;
  306. export interface AssociateDelegationSignerToDomainRequest {
  307. /**
  308. * The name of the domain.
  309. */
  310. DomainName: DomainName;
  311. /**
  312. * The information about a key, including the algorithm, public key-value, and flags.
  313. */
  314. SigningAttributes: DnssecSigningAttributes;
  315. }
  316. export interface AssociateDelegationSignerToDomainResponse {
  317. /**
  318. * The identifier for tracking the progress of the request. To query the operation status, use GetOperationDetail.
  319. */
  320. OperationId?: OperationId;
  321. }
  322. export interface BillingRecord {
  323. /**
  324. * 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.
  325. */
  326. DomainName?: DomainName;
  327. /**
  328. * The operation that you were charged for.
  329. */
  330. Operation?: OperationType;
  331. /**
  332. * The ID of the invoice that is associated with the billing record.
  333. */
  334. InvoiceId?: InvoiceId;
  335. /**
  336. * The date that the operation was billed, in Unix format.
  337. */
  338. BillDate?: Timestamp;
  339. /**
  340. * The price that you were charged for the operation, in US dollars. Example value: 12.0
  341. */
  342. Price?: Price;
  343. }
  344. export type BillingRecords = BillingRecord[];
  345. export type Boolean = boolean;
  346. export interface CancelDomainTransferToAnotherAwsAccountRequest {
  347. /**
  348. * The name of the domain for which you want to cancel the transfer to another Amazon Web Services account.
  349. */
  350. DomainName: DomainName;
  351. }
  352. export interface CancelDomainTransferToAnotherAwsAccountResponse {
  353. /**
  354. * 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.
  355. */
  356. OperationId?: OperationId;
  357. }
  358. export interface CheckDomainAvailabilityRequest {
  359. /**
  360. * 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.
  361. */
  362. DomainName: DomainName;
  363. /**
  364. * Reserved for future use.
  365. */
  366. IdnLangCode?: LangCode;
  367. }
  368. export interface CheckDomainAvailabilityResponse {
  369. /**
  370. * 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.
  371. */
  372. Availability?: DomainAvailability;
  373. }
  374. export interface CheckDomainTransferabilityRequest {
  375. /**
  376. * 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.
  377. */
  378. DomainName: DomainName;
  379. /**
  380. * 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.
  381. */
  382. AuthCode?: DomainAuthCode;
  383. }
  384. export interface CheckDomainTransferabilityResponse {
  385. /**
  386. * A complex type that contains information about whether the specified domain can be transferred to Route 53.
  387. */
  388. Transferability?: DomainTransferability;
  389. /**
  390. * Provides an explanation for when a domain can't be transferred.
  391. */
  392. Message?: Message;
  393. }
  394. export type City = string;
  395. export interface Consent {
  396. /**
  397. * Maximum amount the customer agreed to accept.
  398. */
  399. MaxPrice: Price;
  400. /**
  401. * Currency for the MaxPrice.
  402. */
  403. Currency: Currency;
  404. }
  405. export interface ContactDetail {
  406. /**
  407. * First name of contact.
  408. */
  409. FirstName?: ContactName;
  410. /**
  411. * Last name of contact.
  412. */
  413. LastName?: ContactName;
  414. /**
  415. * 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.
  416. */
  417. ContactType?: ContactType;
  418. /**
  419. * Name of the organization for contact types other than PERSON.
  420. */
  421. OrganizationName?: ContactName;
  422. /**
  423. * First line of the contact's address.
  424. */
  425. AddressLine1?: AddressLine;
  426. /**
  427. * Second line of contact's address, if any.
  428. */
  429. AddressLine2?: AddressLine;
  430. /**
  431. * The city of the contact's address.
  432. */
  433. City?: City;
  434. /**
  435. * The state or province of the contact's city.
  436. */
  437. State?: State;
  438. /**
  439. * Code for the country of the contact's address.
  440. */
  441. CountryCode?: CountryCode;
  442. /**
  443. * The zip or postal code of the contact's address.
  444. */
  445. ZipCode?: ZipCode;
  446. /**
  447. * The phone number of the contact. Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code&gt;]". For example, a US phone number might appear as "+1.1234567890".
  448. */
  449. PhoneNumber?: ContactNumber;
  450. /**
  451. * Email address of the contact.
  452. */
  453. Email?: Email;
  454. /**
  455. * 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".
  456. */
  457. Fax?: ContactNumber;
  458. /**
  459. * A list of name-value pairs for parameters required by certain top-level domains.
  460. */
  461. ExtraParams?: ExtraParamList;
  462. }
  463. export type ContactName = string;
  464. export type ContactNumber = string;
  465. export type ContactType = "PERSON"|"COMPANY"|"ASSOCIATION"|"PUBLIC_BODY"|"RESELLER"|string;
  466. export type CountryCode = "AC"|"AD"|"AE"|"AF"|"AG"|"AI"|"AL"|"AM"|"AN"|"AO"|"AQ"|"AR"|"AS"|"AT"|"AU"|"AW"|"AX"|"AZ"|"BA"|"BB"|"BD"|"BE"|"BF"|"BG"|"BH"|"BI"|"BJ"|"BL"|"BM"|"BN"|"BO"|"BQ"|"BR"|"BS"|"BT"|"BV"|"BW"|"BY"|"BZ"|"CA"|"CC"|"CD"|"CF"|"CG"|"CH"|"CI"|"CK"|"CL"|"CM"|"CN"|"CO"|"CR"|"CU"|"CV"|"CW"|"CX"|"CY"|"CZ"|"DE"|"DJ"|"DK"|"DM"|"DO"|"DZ"|"EC"|"EE"|"EG"|"EH"|"ER"|"ES"|"ET"|"FI"|"FJ"|"FK"|"FM"|"FO"|"FR"|"GA"|"GB"|"GD"|"GE"|"GF"|"GG"|"GH"|"GI"|"GL"|"GM"|"GN"|"GP"|"GQ"|"GR"|"GS"|"GT"|"GU"|"GW"|"GY"|"HK"|"HM"|"HN"|"HR"|"HT"|"HU"|"ID"|"IE"|"IL"|"IM"|"IN"|"IO"|"IQ"|"IR"|"IS"|"IT"|"JE"|"JM"|"JO"|"JP"|"KE"|"KG"|"KH"|"KI"|"KM"|"KN"|"KP"|"KR"|"KW"|"KY"|"KZ"|"LA"|"LB"|"LC"|"LI"|"LK"|"LR"|"LS"|"LT"|"LU"|"LV"|"LY"|"MA"|"MC"|"MD"|"ME"|"MF"|"MG"|"MH"|"MK"|"ML"|"MM"|"MN"|"MO"|"MP"|"MQ"|"MR"|"MS"|"MT"|"MU"|"MV"|"MW"|"MX"|"MY"|"MZ"|"NA"|"NC"|"NE"|"NF"|"NG"|"NI"|"NL"|"NO"|"NP"|"NR"|"NU"|"NZ"|"OM"|"PA"|"PE"|"PF"|"PG"|"PH"|"PK"|"PL"|"PM"|"PN"|"PR"|"PS"|"PT"|"PW"|"PY"|"QA"|"RE"|"RO"|"RS"|"RU"|"RW"|"SA"|"SB"|"SC"|"SD"|"SE"|"SG"|"SH"|"SI"|"SJ"|"SK"|"SL"|"SM"|"SN"|"SO"|"SR"|"SS"|"ST"|"SV"|"SX"|"SY"|"SZ"|"TC"|"TD"|"TF"|"TG"|"TH"|"TJ"|"TK"|"TL"|"TM"|"TN"|"TO"|"TP"|"TR"|"TT"|"TV"|"TW"|"TZ"|"UA"|"UG"|"US"|"UY"|"UZ"|"VA"|"VC"|"VE"|"VG"|"VI"|"VN"|"VU"|"WF"|"WS"|"YE"|"YT"|"ZA"|"ZM"|"ZW"|string;
  467. export type Currency = string;
  468. export type CurrentExpiryYear = number;
  469. export type DNSSec = string;
  470. export interface DeleteDomainRequest {
  471. /**
  472. * Name of the domain to be deleted.
  473. */
  474. DomainName: DomainName;
  475. }
  476. export interface DeleteDomainResponse {
  477. /**
  478. * Identifier for tracking the progress of the request. To query the operation status, use GetOperationDetail.
  479. */
  480. OperationId?: OperationId;
  481. }
  482. export interface DeleteTagsForDomainRequest {
  483. /**
  484. * The domain for which you want to delete one or more tags.
  485. */
  486. DomainName: DomainName;
  487. /**
  488. * A list of tag keys to delete.
  489. */
  490. TagsToDelete: TagKeyList;
  491. }
  492. export interface DeleteTagsForDomainResponse {
  493. }
  494. export interface DisableDomainAutoRenewRequest {
  495. /**
  496. * The name of the domain that you want to disable automatic renewal for.
  497. */
  498. DomainName: DomainName;
  499. }
  500. export interface DisableDomainAutoRenewResponse {
  501. }
  502. export interface DisableDomainTransferLockRequest {
  503. /**
  504. * The name of the domain that you want to remove the transfer lock for.
  505. */
  506. DomainName: DomainName;
  507. }
  508. export interface DisableDomainTransferLockResponse {
  509. /**
  510. * Identifier for tracking the progress of the request. To query the operation status, use GetOperationDetail.
  511. */
  512. OperationId?: OperationId;
  513. }
  514. export interface DisassociateDelegationSignerFromDomainRequest {
  515. /**
  516. * Name of the domain.
  517. */
  518. DomainName: DomainName;
  519. /**
  520. * 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.
  521. */
  522. Id: String;
  523. }
  524. export interface DisassociateDelegationSignerFromDomainResponse {
  525. /**
  526. * Identifier for tracking the progress of the request. To query the operation status, use GetOperationDetail.
  527. */
  528. OperationId?: OperationId;
  529. }
  530. export interface DnssecKey {
  531. /**
  532. * 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.
  533. */
  534. Algorithm?: NullableInteger;
  535. /**
  536. * 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.
  537. */
  538. Flags?: NullableInteger;
  539. /**
  540. * The base64-encoded public key part of the key pair that is passed to the registry .
  541. */
  542. PublicKey?: DnssecPublicKey;
  543. /**
  544. * 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.
  545. */
  546. DigestType?: NullableInteger;
  547. /**
  548. * 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.
  549. */
  550. Digest?: String;
  551. /**
  552. * A numeric identification of the DNSKEY record referred to by this DS record.
  553. */
  554. KeyTag?: NullableInteger;
  555. /**
  556. * An ID assigned to each DS record created by AssociateDelegationSignerToDomain.
  557. */
  558. Id?: String;
  559. }
  560. export type DnssecKeyList = DnssecKey[];
  561. export type DnssecPublicKey = string;
  562. export interface DnssecSigningAttributes {
  563. /**
  564. * Algorithm which was used to generate the digest from the public key.
  565. */
  566. Algorithm?: NullableInteger;
  567. /**
  568. * 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.
  569. */
  570. Flags?: NullableInteger;
  571. /**
  572. * The base64-encoded public key part of the key pair that is passed to the registry.
  573. */
  574. PublicKey?: DnssecPublicKey;
  575. }
  576. export type DomainAuthCode = string;
  577. export type DomainAvailability = "AVAILABLE"|"AVAILABLE_RESERVED"|"AVAILABLE_PREORDER"|"UNAVAILABLE"|"UNAVAILABLE_PREMIUM"|"UNAVAILABLE_RESTRICTED"|"RESERVED"|"DONT_KNOW"|"INVALID_NAME_FOR_TLD"|"PENDING"|string;
  578. export type DomainName = string;
  579. export interface DomainPrice {
  580. /**
  581. * The name of the TLD for which the prices apply.
  582. */
  583. Name?: DomainPriceName;
  584. /**
  585. * The price for domain registration with Route 53.
  586. */
  587. RegistrationPrice?: PriceWithCurrency;
  588. /**
  589. * The price for transferring the domain registration to Route 53.
  590. */
  591. TransferPrice?: PriceWithCurrency;
  592. /**
  593. * The price for renewing domain registration with Route 53.
  594. */
  595. RenewalPrice?: PriceWithCurrency;
  596. /**
  597. * The price for changing domain ownership.
  598. */
  599. ChangeOwnershipPrice?: PriceWithCurrency;
  600. /**
  601. * The price for restoring the domain with Route 53.
  602. */
  603. RestorationPrice?: PriceWithCurrency;
  604. }
  605. export type DomainPriceList = DomainPrice[];
  606. export type DomainPriceName = string;
  607. export type DomainStatus = string;
  608. export type DomainStatusList = DomainStatus[];
  609. export interface DomainSuggestion {
  610. /**
  611. * A suggested domain name.
  612. */
  613. DomainName?: DomainName;
  614. /**
  615. * 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.
  616. */
  617. Availability?: String;
  618. }
  619. export type DomainSuggestionsList = DomainSuggestion[];
  620. export interface DomainSummary {
  621. /**
  622. * The name of the domain that the summary information applies to.
  623. */
  624. DomainName?: DomainName;
  625. /**
  626. * Indicates whether the domain is automatically renewed upon expiration.
  627. */
  628. AutoRenew?: Boolean;
  629. /**
  630. * Indicates whether a domain is locked from unauthorized transfer to another party.
  631. */
  632. TransferLock?: Boolean;
  633. /**
  634. * Expiration date of the domain in Unix time format and Coordinated Universal Time (UTC).
  635. */
  636. Expiry?: Timestamp;
  637. }
  638. export type DomainSummaryList = DomainSummary[];
  639. export interface DomainTransferability {
  640. Transferable?: Transferable;
  641. }
  642. export type DurationInYears = number;
  643. export type Email = string;
  644. export interface EnableDomainAutoRenewRequest {
  645. /**
  646. * The name of the domain that you want to enable automatic renewal for.
  647. */
  648. DomainName: DomainName;
  649. }
  650. export interface EnableDomainAutoRenewResponse {
  651. }
  652. export interface EnableDomainTransferLockRequest {
  653. /**
  654. * The name of the domain that you want to set the transfer lock for.
  655. */
  656. DomainName: DomainName;
  657. }
  658. export interface EnableDomainTransferLockResponse {
  659. /**
  660. * Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
  661. */
  662. OperationId?: OperationId;
  663. }
  664. export type ErrorMessage = string;
  665. export interface ExtraParam {
  666. /**
  667. * The name of an additional parameter that is required by a top-level domain. Here are the top-level domains that require additional parameters and the names of the parameters that they require: .com.au and .net.au AU_ID_NUMBER AU_ID_TYPE Valid values include the following: ABN (Australian business number) ACN (Australian company number) TM (Trademark number) .ca BRAND_NUMBER CA_BUSINESS_ENTITY_TYPE Valid values include the following: BANK (Bank) COMMERCIAL_COMPANY (Commercial company) COMPANY (Company) COOPERATION (Cooperation) COOPERATIVE (Cooperative) COOPRIX (Cooprix) CORP (Corporation) CREDIT_UNION (Credit union) FOMIA (Federation of mutual insurance associations) INC (Incorporated) LTD (Limited) LTEE (Limitée) LLC (Limited liability corporation) LLP (Limited liability partnership) LTE (Lte.) MBA (Mutual benefit association) MIC (Mutual insurance company) NFP (Not-for-profit corporation) SA (S.A.) SAVINGS_COMPANY (Savings company) SAVINGS_UNION (Savings union) SARL (Société à responsabilité limitée) TRUST (Trust) ULC (Unlimited liability corporation) CA_LEGAL_TYPE When ContactType is PERSON, valid values include the following: ABO (Aboriginal Peoples indigenous to Canada) CCT (Canadian citizen) LGR (Legal Representative of a Canadian Citizen or Permanent Resident) RES (Permanent resident of Canada) When ContactType is a value other than PERSON, valid values include the following: ASS (Canadian unincorporated association) CCO (Canadian corporation) EDU (Canadian educational institution) GOV (Government or government entity in Canada) HOP (Canadian Hospital) INB (Indian Band recognized by the Indian Act of Canada) LAM (Canadian Library, Archive, or Museum) MAJ (Her/His Majesty the Queen/King) OMK (Official mark registered in Canada) PLT (Canadian Political Party) PRT (Partnership Registered in Canada) TDM (Trademark registered in Canada) TRD (Canadian Trade Union) TRS (Trust established in Canada) .es ES_IDENTIFICATION The value of ES_IDENTIFICATION depends on the following values: The value of ES_LEGAL_FORM The value of ES_IDENTIFICATION_TYPE If ES_LEGAL_FORM is any value other than INDIVIDUAL: Specify 1 letter + 8 numbers (CIF [Certificado de Identificación Fiscal]) Example: B12345678 If ES_LEGAL_FORM is INDIVIDUAL, the value that you specify for ES_IDENTIFICATION depends on the value of ES_IDENTIFICATION_TYPE: If ES_IDENTIFICATION_TYPE is DNI_AND_NIF (for Spanish contacts): Specify 8 numbers + 1 letter (DNI [Documento Nacional de Identidad], NIF [Número de Identificación Fiscal]) Example: 12345678M If ES_IDENTIFICATION_TYPE is NIE (for foreigners with legal residence): Specify 1 letter + 7 numbers + 1 letter ( NIE [Número de Identidad de Extranjero]) Example: Y1234567X If ES_IDENTIFICATION_TYPE is OTHER (for contacts outside of Spain): Specify a passport number, drivers license number, or national identity card number ES_IDENTIFICATION_TYPE Valid values include the following: DNI_AND_NIF (For Spanish contacts) NIE (For foreigners with legal residence) OTHER (For contacts outside of Spain) ES_LEGAL_FORM Valid values include the following: ASSOCIATION CENTRAL_GOVERNMENT_BODY CIVIL_SOCIETY COMMUNITY_OF_OWNERS COMMUNITY_PROPERTY CONSULATE COOPERATIVE DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL ECONOMIC_INTEREST_GROUP EMBASSY ENTITY_MANAGING_NATURAL_AREAS FARM_PARTNERSHIP FOUNDATION GENERAL_AND_LIMITED_PARTNERSHIP GENERAL_PARTNERSHIP INDIVIDUAL LIMITED_COMPANY LOCAL_AUTHORITY LOCAL_PUBLIC_ENTITY MUTUAL_INSURANCE_COMPANY NATIONAL_PUBLIC_ENTITY ORDER_OR_RELIGIOUS_INSTITUTION OTHERS (Only for contacts outside of Spain) POLITICAL_PARTY PROFESSIONAL_ASSOCIATION PUBLIC_LAW_ASSOCIATION PUBLIC_LIMITED_COMPANY REGIONAL_GOVERNMENT_BODY REGIONAL_PUBLIC_ENTITY SAVINGS_BANK SPANISH_OFFICE SPORTS_ASSOCIATION SPORTS_FEDERATION SPORTS_LIMITED_COMPANY TEMPORARY_ALLIANCE_OF_ENTERPRISES TRADE_UNION WORKER_OWNED_COMPANY WORKER_OWNED_LIMITED_COMPANY .eu EU_COUNTRY_OF_CITIZENSHIP .fi BIRTH_DATE_IN_YYYY_MM_DD FI_BUSINESS_NUMBER FI_ID_NUMBER FI_NATIONALITY Valid values include the following: FINNISH NOT_FINNISH FI_ORGANIZATION_TYPE Valid values include the following: COMPANY CORPORATION GOVERNMENT INSTITUTION POLITICAL_PARTY PUBLIC_COMMUNITY TOWNSHIP .it IT_NATIONALITY IT_PIN IT_REGISTRANT_ENTITY_TYPE Valid values include the following: FOREIGNERS FREELANCE_WORKERS (Freelance workers and professionals) ITALIAN_COMPANIES (Italian companies and one-person companies) NON_PROFIT_ORGANIZATIONS OTHER_SUBJECTS PUBLIC_ORGANIZATIONS .ru BIRTH_DATE_IN_YYYY_MM_DD RU_PASSPORT_DATA .se BIRTH_COUNTRY SE_ID_NUMBER .sg SG_ID_NUMBER .uk, .co.uk, .me.uk, and .org.uk UK_CONTACT_TYPE Valid values include the following: CRC (UK Corporation by Royal Charter) FCORP (Non-UK Corporation) FIND (Non-UK Individual, representing self) FOTHER (Non-UK Entity that does not fit into any other category) GOV (UK Government Body) IND (UK Individual (representing self)) IP (UK Industrial/Provident Registered Company) LLP (UK Limited Liability Partnership) LTD (UK Limited Company) OTHER (UK Entity that does not fit into any other category) PLC (UK Public Limited Company) PTNR (UK Partnership) RCHAR (UK Registered Charity) SCH (UK School) STAT (UK Statutory Body) STRA (UK Sole Trader) UK_COMPANY_NUMBER In addition, many TLDs require a VAT_NUMBER.
  668. */
  669. Name: ExtraParamName;
  670. /**
  671. * The value that corresponds with the name of an extra parameter.
  672. */
  673. Value: ExtraParamValue;
  674. }
  675. export type ExtraParamList = ExtraParam[];
  676. export type ExtraParamName = "DUNS_NUMBER"|"BRAND_NUMBER"|"BIRTH_DEPARTMENT"|"BIRTH_DATE_IN_YYYY_MM_DD"|"BIRTH_COUNTRY"|"BIRTH_CITY"|"DOCUMENT_NUMBER"|"AU_ID_NUMBER"|"AU_ID_TYPE"|"CA_LEGAL_TYPE"|"CA_BUSINESS_ENTITY_TYPE"|"CA_LEGAL_REPRESENTATIVE"|"CA_LEGAL_REPRESENTATIVE_CAPACITY"|"ES_IDENTIFICATION"|"ES_IDENTIFICATION_TYPE"|"ES_LEGAL_FORM"|"FI_BUSINESS_NUMBER"|"FI_ID_NUMBER"|"FI_NATIONALITY"|"FI_ORGANIZATION_TYPE"|"IT_NATIONALITY"|"IT_PIN"|"IT_REGISTRANT_ENTITY_TYPE"|"RU_PASSPORT_DATA"|"SE_ID_NUMBER"|"SG_ID_NUMBER"|"VAT_NUMBER"|"UK_CONTACT_TYPE"|"UK_COMPANY_NUMBER"|"EU_COUNTRY_OF_CITIZENSHIP"|"AU_PRIORITY_TOKEN"|string;
  677. export type ExtraParamValue = string;
  678. export type FIAuthKey = string;
  679. export interface FilterCondition {
  680. /**
  681. * Name of the field which should be used for filtering the list of domains.
  682. */
  683. Name: ListDomainsAttributeName;
  684. /**
  685. * 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
  686. */
  687. Operator: Operator;
  688. /**
  689. * An array of strings presenting values to compare. Only 1 item in the list is currently supported.
  690. */
  691. Values: Values;
  692. }
  693. export type FilterConditions = FilterCondition[];
  694. export interface GetContactReachabilityStatusRequest {
  695. /**
  696. * The name of the domain for which you want to know whether the registrant contact has confirmed that the email address is valid.
  697. */
  698. domainName?: DomainName;
  699. }
  700. export interface GetContactReachabilityStatusResponse {
  701. /**
  702. * The domain name for which you requested the reachability status.
  703. */
  704. domainName?: DomainName;
  705. /**
  706. * 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.
  707. */
  708. status?: ReachabilityStatus;
  709. }
  710. export interface GetDomainDetailRequest {
  711. /**
  712. * The name of the domain that you want to get detailed information about.
  713. */
  714. DomainName: DomainName;
  715. }
  716. export interface GetDomainDetailResponse {
  717. /**
  718. * The name of a domain.
  719. */
  720. DomainName?: DomainName;
  721. /**
  722. * The name servers of the domain.
  723. */
  724. Nameservers?: NameserverList;
  725. /**
  726. * Specifies whether the domain registration is set to renew automatically.
  727. */
  728. AutoRenew?: Boolean;
  729. /**
  730. * Provides details about the domain administrative contact.
  731. */
  732. AdminContact?: ContactDetail;
  733. /**
  734. * Provides details about the domain registrant.
  735. */
  736. RegistrantContact?: ContactDetail;
  737. /**
  738. * Provides details about the domain technical contact.
  739. */
  740. TechContact?: ContactDetail;
  741. /**
  742. * 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.
  743. */
  744. AdminPrivacy?: Boolean;
  745. /**
  746. * 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).
  747. */
  748. RegistrantPrivacy?: Boolean;
  749. /**
  750. * 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.
  751. */
  752. TechPrivacy?: Boolean;
  753. /**
  754. * Name of the registrar of the domain as identified in the registry.
  755. */
  756. RegistrarName?: RegistrarName;
  757. /**
  758. * The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.
  759. */
  760. WhoIsServer?: RegistrarWhoIsServer;
  761. /**
  762. * Web address of the registrar.
  763. */
  764. RegistrarUrl?: RegistrarUrl;
  765. /**
  766. * 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.
  767. */
  768. AbuseContactEmail?: Email;
  769. /**
  770. * Phone number for reporting abuse.
  771. */
  772. AbuseContactPhone?: ContactNumber;
  773. /**
  774. * Reserved for future use.
  775. */
  776. RegistryDomainId?: RegistryDomainId;
  777. /**
  778. * 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).
  779. */
  780. CreationDate?: Timestamp;
  781. /**
  782. * 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).
  783. */
  784. UpdatedDate?: Timestamp;
  785. /**
  786. * 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).
  787. */
  788. ExpirationDate?: Timestamp;
  789. /**
  790. * Reseller of the domain. Domains registered or transferred using Route 53 domains will have "Amazon" as the reseller.
  791. */
  792. Reseller?: Reseller;
  793. /**
  794. * Deprecated.
  795. */
  796. DnsSec?: DNSSec;
  797. /**
  798. * 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.)
  799. */
  800. StatusList?: DomainStatusList;
  801. /**
  802. * A complex type that contains information about the DNSSEC configuration.
  803. */
  804. DnssecKeys?: DnssecKeyList;
  805. /**
  806. * Provides details about the domain billing contact.
  807. */
  808. BillingContact?: ContactDetail;
  809. /**
  810. * 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.
  811. */
  812. BillingPrivacy?: Boolean;
  813. }
  814. export interface GetDomainSuggestionsRequest {
  815. /**
  816. * 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.
  817. */
  818. DomainName: DomainName;
  819. /**
  820. * The number of suggested domain names that you want Route 53 to return. Specify a value between 1 and 50.
  821. */
  822. SuggestionCount: Integer;
  823. /**
  824. * 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.
  825. */
  826. OnlyAvailable: Boolean;
  827. }
  828. export interface GetDomainSuggestionsResponse {
  829. /**
  830. * 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.
  831. */
  832. SuggestionsList?: DomainSuggestionsList;
  833. }
  834. export interface GetOperationDetailRequest {
  835. /**
  836. * 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.
  837. */
  838. OperationId: OperationId;
  839. }
  840. export interface GetOperationDetailResponse {
  841. /**
  842. * The identifier for the operation.
  843. */
  844. OperationId?: OperationId;
  845. /**
  846. * The current status of the requested operation in the system.
  847. */
  848. Status?: OperationStatus;
  849. /**
  850. * Detailed information on the status including possible errors.
  851. */
  852. Message?: ErrorMessage;
  853. /**
  854. * The name of a domain.
  855. */
  856. DomainName?: DomainName;
  857. /**
  858. * The type of operation that was requested.
  859. */
  860. Type?: OperationType;
  861. /**
  862. * The date when the request was submitted.
  863. */
  864. SubmittedDate?: Timestamp;
  865. /**
  866. * The date when the operation was last updated.
  867. */
  868. LastUpdatedDate?: Timestamp;
  869. /**
  870. * 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.
  871. */
  872. StatusFlag?: StatusFlag;
  873. }
  874. export type GlueIp = string;
  875. export type GlueIpList = GlueIp[];
  876. export type HostName = string;
  877. export type Integer = number;
  878. export type InvoiceId = string;
  879. export type Label = string;
  880. export type LangCode = string;
  881. export type ListDomainsAttributeName = "DomainName"|"Expiry"|string;
  882. export interface ListDomainsRequest {
  883. /**
  884. * A complex type that contains information about the filters applied during the ListDomains request. The filter conditions can include domain name and domain expiration.
  885. */
  886. FilterConditions?: FilterConditions;
  887. /**
  888. * A complex type that contains information about the requested ordering of domains in the returned list.
  889. */
  890. SortCondition?: SortCondition;
  891. /**
  892. * 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.
  893. */
  894. Marker?: PageMarker;
  895. /**
  896. * Number of domains to be returned. Default: 20
  897. */
  898. MaxItems?: PageMaxItems;
  899. }
  900. export interface ListDomainsResponse {
  901. /**
  902. * A list of domains.
  903. */
  904. Domains?: DomainSummaryList;
  905. /**
  906. * 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.
  907. */
  908. NextPageMarker?: PageMarker;
  909. }
  910. export interface ListOperationsRequest {
  911. /**
  912. * 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).
  913. */
  914. SubmittedSince?: Timestamp;
  915. /**
  916. * 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.
  917. */
  918. Marker?: PageMarker;
  919. /**
  920. * Number of domains to be returned. Default: 20
  921. */
  922. MaxItems?: PageMaxItems;
  923. /**
  924. * The status of the operations.
  925. */
  926. Status?: OperationStatusList;
  927. /**
  928. * An arrays of the domains operation types.
  929. */
  930. Type?: OperationTypeList;
  931. /**
  932. * The sort type for returned values.
  933. */
  934. SortBy?: ListOperationsSortAttributeName;
  935. /**
  936. * The sort order for returned values, either ascending or descending.
  937. */
  938. SortOrder?: SortOrder;
  939. }
  940. export interface ListOperationsResponse {
  941. /**
  942. * Lists summaries of the operations.
  943. */
  944. Operations?: OperationSummaryList;
  945. /**
  946. * 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.
  947. */
  948. NextPageMarker?: PageMarker;
  949. }
  950. export type ListOperationsSortAttributeName = "SubmittedDate"|string;
  951. export type ListPricesPageMaxItems = number;
  952. export interface ListPricesRequest {
  953. /**
  954. * 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.
  955. */
  956. Tld?: TldName;
  957. /**
  958. * 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.
  959. */
  960. Marker?: PageMarker;
  961. /**
  962. * Number of Prices to be returned. Used only for all TLDs. If you specify a TLD, don't specify a MaxItems.
  963. */
  964. MaxItems?: ListPricesPageMaxItems;
  965. }
  966. export interface ListPricesResponse {
  967. /**
  968. * A complex type that includes all the pricing information. If you specify a TLD, this array contains only the pricing for that TLD.
  969. */
  970. Prices?: DomainPriceList;
  971. /**
  972. * 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.
  973. */
  974. NextPageMarker?: PageMarker;
  975. }
  976. export interface ListTagsForDomainRequest {
  977. /**
  978. * The domain for which you want to get a list of tags.
  979. */
  980. DomainName: DomainName;
  981. }
  982. export interface ListTagsForDomainResponse {
  983. /**
  984. * A list of the tags that are associated with the specified domain.
  985. */
  986. TagList?: TagList;
  987. }
  988. export type Message = string;
  989. export interface Nameserver {
  990. /**
  991. * The fully qualified host name of the name server. Constraint: Maximum 255 characters
  992. */
  993. Name: HostName;
  994. /**
  995. * 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.
  996. */
  997. GlueIps?: GlueIpList;
  998. }
  999. export type NameserverList = Nameserver[];
  1000. export type NullableInteger = number;
  1001. export type OperationId = string;
  1002. export type OperationStatus = "SUBMITTED"|"IN_PROGRESS"|"ERROR"|"SUCCESSFUL"|"FAILED"|string;
  1003. export type OperationStatusList = OperationStatus[];
  1004. export interface OperationSummary {
  1005. /**
  1006. * Identifier returned to track the requested action.
  1007. */
  1008. OperationId?: OperationId;
  1009. /**
  1010. * The current status of the requested operation in the system.
  1011. */
  1012. Status?: OperationStatus;
  1013. /**
  1014. * Type of the action requested.
  1015. */
  1016. Type?: OperationType;
  1017. /**
  1018. * The date when the request was submitted.
  1019. */
  1020. SubmittedDate?: Timestamp;
  1021. /**
  1022. * Name of the domain.
  1023. */
  1024. DomainName?: DomainName;
  1025. /**
  1026. * Message about the operation.
  1027. */
  1028. Message?: ErrorMessage;
  1029. /**
  1030. * 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.
  1031. */
  1032. StatusFlag?: StatusFlag;
  1033. /**
  1034. * The date when the last change was made in Unix time format and Coordinated Universal Time (UTC).
  1035. */
  1036. LastUpdatedDate?: Timestamp;
  1037. }
  1038. export type OperationSummaryList = OperationSummary[];
  1039. export type OperationType = "REGISTER_DOMAIN"|"DELETE_DOMAIN"|"TRANSFER_IN_DOMAIN"|"UPDATE_DOMAIN_CONTACT"|"UPDATE_NAMESERVER"|"CHANGE_PRIVACY_PROTECTION"|"DOMAIN_LOCK"|"ENABLE_AUTORENEW"|"DISABLE_AUTORENEW"|"ADD_DNSSEC"|"REMOVE_DNSSEC"|"EXPIRE_DOMAIN"|"TRANSFER_OUT_DOMAIN"|"CHANGE_DOMAIN_OWNER"|"RENEW_DOMAIN"|"PUSH_DOMAIN"|"INTERNAL_TRANSFER_OUT_DOMAIN"|"INTERNAL_TRANSFER_IN_DOMAIN"|"RELEASE_TO_GANDI"|"TRANSFER_ON_RENEW"|string;
  1040. export type OperationTypeList = OperationType[];
  1041. export type Operator = "LE"|"GE"|"BEGINS_WITH"|string;
  1042. export type PageMarker = string;
  1043. export type PageMaxItems = number;
  1044. export type Password = string;
  1045. export type Price = number;
  1046. export interface PriceWithCurrency {
  1047. /**
  1048. * The price of a domain, in a specific currency.
  1049. */
  1050. Price: Price;
  1051. /**
  1052. * The currency specifier.
  1053. */
  1054. Currency: Currency;
  1055. }
  1056. export interface PushDomainRequest {
  1057. /**
  1058. * Name of the domain.
  1059. */
  1060. DomainName: DomainName;
  1061. /**
  1062. * New IPS tag for the domain.
  1063. */
  1064. Target: Label;
  1065. }
  1066. export type ReachabilityStatus = "PENDING"|"DONE"|"EXPIRED"|string;
  1067. export interface RegisterDomainRequest {
  1068. /**
  1069. * 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.
  1070. */
  1071. DomainName: DomainName;
  1072. /**
  1073. * Reserved for future use.
  1074. */
  1075. IdnLangCode?: LangCode;
  1076. /**
  1077. * 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
  1078. */
  1079. DurationInYears: DurationInYears;
  1080. /**
  1081. * Indicates whether the domain will be automatically renewed (true) or not (false). Auto renewal only takes effect after the account is charged. Default: true
  1082. */
  1083. AutoRenew?: Boolean;
  1084. /**
  1085. * Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.
  1086. */
  1087. AdminContact: ContactDetail;
  1088. /**
  1089. * Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.
  1090. */
  1091. RegistrantContact: ContactDetail;
  1092. /**
  1093. * Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.
  1094. */
  1095. TechContact: ContactDetail;
  1096. /**
  1097. * 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
  1098. */
  1099. PrivacyProtectAdminContact?: Boolean;
  1100. /**
  1101. * 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
  1102. */
  1103. PrivacyProtectRegistrantContact?: Boolean;
  1104. /**
  1105. * 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
  1106. */
  1107. PrivacyProtectTechContact?: Boolean;
  1108. /**
  1109. * Provides detailed contact information. For information about the values that you specify for each element, see ContactDetail.
  1110. */
  1111. BillingContact?: ContactDetail;
  1112. /**
  1113. * 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.
  1114. */
  1115. PrivacyProtectBillingContact?: Boolean;
  1116. }
  1117. export interface RegisterDomainResponse {
  1118. /**
  1119. * Identifier for tracking the progress of the request. To query the operation status, use GetOperationDetail.
  1120. */
  1121. OperationId?: OperationId;
  1122. }
  1123. export type RegistrarName = string;
  1124. export type RegistrarUrl = string;
  1125. export type RegistrarWhoIsServer = string;
  1126. export type RegistryDomainId = string;
  1127. export interface RejectDomainTransferFromAnotherAwsAccountRequest {
  1128. /**
  1129. * The name of the domain that was specified when another Amazon Web Services account submitted a TransferDomainToAnotherAwsAccount request.
  1130. */
  1131. DomainName: DomainName;
  1132. }
  1133. export interface RejectDomainTransferFromAnotherAwsAccountResponse {
  1134. /**
  1135. * 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.
  1136. */
  1137. OperationId?: OperationId;
  1138. }
  1139. export interface RenewDomainRequest {
  1140. /**
  1141. * The name of the domain that you want to renew.
  1142. */
  1143. DomainName: DomainName;
  1144. /**
  1145. * 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
  1146. */
  1147. DurationInYears?: DurationInYears;
  1148. /**
  1149. * The year when the registration for the domain is set to expire. This value must match the current expiration date for the domain.
  1150. */
  1151. CurrentExpiryYear: CurrentExpiryYear;
  1152. }
  1153. export interface RenewDomainResponse {
  1154. /**
  1155. * Identifier for tracking the progress of the request. To query the operation status, use GetOperationDetail.
  1156. */
  1157. OperationId?: OperationId;
  1158. }
  1159. export type Reseller = string;
  1160. export interface ResendContactReachabilityEmailRequest {
  1161. /**
  1162. * The name of the domain for which you want Route 53 to resend a confirmation email to the registrant contact.
  1163. */
  1164. domainName?: DomainName;
  1165. }
  1166. export interface ResendContactReachabilityEmailResponse {
  1167. /**
  1168. * The domain name for which you requested a confirmation email.
  1169. */
  1170. domainName?: DomainName;
  1171. /**
  1172. * The email address for the registrant contact at the time that we sent the verification email.
  1173. */
  1174. emailAddress?: Email;
  1175. /**
  1176. * 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.
  1177. */
  1178. isAlreadyVerified?: Boolean;
  1179. }
  1180. export interface ResendOperationAuthorizationRequest {
  1181. /**
  1182. * Operation ID.
  1183. */
  1184. OperationId: OperationId;
  1185. }
  1186. export interface RetrieveDomainAuthCodeRequest {
  1187. /**
  1188. * The name of the domain that you want to get an authorization code for.
  1189. */
  1190. DomainName: DomainName;
  1191. }
  1192. export interface RetrieveDomainAuthCodeResponse {
  1193. /**
  1194. * The authorization code for the domain.
  1195. */
  1196. AuthCode?: DomainAuthCode;
  1197. }
  1198. export interface SortCondition {
  1199. /**
  1200. * 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.
  1201. */
  1202. Name: ListDomainsAttributeName;
  1203. /**
  1204. * The sort order for a list of domains. Either ascending (ASC) or descending (DES).
  1205. */
  1206. SortOrder: SortOrder;
  1207. }
  1208. export type SortOrder = "ASC"|"DESC"|string;
  1209. export type State = string;
  1210. export type StatusFlag = "PENDING_ACCEPTANCE"|"PENDING_CUSTOMER_ACTION"|"PENDING_AUTHORIZATION"|"PENDING_PAYMENT_VERIFICATION"|"PENDING_SUPPORT_CASE"|string;
  1211. export type String = string;
  1212. export interface Tag {
  1213. /**
  1214. * The key (name) of a tag. Valid values: A-Z, a-z, 0-9, space, ".:/=+\-@" Constraints: Each key can be 1-128 characters long.
  1215. */
  1216. Key?: TagKey;
  1217. /**
  1218. * The value of a tag. Valid values: A-Z, a-z, 0-9, space, ".:/=+\-@" Constraints: Each value can be 0-256 characters long.
  1219. */
  1220. Value?: TagValue;
  1221. }
  1222. export type TagKey = string;
  1223. export type TagKeyList = TagKey[];
  1224. export type TagList = Tag[];
  1225. export type TagValue = string;
  1226. export type Timestamp = Date;
  1227. export type TldName = string;
  1228. export interface TransferDomainRequest {
  1229. /**
  1230. * 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.
  1231. */
  1232. DomainName: DomainName;
  1233. /**
  1234. * Reserved for future use.
  1235. */
  1236. IdnLangCode?: LangCode;
  1237. /**
  1238. * 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
  1239. */
  1240. DurationInYears: DurationInYears;
  1241. /**
  1242. * Contains details for the host and glue IP addresses.
  1243. */
  1244. Nameservers?: NameserverList;
  1245. /**
  1246. * The authorization code for the domain. You get this value from the current registrar.
  1247. */
  1248. AuthCode?: DomainAuthCode;
  1249. /**
  1250. * Indicates whether the domain will be automatically renewed (true) or not (false). Auto renewal only takes effect after the account is charged. Default: true
  1251. */
  1252. AutoRenew?: Boolean;
  1253. /**
  1254. * Provides detailed contact information.
  1255. */
  1256. AdminContact: ContactDetail;
  1257. /**
  1258. * Provides detailed contact information.
  1259. */
  1260. RegistrantContact: ContactDetail;
  1261. /**
  1262. * Provides detailed contact information.
  1263. */
  1264. TechContact: ContactDetail;
  1265. /**
  1266. * 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 &lt;domain name&gt; owner.". While some domains may allow different privacy settings per contact, we recommend specifying the same privacy setting for all contacts. Default: true
  1267. */
  1268. PrivacyProtectAdminContact?: Boolean;
  1269. /**
  1270. * 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
  1271. */
  1272. PrivacyProtectRegistrantContact?: Boolean;
  1273. /**
  1274. * 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
  1275. */
  1276. PrivacyProtectTechContact?: Boolean;
  1277. /**
  1278. * Provides detailed contact information.
  1279. */
  1280. BillingContact?: ContactDetail;
  1281. /**
  1282. * 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.
  1283. */
  1284. PrivacyProtectBillingContact?: Boolean;
  1285. }
  1286. export interface TransferDomainResponse {
  1287. /**
  1288. * Identifier for tracking the progress of the request. To query the operation status, use GetOperationDetail.
  1289. */
  1290. OperationId?: OperationId;
  1291. }
  1292. export interface TransferDomainToAnotherAwsAccountRequest {
  1293. /**
  1294. * The name of the domain that you want to transfer from the current Amazon Web Services account to another account.
  1295. */
  1296. DomainName: DomainName;
  1297. /**
  1298. * The account ID of the Amazon Web Services account that you want to transfer the domain to, for example, 111122223333.
  1299. */
  1300. AccountId: AccountId;
  1301. }
  1302. export interface TransferDomainToAnotherAwsAccountResponse {
  1303. /**
  1304. * Identifier for tracking the progress of the request. To query the operation status, use GetOperationDetail.
  1305. */
  1306. OperationId?: OperationId;
  1307. /**
  1308. * 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.
  1309. */
  1310. Password?: Password;
  1311. }
  1312. export type Transferable = "TRANSFERABLE"|"UNTRANSFERABLE"|"DONT_KNOW"|"DOMAIN_IN_OWN_ACCOUNT"|"DOMAIN_IN_ANOTHER_ACCOUNT"|"PREMIUM_DOMAIN"|string;
  1313. export interface UpdateDomainContactPrivacyRequest {
  1314. /**
  1315. * The name of the domain that you want to update the privacy setting for.
  1316. */
  1317. DomainName: DomainName;
  1318. /**
  1319. * 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.
  1320. */
  1321. AdminPrivacy?: Boolean;
  1322. /**
  1323. * 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.
  1324. */
  1325. RegistrantPrivacy?: Boolean;
  1326. /**
  1327. * 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.
  1328. */
  1329. TechPrivacy?: Boolean;
  1330. /**
  1331. * 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.
  1332. */
  1333. BillingPrivacy?: Boolean;
  1334. }
  1335. export interface UpdateDomainContactPrivacyResponse {
  1336. /**
  1337. * Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
  1338. */
  1339. OperationId?: OperationId;
  1340. }
  1341. export interface UpdateDomainContactRequest {
  1342. /**
  1343. * The name of the domain that you want to update contact information for.
  1344. */
  1345. DomainName: DomainName;
  1346. /**
  1347. * Provides detailed contact information.
  1348. */
  1349. AdminContact?: ContactDetail;
  1350. /**
  1351. * Provides detailed contact information.
  1352. */
  1353. RegistrantContact?: ContactDetail;
  1354. /**
  1355. * Provides detailed contact information.
  1356. */
  1357. TechContact?: ContactDetail;
  1358. /**
  1359. * Customer's consent for the owner change request. Required if the domain is not free (consent price is more than $0.00).
  1360. */
  1361. Consent?: Consent;
  1362. /**
  1363. * Provides detailed contact information.
  1364. */
  1365. BillingContact?: ContactDetail;
  1366. }
  1367. export interface UpdateDomainContactResponse {
  1368. /**
  1369. * Identifier for tracking the progress of the request. To query the operation status, use GetOperationDetail.
  1370. */
  1371. OperationId?: OperationId;
  1372. }
  1373. export interface UpdateDomainNameserversRequest {
  1374. /**
  1375. * The name of the domain that you want to change name servers for.
  1376. */
  1377. DomainName: DomainName;
  1378. /**
  1379. * The authorization key for .fi domains
  1380. */
  1381. FIAuthKey?: FIAuthKey;
  1382. /**
  1383. * A list of new name servers for the domain.
  1384. */
  1385. Nameservers: NameserverList;
  1386. }
  1387. export interface UpdateDomainNameserversResponse {
  1388. /**
  1389. * Identifier for tracking the progress of the request. To query the operation status, use GetOperationDetail.
  1390. */
  1391. OperationId?: OperationId;
  1392. }
  1393. export interface UpdateTagsForDomainRequest {
  1394. /**
  1395. * The domain for which you want to add or update tags.
  1396. */
  1397. DomainName: DomainName;
  1398. /**
  1399. * 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.
  1400. */
  1401. TagsToUpdate?: TagList;
  1402. }
  1403. export interface UpdateTagsForDomainResponse {
  1404. }
  1405. export type Value = string;
  1406. export type Values = Value[];
  1407. export interface ViewBillingRequest {
  1408. /**
  1409. * 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).
  1410. */
  1411. Start?: Timestamp;
  1412. /**
  1413. * 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).
  1414. */
  1415. End?: Timestamp;
  1416. /**
  1417. * 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.
  1418. */
  1419. Marker?: PageMarker;
  1420. /**
  1421. * The number of billing records to be returned. Default: 20
  1422. */
  1423. MaxItems?: PageMaxItems;
  1424. }
  1425. export interface ViewBillingResponse {
  1426. /**
  1427. * 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.
  1428. */
  1429. NextPageMarker?: PageMarker;
  1430. /**
  1431. * A summary of billing records.
  1432. */
  1433. BillingRecords?: BillingRecords;
  1434. }
  1435. export type ZipCode = string;
  1436. /**
  1437. * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
  1438. */
  1439. export type apiVersion = "2014-05-15"|"latest"|string;
  1440. export interface ClientApiVersions {
  1441. /**
  1442. * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
  1443. */
  1444. apiVersion?: apiVersion;
  1445. }
  1446. export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  1447. /**
  1448. * Contains interfaces for use with the Route53Domains client.
  1449. */
  1450. export import Types = Route53Domains;
  1451. }
  1452. export = Route53Domains;