@aws-sdk/client-route-53-domains 3.379.1 → 3.385.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7,11 +7,13 @@ import { Route53DomainsServiceException as __BaseException } from "./Route53Doma
7
7
  */
8
8
  export interface AcceptDomainTransferFromAnotherAwsAccountRequest {
9
9
  /**
10
+ * @public
10
11
  * <p>The name of the domain that was specified when another Amazon Web Services account
11
12
  * submitted a <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html">TransferDomainToAnotherAwsAccount</a> request. </p>
12
13
  */
13
14
  DomainName: string | undefined;
14
15
  /**
16
+ * @public
15
17
  * <p>The password that was returned by the <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html">TransferDomainToAnotherAwsAccount</a> request. </p>
16
18
  */
17
19
  Password: string | undefined;
@@ -23,6 +25,7 @@ export interface AcceptDomainTransferFromAnotherAwsAccountRequest {
23
25
  */
24
26
  export interface AcceptDomainTransferFromAnotherAwsAccountResponse {
25
27
  /**
28
+ * @public
26
29
  * <p>Identifier for tracking the progress of the request. To query the operation status,
27
30
  * use <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html">GetOperationDetail</a>.</p>
28
31
  */
@@ -87,10 +90,12 @@ export declare class UnsupportedTLD extends __BaseException {
87
90
  */
88
91
  export interface DnssecSigningAttributes {
89
92
  /**
93
+ * @public
90
94
  * <p> Algorithm which was used to generate the digest from the public key. </p>
91
95
  */
92
96
  Algorithm?: number;
93
97
  /**
98
+ * @public
94
99
  * <p>Defines the type of key. It can be either a KSK (key-signing-key, value 257) or ZSK
95
100
  * (zone-signing-key, value 256). Using KSK is always encouraged. Only use ZSK if your DNS
96
101
  * provider isn't Route 53 and you don’t have KSK available.</p>
@@ -99,6 +104,7 @@ export interface DnssecSigningAttributes {
99
104
  */
100
105
  Flags?: number;
101
106
  /**
107
+ * @public
102
108
  * <p> The base64-encoded public key part of the key pair that is passed to the registry.
103
109
  * </p>
104
110
  */
@@ -109,10 +115,12 @@ export interface DnssecSigningAttributes {
109
115
  */
110
116
  export interface AssociateDelegationSignerToDomainRequest {
111
117
  /**
118
+ * @public
112
119
  * <p>The name of the domain.</p>
113
120
  */
114
121
  DomainName: string | undefined;
115
122
  /**
123
+ * @public
116
124
  * <p>The information about a key, including the algorithm, public key-value, and
117
125
  * flags.</p>
118
126
  */
@@ -123,6 +131,7 @@ export interface AssociateDelegationSignerToDomainRequest {
123
131
  */
124
132
  export interface AssociateDelegationSignerToDomainResponse {
125
133
  /**
134
+ * @public
126
135
  * <p>The identifier for tracking the progress of the request. To query the operation
127
136
  * status, use <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html">GetOperationDetail</a>.</p>
128
137
  */
@@ -200,6 +209,7 @@ export type OperationType = (typeof OperationType)[keyof typeof OperationType];
200
209
  */
201
210
  export interface BillingRecord {
202
211
  /**
212
+ * @public
203
213
  * <p>The name of the domain that the billing record applies to. If the domain name contains
204
214
  * characters other than a-z, 0-9, and - (hyphen), such as an internationalized domain
205
215
  * name, then this value is in Punycode. For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html">DNS
@@ -208,18 +218,22 @@ export interface BillingRecord {
208
218
  */
209
219
  DomainName?: string;
210
220
  /**
221
+ * @public
211
222
  * <p>The operation that you were charged for.</p>
212
223
  */
213
224
  Operation?: OperationType | string;
214
225
  /**
226
+ * @public
215
227
  * <p>The ID of the invoice that is associated with the billing record.</p>
216
228
  */
217
229
  InvoiceId?: string;
218
230
  /**
231
+ * @public
219
232
  * <p>The date that the operation was billed, in Unix format.</p>
220
233
  */
221
234
  BillDate?: Date;
222
235
  /**
236
+ * @public
223
237
  * <p>The price that you were charged for the operation, in US dollars.</p>
224
238
  * <p>Example value: 12.0</p>
225
239
  */
@@ -232,6 +246,7 @@ export interface BillingRecord {
232
246
  */
233
247
  export interface CancelDomainTransferToAnotherAwsAccountRequest {
234
248
  /**
249
+ * @public
235
250
  * <p>The name of the domain for which you want to cancel the transfer to another Amazon Web Services account.</p>
236
251
  */
237
252
  DomainName: string | undefined;
@@ -243,6 +258,7 @@ export interface CancelDomainTransferToAnotherAwsAccountRequest {
243
258
  */
244
259
  export interface CancelDomainTransferToAnotherAwsAccountResponse {
245
260
  /**
261
+ * @public
246
262
  * <p>The identifier that <code>TransferDomainToAnotherAwsAccount</code> returned to track
247
263
  * the progress of the request. Because the transfer request was canceled, the value is no
248
264
  * longer valid, and you can't use <code>GetOperationDetail</code> to query the operation
@@ -256,6 +272,7 @@ export interface CancelDomainTransferToAnotherAwsAccountResponse {
256
272
  */
257
273
  export interface CheckDomainAvailabilityRequest {
258
274
  /**
275
+ * @public
259
276
  * <p>The name of the domain that you want to get availability for. The top-level domain
260
277
  * (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs,
261
278
  * see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html">Domains that You Can
@@ -285,6 +302,7 @@ export interface CheckDomainAvailabilityRequest {
285
302
  */
286
303
  DomainName: string | undefined;
287
304
  /**
305
+ * @public
288
306
  * <p>Reserved for future use.</p>
289
307
  */
290
308
  IdnLangCode?: string;
@@ -313,6 +331,7 @@ export type DomainAvailability = (typeof DomainAvailability)[keyof typeof Domain
313
331
  */
314
332
  export interface CheckDomainAvailabilityResponse {
315
333
  /**
334
+ * @public
316
335
  * <p>Whether the domain name is available for registering.</p>
317
336
  * <note>
318
337
  * <p>You can register only domains designated as <code>AVAILABLE</code>.</p>
@@ -371,6 +390,7 @@ export interface CheckDomainAvailabilityResponse {
371
390
  */
372
391
  export interface CheckDomainTransferabilityRequest {
373
392
  /**
393
+ * @public
374
394
  * <p>The name of the domain that you want to transfer to Route 53. The top-level domain
375
395
  * (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs,
376
396
  * see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html">Domains that You Can
@@ -396,6 +416,7 @@ export interface CheckDomainTransferabilityRequest {
396
416
  */
397
417
  DomainName: string | undefined;
398
418
  /**
419
+ * @public
399
420
  * <p>If the registrar for the top-level domain (TLD) requires an authorization code to
400
421
  * transfer the domain, the code that you got from the current registrar for the
401
422
  * domain.</p>
@@ -425,6 +446,7 @@ export type Transferable = (typeof Transferable)[keyof typeof Transferable];
425
446
  */
426
447
  export interface DomainTransferability {
427
448
  /**
449
+ * @public
428
450
  * <p>Whether the domain name can be transferred to Route 53.</p>
429
451
  * <note>
430
452
  * <p>You can transfer only domains that have a value of <code>TRANSFERABLE</code> or
@@ -466,6 +488,7 @@ export interface DomainTransferability {
466
488
  */
467
489
  export interface CheckDomainTransferabilityResponse {
468
490
  /**
491
+ * @public
469
492
  * <p>A complex type that contains information about whether the specified domain can be
470
493
  * transferred to Route 53.</p>
471
494
  */
@@ -477,10 +500,12 @@ export interface CheckDomainTransferabilityResponse {
477
500
  */
478
501
  export interface Consent {
479
502
  /**
503
+ * @public
480
504
  * <p> Maximum amount the customer agreed to accept. </p>
481
505
  */
482
506
  MaxPrice: number | undefined;
483
507
  /**
508
+ * @public
484
509
  * <p> Currency for the <code>MaxPrice</code>. </p>
485
510
  */
486
511
  Currency: string | undefined;
@@ -808,6 +833,7 @@ export type ExtraParamName = (typeof ExtraParamName)[keyof typeof ExtraParamName
808
833
  */
809
834
  export interface ExtraParam {
810
835
  /**
836
+ * @public
811
837
  * <p>The name of an additional parameter that is required by a top-level domain. Here are
812
838
  * the top-level domains that require additional parameters and the names of the parameters
813
839
  * that they require:</p>
@@ -1628,6 +1654,7 @@ export interface ExtraParam {
1628
1654
  */
1629
1655
  Name: ExtraParamName | string | undefined;
1630
1656
  /**
1657
+ * @public
1631
1658
  * <p>The value that corresponds with the name of an extra parameter.</p>
1632
1659
  */
1633
1660
  Value: string | undefined;
@@ -1638,14 +1665,17 @@ export interface ExtraParam {
1638
1665
  */
1639
1666
  export interface ContactDetail {
1640
1667
  /**
1668
+ * @public
1641
1669
  * <p>First name of contact.</p>
1642
1670
  */
1643
1671
  FirstName?: string;
1644
1672
  /**
1673
+ * @public
1645
1674
  * <p>Last name of contact.</p>
1646
1675
  */
1647
1676
  LastName?: string;
1648
1677
  /**
1678
+ * @public
1649
1679
  * <p>Indicates whether the contact is a person, company, association, or public
1650
1680
  * organization. Note the following:</p>
1651
1681
  * <ul>
@@ -1669,34 +1699,42 @@ export interface ContactDetail {
1669
1699
  */
1670
1700
  ContactType?: ContactType | string;
1671
1701
  /**
1702
+ * @public
1672
1703
  * <p>Name of the organization for contact types other than <code>PERSON</code>.</p>
1673
1704
  */
1674
1705
  OrganizationName?: string;
1675
1706
  /**
1707
+ * @public
1676
1708
  * <p>First line of the contact's address.</p>
1677
1709
  */
1678
1710
  AddressLine1?: string;
1679
1711
  /**
1712
+ * @public
1680
1713
  * <p>Second line of contact's address, if any.</p>
1681
1714
  */
1682
1715
  AddressLine2?: string;
1683
1716
  /**
1717
+ * @public
1684
1718
  * <p>The city of the contact's address.</p>
1685
1719
  */
1686
1720
  City?: string;
1687
1721
  /**
1722
+ * @public
1688
1723
  * <p>The state or province of the contact's city.</p>
1689
1724
  */
1690
1725
  State?: string;
1691
1726
  /**
1727
+ * @public
1692
1728
  * <p>Code for the country of the contact's address.</p>
1693
1729
  */
1694
1730
  CountryCode?: CountryCode | string;
1695
1731
  /**
1732
+ * @public
1696
1733
  * <p>The zip or postal code of the contact's address.</p>
1697
1734
  */
1698
1735
  ZipCode?: string;
1699
1736
  /**
1737
+ * @public
1700
1738
  * <p>The phone number of the contact.</p>
1701
1739
  * <p>Constraints: Phone number must be specified in the format "+[country dialing
1702
1740
  * code].[number including any area code>]". For example, a US phone number might appear
@@ -1704,10 +1742,12 @@ export interface ContactDetail {
1704
1742
  */
1705
1743
  PhoneNumber?: string;
1706
1744
  /**
1745
+ * @public
1707
1746
  * <p>Email address of the contact.</p>
1708
1747
  */
1709
1748
  Email?: string;
1710
1749
  /**
1750
+ * @public
1711
1751
  * <p>Fax number of the contact.</p>
1712
1752
  * <p>Constraints: Phone number must be specified in the format "+[country dialing
1713
1753
  * code].[number including any area code]". For example, a US phone number might appear as
@@ -1715,6 +1755,7 @@ export interface ContactDetail {
1715
1755
  */
1716
1756
  Fax?: string;
1717
1757
  /**
1758
+ * @public
1718
1759
  * <p>A list of name-value pairs for parameters required by certain top-level
1719
1760
  * domains.</p>
1720
1761
  */
@@ -1725,6 +1766,7 @@ export interface ContactDetail {
1725
1766
  */
1726
1767
  export interface DeleteDomainRequest {
1727
1768
  /**
1769
+ * @public
1728
1770
  * <p>Name of the domain to be deleted.</p>
1729
1771
  */
1730
1772
  DomainName: string | undefined;
@@ -1734,6 +1776,7 @@ export interface DeleteDomainRequest {
1734
1776
  */
1735
1777
  export interface DeleteDomainResponse {
1736
1778
  /**
1779
+ * @public
1737
1780
  * <p>Identifier for tracking the progress of the request. To query the operation status,
1738
1781
  * use <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html">GetOperationDetail</a>.</p>
1739
1782
  */
@@ -1745,10 +1788,12 @@ export interface DeleteDomainResponse {
1745
1788
  */
1746
1789
  export interface DeleteTagsForDomainRequest {
1747
1790
  /**
1791
+ * @public
1748
1792
  * <p>The domain for which you want to delete one or more tags.</p>
1749
1793
  */
1750
1794
  DomainName: string | undefined;
1751
1795
  /**
1796
+ * @public
1752
1797
  * <p>A list of tag keys to delete.</p>
1753
1798
  */
1754
1799
  TagsToDelete: string[] | undefined;
@@ -1763,6 +1808,7 @@ export interface DeleteTagsForDomainResponse {
1763
1808
  */
1764
1809
  export interface DisableDomainAutoRenewRequest {
1765
1810
  /**
1811
+ * @public
1766
1812
  * <p>The name of the domain that you want to disable automatic renewal for.</p>
1767
1813
  */
1768
1814
  DomainName: string | undefined;
@@ -1778,6 +1824,7 @@ export interface DisableDomainAutoRenewResponse {
1778
1824
  */
1779
1825
  export interface DisableDomainTransferLockRequest {
1780
1826
  /**
1827
+ * @public
1781
1828
  * <p>The name of the domain that you want to remove the transfer lock for.</p>
1782
1829
  */
1783
1830
  DomainName: string | undefined;
@@ -1788,6 +1835,7 @@ export interface DisableDomainTransferLockRequest {
1788
1835
  */
1789
1836
  export interface DisableDomainTransferLockResponse {
1790
1837
  /**
1838
+ * @public
1791
1839
  * <p>Identifier for tracking the progress of the request. To query the operation status,
1792
1840
  * use <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html">GetOperationDetail</a>.</p>
1793
1841
  */
@@ -1798,10 +1846,12 @@ export interface DisableDomainTransferLockResponse {
1798
1846
  */
1799
1847
  export interface DisassociateDelegationSignerFromDomainRequest {
1800
1848
  /**
1849
+ * @public
1801
1850
  * <p>Name of the domain.</p>
1802
1851
  */
1803
1852
  DomainName: string | undefined;
1804
1853
  /**
1854
+ * @public
1805
1855
  * <p>An internal identification number assigned to each DS record after it’s created. You
1806
1856
  * can retrieve it as part of DNSSEC information returned by <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetDomainDetail.html">GetDomainDetail</a>.</p>
1807
1857
  */
@@ -1812,6 +1862,7 @@ export interface DisassociateDelegationSignerFromDomainRequest {
1812
1862
  */
1813
1863
  export interface DisassociateDelegationSignerFromDomainResponse {
1814
1864
  /**
1865
+ * @public
1815
1866
  * <p>Identifier for tracking the progress of the request. To query the operation status,
1816
1867
  * use <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html">GetOperationDetail</a>.</p>
1817
1868
  */
@@ -1826,12 +1877,14 @@ export interface DisassociateDelegationSignerFromDomainResponse {
1826
1877
  */
1827
1878
  export interface DnssecKey {
1828
1879
  /**
1880
+ * @public
1829
1881
  * <p>The number of the public key’s cryptographic algorithm according to an <a href="https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xml">IANA</a> assignment. </p>
1830
1882
  * <p>If Route 53 is your DNS service, set this to 13.</p>
1831
1883
  * <p>For more information about enabling DNSSEC signing, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-configuring-dnssec-enable-signing.html">Enabling DNSSEC signing and establishing a chain of trust</a>.</p>
1832
1884
  */
1833
1885
  Algorithm?: number;
1834
1886
  /**
1887
+ * @public
1835
1888
  * <p>Defines the type of key. It can be either a KSK (key-signing-key, value 257) or ZSK
1836
1889
  * (zone-signing-key, value 256). Using KSK is always encouraged. Only use ZSK if your DNS
1837
1890
  * provider isn't Route 53 and you don’t have KSK available.</p>
@@ -1840,17 +1893,20 @@ export interface DnssecKey {
1840
1893
  */
1841
1894
  Flags?: number;
1842
1895
  /**
1896
+ * @public
1843
1897
  * <p>The base64-encoded public key part of the key pair that is passed to the registry
1844
1898
  * .</p>
1845
1899
  */
1846
1900
  PublicKey?: string;
1847
1901
  /**
1902
+ * @public
1848
1903
  * <p> The number of the DS digest algorithm according to an IANA assignment.</p>
1849
1904
  * <p>For more information, see <a href="https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml">IANA</a>
1850
1905
  * for DNSSEC Delegation Signer (DS) Resource Record (RR) Type Digest Algorithms. </p>
1851
1906
  */
1852
1907
  DigestType?: number;
1853
1908
  /**
1909
+ * @public
1854
1910
  * <p> The delegation signer digest.</p>
1855
1911
  * <p>Digest is calculated from the public key provided using specified digest algorithm and
1856
1912
  * this digest is the actual value returned from the registry nameservers as the value of
@@ -1858,10 +1914,12 @@ export interface DnssecKey {
1858
1914
  */
1859
1915
  Digest?: string;
1860
1916
  /**
1917
+ * @public
1861
1918
  * <p> A numeric identification of the DNSKEY record referred to by this DS record. </p>
1862
1919
  */
1863
1920
  KeyTag?: number;
1864
1921
  /**
1922
+ * @public
1865
1923
  * <p> An ID assigned to each DS record created by <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_AssociateDelegationSignerToDomain.html">AssociateDelegationSignerToDomain</a>. </p>
1866
1924
  */
1867
1925
  Id?: string;
@@ -1872,10 +1930,12 @@ export interface DnssecKey {
1872
1930
  */
1873
1931
  export interface PriceWithCurrency {
1874
1932
  /**
1933
+ * @public
1875
1934
  * <p>The price of a domain, in a specific currency.</p>
1876
1935
  */
1877
1936
  Price: number | undefined;
1878
1937
  /**
1938
+ * @public
1879
1939
  * <p>The currency specifier.</p>
1880
1940
  */
1881
1941
  Currency: string | undefined;
@@ -1886,26 +1946,32 @@ export interface PriceWithCurrency {
1886
1946
  */
1887
1947
  export interface DomainPrice {
1888
1948
  /**
1949
+ * @public
1889
1950
  * <p>The name of the TLD for which the prices apply.</p>
1890
1951
  */
1891
1952
  Name?: string;
1892
1953
  /**
1954
+ * @public
1893
1955
  * <p>The price for domain registration with Route 53.</p>
1894
1956
  */
1895
1957
  RegistrationPrice?: PriceWithCurrency;
1896
1958
  /**
1959
+ * @public
1897
1960
  * <p>The price for transferring the domain registration to Route 53.</p>
1898
1961
  */
1899
1962
  TransferPrice?: PriceWithCurrency;
1900
1963
  /**
1964
+ * @public
1901
1965
  * <p>The price for renewing domain registration with Route 53.</p>
1902
1966
  */
1903
1967
  RenewalPrice?: PriceWithCurrency;
1904
1968
  /**
1969
+ * @public
1905
1970
  * <p>The price for changing domain ownership.</p>
1906
1971
  */
1907
1972
  ChangeOwnershipPrice?: PriceWithCurrency;
1908
1973
  /**
1974
+ * @public
1909
1975
  * <p>The price for restoring the domain with Route 53.</p>
1910
1976
  */
1911
1977
  RestorationPrice?: PriceWithCurrency;
@@ -1916,10 +1982,12 @@ export interface DomainPrice {
1916
1982
  */
1917
1983
  export interface DomainSuggestion {
1918
1984
  /**
1985
+ * @public
1919
1986
  * <p>A suggested domain name.</p>
1920
1987
  */
1921
1988
  DomainName?: string;
1922
1989
  /**
1990
+ * @public
1923
1991
  * <p>Whether the domain name is available for registering.</p>
1924
1992
  * <note>
1925
1993
  * <p>You can register only the domains that are designated as
@@ -1979,19 +2047,23 @@ export interface DomainSuggestion {
1979
2047
  */
1980
2048
  export interface DomainSummary {
1981
2049
  /**
2050
+ * @public
1982
2051
  * <p>The name of the domain that the summary information applies to.</p>
1983
2052
  */
1984
2053
  DomainName?: string;
1985
2054
  /**
2055
+ * @public
1986
2056
  * <p>Indicates whether the domain is automatically renewed upon expiration.</p>
1987
2057
  */
1988
2058
  AutoRenew?: boolean;
1989
2059
  /**
2060
+ * @public
1990
2061
  * <p>Indicates whether a domain is locked from unauthorized transfer to another
1991
2062
  * party.</p>
1992
2063
  */
1993
2064
  TransferLock?: boolean;
1994
2065
  /**
2066
+ * @public
1995
2067
  * <p>Expiration date of the domain in Unix time format and Coordinated Universal Time
1996
2068
  * (UTC).</p>
1997
2069
  */
@@ -2002,6 +2074,7 @@ export interface DomainSummary {
2002
2074
  */
2003
2075
  export interface EnableDomainAutoRenewRequest {
2004
2076
  /**
2077
+ * @public
2005
2078
  * <p>The name of the domain that you want to enable automatic renewal for.</p>
2006
2079
  */
2007
2080
  DomainName: string | undefined;
@@ -2017,6 +2090,7 @@ export interface EnableDomainAutoRenewResponse {
2017
2090
  */
2018
2091
  export interface EnableDomainTransferLockRequest {
2019
2092
  /**
2093
+ * @public
2020
2094
  * <p>The name of the domain that you want to set the transfer lock for.</p>
2021
2095
  */
2022
2096
  DomainName: string | undefined;
@@ -2027,6 +2101,7 @@ export interface EnableDomainTransferLockRequest {
2027
2101
  */
2028
2102
  export interface EnableDomainTransferLockResponse {
2029
2103
  /**
2104
+ * @public
2030
2105
  * <p>Identifier for tracking the progress of the request. To use this ID to query the
2031
2106
  * operation status, use GetOperationDetail.</p>
2032
2107
  */
@@ -2063,10 +2138,12 @@ export type Operator = (typeof Operator)[keyof typeof Operator];
2063
2138
  */
2064
2139
  export interface FilterCondition {
2065
2140
  /**
2141
+ * @public
2066
2142
  * <p>Name of the field which should be used for filtering the list of domains.</p>
2067
2143
  */
2068
2144
  Name: ListDomainsAttributeName | string | undefined;
2069
2145
  /**
2146
+ * @public
2070
2147
  * <p>The operator values for filtering domain names. The values can be:</p>
2071
2148
  * <ul>
2072
2149
  * <li>
@@ -2085,6 +2162,7 @@ export interface FilterCondition {
2085
2162
  */
2086
2163
  Operator: Operator | string | undefined;
2087
2164
  /**
2165
+ * @public
2088
2166
  * <p> An array of strings presenting values to compare. Only 1 item in the list is
2089
2167
  * currently supported.</p>
2090
2168
  */
@@ -2095,6 +2173,7 @@ export interface FilterCondition {
2095
2173
  */
2096
2174
  export interface GetContactReachabilityStatusRequest {
2097
2175
  /**
2176
+ * @public
2098
2177
  * <p>The name of the domain for which you want to know whether the registrant contact has
2099
2178
  * confirmed that the email address is valid.</p>
2100
2179
  */
@@ -2118,10 +2197,12 @@ export type ReachabilityStatus = (typeof ReachabilityStatus)[keyof typeof Reacha
2118
2197
  */
2119
2198
  export interface GetContactReachabilityStatusResponse {
2120
2199
  /**
2200
+ * @public
2121
2201
  * <p>The domain name for which you requested the reachability status.</p>
2122
2202
  */
2123
2203
  domainName?: string;
2124
2204
  /**
2205
+ * @public
2125
2206
  * <p>Whether the registrant contact has responded. Values include the following:</p>
2126
2207
  * <dl>
2127
2208
  * <dt>PENDING</dt>
@@ -2146,6 +2227,7 @@ export interface GetContactReachabilityStatusResponse {
2146
2227
  */
2147
2228
  export interface GetDomainDetailRequest {
2148
2229
  /**
2230
+ * @public
2149
2231
  * <p>The name of the domain that you want to get detailed information about.</p>
2150
2232
  */
2151
2233
  DomainName: string | undefined;
@@ -2156,11 +2238,13 @@ export interface GetDomainDetailRequest {
2156
2238
  */
2157
2239
  export interface Nameserver {
2158
2240
  /**
2241
+ * @public
2159
2242
  * <p>The fully qualified host name of the name server.</p>
2160
2243
  * <p>Constraint: Maximum 255 characters</p>
2161
2244
  */
2162
2245
  Name: string | undefined;
2163
2246
  /**
2247
+ * @public
2164
2248
  * <p>Glue IP address of a name server entry. Glue IP addresses are required only when the
2165
2249
  * name of the name server is a subdomain of the domain. For example, if your domain is
2166
2250
  * example.com and the name server for the domain is ns.example.com, you need to specify
@@ -2175,30 +2259,37 @@ export interface Nameserver {
2175
2259
  */
2176
2260
  export interface GetDomainDetailResponse {
2177
2261
  /**
2262
+ * @public
2178
2263
  * <p>The name of a domain.</p>
2179
2264
  */
2180
2265
  DomainName?: string;
2181
2266
  /**
2267
+ * @public
2182
2268
  * <p>The name servers of the domain.</p>
2183
2269
  */
2184
2270
  Nameservers?: Nameserver[];
2185
2271
  /**
2272
+ * @public
2186
2273
  * <p>Specifies whether the domain registration is set to renew automatically.</p>
2187
2274
  */
2188
2275
  AutoRenew?: boolean;
2189
2276
  /**
2277
+ * @public
2190
2278
  * <p>Provides details about the domain administrative contact.</p>
2191
2279
  */
2192
2280
  AdminContact?: ContactDetail;
2193
2281
  /**
2282
+ * @public
2194
2283
  * <p>Provides details about the domain registrant.</p>
2195
2284
  */
2196
2285
  RegistrantContact?: ContactDetail;
2197
2286
  /**
2287
+ * @public
2198
2288
  * <p>Provides details about the domain technical contact.</p>
2199
2289
  */
2200
2290
  TechContact?: ContactDetail;
2201
2291
  /**
2292
+ * @public
2202
2293
  * <p>Specifies whether contact information is concealed from WHOIS queries. If the value is
2203
2294
  * <code>true</code>, WHOIS ("who is") queries return contact information either for
2204
2295
  * Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate,
@@ -2207,6 +2298,7 @@ export interface GetDomainDetailResponse {
2207
2298
  */
2208
2299
  AdminPrivacy?: boolean;
2209
2300
  /**
2301
+ * @public
2210
2302
  * <p>Specifies whether contact information is concealed from WHOIS queries. If the value is
2211
2303
  * <code>true</code>, WHOIS ("who is") queries return contact information either for
2212
2304
  * Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate,
@@ -2215,6 +2307,7 @@ export interface GetDomainDetailResponse {
2215
2307
  */
2216
2308
  RegistrantPrivacy?: boolean;
2217
2309
  /**
2310
+ * @public
2218
2311
  * <p>Specifies whether contact information is concealed from WHOIS queries. If the value is
2219
2312
  * <code>true</code>, WHOIS ("who is") queries return contact information either for
2220
2313
  * Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate,
@@ -2223,6 +2316,7 @@ export interface GetDomainDetailResponse {
2223
2316
  */
2224
2317
  TechPrivacy?: boolean;
2225
2318
  /**
2319
+ * @public
2226
2320
  * <p>Name of the registrar of the domain as identified in the registry. Domains with a
2227
2321
  * .com, .net, or .org TLD are registered by Amazon Registrar. All other domains are
2228
2322
  * registered by our registrar associate, Gandi. The value for domains that are registered
@@ -2230,53 +2324,64 @@ export interface GetDomainDetailResponse {
2230
2324
  */
2231
2325
  RegistrarName?: string;
2232
2326
  /**
2327
+ * @public
2233
2328
  * <p>The fully qualified name of the WHOIS server that can answer the WHOIS query for the
2234
2329
  * domain.</p>
2235
2330
  */
2236
2331
  WhoIsServer?: string;
2237
2332
  /**
2333
+ * @public
2238
2334
  * <p>Web address of the registrar.</p>
2239
2335
  */
2240
2336
  RegistrarUrl?: string;
2241
2337
  /**
2338
+ * @public
2242
2339
  * <p>Email address to contact to report incorrect contact information for a domain, to
2243
2340
  * report that the domain is being used to send spam, to report that someone is
2244
2341
  * cybersquatting on a domain name, or report some other type of abuse.</p>
2245
2342
  */
2246
2343
  AbuseContactEmail?: string;
2247
2344
  /**
2345
+ * @public
2248
2346
  * <p>Phone number for reporting abuse.</p>
2249
2347
  */
2250
2348
  AbuseContactPhone?: string;
2251
2349
  /**
2350
+ * @public
2252
2351
  * <p>Reserved for future use.</p>
2253
2352
  */
2254
2353
  RegistryDomainId?: string;
2255
2354
  /**
2355
+ * @public
2256
2356
  * <p>The date when the domain was created as found in the response to a WHOIS query. The
2257
2357
  * date and time is in Unix time format and Coordinated Universal time (UTC).</p>
2258
2358
  */
2259
2359
  CreationDate?: Date;
2260
2360
  /**
2361
+ * @public
2261
2362
  * <p>The last updated date of the domain as found in the response to a WHOIS query. The
2262
2363
  * date and time is in Unix time format and Coordinated Universal time (UTC).</p>
2263
2364
  */
2264
2365
  UpdatedDate?: Date;
2265
2366
  /**
2367
+ * @public
2266
2368
  * <p>The date when the registration for the domain is set to expire. The date and time is
2267
2369
  * in Unix time format and Coordinated Universal time (UTC).</p>
2268
2370
  */
2269
2371
  ExpirationDate?: Date;
2270
2372
  /**
2373
+ * @public
2271
2374
  * <p>Reseller of the domain. Domains registered or transferred using Route 53 domains will
2272
2375
  * have <code>"Amazon"</code> as the reseller. </p>
2273
2376
  */
2274
2377
  Reseller?: string;
2275
2378
  /**
2379
+ * @public
2276
2380
  * <p>Deprecated.</p>
2277
2381
  */
2278
2382
  DnsSec?: string;
2279
2383
  /**
2384
+ * @public
2280
2385
  * <p>An array of domain name status codes, also known as Extensible Provisioning Protocol
2281
2386
  * (EPP) status codes.</p>
2282
2387
  * <p>ICANN, the organization that maintains a central database of domain names, has
@@ -2291,6 +2396,7 @@ export interface GetDomainDetailResponse {
2291
2396
  */
2292
2397
  StatusList?: string[];
2293
2398
  /**
2399
+ * @public
2294
2400
  * <p>A complex type that contains information about the DNSSEC configuration.</p>
2295
2401
  */
2296
2402
  DnssecKeys?: DnssecKey[];
@@ -2300,6 +2406,7 @@ export interface GetDomainDetailResponse {
2300
2406
  */
2301
2407
  export interface GetDomainSuggestionsRequest {
2302
2408
  /**
2409
+ * @public
2303
2410
  * <p>A domain name that you want to use as the basis for a list of possible domain names.
2304
2411
  * The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a
2305
2412
  * list of supported TLDs, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html">Domains that You Can
@@ -2329,11 +2436,13 @@ export interface GetDomainSuggestionsRequest {
2329
2436
  */
2330
2437
  DomainName: string | undefined;
2331
2438
  /**
2439
+ * @public
2332
2440
  * <p>The number of suggested domain names that you want Route 53 to return. Specify a value
2333
2441
  * between 1 and 50.</p>
2334
2442
  */
2335
2443
  SuggestionCount: number | undefined;
2336
2444
  /**
2445
+ * @public
2337
2446
  * <p>If <code>OnlyAvailable</code> is <code>true</code>, Route 53 returns only domain names
2338
2447
  * that are available. If <code>OnlyAvailable</code> is <code>false</code>, Route 53
2339
2448
  * returns domain names without checking whether they're available to be registered. To
@@ -2347,6 +2456,7 @@ export interface GetDomainSuggestionsRequest {
2347
2456
  */
2348
2457
  export interface GetDomainSuggestionsResponse {
2349
2458
  /**
2459
+ * @public
2350
2460
  * <p>A list of possible domain names. If you specified <code>true</code> for
2351
2461
  * <code>OnlyAvailable</code> in the request, the list contains only domains that are
2352
2462
  * available for registration.</p>
@@ -2359,6 +2469,7 @@ export interface GetDomainSuggestionsResponse {
2359
2469
  */
2360
2470
  export interface GetOperationDetailRequest {
2361
2471
  /**
2472
+ * @public
2362
2473
  * <p>The identifier for the operation for which you want to get the status. Route 53
2363
2474
  * returned the identifier in the response to the original request.</p>
2364
2475
  */
@@ -2400,34 +2511,42 @@ export type StatusFlag = (typeof StatusFlag)[keyof typeof StatusFlag];
2400
2511
  */
2401
2512
  export interface GetOperationDetailResponse {
2402
2513
  /**
2514
+ * @public
2403
2515
  * <p>The identifier for the operation.</p>
2404
2516
  */
2405
2517
  OperationId?: string;
2406
2518
  /**
2519
+ * @public
2407
2520
  * <p>The current status of the requested operation in the system.</p>
2408
2521
  */
2409
2522
  Status?: OperationStatus | string;
2410
2523
  /**
2524
+ * @public
2411
2525
  * <p>Detailed information on the status including possible errors.</p>
2412
2526
  */
2413
2527
  Message?: string;
2414
2528
  /**
2529
+ * @public
2415
2530
  * <p>The name of a domain.</p>
2416
2531
  */
2417
2532
  DomainName?: string;
2418
2533
  /**
2534
+ * @public
2419
2535
  * <p>The type of operation that was requested.</p>
2420
2536
  */
2421
2537
  Type?: OperationType | string;
2422
2538
  /**
2539
+ * @public
2423
2540
  * <p>The date when the request was submitted.</p>
2424
2541
  */
2425
2542
  SubmittedDate?: Date;
2426
2543
  /**
2544
+ * @public
2427
2545
  * <p> The date when the operation was last updated. </p>
2428
2546
  */
2429
2547
  LastUpdatedDate?: Date;
2430
2548
  /**
2549
+ * @public
2431
2550
  * <p> Lists any outstanding operations that require customer action. Valid values
2432
2551
  * are:</p>
2433
2552
  * <ul>
@@ -2478,6 +2597,7 @@ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
2478
2597
  */
2479
2598
  export interface SortCondition {
2480
2599
  /**
2600
+ * @public
2481
2601
  * <p>Field to be used for sorting the list of domains. It can be either the name or the
2482
2602
  * expiration for a domain. Note that if <code>filterCondition</code> is used in the same
2483
2603
  * <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains__ListDomains.html">ListDomains</a>
@@ -2486,6 +2606,7 @@ export interface SortCondition {
2486
2606
  */
2487
2607
  Name: ListDomainsAttributeName | string | undefined;
2488
2608
  /**
2609
+ * @public
2489
2610
  * <p>The sort order for a list of domains. Either ascending (ASC) or descending
2490
2611
  * (DES).</p>
2491
2612
  */
@@ -2497,17 +2618,20 @@ export interface SortCondition {
2497
2618
  */
2498
2619
  export interface ListDomainsRequest {
2499
2620
  /**
2621
+ * @public
2500
2622
  * <p>A complex type that contains information about the filters applied during the
2501
2623
  * <code>ListDomains</code> request. The filter conditions can include domain name and
2502
2624
  * domain expiration.</p>
2503
2625
  */
2504
2626
  FilterConditions?: FilterCondition[];
2505
2627
  /**
2628
+ * @public
2506
2629
  * <p>A complex type that contains information about the requested ordering of domains in
2507
2630
  * the returned list.</p>
2508
2631
  */
2509
2632
  SortCondition?: SortCondition;
2510
2633
  /**
2634
+ * @public
2511
2635
  * <p>For an initial request for a list of domains, omit this element. If the number of
2512
2636
  * domains that are associated with the current Amazon Web Services account is greater than
2513
2637
  * the value that you specified for <code>MaxItems</code>, you can use <code>Marker</code>
@@ -2518,6 +2642,7 @@ export interface ListDomainsRequest {
2518
2642
  */
2519
2643
  Marker?: string;
2520
2644
  /**
2645
+ * @public
2521
2646
  * <p>Number of domains to be returned.</p>
2522
2647
  * <p>Default: 20</p>
2523
2648
  */
@@ -2529,10 +2654,12 @@ export interface ListDomainsRequest {
2529
2654
  */
2530
2655
  export interface ListDomainsResponse {
2531
2656
  /**
2657
+ * @public
2532
2658
  * <p>A list of domains.</p>
2533
2659
  */
2534
2660
  Domains?: DomainSummary[];
2535
2661
  /**
2662
+ * @public
2536
2663
  * <p>If there are more domains than you specified for <code>MaxItems</code> in the request,
2537
2664
  * submit another request and include the value of <code>NextPageMarker</code> in the value
2538
2665
  * of <code>Marker</code>.</p>
@@ -2556,12 +2683,14 @@ export type ListOperationsSortAttributeName = (typeof ListOperationsSortAttribut
2556
2683
  */
2557
2684
  export interface ListOperationsRequest {
2558
2685
  /**
2686
+ * @public
2559
2687
  * <p>An optional parameter that lets you get information about all the operations that you
2560
2688
  * submitted after a specified date and time. Specify the date and time in Unix time format
2561
2689
  * and Coordinated Universal time (UTC).</p>
2562
2690
  */
2563
2691
  SubmittedSince?: Date;
2564
2692
  /**
2693
+ * @public
2565
2694
  * <p>For an initial request for a list of operations, omit this element. If the number of
2566
2695
  * operations that are not yet complete is greater than the value that you specified for
2567
2696
  * <code>MaxItems</code>, you can use <code>Marker</code> to return additional
@@ -2571,23 +2700,28 @@ export interface ListOperationsRequest {
2571
2700
  */
2572
2701
  Marker?: string;
2573
2702
  /**
2703
+ * @public
2574
2704
  * <p>Number of domains to be returned.</p>
2575
2705
  * <p>Default: 20</p>
2576
2706
  */
2577
2707
  MaxItems?: number;
2578
2708
  /**
2709
+ * @public
2579
2710
  * <p> The status of the operations. </p>
2580
2711
  */
2581
2712
  Status?: (OperationStatus | string)[];
2582
2713
  /**
2714
+ * @public
2583
2715
  * <p> An arrays of the domains operation types. </p>
2584
2716
  */
2585
2717
  Type?: (OperationType | string)[];
2586
2718
  /**
2719
+ * @public
2587
2720
  * <p> The sort type for returned values. </p>
2588
2721
  */
2589
2722
  SortBy?: ListOperationsSortAttributeName | string;
2590
2723
  /**
2724
+ * @public
2591
2725
  * <p> The sort order ofr returned values, either ascending or descending. </p>
2592
2726
  */
2593
2727
  SortOrder?: SortOrder | string;
@@ -2598,30 +2732,37 @@ export interface ListOperationsRequest {
2598
2732
  */
2599
2733
  export interface OperationSummary {
2600
2734
  /**
2735
+ * @public
2601
2736
  * <p>Identifier returned to track the requested action.</p>
2602
2737
  */
2603
2738
  OperationId?: string;
2604
2739
  /**
2740
+ * @public
2605
2741
  * <p>The current status of the requested operation in the system.</p>
2606
2742
  */
2607
2743
  Status?: OperationStatus | string;
2608
2744
  /**
2745
+ * @public
2609
2746
  * <p>Type of the action requested.</p>
2610
2747
  */
2611
2748
  Type?: OperationType | string;
2612
2749
  /**
2750
+ * @public
2613
2751
  * <p>The date when the request was submitted.</p>
2614
2752
  */
2615
2753
  SubmittedDate?: Date;
2616
2754
  /**
2755
+ * @public
2617
2756
  * <p> Name of the domain. </p>
2618
2757
  */
2619
2758
  DomainName?: string;
2620
2759
  /**
2760
+ * @public
2621
2761
  * <p> Message about the operation. </p>
2622
2762
  */
2623
2763
  Message?: string;
2624
2764
  /**
2765
+ * @public
2625
2766
  * <p> Automatically checks whether there are no outstanding operations on domains that need
2626
2767
  * customer attention. </p>
2627
2768
  * <p> Valid values are:</p>
@@ -2655,6 +2796,7 @@ export interface OperationSummary {
2655
2796
  */
2656
2797
  StatusFlag?: StatusFlag | string;
2657
2798
  /**
2799
+ * @public
2658
2800
  * <p> The date when the last change was made in Unix time format and Coordinated Universal
2659
2801
  * Time (UTC). </p>
2660
2802
  */
@@ -2666,10 +2808,12 @@ export interface OperationSummary {
2666
2808
  */
2667
2809
  export interface ListOperationsResponse {
2668
2810
  /**
2811
+ * @public
2669
2812
  * <p>Lists summaries of the operations.</p>
2670
2813
  */
2671
2814
  Operations?: OperationSummary[];
2672
2815
  /**
2816
+ * @public
2673
2817
  * <p>If there are more operations than you specified for <code>MaxItems</code> in the
2674
2818
  * request, submit another request and include the value of <code>NextPageMarker</code> in
2675
2819
  * the value of <code>Marker</code>.</p>
@@ -2681,6 +2825,7 @@ export interface ListOperationsResponse {
2681
2825
  */
2682
2826
  export interface ListPricesRequest {
2683
2827
  /**
2828
+ * @public
2684
2829
  * <p>The TLD for which you want to receive the pricing information. For example.
2685
2830
  * <code>.net</code>.</p>
2686
2831
  * <p>If a <code>Tld</code> value is not provided, a list of prices for all TLDs supported
@@ -2688,6 +2833,7 @@ export interface ListPricesRequest {
2688
2833
  */
2689
2834
  Tld?: string;
2690
2835
  /**
2836
+ * @public
2691
2837
  * <p>For an initial request for a list of prices, omit this element. If the number of
2692
2838
  * prices that are not yet complete is greater than the value that you specified for
2693
2839
  * <code>MaxItems</code>, you can use <code>Marker</code> to return additional prices.
@@ -2699,6 +2845,7 @@ export interface ListPricesRequest {
2699
2845
  */
2700
2846
  Marker?: string;
2701
2847
  /**
2848
+ * @public
2702
2849
  * <p>Number of <code>Prices</code> to be returned.</p>
2703
2850
  * <p>Used only for all TLDs. If you specify a TLD, don't specify a
2704
2851
  * <code>MaxItems</code>.</p>
@@ -2710,11 +2857,13 @@ export interface ListPricesRequest {
2710
2857
  */
2711
2858
  export interface ListPricesResponse {
2712
2859
  /**
2860
+ * @public
2713
2861
  * <p>A complex type that includes all the pricing information. If you specify a TLD, this
2714
2862
  * array contains only the pricing for that TLD.</p>
2715
2863
  */
2716
2864
  Prices?: DomainPrice[];
2717
2865
  /**
2866
+ * @public
2718
2867
  * <p>If there are more prices than you specified for <code>MaxItems</code> in the request,
2719
2868
  * submit another request and include the value of <code>NextPageMarker</code> in the value
2720
2869
  * of <code>Marker</code>. </p>
@@ -2729,6 +2878,7 @@ export interface ListPricesResponse {
2729
2878
  */
2730
2879
  export interface ListTagsForDomainRequest {
2731
2880
  /**
2881
+ * @public
2732
2882
  * <p>The domain for which you want to get a list of tags.</p>
2733
2883
  */
2734
2884
  DomainName: string | undefined;
@@ -2739,12 +2889,14 @@ export interface ListTagsForDomainRequest {
2739
2889
  */
2740
2890
  export interface Tag {
2741
2891
  /**
2892
+ * @public
2742
2893
  * <p>The key (name) of a tag.</p>
2743
2894
  * <p>Valid values: A-Z, a-z, 0-9, space, ".:/=+\-@"</p>
2744
2895
  * <p>Constraints: Each key can be 1-128 characters long.</p>
2745
2896
  */
2746
2897
  Key?: string;
2747
2898
  /**
2899
+ * @public
2748
2900
  * <p>The value of a tag.</p>
2749
2901
  * <p>Valid values: A-Z, a-z, 0-9, space, ".:/=+\-@"</p>
2750
2902
  * <p>Constraints: Each value can be 0-256 characters long.</p>
@@ -2757,6 +2909,7 @@ export interface Tag {
2757
2909
  */
2758
2910
  export interface ListTagsForDomainResponse {
2759
2911
  /**
2912
+ * @public
2760
2913
  * <p>A list of the tags that are associated with the specified domain.</p>
2761
2914
  */
2762
2915
  TagList?: Tag[];
@@ -2766,10 +2919,12 @@ export interface ListTagsForDomainResponse {
2766
2919
  */
2767
2920
  export interface PushDomainRequest {
2768
2921
  /**
2922
+ * @public
2769
2923
  * <p> Name of the domain. </p>
2770
2924
  */
2771
2925
  DomainName: string | undefined;
2772
2926
  /**
2927
+ * @public
2773
2928
  * <p> New IPS tag for the domain. </p>
2774
2929
  */
2775
2930
  Target: string | undefined;
@@ -2780,6 +2935,7 @@ export interface PushDomainRequest {
2780
2935
  */
2781
2936
  export interface RegisterDomainRequest {
2782
2937
  /**
2938
+ * @public
2783
2939
  * <p>The domain name that you want to register. The top-level domain (TLD), such as .com,
2784
2940
  * must be a TLD that Route 53 supports. For a list of supported TLDs, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html">Domains that You Can Register with Amazon Route 53</a> in the <i>Amazon
2785
2941
  * Route 53 Developer Guide</i>.</p>
@@ -2807,10 +2963,12 @@ export interface RegisterDomainRequest {
2807
2963
  */
2808
2964
  DomainName: string | undefined;
2809
2965
  /**
2966
+ * @public
2810
2967
  * <p>Reserved for future use.</p>
2811
2968
  */
2812
2969
  IdnLangCode?: string;
2813
2970
  /**
2971
+ * @public
2814
2972
  * <p>The number of years that you want to register the domain for. Domains are registered
2815
2973
  * for a minimum of one year. The maximum period depends on the top-level domain. For the
2816
2974
  * range of valid values for your domain, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html">Domains that You Can
@@ -2820,6 +2978,7 @@ export interface RegisterDomainRequest {
2820
2978
  */
2821
2979
  DurationInYears: number | undefined;
2822
2980
  /**
2981
+ * @public
2823
2982
  * <p>Indicates whether the domain will be automatically renewed (<code>true</code>) or not
2824
2983
  * (<code>false</code>). Auto renewal only takes effect after the account is
2825
2984
  * charged.</p>
@@ -2828,21 +2987,25 @@ export interface RegisterDomainRequest {
2828
2987
  */
2829
2988
  AutoRenew?: boolean;
2830
2989
  /**
2990
+ * @public
2831
2991
  * <p>Provides detailed contact information. For information about the values that you
2832
2992
  * specify for each element, see <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ContactDetail.html">ContactDetail</a>.</p>
2833
2993
  */
2834
2994
  AdminContact: ContactDetail | undefined;
2835
2995
  /**
2996
+ * @public
2836
2997
  * <p>Provides detailed contact information. For information about the values that you
2837
2998
  * specify for each element, see <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ContactDetail.html">ContactDetail</a>.</p>
2838
2999
  */
2839
3000
  RegistrantContact: ContactDetail | undefined;
2840
3001
  /**
3002
+ * @public
2841
3003
  * <p>Provides detailed contact information. For information about the values that you
2842
3004
  * specify for each element, see <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ContactDetail.html">ContactDetail</a>.</p>
2843
3005
  */
2844
3006
  TechContact: ContactDetail | undefined;
2845
3007
  /**
3008
+ * @public
2846
3009
  * <p>Whether you want to conceal contact information from WHOIS queries. If you specify
2847
3010
  * <code>true</code>, WHOIS ("who is") queries return contact information either for
2848
3011
  * Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate,
@@ -2857,6 +3020,7 @@ export interface RegisterDomainRequest {
2857
3020
  */
2858
3021
  PrivacyProtectAdminContact?: boolean;
2859
3022
  /**
3023
+ * @public
2860
3024
  * <p>Whether you want to conceal contact information from WHOIS queries. If you specify
2861
3025
  * <code>true</code>, WHOIS ("who is") queries return contact information either for
2862
3026
  * Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate,
@@ -2871,6 +3035,7 @@ export interface RegisterDomainRequest {
2871
3035
  */
2872
3036
  PrivacyProtectRegistrantContact?: boolean;
2873
3037
  /**
3038
+ * @public
2874
3039
  * <p>Whether you want to conceal contact information from WHOIS queries. If you specify
2875
3040
  * <code>true</code>, WHOIS ("who is") queries return contact information either for
2876
3041
  * Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate,
@@ -2891,6 +3056,7 @@ export interface RegisterDomainRequest {
2891
3056
  */
2892
3057
  export interface RegisterDomainResponse {
2893
3058
  /**
3059
+ * @public
2894
3060
  * <p>Identifier for tracking the progress of the request. To query the operation status,
2895
3061
  * use <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html">GetOperationDetail</a>.</p>
2896
3062
  */
@@ -2903,6 +3069,7 @@ export interface RegisterDomainResponse {
2903
3069
  */
2904
3070
  export interface RejectDomainTransferFromAnotherAwsAccountRequest {
2905
3071
  /**
3072
+ * @public
2906
3073
  * <p>The name of the domain that was specified when another Amazon Web Services account
2907
3074
  * submitted a <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html">TransferDomainToAnotherAwsAccount</a> request. </p>
2908
3075
  */
@@ -2915,6 +3082,7 @@ export interface RejectDomainTransferFromAnotherAwsAccountRequest {
2915
3082
  */
2916
3083
  export interface RejectDomainTransferFromAnotherAwsAccountResponse {
2917
3084
  /**
3085
+ * @public
2918
3086
  * <p>The identifier that <code>TransferDomainToAnotherAwsAccount</code> returned to track
2919
3087
  * the progress of the request. Because the transfer request was rejected, the value is no
2920
3088
  * longer valid, and you can't use <code>GetOperationDetail</code> to query the operation
@@ -2929,10 +3097,12 @@ export interface RejectDomainTransferFromAnotherAwsAccountResponse {
2929
3097
  */
2930
3098
  export interface RenewDomainRequest {
2931
3099
  /**
3100
+ * @public
2932
3101
  * <p>The name of the domain that you want to renew.</p>
2933
3102
  */
2934
3103
  DomainName: string | undefined;
2935
3104
  /**
3105
+ * @public
2936
3106
  * <p>The number of years that you want to renew the domain for. The maximum number of years
2937
3107
  * depends on the top-level domain. For the range of valid values for your domain, see
2938
3108
  * <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html">Domains that You Can
@@ -2942,6 +3112,7 @@ export interface RenewDomainRequest {
2942
3112
  */
2943
3113
  DurationInYears?: number;
2944
3114
  /**
3115
+ * @public
2945
3116
  * <p>The year when the registration for the domain is set to expire. This value must match
2946
3117
  * the current expiration date for the domain.</p>
2947
3118
  */
@@ -2952,6 +3123,7 @@ export interface RenewDomainRequest {
2952
3123
  */
2953
3124
  export interface RenewDomainResponse {
2954
3125
  /**
3126
+ * @public
2955
3127
  * <p>Identifier for tracking the progress of the request. To query the operation status,
2956
3128
  * use <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html">GetOperationDetail</a>.</p>
2957
3129
  */
@@ -2962,6 +3134,7 @@ export interface RenewDomainResponse {
2962
3134
  */
2963
3135
  export interface ResendContactReachabilityEmailRequest {
2964
3136
  /**
3137
+ * @public
2965
3138
  * <p>The name of the domain for which you want Route 53 to resend a confirmation email to
2966
3139
  * the registrant contact.</p>
2967
3140
  */
@@ -2972,15 +3145,18 @@ export interface ResendContactReachabilityEmailRequest {
2972
3145
  */
2973
3146
  export interface ResendContactReachabilityEmailResponse {
2974
3147
  /**
3148
+ * @public
2975
3149
  * <p>The domain name for which you requested a confirmation email.</p>
2976
3150
  */
2977
3151
  domainName?: string;
2978
3152
  /**
3153
+ * @public
2979
3154
  * <p>The email address for the registrant contact at the time that we sent the verification
2980
3155
  * email.</p>
2981
3156
  */
2982
3157
  emailAddress?: string;
2983
3158
  /**
3159
+ * @public
2984
3160
  * <p>
2985
3161
  * <code>True</code> if the email address for the registrant contact has already been
2986
3162
  * verified, and <code>false</code> otherwise. If the email address has already been
@@ -2993,6 +3169,7 @@ export interface ResendContactReachabilityEmailResponse {
2993
3169
  */
2994
3170
  export interface ResendOperationAuthorizationRequest {
2995
3171
  /**
3172
+ * @public
2996
3173
  * <p> Operation ID. </p>
2997
3174
  */
2998
3175
  OperationId: string | undefined;
@@ -3004,6 +3181,7 @@ export interface ResendOperationAuthorizationRequest {
3004
3181
  */
3005
3182
  export interface RetrieveDomainAuthCodeRequest {
3006
3183
  /**
3184
+ * @public
3007
3185
  * <p>The name of the domain that you want to get an authorization code for.</p>
3008
3186
  */
3009
3187
  DomainName: string | undefined;
@@ -3014,6 +3192,7 @@ export interface RetrieveDomainAuthCodeRequest {
3014
3192
  */
3015
3193
  export interface RetrieveDomainAuthCodeResponse {
3016
3194
  /**
3195
+ * @public
3017
3196
  * <p>The authorization code for the domain.</p>
3018
3197
  */
3019
3198
  AuthCode?: string;
@@ -3024,6 +3203,7 @@ export interface RetrieveDomainAuthCodeResponse {
3024
3203
  */
3025
3204
  export interface TransferDomainRequest {
3026
3205
  /**
3206
+ * @public
3027
3207
  * <p>The name of the domain that you want to transfer to Route 53. The top-level domain
3028
3208
  * (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs,
3029
3209
  * see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html">Domains that You Can
@@ -3049,43 +3229,52 @@ export interface TransferDomainRequest {
3049
3229
  */
3050
3230
  DomainName: string | undefined;
3051
3231
  /**
3232
+ * @public
3052
3233
  * <p>Reserved for future use.</p>
3053
3234
  */
3054
3235
  IdnLangCode?: string;
3055
3236
  /**
3237
+ * @public
3056
3238
  * <p>The number of years that you want to register the domain for. Domains are registered
3057
3239
  * for a minimum of one year. The maximum period depends on the top-level domain.</p>
3058
3240
  * <p>Default: 1</p>
3059
3241
  */
3060
3242
  DurationInYears: number | undefined;
3061
3243
  /**
3244
+ * @public
3062
3245
  * <p>Contains details for the host and glue IP addresses.</p>
3063
3246
  */
3064
3247
  Nameservers?: Nameserver[];
3065
3248
  /**
3249
+ * @public
3066
3250
  * <p>The authorization code for the domain. You get this value from the current
3067
3251
  * registrar.</p>
3068
3252
  */
3069
3253
  AuthCode?: string;
3070
3254
  /**
3255
+ * @public
3071
3256
  * <p>Indicates whether the domain will be automatically renewed (true) or not (false). Auto
3072
3257
  * renewal only takes effect after the account is charged.</p>
3073
3258
  * <p>Default: true</p>
3074
3259
  */
3075
3260
  AutoRenew?: boolean;
3076
3261
  /**
3262
+ * @public
3077
3263
  * <p>Provides detailed contact information.</p>
3078
3264
  */
3079
3265
  AdminContact: ContactDetail | undefined;
3080
3266
  /**
3267
+ * @public
3081
3268
  * <p>Provides detailed contact information.</p>
3082
3269
  */
3083
3270
  RegistrantContact: ContactDetail | undefined;
3084
3271
  /**
3272
+ * @public
3085
3273
  * <p>Provides detailed contact information.</p>
3086
3274
  */
3087
3275
  TechContact: ContactDetail | undefined;
3088
3276
  /**
3277
+ * @public
3089
3278
  * <p>Whether you want to conceal contact information from WHOIS queries. If you specify
3090
3279
  * <code>true</code>, WHOIS ("who is") queries return contact information for the
3091
3280
  * registrar, the phrase "REDACTED FOR PRIVACY", or "On behalf of <domain name>
@@ -3099,6 +3288,7 @@ export interface TransferDomainRequest {
3099
3288
  */
3100
3289
  PrivacyProtectAdminContact?: boolean;
3101
3290
  /**
3291
+ * @public
3102
3292
  * <p>Whether you want to conceal contact information from WHOIS queries. If you specify
3103
3293
  * <code>true</code>, WHOIS ("who is") queries return contact information either for
3104
3294
  * Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate,
@@ -3113,6 +3303,7 @@ export interface TransferDomainRequest {
3113
3303
  */
3114
3304
  PrivacyProtectRegistrantContact?: boolean;
3115
3305
  /**
3306
+ * @public
3116
3307
  * <p>Whether you want to conceal contact information from WHOIS queries. If you specify
3117
3308
  * <code>true</code>, WHOIS ("who is") queries return contact information either for
3118
3309
  * Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate,
@@ -3133,6 +3324,7 @@ export interface TransferDomainRequest {
3133
3324
  */
3134
3325
  export interface TransferDomainResponse {
3135
3326
  /**
3327
+ * @public
3136
3328
  * <p>Identifier for tracking the progress of the request. To query the operation status,
3137
3329
  * use <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html">GetOperationDetail</a>.</p>
3138
3330
  */
@@ -3144,10 +3336,12 @@ export interface TransferDomainResponse {
3144
3336
  */
3145
3337
  export interface TransferDomainToAnotherAwsAccountRequest {
3146
3338
  /**
3339
+ * @public
3147
3340
  * <p>The name of the domain that you want to transfer from the current Amazon Web Services account to another account.</p>
3148
3341
  */
3149
3342
  DomainName: string | undefined;
3150
3343
  /**
3344
+ * @public
3151
3345
  * <p>The account ID of the Amazon Web Services account that you want to transfer the domain
3152
3346
  * to, for example, <code>111122223333</code>.</p>
3153
3347
  */
@@ -3160,11 +3354,13 @@ export interface TransferDomainToAnotherAwsAccountRequest {
3160
3354
  */
3161
3355
  export interface TransferDomainToAnotherAwsAccountResponse {
3162
3356
  /**
3357
+ * @public
3163
3358
  * <p>Identifier for tracking the progress of the request. To query the operation status,
3164
3359
  * use <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html">GetOperationDetail</a>.</p>
3165
3360
  */
3166
3361
  OperationId?: string;
3167
3362
  /**
3363
+ * @public
3168
3364
  * <p>To finish transferring a domain to another Amazon Web Services account, the account
3169
3365
  * that the domain is being transferred to must submit an <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_AcceptDomainTransferFromAnotherAwsAccount.html">AcceptDomainTransferFromAnotherAwsAccount</a> request. The request must include
3170
3366
  * the value of the <code>Password</code> element that was returned in the
@@ -3178,22 +3374,27 @@ export interface TransferDomainToAnotherAwsAccountResponse {
3178
3374
  */
3179
3375
  export interface UpdateDomainContactRequest {
3180
3376
  /**
3377
+ * @public
3181
3378
  * <p>The name of the domain that you want to update contact information for.</p>
3182
3379
  */
3183
3380
  DomainName: string | undefined;
3184
3381
  /**
3382
+ * @public
3185
3383
  * <p>Provides detailed contact information.</p>
3186
3384
  */
3187
3385
  AdminContact?: ContactDetail;
3188
3386
  /**
3387
+ * @public
3189
3388
  * <p>Provides detailed contact information.</p>
3190
3389
  */
3191
3390
  RegistrantContact?: ContactDetail;
3192
3391
  /**
3392
+ * @public
3193
3393
  * <p>Provides detailed contact information.</p>
3194
3394
  */
3195
3395
  TechContact?: ContactDetail;
3196
3396
  /**
3397
+ * @public
3197
3398
  * <p> Customer's consent for the owner change request. Required if the domain is not free (consent price is more than $0.00).</p>
3198
3399
  */
3199
3400
  Consent?: Consent;
@@ -3204,6 +3405,7 @@ export interface UpdateDomainContactRequest {
3204
3405
  */
3205
3406
  export interface UpdateDomainContactResponse {
3206
3407
  /**
3408
+ * @public
3207
3409
  * <p>Identifier for tracking the progress of the request. To query the operation status,
3208
3410
  * use <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html">GetOperationDetail</a>.</p>
3209
3411
  */
@@ -3215,10 +3417,12 @@ export interface UpdateDomainContactResponse {
3215
3417
  */
3216
3418
  export interface UpdateDomainContactPrivacyRequest {
3217
3419
  /**
3420
+ * @public
3218
3421
  * <p>The name of the domain that you want to update the privacy setting for.</p>
3219
3422
  */
3220
3423
  DomainName: string | undefined;
3221
3424
  /**
3425
+ * @public
3222
3426
  * <p>Whether you want to conceal contact information from WHOIS queries. If you specify
3223
3427
  * <code>true</code>, WHOIS ("who is") queries return contact information either for
3224
3428
  * Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate,
@@ -3231,6 +3435,7 @@ export interface UpdateDomainContactPrivacyRequest {
3231
3435
  */
3232
3436
  AdminPrivacy?: boolean;
3233
3437
  /**
3438
+ * @public
3234
3439
  * <p>Whether you want to conceal contact information from WHOIS queries. If you specify
3235
3440
  * <code>true</code>, WHOIS ("who is") queries return contact information either for
3236
3441
  * Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate,
@@ -3243,6 +3448,7 @@ export interface UpdateDomainContactPrivacyRequest {
3243
3448
  */
3244
3449
  RegistrantPrivacy?: boolean;
3245
3450
  /**
3451
+ * @public
3246
3452
  * <p>Whether you want to conceal contact information from WHOIS queries. If you specify
3247
3453
  * <code>true</code>, WHOIS ("who is") queries return contact information either for
3248
3454
  * Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate,
@@ -3261,6 +3467,7 @@ export interface UpdateDomainContactPrivacyRequest {
3261
3467
  */
3262
3468
  export interface UpdateDomainContactPrivacyResponse {
3263
3469
  /**
3470
+ * @public
3264
3471
  * <p>Identifier for tracking the progress of the request. To use this ID to query the
3265
3472
  * operation status, use GetOperationDetail.</p>
3266
3473
  */
@@ -3277,16 +3484,19 @@ export interface UpdateDomainContactPrivacyResponse {
3277
3484
  */
3278
3485
  export interface UpdateDomainNameserversRequest {
3279
3486
  /**
3487
+ * @public
3280
3488
  * <p>The name of the domain that you want to change name servers for.</p>
3281
3489
  */
3282
3490
  DomainName: string | undefined;
3283
3491
  /**
3492
+ * @public
3284
3493
  * @deprecated
3285
3494
  *
3286
3495
  * <p>The authorization key for .fi domains</p>
3287
3496
  */
3288
3497
  FIAuthKey?: string;
3289
3498
  /**
3499
+ * @public
3290
3500
  * <p>A list of new name servers for the domain.</p>
3291
3501
  */
3292
3502
  Nameservers: Nameserver[] | undefined;
@@ -3297,6 +3507,7 @@ export interface UpdateDomainNameserversRequest {
3297
3507
  */
3298
3508
  export interface UpdateDomainNameserversResponse {
3299
3509
  /**
3510
+ * @public
3300
3511
  * <p>Identifier for tracking the progress of the request. To query the operation status,
3301
3512
  * use <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html">GetOperationDetail</a>.</p>
3302
3513
  */
@@ -3308,10 +3519,12 @@ export interface UpdateDomainNameserversResponse {
3308
3519
  */
3309
3520
  export interface UpdateTagsForDomainRequest {
3310
3521
  /**
3522
+ * @public
3311
3523
  * <p>The domain for which you want to add or update tags.</p>
3312
3524
  */
3313
3525
  DomainName: string | undefined;
3314
3526
  /**
3527
+ * @public
3315
3528
  * <p>A list of the tag keys and values that you want to add or update. If you specify a key
3316
3529
  * that already exists, the corresponding value will be replaced.</p>
3317
3530
  */
@@ -3328,18 +3541,21 @@ export interface UpdateTagsForDomainResponse {
3328
3541
  */
3329
3542
  export interface ViewBillingRequest {
3330
3543
  /**
3544
+ * @public
3331
3545
  * <p>The beginning date and time for the time period for which you want a list of billing
3332
3546
  * records. Specify the date and time in Unix time format and Coordinated Universal time
3333
3547
  * (UTC).</p>
3334
3548
  */
3335
3549
  Start?: Date;
3336
3550
  /**
3551
+ * @public
3337
3552
  * <p>The end date and time for the time period for which you want a list of billing
3338
3553
  * records. Specify the date and time in Unix time format and Coordinated Universal time
3339
3554
  * (UTC).</p>
3340
3555
  */
3341
3556
  End?: Date;
3342
3557
  /**
3558
+ * @public
3343
3559
  * <p>For an initial request for a list of billing records, omit this element. If the number
3344
3560
  * of billing records that are associated with the current Amazon Web Services account
3345
3561
  * during the specified period is greater than the value that you specified for
@@ -3352,6 +3568,7 @@ export interface ViewBillingRequest {
3352
3568
  */
3353
3569
  Marker?: string;
3354
3570
  /**
3571
+ * @public
3355
3572
  * <p>The number of billing records to be returned.</p>
3356
3573
  * <p>Default: 20</p>
3357
3574
  */
@@ -3363,12 +3580,14 @@ export interface ViewBillingRequest {
3363
3580
  */
3364
3581
  export interface ViewBillingResponse {
3365
3582
  /**
3583
+ * @public
3366
3584
  * <p>If there are more billing records than you specified for <code>MaxItems</code> in the
3367
3585
  * request, submit another request and include the value of <code>NextPageMarker</code> in
3368
3586
  * the value of <code>Marker</code>.</p>
3369
3587
  */
3370
3588
  NextPageMarker?: string;
3371
3589
  /**
3590
+ * @public
3372
3591
  * <p>A summary of billing records.</p>
3373
3592
  */
3374
3593
  BillingRecords?: BillingRecord[];