/
route_53_domains.jl
1613 lines (1483 loc) · 64.4 KB
/
route_53_domains.jl
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
# This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: route_53_domains
using AWS.Compat
using AWS.UUIDs
"""
accept_domain_transfer_from_another_aws_account(domain_name, password)
accept_domain_transfer_from_another_aws_account(domain_name, password, params::Dict{String,<:Any})
Accepts the transfer of a domain from another Amazon Web Services account to the
currentAmazon Web Services account. You initiate a transfer between Amazon Web Services
accounts using TransferDomainToAnotherAwsAccount. If you use the CLI command at
accept-domain-transfer-from-another-aws-account, use JSON format as input instead of text
because otherwise CLI will throw an error from domain transfer input that includes single
quotes. Use either ListOperations or GetOperationDetail to determine whether the operation
succeeded. GetOperationDetail provides additional information, for example, Domain Transfer
from Aws Account 111122223333 has been cancelled.
# Arguments
- `domain_name`: The name of the domain that was specified when another Amazon Web Services
account submitted a TransferDomainToAnotherAwsAccount request.
- `password`: The password that was returned by the TransferDomainToAnotherAwsAccount
request.
"""
function accept_domain_transfer_from_another_aws_account(
DomainName, Password; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"AcceptDomainTransferFromAnotherAwsAccount",
Dict{String,Any}("DomainName" => DomainName, "Password" => Password);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function accept_domain_transfer_from_another_aws_account(
DomainName,
Password,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"AcceptDomainTransferFromAnotherAwsAccount",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DomainName" => DomainName, "Password" => Password),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
associate_delegation_signer_to_domain(domain_name, signing_attributes)
associate_delegation_signer_to_domain(domain_name, signing_attributes, params::Dict{String,<:Any})
Creates a delegation signer (DS) record in the registry zone for this domain name. Note
that creating DS record at the registry impacts DNSSEC validation of your DNS records. This
action may render your domain name unavailable on the internet if the steps are completed
in the wrong order, or with incorrect timing. For more information about DNSSEC signing,
see Configuring DNSSEC signing in the Route 53 developer guide.
# Arguments
- `domain_name`: The name of the domain.
- `signing_attributes`: The information about a key, including the algorithm, public
key-value, and flags.
"""
function associate_delegation_signer_to_domain(
DomainName, SigningAttributes; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"AssociateDelegationSignerToDomain",
Dict{String,Any}(
"DomainName" => DomainName, "SigningAttributes" => SigningAttributes
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_delegation_signer_to_domain(
DomainName,
SigningAttributes,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"AssociateDelegationSignerToDomain",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DomainName" => DomainName, "SigningAttributes" => SigningAttributes
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
cancel_domain_transfer_to_another_aws_account(domain_name)
cancel_domain_transfer_to_another_aws_account(domain_name, params::Dict{String,<:Any})
Cancels the transfer of a domain from the current Amazon Web Services account to another
Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts
using TransferDomainToAnotherAwsAccount. You must cancel the transfer before the other
Amazon Web Services account accepts the transfer using
AcceptDomainTransferFromAnotherAwsAccount. Use either ListOperations or GetOperationDetail
to determine whether the operation succeeded. GetOperationDetail provides additional
information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled.
# Arguments
- `domain_name`: The name of the domain for which you want to cancel the transfer to
another Amazon Web Services account.
"""
function cancel_domain_transfer_to_another_aws_account(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"CancelDomainTransferToAnotherAwsAccount",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function cancel_domain_transfer_to_another_aws_account(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"CancelDomainTransferToAnotherAwsAccount",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
check_domain_availability(domain_name)
check_domain_availability(domain_name, params::Dict{String,<:Any})
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.
# Arguments
- `domain_name`: The name of the domain that you want to get availability for. The
top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of
supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route
53 Developer Guide. The domain name can contain only the following characters: Letters a
through z. Domain names are not case sensitive. Numbers 0 through 9. Hyphen (-). You
can't specify a hyphen at the beginning or end of a label. Period (.) to separate the
labels in the name, such as the . in example.com. Internationalized domain names are not
supported for some top-level domains. To determine whether the TLD that you want to use
supports internationalized domain names, see Domains that You Can Register with Amazon
Route 53. For more information, see Formatting Internationalized Domain Names.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"IdnLangCode"`: Reserved for future use.
"""
function check_domain_availability(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"CheckDomainAvailability",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function check_domain_availability(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"CheckDomainAvailability",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
check_domain_transferability(domain_name)
check_domain_transferability(domain_name, params::Dict{String,<:Any})
Checks whether a domain name can be transferred to Amazon Route 53.
# Arguments
- `domain_name`: The name of the domain that you want to transfer to Route 53. The
top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of
supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route
53 Developer Guide. The domain name can contain only the following characters: Letters a
through z. Domain names are not case sensitive. Numbers 0 through 9. Hyphen (-). You
can't specify a hyphen at the beginning or end of a label. Period (.) to separate the
labels in the name, such as the . in example.com.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AuthCode"`: If the registrar for the top-level domain (TLD) requires an authorization
code to transfer the domain, the code that you got from the current registrar for the
domain.
"""
function check_domain_transferability(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"CheckDomainTransferability",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function check_domain_transferability(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"CheckDomainTransferability",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_domain(domain_name)
delete_domain(domain_name, params::Dict{String,<:Any})
This operation deletes the specified domain. This action is permanent. For more
information, see Deleting a domain name registration. To transfer the domain registration
to another registrar, use the transfer process that’s provided by the registrar to which
you want to transfer the registration. Otherwise, the following apply: You can’t get a
refund for the cost of a deleted domain registration. The registry for the top-level
domain might hold the domain name for a brief time before releasing it for other users to
register (varies by registry). When the registration has been deleted, we'll send you a
confirmation to the registrant contact. The email will come from
noreply@domainnameverification.net or noreply@registrar.amazon.com.
# Arguments
- `domain_name`: Name of the domain to be deleted.
"""
function delete_domain(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return route_53_domains(
"DeleteDomain",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_domain(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"DeleteDomain",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_tags_for_domain(domain_name, tags_to_delete)
delete_tags_for_domain(domain_name, tags_to_delete, params::Dict{String,<:Any})
This operation deletes the specified tags for a domain. All tag operations are eventually
consistent; subsequent operations might not immediately represent all issued operations.
# Arguments
- `domain_name`: The domain for which you want to delete one or more tags.
- `tags_to_delete`: A list of tag keys to delete.
"""
function delete_tags_for_domain(
DomainName, TagsToDelete; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"DeleteTagsForDomain",
Dict{String,Any}("DomainName" => DomainName, "TagsToDelete" => TagsToDelete);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_tags_for_domain(
DomainName,
TagsToDelete,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"DeleteTagsForDomain",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DomainName" => DomainName, "TagsToDelete" => TagsToDelete
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_domain_auto_renew(domain_name)
disable_domain_auto_renew(domain_name, params::Dict{String,<:Any})
This operation disables automatic renewal of domain registration for the specified domain.
# Arguments
- `domain_name`: The name of the domain that you want to disable automatic renewal for.
"""
function disable_domain_auto_renew(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"DisableDomainAutoRenew",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_domain_auto_renew(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"DisableDomainAutoRenew",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disable_domain_transfer_lock(domain_name)
disable_domain_transfer_lock(domain_name, params::Dict{String,<:Any})
This operation removes the transfer lock on the domain (specifically the
clientTransferProhibited status) to allow domain transfers. We recommend you refrain from
performing this action unless you intend to transfer the domain to a different registrar.
Successful submission returns an operation ID that you can use to track the progress and
completion of the action. If the request is not completed successfully, the domain
registrant will be notified by email.
# Arguments
- `domain_name`: The name of the domain that you want to remove the transfer lock for.
"""
function disable_domain_transfer_lock(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"DisableDomainTransferLock",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disable_domain_transfer_lock(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"DisableDomainTransferLock",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_delegation_signer_from_domain(domain_name, id)
disassociate_delegation_signer_from_domain(domain_name, id, params::Dict{String,<:Any})
Deletes a delegation signer (DS) record in the registry zone for this domain name.
# Arguments
- `domain_name`: Name of the domain.
- `id`: An internal identification number assigned to each DS record after it’s created.
You can retrieve it as part of DNSSEC information returned by GetDomainDetail.
"""
function disassociate_delegation_signer_from_domain(
DomainName, Id; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"DisassociateDelegationSignerFromDomain",
Dict{String,Any}("DomainName" => DomainName, "Id" => Id);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_delegation_signer_from_domain(
DomainName,
Id,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"DisassociateDelegationSignerFromDomain",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("DomainName" => DomainName, "Id" => Id), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_domain_auto_renew(domain_name)
enable_domain_auto_renew(domain_name, params::Dict{String,<:Any})
This operation configures Amazon Route 53 to automatically renew the specified domain
before the domain registration expires. The cost of renewing your domain registration is
billed to your Amazon Web Services account. The period during which you can renew a domain
name varies by TLD. For a list of TLDs and their renewal policies, see Domains That You Can
Register with Amazon Route 53 in the Amazon Route 53 Developer Guide. Route 53 requires
that you renew before the end of the renewal period so we can complete processing before
the deadline.
# Arguments
- `domain_name`: The name of the domain that you want to enable automatic renewal for.
"""
function enable_domain_auto_renew(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"EnableDomainAutoRenew",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_domain_auto_renew(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"EnableDomainAutoRenew",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
enable_domain_transfer_lock(domain_name)
enable_domain_transfer_lock(domain_name, params::Dict{String,<:Any})
This operation sets the transfer lock on the domain (specifically the
clientTransferProhibited status) to prevent domain transfers. Successful submission returns
an operation ID that you can use to track the progress and completion of the action. If the
request is not completed successfully, the domain registrant will be notified by email.
# Arguments
- `domain_name`: The name of the domain that you want to set the transfer lock for.
"""
function enable_domain_transfer_lock(
DomainName; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"EnableDomainTransferLock",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function enable_domain_transfer_lock(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"EnableDomainTransferLock",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_contact_reachability_status()
get_contact_reachability_status(params::Dict{String,<:Any})
For operations that require confirmation that the email address for the registrant contact
is valid, such as registering a new domain, this operation returns information about
whether the registrant contact has responded. If you want us to resend the email, use the
ResendContactReachabilityEmail operation.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"domainName"`: The name of the domain for which you want to know whether the registrant
contact has confirmed that the email address is valid.
"""
function get_contact_reachability_status(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"GetContactReachabilityStatus";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_contact_reachability_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"GetContactReachabilityStatus",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_domain_detail(domain_name)
get_domain_detail(domain_name, params::Dict{String,<:Any})
This operation returns detailed information about a specified domain that is associated
with the current Amazon Web Services account. Contact information for the domain is also
returned as part of the output.
# Arguments
- `domain_name`: The name of the domain that you want to get detailed information about.
"""
function get_domain_detail(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return route_53_domains(
"GetDomainDetail",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_domain_detail(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"GetDomainDetail",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_domain_suggestions(domain_name, only_available, suggestion_count)
get_domain_suggestions(domain_name, only_available, suggestion_count, params::Dict{String,<:Any})
The GetDomainSuggestions operation returns a list of suggested domain names.
# Arguments
- `domain_name`: A domain name that you want to use as the basis for a list of possible
domain names. The top-level domain (TLD), such as .com, must be a TLD that Route 53
supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route
53 in the Amazon Route 53 Developer Guide. The domain name can contain only the following
characters: Letters a through z. Domain names are not case sensitive. Numbers 0 through
9. Hyphen (-). You can't specify a hyphen at the beginning or end of a label. Period
(.) to separate the labels in the name, such as the . in example.com. Internationalized
domain names are not supported for some top-level domains. To determine whether the TLD
that you want to use supports internationalized domain names, see Domains that You Can
Register with Amazon Route 53.
- `only_available`: If OnlyAvailable is true, Route 53 returns only domain names that are
available. If OnlyAvailable is false, Route 53 returns domain names without checking
whether they're available to be registered. To determine whether the domain is available,
you can call checkDomainAvailability for each suggestion.
- `suggestion_count`: The number of suggested domain names that you want Route 53 to
return. Specify a value between 1 and 50.
"""
function get_domain_suggestions(
DomainName,
OnlyAvailable,
SuggestionCount;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"GetDomainSuggestions",
Dict{String,Any}(
"DomainName" => DomainName,
"OnlyAvailable" => OnlyAvailable,
"SuggestionCount" => SuggestionCount,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_domain_suggestions(
DomainName,
OnlyAvailable,
SuggestionCount,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"GetDomainSuggestions",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"DomainName" => DomainName,
"OnlyAvailable" => OnlyAvailable,
"SuggestionCount" => SuggestionCount,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_operation_detail(operation_id)
get_operation_detail(operation_id, params::Dict{String,<:Any})
This operation returns the current status of an operation that is not completed.
# Arguments
- `operation_id`: The identifier for the operation for which you want to get the status.
Route 53 returned the identifier in the response to the original request.
"""
function get_operation_detail(
OperationId; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"GetOperationDetail",
Dict{String,Any}("OperationId" => OperationId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_operation_detail(
OperationId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"GetOperationDetail",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("OperationId" => OperationId), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
list_domains()
list_domains(params::Dict{String,<:Any})
This operation returns all the domain names registered with Amazon Route 53 for the current
Amazon Web Services account if no filtering conditions are used.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"FilterConditions"`: A complex type that contains information about the filters applied
during the ListDomains request. The filter conditions can include domain name and domain
expiration.
- `"Marker"`: For an initial request for a list of domains, omit this element. If the
number of domains that are associated with the current Amazon Web Services account is
greater than the value that you specified for MaxItems, you can use Marker to return
additional domains. Get the value of NextPageMarker from the previous response, and submit
another request that includes the value of NextPageMarker in the Marker element.
Constraints: The marker must match the value specified in the previous request.
- `"MaxItems"`: Number of domains to be returned. Default: 20
- `"SortCondition"`: A complex type that contains information about the requested ordering
of domains in the returned list.
"""
function list_domains(; aws_config::AbstractAWSConfig=global_aws_config())
return route_53_domains(
"ListDomains"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_domains(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"ListDomains", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_operations()
list_operations(params::Dict{String,<:Any})
Returns information about all of the operations that return an operation ID and that have
ever been performed on domains that were registered by the current account. This command
runs only in the us-east-1 Region.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: For an initial request for a list of operations, omit this element. If the
number of operations that are not yet complete is greater than the value that you specified
for MaxItems, you can use Marker to return additional operations. Get the value of
NextPageMarker from the previous response, and submit another request that includes the
value of NextPageMarker in the Marker element.
- `"MaxItems"`: Number of domains to be returned. Default: 20
- `"SortBy"`: The sort type for returned values.
- `"SortOrder"`: The sort order ofr returned values, either ascending or descending.
- `"Status"`: The status of the operations.
- `"SubmittedSince"`: An optional parameter that lets you get information about all the
operations that you submitted after a specified date and time. Specify the date and time in
Unix time format and Coordinated Universal time (UTC).
- `"Type"`: An arrays of the domains operation types.
"""
function list_operations(; aws_config::AbstractAWSConfig=global_aws_config())
return route_53_domains(
"ListOperations"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_operations(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"ListOperations", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_prices()
list_prices(params::Dict{String,<:Any})
Lists the following prices for either all the TLDs supported by Route 53, or the specified
TLD: Registration Transfer Owner change Domain renewal Domain restoration
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"Marker"`: For an initial request for a list of prices, omit this element. If the number
of prices that are not yet complete is greater than the value that you specified for
MaxItems, you can use Marker to return additional prices. Get the value of NextPageMarker
from the previous response, and submit another request that includes the value of
NextPageMarker in the Marker element. Used only for all TLDs. If you specify a TLD, don't
specify a Marker.
- `"MaxItems"`: Number of Prices to be returned. Used only for all TLDs. If you specify a
TLD, don't specify a MaxItems.
- `"Tld"`: The TLD for which you want to receive the pricing information. For example.
.net. If a Tld value is not provided, a list of prices for all TLDs supported by Route 53
is returned.
"""
function list_prices(; aws_config::AbstractAWSConfig=global_aws_config())
return route_53_domains(
"ListPrices"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function list_prices(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return route_53_domains(
"ListPrices", params; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
"""
list_tags_for_domain(domain_name)
list_tags_for_domain(domain_name, params::Dict{String,<:Any})
This operation returns all of the tags that are associated with the specified domain. All
tag operations are eventually consistent; subsequent operations might not immediately
represent all issued operations.
# Arguments
- `domain_name`: The domain for which you want to get a list of tags.
"""
function list_tags_for_domain(DomainName; aws_config::AbstractAWSConfig=global_aws_config())
return route_53_domains(
"ListTagsForDomain",
Dict{String,Any}("DomainName" => DomainName);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function list_tags_for_domain(
DomainName,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"ListTagsForDomain",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("DomainName" => DomainName), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
push_domain(domain_name, target)
push_domain(domain_name, target, params::Dict{String,<:Any})
Moves a domain from Amazon Web Services to another registrar. Supported actions:
Changes the IPS tags of a .uk domain, and pushes it to transit. Transit means that the
domain is ready to be transferred to another registrar.
# Arguments
- `domain_name`: Name of the domain.
- `target`: New IPS tag for the domain.
"""
function push_domain(DomainName, Target; aws_config::AbstractAWSConfig=global_aws_config())
return route_53_domains(
"PushDomain",
Dict{String,Any}("DomainName" => DomainName, "Target" => Target);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function push_domain(
DomainName,
Target,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"PushDomain",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("DomainName" => DomainName, "Target" => Target),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
register_domain(admin_contact, domain_name, duration_in_years, registrant_contact, tech_contact)
register_domain(admin_contact, domain_name, duration_in_years, registrant_contact, tech_contact, params::Dict{String,<:Any})
This operation registers a domain. Domains are registered either by Amazon Registrar (for
.com, .net, and .org domains) or by our registrar associate, Gandi (for all other domains).
For some top-level domains (TLDs), this operation requires extra parameters. When you
register a domain, Amazon Route 53 does the following: Creates a Route 53 hosted zone
that has the same name as the domain. Route 53 assigns four name servers to your hosted
zone and automatically updates your domain registration with the names of these name
servers. Enables auto renew, so your domain registration will renew automatically each
year. We'll notify you in advance of the renewal date so you can choose whether to renew
the registration. Optionally enables privacy protection, so WHOIS queries return contact
information either for Amazon Registrar (for .com, .net, and .org domains) or for our
registrar associate, Gandi (for all other TLDs). If you don't enable privacy protection,
WHOIS queries return the information that you entered for the administrative, registrant,
and technical contacts. You must specify the same privacy setting for the administrative,
registrant, and technical contacts. If registration is successful, returns an operation
ID that you can use to track the progress and completion of the action. If the request is
not completed successfully, the domain registrant is notified by email. Charges your
Amazon Web Services account an amount based on the top-level domain. For more information,
see Amazon Route 53 Pricing.
# Arguments
- `admin_contact`: Provides detailed contact information. For information about the values
that you specify for each element, see ContactDetail.
- `domain_name`: The domain name that you want to register. The top-level domain (TLD),
such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see
Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.
The domain name can contain only the following characters: Letters a through z. Domain
names are not case sensitive. Numbers 0 through 9. Hyphen (-). You can't specify a
hyphen at the beginning or end of a label. Period (.) to separate the labels in the
name, such as the . in example.com. Internationalized domain names are not supported for
some top-level domains. To determine whether the TLD that you want to use supports
internationalized domain names, see Domains that You Can Register with Amazon Route 53. For
more information, see Formatting Internationalized Domain Names.
- `duration_in_years`: The number of years that you want to register the domain for.
Domains are registered for a minimum of one year. The maximum period depends on the
top-level domain. For the range of valid values for your domain, see Domains that You Can
Register with Amazon Route 53 in the Amazon Route 53 Developer Guide. Default: 1
- `registrant_contact`: Provides detailed contact information. For information about the
values that you specify for each element, see ContactDetail.
- `tech_contact`: Provides detailed contact information. For information about the values
that you specify for each element, see ContactDetail.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"AutoRenew"`: Indicates whether the domain will be automatically renewed (true) or not
(false). Auto renewal only takes effect after the account is charged. Default: true
- `"IdnLangCode"`: Reserved for future use.
- `"PrivacyProtectAdminContact"`: Whether you want to conceal contact information from
WHOIS queries. If you specify true, WHOIS (\"who is\") queries return contact information
either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar
associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return the
information that you entered for the admin contact. You must specify the same privacy
setting for the administrative, registrant, and technical contacts. Default: true
- `"PrivacyProtectRegistrantContact"`: Whether you want to conceal contact information from
WHOIS queries. If you specify true, WHOIS (\"who is\") queries return contact information
either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar
associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return the
information that you entered for the registrant contact (the domain owner). You must
specify the same privacy setting for the administrative, registrant, and technical
contacts. Default: true
- `"PrivacyProtectTechContact"`: Whether you want to conceal contact information from WHOIS
queries. If you specify true, WHOIS (\"who is\") queries return contact information either
for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate,
Gandi (for all other TLDs). If you specify false, WHOIS queries return the information that
you entered for the technical contact. You must specify the same privacy setting for the
administrative, registrant, and technical contacts. Default: true
"""
function register_domain(
AdminContact,
DomainName,
DurationInYears,
RegistrantContact,
TechContact;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"RegisterDomain",
Dict{String,Any}(
"AdminContact" => AdminContact,
"DomainName" => DomainName,
"DurationInYears" => DurationInYears,
"RegistrantContact" => RegistrantContact,
"TechContact" => TechContact,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function register_domain(
AdminContact,
DomainName,
DurationInYears,
RegistrantContact,
TechContact,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return route_53_domains(
"RegisterDomain",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"AdminContact" => AdminContact,
"DomainName" => DomainName,
"DurationInYears" => DurationInYears,
"RegistrantContact" => RegistrantContact,
"TechContact" => TechContact,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
reject_domain_transfer_from_another_aws_account(domain_name)
reject_domain_transfer_from_another_aws_account(domain_name, params::Dict{String,<:Any})