forked from aws/aws-sdk-js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathroute53domains-2014-05-15.normal.json
1804 lines (1804 loc) · 87.2 KB
/
route53domains-2014-05-15.normal.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version":"2.0",
"metadata":{
"uid":"route53domains-2014-05-15",
"apiVersion":"2014-05-15",
"endpointPrefix":"route53domains",
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"Amazon Route 53 Domains",
"signatureVersion":"v4",
"targetPrefix":"Route53Domains_v20140515"
},
"operations":{
"CheckDomainAvailability":{
"name":"CheckDomainAvailability",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CheckDomainAvailabilityRequest"},
"output":{"shape":"CheckDomainAvailabilityResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"UnsupportedTLD"}
],
"documentation":"<p>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.</p>"
},
"DeleteTagsForDomain":{
"name":"DeleteTagsForDomain",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteTagsForDomainRequest"},
"output":{"shape":"DeleteTagsForDomainResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"OperationLimitExceeded"},
{"shape":"UnsupportedTLD"}
],
"documentation":"<p>This operation deletes the specified tags for a domain.</p> <p>All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations.</p>"
},
"DisableDomainAutoRenew":{
"name":"DisableDomainAutoRenew",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisableDomainAutoRenewRequest"},
"output":{"shape":"DisableDomainAutoRenewResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"UnsupportedTLD"}
],
"documentation":"<p>This operation disables automatic renewal of domain registration for the specified domain.</p>"
},
"DisableDomainTransferLock":{
"name":"DisableDomainTransferLock",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisableDomainTransferLockRequest"},
"output":{"shape":"DisableDomainTransferLockResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"DuplicateRequest"},
{"shape":"TLDRulesViolation"},
{"shape":"OperationLimitExceeded"},
{"shape":"UnsupportedTLD"}
],
"documentation":"<p>This operation removes the transfer lock on the domain (specifically the <code>clientTransferProhibited</code> 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.</p>"
},
"EnableDomainAutoRenew":{
"name":"EnableDomainAutoRenew",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"EnableDomainAutoRenewRequest"},
"output":{"shape":"EnableDomainAutoRenewResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"UnsupportedTLD"},
{"shape":"TLDRulesViolation"}
],
"documentation":"<p>This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. The cost of renewing your domain registration is billed to your AWS account.</p> <p>The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see <a href=\"http://wiki.gandi.net/en/domains/renew#renewal_restoration_and_deletion_times\">\"Renewal, restoration, and deletion times\"</a> on the website for our registrar partner, Gandi. Route 53 requires that you renew before the end of the renewal period that is listed on the Gandi website so we can complete processing before the deadline.</p>"
},
"EnableDomainTransferLock":{
"name":"EnableDomainTransferLock",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"EnableDomainTransferLockRequest"},
"output":{"shape":"EnableDomainTransferLockResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"DuplicateRequest"},
{"shape":"TLDRulesViolation"},
{"shape":"OperationLimitExceeded"},
{"shape":"UnsupportedTLD"}
],
"documentation":"<p>This operation sets the transfer lock on the domain (specifically the <code>clientTransferProhibited</code> 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.</p>"
},
"GetContactReachabilityStatus":{
"name":"GetContactReachabilityStatus",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetContactReachabilityStatusRequest"},
"output":{"shape":"GetContactReachabilityStatusResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"OperationLimitExceeded"},
{"shape":"UnsupportedTLD"}
],
"documentation":"<p>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.</p> <p>If you want us to resend the email, use the <code>ResendContactReachabilityEmail</code> operation.</p>"
},
"GetDomainDetail":{
"name":"GetDomainDetail",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetDomainDetailRequest"},
"output":{"shape":"GetDomainDetailResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"UnsupportedTLD"}
],
"documentation":"<p>This operation returns detailed information about the domain. The domain's contact information is also returned as part of the output.</p>"
},
"GetDomainSuggestions":{
"name":"GetDomainSuggestions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetDomainSuggestionsRequest"},
"output":{"shape":"GetDomainSuggestionsResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"UnsupportedTLD"}
],
"documentation":"<p>The GetDomainSuggestions operation returns a list of suggested domain names given a string, which can either be a domain name or simply a word or phrase (without spaces).</p> <p> Parameters: <ul><li>DomainName (string): The basis for your domain suggestion search, a string with (or without) top-level domain specified.</li> <li>SuggestionCount (int): The number of domain suggestions to be returned, maximum 50, minimum 1.</li> <li>OnlyAvailable (bool): If true, availability check will be performed on suggestion results, and only available domains will be returned. If false, suggestions will be returned without checking whether the domain is actually available, and caller will have to call checkDomainAvailability for each suggestion to determine availability for registration.</li> </ul> </p>"
},
"GetOperationDetail":{
"name":"GetOperationDetail",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetOperationDetailRequest"},
"output":{"shape":"GetOperationDetailResponse"},
"errors":[
{"shape":"InvalidInput"}
],
"documentation":"<p>This operation returns the current status of an operation that is not completed.</p>"
},
"ListDomains":{
"name":"ListDomains",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListDomainsRequest"},
"output":{"shape":"ListDomainsResponse"},
"errors":[
{"shape":"InvalidInput"}
],
"documentation":"<p>This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.</p>"
},
"ListOperations":{
"name":"ListOperations",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListOperationsRequest"},
"output":{"shape":"ListOperationsResponse"},
"errors":[
{"shape":"InvalidInput"}
],
"documentation":"<p>This operation returns the operation IDs of operations that are not yet complete.</p>"
},
"ListTagsForDomain":{
"name":"ListTagsForDomain",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTagsForDomainRequest"},
"output":{"shape":"ListTagsForDomainResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"OperationLimitExceeded"},
{"shape":"UnsupportedTLD"}
],
"documentation":"<p>This operation returns all of the tags that are associated with the specified domain.</p> <p>All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations.</p>"
},
"RegisterDomain":{
"name":"RegisterDomain",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RegisterDomainRequest"},
"output":{"shape":"RegisterDomainResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"UnsupportedTLD"},
{"shape":"DuplicateRequest"},
{"shape":"TLDRulesViolation"},
{"shape":"DomainLimitExceeded"},
{"shape":"OperationLimitExceeded"}
],
"documentation":"<p>This operation registers a domain. Domains are registered by the AWS registrar partner, Gandi. For some top-level domains (TLDs), this operation requires extra parameters.</p> <p>When you register a domain, Amazon Route 53 does the following:</p> <ul> <li>Creates a Amazon Route 53 hosted zone that has the same name as the domain. Amazon Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers.</li> <li>Enables autorenew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration.</li> <li>Optionally enables privacy protection, so WHOIS queries return contact information for our registrar partner, Gandi, instead of the information you entered for registrant, admin, and tech contacts.</li> <li>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.</li> <li>Charges your AWS account an amount based on the top-level domain. For more information, see <a href=\"http://aws.amazon.com/route53/pricing/\">Amazon Route 53 Pricing</a>.</li> </ul>"
},
"RenewDomain":{
"name":"RenewDomain",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RenewDomainRequest"},
"output":{"shape":"RenewDomainResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"UnsupportedTLD"},
{"shape":"DuplicateRequest"},
{"shape":"TLDRulesViolation"},
{"shape":"OperationLimitExceeded"}
],
"documentation":"<p>This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your AWS account.</p> <p>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 <a href=\"http://docs.aws.amazon.com/console/route53/domain-renew\">Renewing Registration for a Domain</a> in the Amazon Route 53 documentation.</p>"
},
"ResendContactReachabilityEmail":{
"name":"ResendContactReachabilityEmail",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ResendContactReachabilityEmailRequest"},
"output":{"shape":"ResendContactReachabilityEmailResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"OperationLimitExceeded"},
{"shape":"UnsupportedTLD"}
],
"documentation":"<p>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. </p>"
},
"RetrieveDomainAuthCode":{
"name":"RetrieveDomainAuthCode",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RetrieveDomainAuthCodeRequest"},
"output":{"shape":"RetrieveDomainAuthCodeResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"UnsupportedTLD"}
],
"documentation":"<p>This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.</p>"
},
"TransferDomain":{
"name":"TransferDomain",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TransferDomainRequest"},
"output":{"shape":"TransferDomainResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"UnsupportedTLD"},
{"shape":"DuplicateRequest"},
{"shape":"TLDRulesViolation"},
{"shape":"DomainLimitExceeded"},
{"shape":"OperationLimitExceeded"}
],
"documentation":"<p>This operation transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered with the AWS registrar partner, Gandi.</p> <p>For transfer requirements, a detailed procedure, and information about viewing the status of a domain transfer, see <a href=\"http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-transfer-to-route-53.html\">Transferring Registration for a Domain to Amazon Route 53</a> in the Amazon Route 53 Developer Guide.</p> <p>If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you consider transferring your DNS service to Amazon Route 53 or to another DNS service provider before you transfer your registration. Some registrars provide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar will not renew your domain registration and could end your DNS service at any time.</p> <note>Caution! 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.</note> <p>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.</p>"
},
"UpdateDomainContact":{
"name":"UpdateDomainContact",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateDomainContactRequest"},
"output":{"shape":"UpdateDomainContactResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"DuplicateRequest"},
{"shape":"TLDRulesViolation"},
{"shape":"OperationLimitExceeded"},
{"shape":"UnsupportedTLD"}
],
"documentation":"<p>This operation updates the contact information for a particular domain. Information for at least one contact (registrant, administrator, or technical) must be supplied for update.</p> <p>If the update is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.</p>"
},
"UpdateDomainContactPrivacy":{
"name":"UpdateDomainContactPrivacy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateDomainContactPrivacyRequest"},
"output":{"shape":"UpdateDomainContactPrivacyResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"DuplicateRequest"},
{"shape":"TLDRulesViolation"},
{"shape":"OperationLimitExceeded"},
{"shape":"UnsupportedTLD"}
],
"documentation":"<p>This operation updates the specified domain contact's privacy setting. When the privacy option is enabled, personal information such as postal or email address is hidden from the results of a public WHOIS query. The privacy services are provided by the AWS registrar, Gandi. For more information, see the <a href=\"http://www.gandi.net/domain/whois/?currency=USD&amp;lang=en\">Gandi privacy features</a>.</p> <p>This operation only affects the privacy of the specified contact type (registrant, administrator, or tech). Successful acceptance returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.</p>"
},
"UpdateDomainNameservers":{
"name":"UpdateDomainNameservers",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateDomainNameserversRequest"},
"output":{"shape":"UpdateDomainNameserversResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"DuplicateRequest"},
{"shape":"TLDRulesViolation"},
{"shape":"OperationLimitExceeded"},
{"shape":"UnsupportedTLD"}
],
"documentation":"<p>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. </p> <p>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.</p>"
},
"UpdateTagsForDomain":{
"name":"UpdateTagsForDomain",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateTagsForDomainRequest"},
"output":{"shape":"UpdateTagsForDomainResponse"},
"errors":[
{"shape":"InvalidInput"},
{"shape":"OperationLimitExceeded"},
{"shape":"UnsupportedTLD"}
],
"documentation":"<p>This operation adds or updates tags for a specified domain.</p> <p>All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations.</p>"
},
"ViewBilling":{
"name":"ViewBilling",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ViewBillingRequest"},
"output":{"shape":"ViewBillingResponse"},
"errors":[
{"shape":"InvalidInput"}
],
"documentation":"<p>This operation returns all the domain-related billing records for the current AWS account for a specified period</p>"
}
},
"shapes":{
"AddressLine":{
"type":"string",
"max":255
},
"BillingRecord":{
"type":"structure",
"members":{
"DomainName":{
"shape":"DomainName",
"documentation":"<p>The name of a domain.</p> <p>Type: String</p>"
},
"Operation":{
"shape":"OperationType",
"documentation":"<p>The operation that you were charged for.</p> <p>Type: String</p> <p>Valid values: <ul> <li><code>REGISTER_DOMAIN</code></li> <li><code>TRANSFER_IN_DOMAIN</code></li> <li><code>RENEW_DOMAIN</code></li> <li><code>CHANGE_DOMAIN_OWNER</code></li> </ul> </p>"
},
"InvoiceId":{
"shape":"InvoiceId",
"documentation":"<p>The ID of the invoice that is associated with the billing record.</p> <p>Type: String</p>"
},
"BillDate":{
"shape":"Timestamp",
"documentation":"<p>The date that the operation was billed, in Unix format.</p> <p>Type: Double</p>"
},
"Price":{
"shape":"Price",
"documentation":"<p>The price that you were charged for the operation, in US dollars.</p> <p>Type: Double</p> <p>Example value: 12.0</p>"
}
}
},
"BillingRecords":{
"type":"list",
"member":{"shape":"BillingRecord"}
},
"Boolean":{"type":"boolean"},
"CheckDomainAvailabilityRequest":{
"type":"structure",
"required":["DomainName"],
"members":{
"DomainName":{
"shape":"DomainName",
"documentation":"<p>The name of a domain.</p> <p>Type: String</p> <p>Default: None</p> <p>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.</p> <p>Required: Yes</p>"
},
"IdnLangCode":{
"shape":"LangCode",
"documentation":"<p>Reserved for future use.</p>"
}
},
"documentation":"<p>The CheckDomainAvailability request contains the following elements.</p>"
},
"CheckDomainAvailabilityResponse":{
"type":"structure",
"required":["Availability"],
"members":{
"Availability":{
"shape":"DomainAvailability",
"documentation":"<p>Whether the domain name is available for registering.</p> <note> <p>You can only register domains designated as <code>AVAILABLE</code>.</p> </note> <p>Type: String</p> <p>Valid values:</p> <ul> <li><code>AVAILABLE</code> – The domain name is available.</li> <li><code>AVAILABLE_RESERVED</code> – The domain name is reserved under specific conditions.</li> <li><code>AVAILABLE_PREORDER</code> – The domain name is available and can be preordered.</li> <li><code>UNAVAILABLE</code> – The domain name is not available.</li> <li><code>UNAVAILABLE_PREMIUM</code> – The domain name is not available.</li> <li><code>UNAVAILABLE_RESTRICTED</code> – The domain name is forbidden.</li> <li><code>RESERVED</code> – The domain name has been reserved for another person or organization.</li> <li><code>DONT_KNOW</code> – The TLD registry didn't reply with a definitive answer about whether the domain name is available. Amazon Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later.</li> </ul>"
}
},
"documentation":"<p>The CheckDomainAvailability response includes the following elements.</p>"
},
"City":{
"type":"string",
"max":255
},
"ContactDetail":{
"type":"structure",
"members":{
"FirstName":{
"shape":"ContactName",
"documentation":"<p>First name of contact.</p> <p>Type: String</p> <p>Default: None</p> <p>Constraints: Maximum 255 characters.</p> <p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code> </p> <p>Required: Yes</p>"
},
"LastName":{
"shape":"ContactName",
"documentation":"<p>Last name of contact.</p> <p>Type: String</p> <p>Default: None</p> <p>Constraints: Maximum 255 characters.</p> <p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p> <p>Required: Yes</p>"
},
"ContactType":{
"shape":"ContactType",
"documentation":"<p>Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't enable privacy protection for the contact.</p> <p>Type: String</p> <p>Default: None</p> <p>Constraints: Maximum 255 characters.</p> <p>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></p> <p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code> </p> <p>Required: Yes</p>"
},
"OrganizationName":{
"shape":"ContactName",
"documentation":"<p>Name of the organization for contact types other than <code>PERSON</code>.</p> <p>Type: String</p> <p>Default: None</p> <p>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</p> <p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p> <p>Required: No</p>"
},
"AddressLine1":{
"shape":"AddressLine",
"documentation":"<p>First line of the contact's address.</p> <p>Type: String</p> <p>Default: None</p> <p>Constraints: Maximum 255 characters.</p> <p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p> <p>Required: Yes</p>"
},
"AddressLine2":{
"shape":"AddressLine",
"documentation":"<p>Second line of contact's address, if any.</p> <p>Type: String</p> <p>Default: None</p> <p>Constraints: Maximum 255 characters.</p> <p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p> <p>Required: No</p>"
},
"City":{
"shape":"City",
"documentation":"<p>The city of the contact's address.</p> <p>Type: String</p> <p>Default: None</p> <p>Constraints: Maximum 255 characters.</p> <p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p> <p>Required: Yes</p>"
},
"State":{
"shape":"State",
"documentation":"<p>The state or province of the contact's city.</p> <p>Type: String</p> <p>Default: None</p> <p>Constraints: Maximum 255 characters.</p> <p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p> <p>Required: No</p>"
},
"CountryCode":{
"shape":"CountryCode",
"documentation":"<p>Code for the country of the contact's address.</p> <p>Type: String</p> <p>Default: None</p> <p>Constraints: Maximum 255 characters.</p> <p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p> <p>Required: Yes</p>"
},
"ZipCode":{
"shape":"ZipCode",
"documentation":"<p>The zip or postal code of the contact's address.</p> <p>Type: String</p> <p>Default: None</p> <p>Constraints: Maximum 255 characters.</p> <p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p> <p>Required: No</p>"
},
"PhoneNumber":{
"shape":"ContactNumber",
"documentation":"<p>The phone number of the contact.</p> <p>Type: String</p> <p>Default: None</p> <p>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 <code>\"+1.1234567890\"</code>.</p> <p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p> <p>Required: Yes</p>"
},
"Email":{
"shape":"Email",
"documentation":"<p>Email address of the contact.</p> <p>Type: String</p> <p>Default: None</p> <p>Constraints: Maximum 254 characters.</p> <p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code> </p> <p>Required: Yes</p>"
},
"Fax":{
"shape":"ContactNumber",
"documentation":"<p>Fax number of the contact.</p> <p>Type: String</p> <p>Default: None</p> <p>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 <code>\"+1.1234567890\"</code>.</p> <p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p> <p>Required: No</p>"
},
"ExtraParams":{
"shape":"ExtraParamList",
"documentation":"<p>A list of name-value pairs for parameters required by certain top-level domains.</p> <p>Type: Complex</p> <p>Default: None</p> <p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p> <p>Children: <code>Name</code>, <code>Value</code></p> <p>Required: No</p>"
}
},
"documentation":"<p>ContactDetail includes the following elements.</p>",
"sensitive":true
},
"ContactName":{
"type":"string",
"max":255
},
"ContactNumber":{
"type":"string",
"max":30
},
"ContactType":{
"type":"string",
"enum":[
"PERSON",
"COMPANY",
"ASSOCIATION",
"PUBLIC_BODY",
"RESELLER"
]
},
"CountryCode":{
"type":"string",
"enum":[
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AN",
"AO",
"AQ",
"AR",
"AS",
"AT",
"AU",
"AW",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BL",
"BM",
"BN",
"BO",
"BR",
"BS",
"BT",
"BW",
"BY",
"BZ",
"CA",
"CC",
"CD",
"CF",
"CG",
"CH",
"CI",
"CK",
"CL",
"CM",
"CN",
"CO",
"CR",
"CU",
"CV",
"CX",
"CY",
"CZ",
"DE",
"DJ",
"DK",
"DM",
"DO",
"DZ",
"EC",
"EE",
"EG",
"ER",
"ES",
"ET",
"FI",
"FJ",
"FK",
"FM",
"FO",
"FR",
"GA",
"GB",
"GD",
"GE",
"GH",
"GI",
"GL",
"GM",
"GN",
"GQ",
"GR",
"GT",
"GU",
"GW",
"GY",
"HK",
"HN",
"HR",
"HT",
"HU",
"ID",
"IE",
"IL",
"IM",
"IN",
"IQ",
"IR",
"IS",
"IT",
"JM",
"JO",
"JP",
"KE",
"KG",
"KH",
"KI",
"KM",
"KN",
"KP",
"KR",
"KW",
"KY",
"KZ",
"LA",
"LB",
"LC",
"LI",
"LK",
"LR",
"LS",
"LT",
"LU",
"LV",
"LY",
"MA",
"MC",
"MD",
"ME",
"MF",
"MG",
"MH",
"MK",
"ML",
"MM",
"MN",
"MO",
"MP",
"MR",
"MS",
"MT",
"MU",
"MV",
"MW",
"MX",
"MY",
"MZ",
"NA",
"NC",
"NE",
"NG",
"NI",
"NL",
"NO",
"NP",
"NR",
"NU",
"NZ",
"OM",
"PA",
"PE",
"PF",
"PG",
"PH",
"PK",
"PL",
"PM",
"PN",
"PR",
"PT",
"PW",
"PY",
"QA",
"RO",
"RS",
"RU",
"RW",
"SA",
"SB",
"SC",
"SD",
"SE",
"SG",
"SH",
"SI",
"SK",
"SL",
"SM",
"SN",
"SO",
"SR",
"ST",
"SV",
"SY",
"SZ",
"TC",
"TD",
"TG",
"TH",
"TJ",
"TK",
"TL",
"TM",
"TN",
"TO",
"TR",
"TT",
"TV",
"TW",
"TZ",
"UA",
"UG",
"US",
"UY",
"UZ",
"VA",
"VC",
"VE",
"VG",
"VI",
"VN",
"VU",
"WF",
"WS",
"YE",
"YT",
"ZA",
"ZM",
"ZW"
]
},
"CurrentExpiryYear":{"type":"integer"},
"DNSSec":{"type":"string"},
"DeleteTagsForDomainRequest":{
"type":"structure",
"required":[
"DomainName",
"TagsToDelete"
],
"members":{
"DomainName":{
"shape":"DomainName",
"documentation":"<p>The domain for which you want to delete one or more tags.</p> <p>The name of a domain.</p> <p>Type: String</p> <p>Default: None</p> <p>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Hyphens are allowed only when they're surrounded by letters, numbers, or other hyphens. You can't specify a hyphen at the beginning or end of a label. To specify an Internationalized Domain Name, you must convert the name to Punycode.</p> <p>Required: Yes</p>"
},
"TagsToDelete":{
"shape":"TagKeyList",
"documentation":"<p>A list of tag keys to delete.</p> <p>Type: A list that contains the keys of the tags that you want to delete.</p> <p>Default: None</p> <p>Required: No</p>'>"
}
},
"documentation":"<p>The DeleteTagsForDomainRequest includes the following elements.</p>"
},
"DeleteTagsForDomainResponse":{
"type":"structure",
"members":{
}
},
"DisableDomainAutoRenewRequest":{
"type":"structure",
"required":["DomainName"],
"members":{
"DomainName":{"shape":"DomainName"}
}
},
"DisableDomainAutoRenewResponse":{
"type":"structure",
"members":{
}
},
"DisableDomainTransferLockRequest":{
"type":"structure",
"required":["DomainName"],
"members":{
"DomainName":{
"shape":"DomainName",
"documentation":"<p>The name of a domain.</p> <p>Type: String</p> <p>Default: None</p> <p>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.</p> <p>Required: Yes</p>"
}
},
"documentation":"<p>The DisableDomainTransferLock request includes the following element.</p>"
},
"DisableDomainTransferLockResponse":{
"type":"structure",
"required":["OperationId"],
"members":{
"OperationId":{
"shape":"OperationId",
"documentation":"<p>Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.</p> <p>Type: String</p> <p>Default: None</p> <p>Constraints: Maximum 255 characters.</p>"
}
},
"documentation":"<p>The DisableDomainTransferLock response includes the following element.</p>"
},
"DomainAuthCode":{
"type":"string",
"max":1024,
"sensitive":true
},
"DomainAvailability":{
"type":"string",
"enum":[
"AVAILABLE",
"AVAILABLE_RESERVED",
"AVAILABLE_PREORDER",
"UNAVAILABLE",
"UNAVAILABLE_PREMIUM",
"UNAVAILABLE_RESTRICTED",
"RESERVED",
"DONT_KNOW"
]
},
"DomainLimitExceeded":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The number of domains has exceeded the allowed threshold for the account.</p>",
"exception":true
},
"DomainName":{
"type":"string",
"max":255,
"pattern":"[a-zA-Z0-9_\\-.]*"
},
"DomainStatus":{"type":"string"},
"DomainStatusList":{
"type":"list",
"member":{"shape":"DomainStatus"}
},
"DomainSuggestion":{
"type":"structure",
"members":{
"DomainName":{"shape":"DomainName"},
"Availability":{"shape":"String"}
}
},
"DomainSuggestionsList":{
"type":"list",
"member":{"shape":"DomainSuggestion"}
},
"DomainSummary":{
"type":"structure",
"required":["DomainName"],
"members":{
"DomainName":{
"shape":"DomainName",
"documentation":"<p>The name of a domain.</p> <p>Type: String</p>"
},
"AutoRenew":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the domain is automatically renewed upon expiration.</p> <p>Type: Boolean</p> <p>Valid values: <code>True</code> | <code>False</code></p>"
},
"TransferLock":{
"shape":"Boolean",
"documentation":"<p>Indicates whether a domain is locked from unauthorized transfer to another party.</p> <p>Type: Boolean</p> <p>Valid values: <code>True</code> | <code>False</code></p>"
},
"Expiry":{
"shape":"Timestamp",
"documentation":"<p>Expiration date of the domain in Coordinated Universal Time (UTC).</p> <p>Type: Long</p>"
}
}
},
"DomainSummaryList":{
"type":"list",
"member":{"shape":"DomainSummary"}
},
"DuplicateRequest":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The request is already in progress for the domain.</p>",
"exception":true
},
"DurationInYears":{
"type":"integer",
"max":10,
"min":1
},
"Email":{
"type":"string",
"max":254
},
"EnableDomainAutoRenewRequest":{
"type":"structure",
"required":["DomainName"],
"members":{
"DomainName":{"shape":"DomainName"}
}
},
"EnableDomainAutoRenewResponse":{
"type":"structure",
"members":{
}
},
"EnableDomainTransferLockRequest":{
"type":"structure",
"required":["DomainName"],
"members":{
"DomainName":{
"shape":"DomainName",
"documentation":"<p>The name of a domain.</p> <p>Type: String</p> <p>Default: None</p> <p>Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.</p> <p>Required: Yes</p>"
}
},
"documentation":"<p>The EnableDomainTransferLock request includes the following element.</p>"
},
"EnableDomainTransferLockResponse":{
"type":"structure",
"required":["OperationId"],
"members":{
"OperationId":{
"shape":"OperationId",
"documentation":"<p>Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.</p> <p>Type: String</p> <p>Default: None</p> <p>Constraints: Maximum 255 characters.</p>"
}
},
"documentation":"<p>The EnableDomainTransferLock response includes the following elements.</p>"
},
"ErrorMessage":{"type":"string"},
"ExtraParam":{
"type":"structure",
"required":[
"Name",
"Value"
],
"members":{
"Name":{
"shape":"ExtraParamName",
"documentation":"<p>Name of the additional parameter required by the top-level domain.</p> <p>Type: String</p> <p>Default: None</p> <p>Valid values: <code>DUNS_NUMBER</code> | <code>BRAND_NUMBER</code> | <code>BIRTH_DEPARTMENT</code> | <code>BIRTH_DATE_IN_YYYY_MM_DD</code> | <code>BIRTH_COUNTRY</code> | <code>BIRTH_CITY</code> | <code>DOCUMENT_NUMBER</code> | <code>AU_ID_NUMBER</code> | <code>AU_ID_TYPE</code> | <code>CA_LEGAL_TYPE</code> | <code>CA_BUSINESS_ENTITY_TYPE</code> |<code>ES_IDENTIFICATION</code> | <code>ES_IDENTIFICATION_TYPE</code> | <code>ES_LEGAL_FORM</code> | <code>FI_BUSINESS_NUMBER</code> | <code>FI_ID_NUMBER</code> | <code>IT_PIN</code> | <code>RU_PASSPORT_DATA</code> | <code>SE_ID_NUMBER</code> | <code>SG_ID_NUMBER</code> | <code>VAT_NUMBER</code></p> <p>Parent: <code>ExtraParams</code></p> <p>Required: Yes</p>"
},
"Value":{
"shape":"ExtraParamValue",
"documentation":"<p>Values corresponding to the additional parameter names required by some top-level domains.</p> <p>Type: String</p> <p>Default: None</p> <p>Constraints: Maximum 2048 characters.</p> <p>Parent: <code>ExtraParams</code></p> <p>Required: Yes</p>"
}
},
"documentation":"<p>ExtraParam includes the following elements.</p>"
},
"ExtraParamList":{
"type":"list",
"member":{"shape":"ExtraParam"}
},
"ExtraParamName":{
"type":"string",
"enum":[
"DUNS_NUMBER",
"BRAND_NUMBER",
"BIRTH_DEPARTMENT",
"BIRTH_DATE_IN_YYYY_MM_DD",
"BIRTH_COUNTRY",
"BIRTH_CITY",
"DOCUMENT_NUMBER",
"AU_ID_NUMBER",
"AU_ID_TYPE",
"CA_LEGAL_TYPE",
"CA_BUSINESS_ENTITY_TYPE",
"ES_IDENTIFICATION",
"ES_IDENTIFICATION_TYPE",
"ES_LEGAL_FORM",
"FI_BUSINESS_NUMBER",
"FI_ID_NUMBER",
"IT_PIN",
"RU_PASSPORT_DATA",
"SE_ID_NUMBER",
"SG_ID_NUMBER",
"VAT_NUMBER"
]
},
"ExtraParamValue":{
"type":"string",
"max":2048
},
"FIAuthKey":{"type":"string"},
"GetContactReachabilityStatusRequest":{
"type":"structure",
"members":{
"domainName":{
"shape":"DomainName",
"documentation":"<p>The name of the domain for which you want to know whether the registrant contact has confirmed that the email address is valid.</p> <p>Type: String</p> <p>Default: None</p> <p>Required: Yes</p>"
}
}
},
"GetContactReachabilityStatusResponse":{
"type":"structure",
"members":{
"domainName":{
"shape":"DomainName",
"documentation":"<p>The domain name for which you requested the reachability status.</p>"
},
"status":{
"shape":"ReachabilityStatus",
"documentation":"<p>Whether the registrant contact has responded. <code>PENDING</code> indicates that we sent the confirmation email and haven't received a response yet, <code>DONE</code> indicates that we sent the email and got confirmation from the registrant contact, and <code>EXPIRED</code> indicates that the time limit expired before the registrant contact responded. </p> <p>Type: String</p> <p>Valid values: <code>PENDING</code>, <code>DONE</code>, <code>EXPIRED</code></p>"