-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
docs-2.json
1527 lines (1527 loc) · 125 KB
/
docs-2.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",
"service": "<fullname>Global Accelerator</fullname> <p>This is the <i>Global Accelerator API Reference</i>. This guide is for developers who need detailed information about Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html\">Global Accelerator Developer Guide</a>.</p> <p>Global Accelerator is a service in which you create <i>accelerators</i> to improve the performance of your applications for local and global users. Depending on the type of accelerator you choose, you can gain additional benefits. </p> <ul> <li> <p>By using a standard accelerator, you can improve availability of your internet applications that are used by a global audience. With a standard accelerator, Global Accelerator directs traffic to optimal endpoints over the Amazon Web Services global network. </p> </li> <li> <p>For other scenarios, you might choose a custom routing accelerator. With a custom routing accelerator, you can use application logic to directly map one or more users to a specific endpoint among many endpoints.</p> </li> </ul> <important> <p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify <code>--region us-west-2</code> on Amazon Web Services CLI commands.</p> </important> <p>By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses are anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack, Global Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses. With a standard accelerator for IPv4, instead of using the addresses that Global Accelerator provides, you can configure these entry points to be IPv4 addresses from your own IP address ranges that you bring to Global Accelerator (BYOIP). </p> <p>For a standard accelerator, they distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services Regions , which increases the availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers, Amazon EC2 instances, or Elastic IP addresses that are located in one Amazon Web Services Region or multiple Amazon Web Services Regions. For custom routing accelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that are virtual private cloud (VPC) subnets.</p> <important> <p>The static IP addresses remain assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you <i>delete</i> an accelerator, you lose the static IP addresses that are assigned to it, so you can no longer route traffic by using them. You can use IAM policies like tag-based permissions with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/access-control-manage-access-tag-policies.html\">Tag-based policies</a>.</p> </important> <p>For standard accelerators, Global Accelerator uses the Amazon Web Services global network to route traffic to the optimal regional endpoint based on health, client location, and policies that you configure. The service reacts instantly to changes in health or configuration to ensure that internet traffic from clients is always directed to healthy endpoints.</p> <p>For more information about understanding and using Global Accelerator, see the <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html\">Global Accelerator Developer Guide</a>.</p>",
"operations": {
"AddCustomRoutingEndpoints": "<p>Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.</p> <p>The listener port range must be large enough to support the number of IP addresses that can be specified in your subnet. The number of ports required is: subnet size times the number of ports per destination EC2 instances. For example, a subnet defined as /24 requires a listener port range of at least 255 ports. </p> <p>Note: You must have enough remaining listener ports available to map to the subnet ports, or the call will fail with a LimitExceededException.</p> <p>By default, all destinations in a subnet in a custom routing accelerator cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/api/API_AllowCustomRoutingTraffic.html\"> AllowCustomRoutingTraffic</a> operation.</p>",
"AddEndpoints": "<p>Add endpoints to an endpoint group. The <code>AddEndpoints</code> API operation is the recommended option for adding endpoints. The alternative options are to add endpoints when you create an endpoint group (with the <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/api/API_CreateEndpointGroup.html\">CreateEndpointGroup</a> API) or when you update an endpoint group (with the <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/api/API_UpdateEndpointGroup.html\">UpdateEndpointGroup</a> API). </p> <p>There are two advantages to using <code>AddEndpoints</code> to add endpoints in Global Accelerator:</p> <ul> <li> <p>It's faster, because Global Accelerator only has to resolve the new endpoints that you're adding, rather than resolving new and existing endpoints.</p> </li> <li> <p>It's more convenient, because you don't need to specify the current endpoints that are already in the endpoint group, in addition to the new endpoints that you want to add.</p> </li> </ul> <p>For information about endpoint types and requirements for endpoints that you can add to Global Accelerator, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints.html\"> Endpoints for standard accelerators</a> in the <i>Global Accelerator Developer Guide</i>.</p>",
"AdvertiseByoipCidr": "<p>Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of propagation delays. </p> <p>To stop advertising the BYOIP address range, use <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/api/WithdrawByoipCidr.html\"> WithdrawByoipCidr</a>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html\">Bring your own IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p>",
"AllowCustomRoutingTraffic": "<p>Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic for a custom routing accelerator. You can allow traffic to all destinations in the subnet endpoint, or allow traffic to a specified list of destination IP addresses and ports in the subnet. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group.</p> <p>After you make changes, you can verify that the updates are complete by checking the status of your accelerator: the status changes from IN_PROGRESS to DEPLOYED.</p>",
"CreateAccelerator": "<p>Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers. </p> <important> <p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify <code>--region us-west-2</code> on Amazon Web Services CLI commands.</p> </important>",
"CreateCrossAccountAttachment": "<p>Create a cross-account attachment in Global Accelerator. You create a cross-account attachment to specify the <i>principals</i> who have permission to work with <i>resources</i> in accelerators in their own account. You specify, in the same attachment, the resources that are shared.</p> <p>A principal can be an Amazon Web Services account number or the Amazon Resource Name (ARN) for an accelerator. For account numbers that are listed as principals, to work with a resource listed in the attachment, you must sign in to an account specified as a principal. Then, you can work with resources that are listed, with any of your accelerators. If an accelerator ARN is listed in the cross-account attachment as a principal, anyone with permission to make updates to the accelerator can work with resources that are listed in the attachment. </p> <p>Specify each principal and resource separately. To specify two CIDR address pools, list them individually under <code>Resources</code>, and so on. For a command line operation, for example, you might use a statement like the following:</p> <p> <code> \"Resources\": [{\"Cidr\": \"169.254.60.0/24\"},{\"Cidr\": \"169.254.59.0/24\"}]</code> </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/cross-account-resources.html\"> Working with cross-account attachments and resources in Global Accelerator</a> in the <i> Global Accelerator Developer Guide</i>.</p>",
"CreateCustomRoutingAccelerator": "<p>Create a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands of Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints.</p> <p>Be aware that, by default, all destination EC2 instances in a VPC subnet endpoint cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/api/API_AllowCustomRoutingTraffic.html\"> AllowCustomRoutingTraffic</a> operation.</p> <important> <p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify <code>--region us-west-2</code> on Amazon Web Services CLI commands.</p> </important>",
"CreateCustomRoutingEndpointGroup": "<p>Create an endpoint group for the specified listener for a custom routing accelerator. An endpoint group is a collection of endpoints in one Amazon Web Services Region. </p>",
"CreateCustomRoutingListener": "<p>Create a listener to process inbound connections from clients to a custom routing accelerator. Connections arrive to assigned static IP addresses on the port range that you specify. </p>",
"CreateEndpointGroup": "<p>Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one Amazon Web Services Region. A resource must be valid and active when you add it as an endpoint.</p> <p>For more information about endpoint types and requirements for endpoints that you can add to Global Accelerator, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints.html\"> Endpoints for standard accelerators</a> in the <i>Global Accelerator Developer Guide</i>.</p>",
"CreateListener": "<p>Create a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static IP addresses on a port, port range, or list of port ranges that you specify. </p>",
"DeleteAccelerator": "<p>Delete an accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator, update the accelerator to set <code>Enabled</code> to false.</p> <important> <p>When you create an accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. Alternatively, you can bring your own IP address ranges to Global Accelerator and assign IP addresses from those ranges. </p> <p>The IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you <i>delete</i> an accelerator, you lose the static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them. As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/auth-and-access-control.html\">Identity and access management</a> in the <i>Global Accelerator Developer Guide</i>.</p> </important>",
"DeleteCrossAccountAttachment": "<p>Delete a cross-account attachment. When you delete an attachment, Global Accelerator revokes the permission to use the resources in the attachment from all principals in the list of principals. Global Accelerator revokes the permission for specific resources.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/cross-account-resources.html\"> Working with cross-account attachments and resources in Global Accelerator</a> in the <i> Global Accelerator Developer Guide</i>.</p>",
"DeleteCustomRoutingAccelerator": "<p>Delete a custom routing accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator, update the accelerator to set <code>Enabled</code> to false.</p> <important> <p>When you create a custom routing accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. </p> <p>The IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you <i>delete</i> an accelerator, you lose the static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them. As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/auth-and-access-control.html\">Identity and access management</a> in the <i>Global Accelerator Developer Guide</i>.</p> </important>",
"DeleteCustomRoutingEndpointGroup": "<p>Delete an endpoint group from a listener for a custom routing accelerator.</p>",
"DeleteCustomRoutingListener": "<p>Delete a listener for a custom routing accelerator.</p>",
"DeleteEndpointGroup": "<p>Delete an endpoint group from a listener.</p>",
"DeleteListener": "<p>Delete a listener from an accelerator.</p>",
"DenyCustomRoutingTraffic": "<p>Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic for a custom routing accelerator. You can deny traffic to all destinations in the VPC endpoint, or deny traffic to a specified list of destination IP addresses and ports. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group.</p> <p>After you make changes, you can verify that the updates are complete by checking the status of your accelerator: the status changes from IN_PROGRESS to DEPLOYED.</p>",
"DeprovisionByoipCidr": "<p>Releases the specified address range that you provisioned to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool. </p> <p>Before you can release an address range, you must stop advertising it by using <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/api/WithdrawByoipCidr.html\">WithdrawByoipCidr</a> and you must not have any accelerators that are using static IP addresses allocated from its address range. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html\">Bring your own IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p>",
"DescribeAccelerator": "<p>Describe an accelerator. </p>",
"DescribeAcceleratorAttributes": "<p>Describe the attributes of an accelerator. </p>",
"DescribeCrossAccountAttachment": "<p>Gets configuration information about a cross-account attachment.</p>",
"DescribeCustomRoutingAccelerator": "<p>Describe a custom routing accelerator. </p>",
"DescribeCustomRoutingAcceleratorAttributes": "<p>Describe the attributes of a custom routing accelerator. </p>",
"DescribeCustomRoutingEndpointGroup": "<p>Describe an endpoint group for a custom routing accelerator. </p>",
"DescribeCustomRoutingListener": "<p>The description of a listener for a custom routing accelerator.</p>",
"DescribeEndpointGroup": "<p>Describe an endpoint group. </p>",
"DescribeListener": "<p>Describe a listener. </p>",
"ListAccelerators": "<p>List the accelerators for an Amazon Web Services account. </p>",
"ListByoipCidrs": "<p>Lists the IP address ranges that were specified in calls to <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/api/ProvisionByoipCidr.html\">ProvisionByoipCidr</a>, including the current state and a history of state changes.</p>",
"ListCrossAccountAttachments": "<p>List the cross-account attachments that have been created in Global Accelerator.</p>",
"ListCrossAccountResourceAccounts": "<p>List the accounts that have cross-account resources.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/cross-account-resources.html\"> Working with cross-account attachments and resources in Global Accelerator</a> in the <i> Global Accelerator Developer Guide</i>.</p>",
"ListCrossAccountResources": "<p>List the cross-account resources available to work with.</p>",
"ListCustomRoutingAccelerators": "<p>List the custom routing accelerators for an Amazon Web Services account. </p>",
"ListCustomRoutingEndpointGroups": "<p>List the endpoint groups that are associated with a listener for a custom routing accelerator. </p>",
"ListCustomRoutingListeners": "<p>List the listeners for a custom routing accelerator. </p>",
"ListCustomRoutingPortMappings": "<p>Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance IP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator. For each subnet endpoint that you add, Global Accelerator creates a new static port mapping for the accelerator. The port mappings don't change after Global Accelerator generates them, so you can retrieve and cache the full mapping on your servers. </p> <p>If you remove a subnet from your accelerator, Global Accelerator removes (reclaims) the port mappings. If you add a subnet to your accelerator, Global Accelerator creates new port mappings (the existing ones don't change). If you add or remove EC2 instances in your subnet, the port mappings don't change, because the mappings are created when you add the subnet to Global Accelerator.</p> <p>The mappings also include a flag for each destination denoting which destination IP addresses and ports are allowed or denied traffic.</p>",
"ListCustomRoutingPortMappingsByDestination": "<p>List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint. The response is the mappings for one destination IP address. This is useful when your subnet endpoint has mappings that span multiple custom routing accelerators in your account, or for scenarios where you only want to list the port mappings for a specific destination instance.</p>",
"ListEndpointGroups": "<p>List the endpoint groups that are associated with a listener. </p>",
"ListListeners": "<p>List the listeners for an accelerator. </p>",
"ListTagsForResource": "<p>List all tags for an accelerator. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html\">Tagging in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>. </p>",
"ProvisionByoipCidr": "<p>Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/api/AdvertiseByoipCidr.html\"> AdvertiseByoipCidr</a>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html\">Bring your own IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p>",
"RemoveCustomRoutingEndpoints": "<p>Remove endpoints from a custom routing accelerator.</p>",
"RemoveEndpoints": "<p>Remove endpoints from an endpoint group. </p> <p>The <code>RemoveEndpoints</code> API operation is the recommended option for removing endpoints. The alternative is to remove endpoints by updating an endpoint group by using the <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/api/API_UpdateEndpointGroup.html\">UpdateEndpointGroup</a> API operation. There are two advantages to using <code>AddEndpoints</code> to remove endpoints instead:</p> <ul> <li> <p>It's more convenient, because you only need to specify the endpoints that you want to remove. With the <code>UpdateEndpointGroup</code> API operation, you must specify all of the endpoints in the endpoint group except the ones that you want to remove from the group.</p> </li> <li> <p>It's faster, because Global Accelerator doesn't need to resolve any endpoints. With the <code>UpdateEndpointGroup</code> API operation, Global Accelerator must resolve all of the endpoints that remain in the group.</p> </li> </ul>",
"TagResource": "<p>Add tags to an accelerator resource. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html\">Tagging in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>. </p>",
"UntagResource": "<p>Remove tags from a Global Accelerator resource. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from an accelerator that was already removed.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html\">Tagging in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>",
"UpdateAccelerator": "<p>Update an accelerator to make changes, such as the following: </p> <ul> <li> <p>Change the name of the accelerator.</p> </li> <li> <p>Disable the accelerator so that it no longer accepts or routes traffic, or so that you can delete it.</p> </li> <li> <p>Enable the accelerator, if it is disabled.</p> </li> <li> <p>Change the IP address type to dual-stack if it is IPv4, or change the IP address type to IPv4 if it's dual-stack.</p> </li> </ul> <p>Be aware that static IP addresses remain assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete the accelerator, you lose the static IP addresses that are assigned to it, so you can no longer route traffic by using them.</p> <important> <p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify <code>--region us-west-2</code> on Amazon Web Services CLI commands.</p> </important>",
"UpdateAcceleratorAttributes": "<p>Update the attributes for an accelerator. </p>",
"UpdateCrossAccountAttachment": "<p>Update a cross-account attachment to add or remove principals or resources. When you update an attachment to remove a principal (account ID or accelerator) or a resource, Global Accelerator revokes the permission for specific resources. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/cross-account-resources.html\"> Working with cross-account attachments and resources in Global Accelerator</a> in the <i> Global Accelerator Developer Guide</i>.</p>",
"UpdateCustomRoutingAccelerator": "<p>Update a custom routing accelerator. </p>",
"UpdateCustomRoutingAcceleratorAttributes": "<p>Update the attributes for a custom routing accelerator. </p>",
"UpdateCustomRoutingListener": "<p>Update a listener for a custom routing accelerator. </p>",
"UpdateEndpointGroup": "<p>Update an endpoint group. A resource must be valid and active when you add it as an endpoint.</p>",
"UpdateListener": "<p>Update a listener. </p>",
"WithdrawByoipCidr": "<p>Stops advertising an address range that is provisioned as an address pool. You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.</p> <p>It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of propagation delays.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html\">Bring your own IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p>"
},
"shapes": {
"Accelerator": {
"base": "<p>An accelerator is a complex type that includes one or more listeners that process inbound connections and then direct traffic to one or more endpoint groups, each of which includes endpoints, such as load balancers.</p>",
"refs": {
"Accelerators$member": null,
"CreateAcceleratorResponse$Accelerator": "<p>The accelerator that is created by specifying a listener and the supported IP address types.</p>",
"DescribeAcceleratorResponse$Accelerator": "<p>The description of the accelerator.</p>",
"UpdateAcceleratorResponse$Accelerator": "<p>Information about the updated accelerator.</p>"
}
},
"AcceleratorAttributes": {
"base": "<p>Attributes of an accelerator.</p>",
"refs": {
"DescribeAcceleratorAttributesResponse$AcceleratorAttributes": "<p>The attributes of the accelerator.</p>",
"UpdateAcceleratorAttributesResponse$AcceleratorAttributes": "<p>Updated attributes for the accelerator.</p>"
}
},
"AcceleratorEvent": {
"base": "<p>A complex type that contains a <code>Timestamp</code> value and <code>Message</code> for changes that you make to an accelerator in Global Accelerator. Messages stored here provide progress or error information when you update an accelerator from IPv4 to dual-stack, or from dual-stack to IPv4. Global Accelerator stores a maximum of ten event messages. </p>",
"refs": {
"AcceleratorEvents$member": null
}
},
"AcceleratorEvents": {
"base": null,
"refs": {
"Accelerator$Events": "<p>A history of changes that you make to an accelerator in Global Accelerator.</p>"
}
},
"AcceleratorNotDisabledException": {
"base": "<p>The accelerator that you specified could not be disabled.</p>",
"refs": {
}
},
"AcceleratorNotFoundException": {
"base": "<p>The accelerator that you specified doesn't exist.</p>",
"refs": {
}
},
"AcceleratorStatus": {
"base": null,
"refs": {
"Accelerator$Status": "<p>Describes the deployment status of the accelerator.</p>"
}
},
"Accelerators": {
"base": null,
"refs": {
"ListAcceleratorsResponse$Accelerators": "<p>The list of accelerators for a customer account.</p>"
}
},
"AccessDeniedException": {
"base": "<p>You don't have access permission.</p>",
"refs": {
}
},
"AddCustomRoutingEndpointsRequest": {
"base": null,
"refs": {
}
},
"AddCustomRoutingEndpointsResponse": {
"base": null,
"refs": {
}
},
"AddEndpointsRequest": {
"base": null,
"refs": {
}
},
"AddEndpointsResponse": {
"base": null,
"refs": {
}
},
"AdvertiseByoipCidrRequest": {
"base": null,
"refs": {
}
},
"AdvertiseByoipCidrResponse": {
"base": null,
"refs": {
}
},
"AllowCustomRoutingTrafficRequest": {
"base": null,
"refs": {
}
},
"AssociatedEndpointGroupFoundException": {
"base": "<p>The listener that you specified has an endpoint group associated with it. You must remove all dependent resources from a listener before you can delete it.</p>",
"refs": {
}
},
"AssociatedListenerFoundException": {
"base": "<p>The accelerator that you specified has a listener associated with it. You must remove all dependent resources from an accelerator before you can delete it.</p>",
"refs": {
}
},
"Attachment": {
"base": "<p>A cross-account attachment in Global Accelerator. A cross-account attachment specifies the <i>principals</i> who have permission to work with <i>resources</i> in your account, which you also list in the attachment.</p>",
"refs": {
"Attachments$member": null,
"CreateCrossAccountAttachmentResponse$CrossAccountAttachment": "<p>Information about the cross-account attachment.</p>",
"DescribeCrossAccountAttachmentResponse$CrossAccountAttachment": "<p>Information about the cross-account attachment.</p>",
"UpdateCrossAccountAttachmentResponse$CrossAccountAttachment": "<p>Information about the updated cross-account attachment.</p>"
}
},
"AttachmentName": {
"base": null,
"refs": {
"Attachment$Name": "<p>The name of the cross-account attachment.</p>",
"CreateCrossAccountAttachmentRequest$Name": "<p>The name of the cross-account attachment. </p>",
"UpdateCrossAccountAttachmentRequest$Name": "<p>The name of the cross-account attachment. </p>"
}
},
"AttachmentNotFoundException": {
"base": "<p>No cross-account attachment was found.</p>",
"refs": {
}
},
"Attachments": {
"base": null,
"refs": {
"ListCrossAccountAttachmentsResponse$CrossAccountAttachments": "<p>Information about the cross-account attachments.</p>"
}
},
"AwsAccountId": {
"base": null,
"refs": {
"AwsAccountIds$member": null,
"ListCrossAccountResourcesRequest$ResourceOwnerAwsAccountId": "<p>The account ID of a resource owner in a cross-account attachment.</p>"
}
},
"AwsAccountIds": {
"base": null,
"refs": {
"ListCrossAccountResourceAccountsResponse$ResourceOwnerAwsAccountIds": "<p>The account IDs of principals (resource owners) in a cross-account attachment who can work with resources listed in the same attachment.</p>"
}
},
"ByoipCidr": {
"base": "<p>Information about an IP address range that is provisioned for use with your Amazon Web Services resources through bring your own IP address (BYOIP).</p> <p>The following describes each BYOIP <code>State</code> that your IP address range can be in.</p> <ul> <li> <p> <b>PENDING_PROVISIONING</b> — You’ve submitted a request to provision an IP address range but it is not yet provisioned with Global Accelerator.</p> </li> <li> <p> <b>READY</b> — The address range is provisioned with Global Accelerator and can be advertised.</p> </li> <li> <p> <b>PENDING_ADVERTISING</b> — You’ve submitted a request for Global Accelerator to advertise an address range but it is not yet being advertised.</p> </li> <li> <p> <b>ADVERTISING</b> — The address range is being advertised by Global Accelerator.</p> </li> <li> <p> <b>PENDING_WITHDRAWING</b> — You’ve submitted a request to withdraw an address range from being advertised but it is still being advertised by Global Accelerator.</p> </li> <li> <p> <b>PENDING_DEPROVISIONING</b> — You’ve submitted a request to deprovision an address range from Global Accelerator but it is still provisioned.</p> </li> <li> <p> <b>DEPROVISIONED</b> — The address range is deprovisioned from Global Accelerator.</p> </li> <li> <p> <b>FAILED_PROVISION </b> — The request to provision the address range from Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact Amazon Web Services support.</p> </li> <li> <p> <b>FAILED_ADVERTISING</b> — The request for Global Accelerator to advertise the address range was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact Amazon Web Services support.</p> </li> <li> <p> <b>FAILED_WITHDRAW</b> — The request to withdraw the address range from advertising by Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact Amazon Web Services support.</p> </li> <li> <p> <b>FAILED_DEPROVISION </b> — The request to deprovision the address range from Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact Amazon Web Services support.</p> </li> </ul>",
"refs": {
"AdvertiseByoipCidrResponse$ByoipCidr": "<p>Information about the address range.</p>",
"ByoipCidrs$member": null,
"DeprovisionByoipCidrResponse$ByoipCidr": "<p>Information about the address range.</p>",
"ProvisionByoipCidrResponse$ByoipCidr": "<p>Information about the address range.</p>",
"WithdrawByoipCidrResponse$ByoipCidr": "<p>Information about the BYOIP address pool.</p>"
}
},
"ByoipCidrEvent": {
"base": "<p>A complex type that contains a <code>Message</code> and a <code>Timestamp</code> value for changes that you make in the status of an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).</p>",
"refs": {
"ByoipCidrEvents$member": null
}
},
"ByoipCidrEvents": {
"base": null,
"refs": {
"ByoipCidr$Events": "<p>A history of status changes for an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).</p>"
}
},
"ByoipCidrNotFoundException": {
"base": "<p>The CIDR that you specified was not found or is incorrect.</p>",
"refs": {
}
},
"ByoipCidrState": {
"base": null,
"refs": {
"ByoipCidr$State": "<p>The state of the address pool.</p>"
}
},
"ByoipCidrs": {
"base": null,
"refs": {
"ListByoipCidrsResponse$ByoipCidrs": "<p>Information about your address ranges.</p>"
}
},
"CidrAuthorizationContext": {
"base": "<p>Provides authorization for Amazon to bring a specific IP address range to a specific Amazon Web Services account using bring your own IP addresses (BYOIP). </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html\">Bring your own IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p>",
"refs": {
"ProvisionByoipCidrRequest$CidrAuthorizationContext": "<p>A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP. </p>"
}
},
"ClientAffinity": {
"base": null,
"refs": {
"CreateListenerRequest$ClientAffinity": "<p>Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint.</p> <p>Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is <code>NONE</code>, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes. </p> <p>If you want a given client to always be routed to the same endpoint, set client affinity to <code>SOURCE_IP</code> instead. When you use the <code>SOURCE_IP</code> setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.</p> <p>The default value is <code>NONE</code>.</p>",
"Listener$ClientAffinity": "<p>Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint.</p> <p>Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is <code>NONE</code>, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes. </p> <p>If you want a given client to always be routed to the same endpoint, set client affinity to <code>SOURCE_IP</code> instead. When you use the <code>SOURCE_IP</code> setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.</p> <p>The default value is <code>NONE</code>.</p>",
"UpdateListenerRequest$ClientAffinity": "<p>Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint.</p> <p>Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is <code>NONE</code>, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes. </p> <p>If you want a given client to always be routed to the same endpoint, set client affinity to <code>SOURCE_IP</code> instead. When you use the <code>SOURCE_IP</code> setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.</p> <p>The default value is <code>NONE</code>.</p>"
}
},
"ConflictException": {
"base": "<p>You can't use both of those options.</p>",
"refs": {
}
},
"CreateAcceleratorRequest": {
"base": null,
"refs": {
}
},
"CreateAcceleratorResponse": {
"base": null,
"refs": {
}
},
"CreateCrossAccountAttachmentRequest": {
"base": null,
"refs": {
}
},
"CreateCrossAccountAttachmentResponse": {
"base": null,
"refs": {
}
},
"CreateCustomRoutingAcceleratorRequest": {
"base": null,
"refs": {
}
},
"CreateCustomRoutingAcceleratorResponse": {
"base": null,
"refs": {
}
},
"CreateCustomRoutingEndpointGroupRequest": {
"base": null,
"refs": {
}
},
"CreateCustomRoutingEndpointGroupResponse": {
"base": null,
"refs": {
}
},
"CreateCustomRoutingListenerRequest": {
"base": null,
"refs": {
}
},
"CreateCustomRoutingListenerResponse": {
"base": null,
"refs": {
}
},
"CreateEndpointGroupRequest": {
"base": null,
"refs": {
}
},
"CreateEndpointGroupResponse": {
"base": null,
"refs": {
}
},
"CreateListenerRequest": {
"base": null,
"refs": {
}
},
"CreateListenerResponse": {
"base": null,
"refs": {
}
},
"CrossAccountResource": {
"base": "<p>An endpoint (Amazon Web Services resource) or an IP address range, in CIDR format, that is listed in a cross-account attachment. A cross-account resource can be added to an accelerator by specified principals, which are also listed in the attachment.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/cross-account-resources.html\"> Working with cross-account attachments and resources in Global Accelerator</a> in the <i> Global Accelerator Developer Guide</i>.</p>",
"refs": {
"CrossAccountResources$member": null
}
},
"CrossAccountResources": {
"base": null,
"refs": {
"ListCrossAccountResourcesResponse$CrossAccountResources": "<p>The cross-account resources used with an accelerator.</p>"
}
},
"CustomRoutingAccelerator": {
"base": "<p>Attributes of a custom routing accelerator.</p>",
"refs": {
"CreateCustomRoutingAcceleratorResponse$Accelerator": "<p>The accelerator that is created.</p>",
"CustomRoutingAccelerators$member": null,
"DescribeCustomRoutingAcceleratorResponse$Accelerator": "<p>The description of the custom routing accelerator.</p>",
"UpdateCustomRoutingAcceleratorResponse$Accelerator": "<p>Information about the updated custom routing accelerator.</p>"
}
},
"CustomRoutingAcceleratorAttributes": {
"base": "<p>Attributes of a custom routing accelerator.</p>",
"refs": {
"DescribeCustomRoutingAcceleratorAttributesResponse$AcceleratorAttributes": "<p>The attributes of the custom routing accelerator.</p>",
"UpdateCustomRoutingAcceleratorAttributesResponse$AcceleratorAttributes": "<p>Updated custom routing accelerator.</p>"
}
},
"CustomRoutingAcceleratorStatus": {
"base": null,
"refs": {
"CustomRoutingAccelerator$Status": "<p>Describes the deployment status of the accelerator.</p>"
}
},
"CustomRoutingAccelerators": {
"base": null,
"refs": {
"ListCustomRoutingAcceleratorsResponse$Accelerators": "<p>The list of custom routing accelerators for a customer account.</p>"
}
},
"CustomRoutingDestinationConfiguration": {
"base": "<p>For a custom routing accelerator, sets the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.</p>",
"refs": {
"CustomRoutingDestinationConfigurations$member": null
}
},
"CustomRoutingDestinationConfigurations": {
"base": null,
"refs": {
"CreateCustomRoutingEndpointGroupRequest$DestinationConfigurations": "<p>Sets the port range and protocol for all endpoints (virtual private cloud subnets) in a custom routing endpoint group to accept client traffic on.</p>"
}
},
"CustomRoutingDestinationDescription": {
"base": "<p>For a custom routing accelerator, describes the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.</p>",
"refs": {
"CustomRoutingDestinationDescriptions$member": null
}
},
"CustomRoutingDestinationDescriptions": {
"base": null,
"refs": {
"CustomRoutingEndpointGroup$DestinationDescriptions": "<p>For a custom routing accelerator, describes the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.</p>"
}
},
"CustomRoutingDestinationTrafficState": {
"base": null,
"refs": {
"DestinationPortMapping$DestinationTrafficState": "<p>Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if traffic is allowed to the destination, or DENY, if traffic is not allowed to the destination.</p>",
"PortMapping$DestinationTrafficState": "<p>Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if traffic is allowed to the destination, or DENY, if traffic is not allowed to the destination.</p>"
}
},
"CustomRoutingEndpointConfiguration": {
"base": "<p>The list of endpoint objects. For custom routing, this is a list of virtual private cloud (VPC) subnet IDs.</p>",
"refs": {
"CustomRoutingEndpointConfigurations$member": null
}
},
"CustomRoutingEndpointConfigurations": {
"base": null,
"refs": {
"AddCustomRoutingEndpointsRequest$EndpointConfigurations": "<p>The list of endpoint objects to add to a custom routing accelerator.</p>"
}
},
"CustomRoutingEndpointDescription": {
"base": "<p>A complex type for an endpoint for a custom routing accelerator. Each endpoint group can include one or more endpoints, which are virtual private cloud (VPC) subnets.</p>",
"refs": {
"CustomRoutingEndpointDescriptions$member": null
}
},
"CustomRoutingEndpointDescriptions": {
"base": null,
"refs": {
"AddCustomRoutingEndpointsResponse$EndpointDescriptions": "<p>The endpoint objects added to the custom routing accelerator.</p>",
"CustomRoutingEndpointGroup$EndpointDescriptions": "<p>For a custom routing accelerator, describes the endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.</p>"
}
},
"CustomRoutingEndpointGroup": {
"base": "<p>A complex type for the endpoint group for a custom routing accelerator. An Amazon Web Services Region can have only one endpoint group for a specific listener. </p>",
"refs": {
"CreateCustomRoutingEndpointGroupResponse$EndpointGroup": "<p>The information about the endpoint group created for a custom routing accelerator.</p>",
"CustomRoutingEndpointGroups$member": null,
"DescribeCustomRoutingEndpointGroupResponse$EndpointGroup": "<p>The description of an endpoint group for a custom routing accelerator.</p>"
}
},
"CustomRoutingEndpointGroups": {
"base": null,
"refs": {
"ListCustomRoutingEndpointGroupsResponse$EndpointGroups": "<p>The list of the endpoint groups associated with a listener for a custom routing accelerator.</p>"
}
},
"CustomRoutingListener": {
"base": "<p>A complex type for a listener for a custom routing accelerator.</p>",
"refs": {
"CreateCustomRoutingListenerResponse$Listener": "<p>The listener that you've created for a custom routing accelerator.</p>",
"CustomRoutingListeners$member": null,
"DescribeCustomRoutingListenerResponse$Listener": "<p>The description of a listener for a custom routing accelerator.</p>",
"UpdateCustomRoutingListenerResponse$Listener": "<p>Information for the updated listener for a custom routing accelerator.</p>"
}
},
"CustomRoutingListeners": {
"base": null,
"refs": {
"ListCustomRoutingListenersResponse$Listeners": "<p>The list of listeners for a custom routing accelerator.</p>"
}
},
"CustomRoutingProtocol": {
"base": null,
"refs": {
"CustomRoutingProtocols$member": null
}
},
"CustomRoutingProtocols": {
"base": null,
"refs": {
"CustomRoutingDestinationConfiguration$Protocols": "<p>The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either TCP or UDP.</p>",
"PortMapping$Protocols": "<p>The protocols supported by the endpoint group.</p>"
}
},
"DeleteAcceleratorRequest": {
"base": null,
"refs": {
}
},
"DeleteCrossAccountAttachmentRequest": {
"base": null,
"refs": {
}
},
"DeleteCustomRoutingAcceleratorRequest": {
"base": null,
"refs": {
}
},
"DeleteCustomRoutingEndpointGroupRequest": {
"base": null,
"refs": {
}
},
"DeleteCustomRoutingListenerRequest": {
"base": null,
"refs": {
}
},
"DeleteEndpointGroupRequest": {
"base": null,
"refs": {
}
},
"DeleteListenerRequest": {
"base": null,
"refs": {
}
},
"DenyCustomRoutingTrafficRequest": {
"base": null,
"refs": {
}
},
"DeprovisionByoipCidrRequest": {
"base": null,
"refs": {
}
},
"DeprovisionByoipCidrResponse": {
"base": null,
"refs": {
}
},
"DescribeAcceleratorAttributesRequest": {
"base": null,
"refs": {
}
},
"DescribeAcceleratorAttributesResponse": {
"base": null,
"refs": {
}
},
"DescribeAcceleratorRequest": {
"base": null,
"refs": {
}
},
"DescribeAcceleratorResponse": {
"base": null,
"refs": {
}
},
"DescribeCrossAccountAttachmentRequest": {
"base": null,
"refs": {
}
},
"DescribeCrossAccountAttachmentResponse": {
"base": null,
"refs": {
}
},
"DescribeCustomRoutingAcceleratorAttributesRequest": {
"base": null,
"refs": {
}
},
"DescribeCustomRoutingAcceleratorAttributesResponse": {
"base": null,
"refs": {
}
},
"DescribeCustomRoutingAcceleratorRequest": {
"base": null,
"refs": {
}
},
"DescribeCustomRoutingAcceleratorResponse": {
"base": null,
"refs": {
}
},
"DescribeCustomRoutingEndpointGroupRequest": {
"base": null,
"refs": {
}
},
"DescribeCustomRoutingEndpointGroupResponse": {
"base": null,
"refs": {
}
},
"DescribeCustomRoutingListenerRequest": {
"base": null,
"refs": {
}
},
"DescribeCustomRoutingListenerResponse": {
"base": null,
"refs": {
}
},
"DescribeEndpointGroupRequest": {
"base": null,
"refs": {
}
},
"DescribeEndpointGroupResponse": {
"base": null,
"refs": {
}
},
"DescribeListenerRequest": {
"base": null,
"refs": {
}
},
"DescribeListenerResponse": {
"base": null,
"refs": {
}
},
"DestinationAddresses": {
"base": null,
"refs": {
"AllowCustomRoutingTrafficRequest$DestinationAddresses": "<p>A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to allow to receive traffic. The IP addresses must be a subset of the IP addresses that you specified for the endpoint group.</p> <p> <code>DestinationAddresses</code> is required if <code>AllowAllTrafficToEndpoint</code> is <code>FALSE</code> or is not specified.</p>",
"DenyCustomRoutingTrafficRequest$DestinationAddresses": "<p>A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to prevent from receiving traffic. The IP addresses must be a subset of the IP addresses allowed for the VPC subnet associated with the endpoint group.</p>"
}
},
"DestinationPortMapping": {
"base": "<p>The port mappings for a specified endpoint IP address (destination).</p>",
"refs": {
"DestinationPortMappings$member": null
}
},
"DestinationPortMappings": {
"base": null,
"refs": {
"ListCustomRoutingPortMappingsByDestinationResponse$DestinationPortMappings": "<p>The port mappings for the endpoint IP address that you specified in the request.</p>"
}
},
"DestinationPorts": {
"base": null,
"refs": {
"AllowCustomRoutingTrafficRequest$DestinationPorts": "<p>A list of specific Amazon EC2 instance ports (destination ports) that you want to allow to receive traffic.</p>",
"DenyCustomRoutingTrafficRequest$DestinationPorts": "<p>A list of specific Amazon EC2 instance ports (destination ports) in a subnet endpoint that you want to prevent from receiving traffic.</p>"
}
},
"EndpointAlreadyExistsException": {
"base": "<p>The endpoint that you specified doesn't exist.</p>",
"refs": {
}
},
"EndpointConfiguration": {
"base": "<p>A complex type for endpoints. A resource must be valid and active when you add it as an endpoint.</p>",
"refs": {
"EndpointConfigurations$member": null
}
},
"EndpointConfigurations": {
"base": null,
"refs": {
"AddEndpointsRequest$EndpointConfigurations": "<p>The list of endpoint objects.</p>",
"CreateEndpointGroupRequest$EndpointConfigurations": "<p>The list of endpoint objects.</p>",
"UpdateEndpointGroupRequest$EndpointConfigurations": "<p>The list of endpoint objects. A resource must be valid and active when you add it as an endpoint.</p>"
}
},
"EndpointDescription": {
"base": "<p>A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.</p>",
"refs": {
"EndpointDescriptions$member": null
}
},
"EndpointDescriptions": {
"base": null,
"refs": {
"AddEndpointsResponse$EndpointDescriptions": "<p>The list of endpoint objects.</p>",
"EndpointGroup$EndpointDescriptions": "<p>The list of endpoint objects.</p>"
}
},
"EndpointGroup": {
"base": "<p>A complex type for the endpoint group. An Amazon Web Services Region can have only one endpoint group for a specific listener. </p>",
"refs": {
"CreateEndpointGroupResponse$EndpointGroup": "<p>The information about the endpoint group that was created.</p>",
"DescribeEndpointGroupResponse$EndpointGroup": "<p>The description of an endpoint group.</p>",
"EndpointGroups$member": null,
"UpdateEndpointGroupResponse$EndpointGroup": "<p>The information about the endpoint group that was updated.</p>"
}
},
"EndpointGroupAlreadyExistsException": {
"base": "<p>The endpoint group that you specified already exists.</p>",
"refs": {
}
},
"EndpointGroupNotFoundException": {
"base": "<p>The endpoint group that you specified doesn't exist.</p>",
"refs": {
}
},
"EndpointGroups": {
"base": null,
"refs": {
"ListEndpointGroupsResponse$EndpointGroups": "<p>The list of the endpoint groups associated with a listener.</p>"
}
},
"EndpointIdentifier": {
"base": "<p>A complex type for an endpoint. Specifies information about the endpoint to remove from the endpoint group.</p>",
"refs": {
"EndpointIdentifiers$member": null
}
},
"EndpointIdentifiers": {
"base": null,
"refs": {
"RemoveEndpointsRequest$EndpointIdentifiers": "<p>The identifiers of the endpoints that you want to remove.</p>"
}
},
"EndpointIds": {
"base": null,
"refs": {
"RemoveCustomRoutingEndpointsRequest$EndpointIds": "<p>The IDs for the endpoints. For custom routing accelerators, endpoint IDs are the virtual private cloud (VPC) subnet IDs. </p>"
}
},
"EndpointNotFoundException": {
"base": "<p>The endpoint that you specified doesn't exist.</p>",
"refs": {
}
},
"EndpointWeight": {
"base": null,
"refs": {
"EndpointConfiguration$Weight": "<p>The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html\">Endpoint weights</a> in the <i>Global Accelerator Developer Guide</i>.</p>",
"EndpointDescription$Weight": "<p>The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html\">Endpoint weights</a> in the <i>Global Accelerator Developer Guide</i>. </p>"
}
},
"ErrorMessage": {
"base": null,
"refs": {
"AcceleratorNotDisabledException$Message": null,
"AcceleratorNotFoundException$Message": null,
"AccessDeniedException$Message": null,
"AssociatedEndpointGroupFoundException$Message": null,
"AssociatedListenerFoundException$Message": null,
"AttachmentNotFoundException$Message": null,
"ByoipCidrNotFoundException$Message": null,
"ConflictException$Message": null,
"EndpointAlreadyExistsException$Message": null,
"EndpointGroupAlreadyExistsException$Message": null,
"EndpointGroupNotFoundException$Message": null,
"EndpointNotFoundException$Message": null,
"IncorrectCidrStateException$Message": null,
"InternalServiceErrorException$Message": null,
"InvalidArgumentException$Message": null,
"InvalidNextTokenException$Message": null,
"InvalidPortRangeException$Message": null,
"LimitExceededException$Message": null,
"ListenerNotFoundException$Message": null,
"TransactionInProgressException$Message": null
}
},
"GenericBoolean": {
"base": null,
"refs": {
"Accelerator$Enabled": "<p>Indicates whether the accelerator is enabled. The value is true or false. The default value is true. </p> <p>If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.</p>",
"AcceleratorAttributes$FlowLogsEnabled": "<p>Indicates whether flow logs are enabled. The default value is false. If the value is true, <code>FlowLogsS3Bucket</code> and <code>FlowLogsS3Prefix</code> must be specified.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html\">Flow logs</a> in the <i>Global Accelerator Developer Guide</i>.</p>",
"AllowCustomRoutingTrafficRequest$AllowAllTrafficToEndpoint": "<p>Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint can receive traffic from a custom routing accelerator. The value is TRUE or FALSE. </p> <p>When set to TRUE, <i>all</i> destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE.</p> <p>When set to FALSE (or not specified), you <i>must</i> specify a list of destination IP addresses that are allowed to receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group.</p> <p>The default value is FALSE.</p>",
"CreateAcceleratorRequest$Enabled": "<p>Indicates whether an accelerator is enabled. The value is true or false. The default value is true. </p> <p>If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.</p>",
"CreateCustomRoutingAcceleratorRequest$Enabled": "<p>Indicates whether an accelerator is enabled. The value is true or false. The default value is true. </p> <p>If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.</p>",
"CustomRoutingAccelerator$Enabled": "<p>Indicates whether the accelerator is enabled. The value is true or false. The default value is true. </p> <p>If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.</p>",
"CustomRoutingAcceleratorAttributes$FlowLogsEnabled": "<p>Indicates whether flow logs are enabled. The default value is false. If the value is true, <code>FlowLogsS3Bucket</code> and <code>FlowLogsS3Prefix</code> must be specified.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html\">Flow logs</a> in the <i>Global Accelerator Developer Guide</i>.</p>",
"DenyCustomRoutingTrafficRequest$DenyAllTrafficToEndpoint": "<p>Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint <i>cannot</i> receive traffic from a custom routing accelerator. The value is TRUE or FALSE. </p> <p>When set to TRUE, <i>no</i> destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE.</p> <p>When set to FALSE (or not specified), you <i>must</i> specify a list of destination IP addresses that cannot receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group.</p> <p>The default value is FALSE.</p>",
"EndpointConfiguration$ClientIPPreservationEnabled": "<p>Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for Application Load Balancer endpoints. </p> <p>If the value is set to true, the client's IP address is preserved in the <code>X-Forwarded-For</code> request header as traffic travels to applications on the endpoint fronted by the accelerator.</p> <p>Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers, Amazon EC2 instances, and Network Load Balancers with security groups. IMPORTANT: You cannot use client IP address preservation with Network Load Balancers with TLS listeners.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html\"> Preserve client IP addresses in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>",
"EndpointDescription$ClientIPPreservationEnabled": "<p>Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for Application Load Balancers endpoints. </p> <p>If the value is set to true, the client's IP address is preserved in the <code>X-Forwarded-For</code> request header as traffic travels to applications on the endpoint fronted by the accelerator.</p> <p>Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers, Amazon EC2 instances, and Network Load Balancers with security groups. IMPORTANT: You cannot use client IP address preservation with Network Load Balancers with TLS listeners.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html\"> Preserve client IP addresses in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>",
"EndpointIdentifier$ClientIPPreservationEnabled": "<p>Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. </p> <p>If the value is set to true, the client's IP address is preserved in the <code>X-Forwarded-For</code> request header as traffic travels to applications on the endpoint fronted by the accelerator.</p>",
"UpdateAcceleratorAttributesRequest$FlowLogsEnabled": "<p>Update whether flow logs are enabled. The default value is false. If the value is true, <code>FlowLogsS3Bucket</code> and <code>FlowLogsS3Prefix</code> must be specified.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html\">Flow Logs</a> in the <i>Global Accelerator Developer Guide</i>.</p>",
"UpdateAcceleratorRequest$Enabled": "<p>Indicates whether an accelerator is enabled. The value is true or false. The default value is true. </p> <p>If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.</p>",
"UpdateCustomRoutingAcceleratorAttributesRequest$FlowLogsEnabled": "<p>Update whether flow logs are enabled. The default value is false. If the value is true, <code>FlowLogsS3Bucket</code> and <code>FlowLogsS3Prefix</code> must be specified.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html\">Flow logs</a> in the <i>Global Accelerator Developer Guide</i>.</p>",
"UpdateCustomRoutingAcceleratorRequest$Enabled": "<p>Indicates whether an accelerator is enabled. The value is true or false. The default value is true. </p> <p>If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.</p>"
}
},
"GenericString": {
"base": null,
"refs": {
"Accelerator$AcceleratorArn": "<p>The Amazon Resource Name (ARN) of the accelerator.</p>",
"Accelerator$Name": "<p>The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.</p>",
"Accelerator$DnsName": "<p>The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.</p> <p>The naming convention for the DNS name for an accelerator is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.</p> <p>If you have a dual-stack accelerator, you also have a second DNS name, <code>DualStackDnsName</code>, that points to both the A record and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses.</p> <p>For more information about the default DNS name, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/dns-addressing-custom-domains.dns-addressing.html\"> Support for DNS addressing in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>",
"Accelerator$DualStackDnsName": "<p>The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses.</p> <p>The naming convention for the dual-stack DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .dualstack.awsglobalaccelerator.com. For example: a1234567890abcdef.dualstack.awsglobalaccelerator.com.</p> <p>Note: Global Accelerator also assigns a default DNS name, <code>DnsName</code>, to your accelerator that points just to the static IPv4 addresses. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/about-accelerators.html#about-accelerators.dns-addressing\"> Support for DNS addressing in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>",
"AcceleratorAttributes$FlowLogsS3Bucket": "<p>The name of the Amazon S3 bucket for the flow logs. Attribute is required if <code>FlowLogsEnabled</code> is <code>true</code>. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the bucket.</p>",
"AcceleratorAttributes$FlowLogsS3Prefix": "<p>The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if <code>FlowLogsEnabled</code> is <code>true</code>.</p> <p>If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:</p> <p>s3-bucket_name//AWSLogs/aws_account_id</p>",
"AcceleratorEvent$Message": "<p>A string that contains an <code>Event</code> message describing changes or errors when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.</p>",
"AddCustomRoutingEndpointsRequest$EndpointGroupArn": "<p>The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.</p>",
"AddCustomRoutingEndpointsResponse$EndpointGroupArn": "<p>The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.</p>",
"AddEndpointsRequest$EndpointGroupArn": "<p>The Amazon Resource Name (ARN) of the endpoint group.</p>",
"AddEndpointsResponse$EndpointGroupArn": "<p>The Amazon Resource Name (ARN) of the endpoint group.</p>",
"AdvertiseByoipCidrRequest$Cidr": "<p>The address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range.</p> <p> For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html\">Bring your own IP addresses (BYOIP)</a> in the Global Accelerator Developer Guide.</p>",
"AllowCustomRoutingTrafficRequest$EndpointGroupArn": "<p>The Amazon Resource Name (ARN) of the endpoint group.</p>",
"AllowCustomRoutingTrafficRequest$EndpointId": "<p>An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.</p>",
"Attachment$AttachmentArn": "<p>The Amazon Resource Name (ARN) of the cross-account attachment.</p>",
"ByoipCidr$Cidr": "<p>The address range, in CIDR notation.</p> <p> For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html\">Bring your own IP addresses (BYOIP)</a> in the Global Accelerator Developer Guide.</p>",
"ByoipCidrEvent$Message": "<p>A string that contains an <code>Event</code> message describing changes that you make in the status of an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).</p>",
"CidrAuthorizationContext$Message": "<p>The plain-text authorization message for the prefix and account.</p>",
"CidrAuthorizationContext$Signature": "<p>The signed authorization message for the prefix and account.</p>",
"CreateAcceleratorRequest$Name": "<p>The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period.</p>",
"CreateCustomRoutingAcceleratorRequest$Name": "<p>The name of a custom routing accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.</p>",
"CreateCustomRoutingEndpointGroupRequest$ListenerArn": "<p>The Amazon Resource Name (ARN) of the listener for a custom routing endpoint.</p>",
"CreateCustomRoutingEndpointGroupRequest$EndpointGroupRegion": "<p>The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.</p>",
"CreateCustomRoutingListenerRequest$AcceleratorArn": "<p>The Amazon Resource Name (ARN) of the accelerator for a custom routing listener.</p>",
"CreateEndpointGroupRequest$ListenerArn": "<p>The Amazon Resource Name (ARN) of the listener.</p>",
"CreateEndpointGroupRequest$EndpointGroupRegion": "<p>The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.</p>",
"CreateListenerRequest$AcceleratorArn": "<p>The Amazon Resource Name (ARN) of your accelerator.</p>",
"CrossAccountResource$EndpointId": "<p>The endpoint ID for the endpoint that is listed in a cross-account attachment and can be added to an accelerator by specified principals.</p>",
"CrossAccountResource$Cidr": "<p>An IP address range, in CIDR format, that is specified as an Amazon Web Services resource. The address must be provisioned and advertised in Global Accelerator by following the bring your own IP address (BYOIP) process for Global Accelerator.</p> <p> For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html\">Bring your own IP addresses (BYOIP)</a> in the Global Accelerator Developer Guide.</p>",
"CrossAccountResource$AttachmentArn": "<p>The Amazon Resource Name (ARN) of the cross-account attachment that specifies the resources (endpoints or CIDR range) that can be added to accelerators and principals that have permission to add them.</p>",
"CustomRoutingAccelerator$AcceleratorArn": "<p>The Amazon Resource Name (ARN) of the custom routing accelerator.</p>",
"CustomRoutingAccelerator$Name": "<p>The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.</p>",
"CustomRoutingAccelerator$DnsName": "<p>The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses. </p> <p>The naming convention for the DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.</p> <p>If you have a dual-stack accelerator, you also have a second DNS name, <code>DualStackDnsName</code>, that points to both the A record and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses.</p> <p>For more information about the default DNS name, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/dns-addressing-custom-domains.dns-addressing.html\"> Support for DNS addressing in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>",
"CustomRoutingAcceleratorAttributes$FlowLogsS3Bucket": "<p>The name of the Amazon S3 bucket for the flow logs. Attribute is required if <code>FlowLogsEnabled</code> is <code>true</code>. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the bucket.</p>",
"CustomRoutingAcceleratorAttributes$FlowLogsS3Prefix": "<p>The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if <code>FlowLogsEnabled</code> is <code>true</code>.</p> <p>If you don’t specify a prefix, the flow logs are stored in the root of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:</p> <p>DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id</p>",
"CustomRoutingEndpointConfiguration$EndpointId": "<p>An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID. </p>",
"CustomRoutingEndpointConfiguration$AttachmentArn": "<p>The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints.</p>",
"CustomRoutingEndpointDescription$EndpointId": "<p>An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID. </p>",
"CustomRoutingEndpointGroup$EndpointGroupArn": "<p>The Amazon Resource Name (ARN) of the endpoint group.</p>",
"CustomRoutingEndpointGroup$EndpointGroupRegion": "<p>The Amazon Web Services Region where the endpoint group is located.</p>",
"CustomRoutingListener$ListenerArn": "<p>The Amazon Resource Name (ARN) of the listener.</p>",
"DeleteAcceleratorRequest$AcceleratorArn": "<p>The Amazon Resource Name (ARN) of an accelerator.</p>",
"DeleteCrossAccountAttachmentRequest$AttachmentArn": "<p>The Amazon Resource Name (ARN) for the cross-account attachment to delete.</p>",
"DeleteCustomRoutingAcceleratorRequest$AcceleratorArn": "<p>The Amazon Resource Name (ARN) of the custom routing accelerator to delete.</p>",
"DeleteCustomRoutingEndpointGroupRequest$EndpointGroupArn": "<p>The Amazon Resource Name (ARN) of the endpoint group to delete.</p>",
"DeleteCustomRoutingListenerRequest$ListenerArn": "<p>The Amazon Resource Name (ARN) of the listener to delete.</p>",
"DeleteEndpointGroupRequest$EndpointGroupArn": "<p>The Amazon Resource Name (ARN) of the endpoint group to delete.</p>",
"DeleteListenerRequest$ListenerArn": "<p>The Amazon Resource Name (ARN) of the listener.</p>",
"DenyCustomRoutingTrafficRequest$EndpointGroupArn": "<p>The Amazon Resource Name (ARN) of the endpoint group.</p>",
"DenyCustomRoutingTrafficRequest$EndpointId": "<p>An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.</p>",
"DeprovisionByoipCidrRequest$Cidr": "<p>The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.</p> <p> For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html\">Bring your own IP addresses (BYOIP)</a> in the Global Accelerator Developer Guide.</p>",
"DescribeAcceleratorAttributesRequest$AcceleratorArn": "<p>The Amazon Resource Name (ARN) of the accelerator with the attributes that you want to describe.</p>",
"DescribeAcceleratorRequest$AcceleratorArn": "<p>The Amazon Resource Name (ARN) of the accelerator to describe.</p>",
"DescribeCrossAccountAttachmentRequest$AttachmentArn": "<p>The Amazon Resource Name (ARN) for the cross-account attachment to describe.</p>",
"DescribeCustomRoutingAcceleratorAttributesRequest$AcceleratorArn": "<p>The Amazon Resource Name (ARN) of the custom routing accelerator to describe the attributes for.</p>",
"DescribeCustomRoutingAcceleratorRequest$AcceleratorArn": "<p>The Amazon Resource Name (ARN) of the accelerator to describe.</p>",
"DescribeCustomRoutingEndpointGroupRequest$EndpointGroupArn": "<p>The Amazon Resource Name (ARN) of the endpoint group to describe.</p>",
"DescribeCustomRoutingListenerRequest$ListenerArn": "<p>The Amazon Resource Name (ARN) of the listener to describe.</p>",
"DescribeEndpointGroupRequest$EndpointGroupArn": "<p>The Amazon Resource Name (ARN) of the endpoint group to describe.</p>",
"DescribeListenerRequest$ListenerArn": "<p>The Amazon Resource Name (ARN) of the listener to describe.</p>",
"DestinationPortMapping$AcceleratorArn": "<p>The Amazon Resource Name (ARN) of the custom routing accelerator that you have port mappings for.</p>",
"DestinationPortMapping$EndpointGroupArn": "<p>The Amazon Resource Name (ARN) of the endpoint group.</p>",
"DestinationPortMapping$EndpointId": "<p>The ID for the virtual private cloud (VPC) subnet.</p>",
"DestinationPortMapping$EndpointGroupRegion": "<p>The Amazon Web Services Region for the endpoint group.</p>",
"EndpointConfiguration$EndpointId": "<p>An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. A resource must be valid and active when you add it as an endpoint.</p> <p>For cross-account endpoints, this must be the ARN of the resource.</p>",
"EndpointConfiguration$AttachmentArn": "<p>The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints.</p>",
"EndpointDescription$EndpointId": "<p>An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. </p> <p>An Application Load Balancer can be either internal or internet-facing.</p>",
"EndpointDescription$HealthReason": "<p>Returns a null result.</p>",
"EndpointGroup$EndpointGroupArn": "<p>The Amazon Resource Name (ARN) of the endpoint group.</p>",
"EndpointGroup$EndpointGroupRegion": "<p>The Amazon Web Services Region where the endpoint group is located.</p>",
"EndpointIdentifier$EndpointId": "<p>An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. </p> <p>An Application Load Balancer can be either internal or internet-facing.</p>",
"EndpointIds$member": null,
"IpSet$IpFamily": "<p>IpFamily is deprecated and has been replaced by IpAddressFamily.</p>",
"ListAcceleratorsRequest$NextToken": "<p>The token for the next set of results. You receive this token from a previous call.</p>",
"ListAcceleratorsResponse$NextToken": "<p>The token for the next set of results. You receive this token from a previous call.</p>",
"ListByoipCidrsRequest$NextToken": "<p>The token for the next page of results.</p>",
"ListByoipCidrsResponse$NextToken": "<p>The token for the next page of results.</p>",
"ListCrossAccountAttachmentsRequest$NextToken": "<p>The token for the next set of results. You receive this token from a previous call.</p>",
"ListCrossAccountAttachmentsResponse$NextToken": "<p>The token for the next set of results. You receive this token from a previous call.</p>",
"ListCrossAccountResourcesRequest$AcceleratorArn": "<p>The Amazon Resource Name (ARN) of an accelerator in a cross-account attachment.</p>",
"ListCrossAccountResourcesRequest$NextToken": "<p>The token for the next set of results. You receive this token from a previous call.</p>",
"ListCrossAccountResourcesResponse$NextToken": "<p>The token for the next set of results. You receive this token from a previous call.</p>",
"ListCustomRoutingAcceleratorsRequest$NextToken": "<p>The token for the next set of results. You receive this token from a previous call.</p>",
"ListCustomRoutingAcceleratorsResponse$NextToken": "<p>The token for the next set of results. You receive this token from a previous call.</p>",
"ListCustomRoutingEndpointGroupsRequest$ListenerArn": "<p>The Amazon Resource Name (ARN) of the listener to list endpoint groups for.</p>",
"ListCustomRoutingEndpointGroupsRequest$NextToken": "<p>The token for the next set of results. You receive this token from a previous call.</p>",
"ListCustomRoutingEndpointGroupsResponse$NextToken": "<p>The token for the next set of results. You receive this token from a previous call.</p>",
"ListCustomRoutingListenersRequest$AcceleratorArn": "<p>The Amazon Resource Name (ARN) of the accelerator to list listeners for.</p>",
"ListCustomRoutingListenersRequest$NextToken": "<p>The token for the next set of results. You receive this token from a previous call.</p>",
"ListCustomRoutingListenersResponse$NextToken": "<p>The token for the next set of results. You receive this token from a previous call.</p>",
"ListCustomRoutingPortMappingsByDestinationRequest$EndpointId": "<p>The ID for the virtual private cloud (VPC) subnet.</p>",
"ListCustomRoutingPortMappingsByDestinationRequest$DestinationAddress": "<p>The endpoint IP address in a virtual private cloud (VPC) subnet for which you want to receive back port mappings.</p>",
"ListCustomRoutingPortMappingsByDestinationRequest$NextToken": "<p>The token for the next set of results. You receive this token from a previous call.</p>",
"ListCustomRoutingPortMappingsByDestinationResponse$NextToken": "<p>The token for the next set of results. You receive this token from a previous call.</p>",
"ListCustomRoutingPortMappingsRequest$AcceleratorArn": "<p>The Amazon Resource Name (ARN) of the accelerator to list the custom routing port mappings for.</p>",
"ListCustomRoutingPortMappingsRequest$EndpointGroupArn": "<p>The Amazon Resource Name (ARN) of the endpoint group to list the custom routing port mappings for.</p>",
"ListCustomRoutingPortMappingsRequest$NextToken": "<p>The token for the next set of results. You receive this token from a previous call.</p>",
"ListCustomRoutingPortMappingsResponse$NextToken": "<p>The token for the next set of results. You receive this token from a previous call.</p>",
"ListEndpointGroupsRequest$ListenerArn": "<p>The Amazon Resource Name (ARN) of the listener.</p>",
"ListEndpointGroupsRequest$NextToken": "<p>The token for the next set of results. You receive this token from a previous call.</p>",
"ListEndpointGroupsResponse$NextToken": "<p>The token for the next set of results. You receive this token from a previous call.</p>",
"ListListenersRequest$AcceleratorArn": "<p>The Amazon Resource Name (ARN) of the accelerator for which you want to list listener objects.</p>",
"ListListenersRequest$NextToken": "<p>The token for the next set of results. You receive this token from a previous call.</p>",
"ListListenersResponse$NextToken": "<p>The token for the next set of results. You receive this token from a previous call.</p>",
"Listener$ListenerArn": "<p>The Amazon Resource Name (ARN) of the listener.</p>",
"PortMapping$EndpointGroupArn": "<p>The Amazon Resource Name (ARN) of the endpoint group.</p>",
"PortMapping$EndpointId": "<p>The IP address of the VPC subnet (the subnet ID).</p>",
"ProvisionByoipCidrRequest$Cidr": "<p>The public IPv4 address range, in CIDR notation. The most specific IP prefix that you can specify is /24. The address range cannot overlap with another address range that you've brought to this Amazon Web Services Region or another Region.</p> <p> For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html\">Bring your own IP addresses (BYOIP)</a> in the Global Accelerator Developer Guide.</p>",
"RemoveCustomRoutingEndpointsRequest$EndpointGroupArn": "<p>The Amazon Resource Name (ARN) of the endpoint group to remove endpoints from.</p>",
"RemoveEndpointsRequest$EndpointGroupArn": "<p>The Amazon Resource Name (ARN) of the endpoint group.</p>",
"Resource$EndpointId": "<p>The endpoint ID for the endpoint that is specified as a Amazon Web Services resource. </p> <p>An endpoint ID for the cross-account feature is the ARN of an Amazon Web Services resource, such as a Network Load Balancer, that Global Accelerator supports as an endpoint for an accelerator.</p>",
"Resource$Cidr": "<p>An IP address range, in CIDR format, that is specified as resource. The address must be provisioned and advertised in Global Accelerator by following the bring your own IP address (BYOIP) process for Global Accelerator</p> <p> For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html\">Bring your own IP addresses (BYOIP)</a> in the Global Accelerator Developer Guide.</p>",
"Resource$Region": "<p>The Amazon Web Services Region where a shared endpoint resource is located.</p>",
"SocketAddress$IpAddress": "<p>The IP address for the socket address.</p>",
"UpdateAcceleratorAttributesRequest$AcceleratorArn": "<p>The Amazon Resource Name (ARN) of the accelerator that you want to update.</p>",
"UpdateAcceleratorAttributesRequest$FlowLogsS3Bucket": "<p>The name of the Amazon S3 bucket for the flow logs. Attribute is required if <code>FlowLogsEnabled</code> is <code>true</code>. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the bucket.</p>",
"UpdateAcceleratorAttributesRequest$FlowLogsS3Prefix": "<p>Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if <code>FlowLogsEnabled</code> is <code>true</code>. </p> <p>If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:</p> <p>s3-bucket_name//AWSLogs/aws_account_id</p>",
"UpdateAcceleratorRequest$AcceleratorArn": "<p>The Amazon Resource Name (ARN) of the accelerator to update.</p>",
"UpdateAcceleratorRequest$Name": "<p>The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period.</p>",
"UpdateCrossAccountAttachmentRequest$AttachmentArn": "<p>The Amazon Resource Name (ARN) of the cross-account attachment to update.</p>",
"UpdateCustomRoutingAcceleratorAttributesRequest$AcceleratorArn": "<p>The Amazon Resource Name (ARN) of the custom routing accelerator to update attributes for.</p>",
"UpdateCustomRoutingAcceleratorAttributesRequest$FlowLogsS3Bucket": "<p>The name of the Amazon S3 bucket for the flow logs. Attribute is required if <code>FlowLogsEnabled</code> is <code>true</code>. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the bucket.</p>",
"UpdateCustomRoutingAcceleratorAttributesRequest$FlowLogsS3Prefix": "<p>Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if <code>FlowLogsEnabled</code> is <code>true</code>. </p> <p>If you don’t specify a prefix, the flow logs are stored in the root of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:</p> <p>DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id</p>",
"UpdateCustomRoutingAcceleratorRequest$AcceleratorArn": "<p>The Amazon Resource Name (ARN) of the accelerator to update.</p>",
"UpdateCustomRoutingAcceleratorRequest$Name": "<p>The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period.</p>",
"UpdateCustomRoutingListenerRequest$ListenerArn": "<p>The Amazon Resource Name (ARN) of the listener to update.</p>",
"UpdateEndpointGroupRequest$EndpointGroupArn": "<p>The Amazon Resource Name (ARN) of the endpoint group.</p>",
"UpdateListenerRequest$ListenerArn": "<p>The Amazon Resource Name (ARN) of the listener to update.</p>",
"WithdrawByoipCidrRequest$Cidr": "<p>The address range, in CIDR notation.</p> <p> For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html\">Bring your own IP addresses (BYOIP)</a> in the Global Accelerator Developer Guide.</p>"
}
},
"HealthCheckIntervalSeconds": {
"base": null,
"refs": {
"CreateEndpointGroupRequest$HealthCheckIntervalSeconds": "<p>The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.</p>",
"EndpointGroup$HealthCheckIntervalSeconds": "<p>The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.</p>",
"UpdateEndpointGroupRequest$HealthCheckIntervalSeconds": "<p>The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.</p>"
}
},
"HealthCheckPath": {
"base": null,
"refs": {
"CreateEndpointGroupRequest$HealthCheckPath": "<p>If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).</p>",
"EndpointGroup$HealthCheckPath": "<p>If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).</p>",
"UpdateEndpointGroupRequest$HealthCheckPath": "<p>If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).</p>"
}
},
"HealthCheckPort": {
"base": null,
"refs": {
"CreateEndpointGroupRequest$HealthCheckPort": "<p>The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list.</p>",
"EndpointGroup$HealthCheckPort": "<p>The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. </p> <p>The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.</p>",
"UpdateEndpointGroupRequest$HealthCheckPort": "<p>The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses the first port in the list.</p>"
}
},
"HealthCheckProtocol": {
"base": null,
"refs": {
"CreateEndpointGroupRequest$HealthCheckProtocol": "<p>The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.</p>",
"EndpointGroup$HealthCheckProtocol": "<p>The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.</p>",
"UpdateEndpointGroupRequest$HealthCheckProtocol": "<p>The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.</p>"
}
},
"HealthState": {
"base": null,
"refs": {
"EndpointDescription$HealthState": "<p>The health status of the endpoint.</p>"
}
},
"IdempotencyToken": {
"base": null,
"refs": {
"CreateAcceleratorRequest$IdempotencyToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an accelerator.</p>",
"CreateCrossAccountAttachmentRequest$IdempotencyToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.</p>",
"CreateCustomRoutingAcceleratorRequest$IdempotencyToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.</p>",
"CreateCustomRoutingEndpointGroupRequest$IdempotencyToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.</p>",
"CreateCustomRoutingListenerRequest$IdempotencyToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.</p>",
"CreateEndpointGroupRequest$IdempotencyToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.</p>",
"CreateListenerRequest$IdempotencyToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.</p>"
}
},
"IncorrectCidrStateException": {
"base": "<p>The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be incorrect for this action.</p>",
"refs": {
}
},
"InternalServiceErrorException": {
"base": "<p>There was an internal error for Global Accelerator.</p>",
"refs": {
}
},
"InvalidArgumentException": {
"base": "<p>An argument that you specified is invalid.</p>",
"refs": {
}
},
"InvalidNextTokenException": {
"base": "<p>There isn't another item to return.</p>",
"refs": {
}
},
"InvalidPortRangeException": {
"base": "<p>The port numbers that you specified are not valid numbers or are not unique for this accelerator.</p>",
"refs": {
}
},
"IpAddress": {
"base": null,
"refs": {
"DestinationAddresses$member": null,
"IpAddresses$member": null
}
},
"IpAddressFamily": {
"base": null,
"refs": {
"IpSet$IpAddressFamily": "<p>The types of IP addresses included in this IP set. </p>"
}
},
"IpAddressType": {
"base": null,
"refs": {
"Accelerator$IpAddressType": "<p>The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.</p>",
"CreateAcceleratorRequest$IpAddressType": "<p>The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.</p>",
"CreateCustomRoutingAcceleratorRequest$IpAddressType": "<p>The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.</p>",
"CustomRoutingAccelerator$IpAddressType": "<p>The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.</p>",
"DestinationPortMapping$IpAddressType": "<p>The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.</p>",
"UpdateAcceleratorRequest$IpAddressType": "<p>The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.</p>",
"UpdateCustomRoutingAcceleratorRequest$IpAddressType": "<p>The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.</p>"
}