forked from aws/aws-sdk-js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdirectconnect-2012-10-25.normal.json
1344 lines (1344 loc) · 60.3 KB
/
directconnect-2012-10-25.normal.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version":"2.0",
"metadata":{
"apiVersion":"2012-10-25",
"endpointPrefix":"directconnect",
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"AWS Direct Connect",
"signatureVersion":"v4",
"targetPrefix":"OvertureService",
"uid":"directconnect-2012-10-25"
},
"operations":{
"AllocateConnectionOnInterconnect":{
"name":"AllocateConnectionOnInterconnect",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AllocateConnectionOnInterconnectRequest"},
"output":{"shape":"Connection"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Creates a hosted connection on an interconnect.</p> <p>Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the given interconnect.</p> <note> <p>This is intended for use by AWS Direct Connect partners only.</p> </note>"
},
"AllocatePrivateVirtualInterface":{
"name":"AllocatePrivateVirtualInterface",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AllocatePrivateVirtualInterfaceRequest"},
"output":{"shape":"VirtualInterface"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Provisions a private virtual interface to be owned by a different customer.</p> <p>The owner of a connection calls this function to provision a private virtual interface which will be owned by another AWS customer.</p> <p>Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPrivateVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.</p>"
},
"AllocatePublicVirtualInterface":{
"name":"AllocatePublicVirtualInterface",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AllocatePublicVirtualInterfaceRequest"},
"output":{"shape":"VirtualInterface"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Provisions a public virtual interface to be owned by a different customer.</p> <p>The owner of a connection calls this function to provision a public virtual interface which will be owned by another AWS customer.</p> <p>Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.</p> <p>When creating an IPv6 public virtual interface (addressFamily is 'ipv6'), the customer and amazon address fields should be left blank to use auto-assigned IPv6 space. Custom IPv6 Addresses are currently not supported.</p>"
},
"ConfirmConnection":{
"name":"ConfirmConnection",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ConfirmConnectionRequest"},
"output":{"shape":"ConfirmConnectionResponse"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Confirm the creation of a hosted connection on an interconnect.</p> <p>Upon creation, the hosted connection is initially in the 'Ordering' state, and will remain in this state until the owner calls ConfirmConnection to confirm creation of the hosted connection.</p>"
},
"ConfirmPrivateVirtualInterface":{
"name":"ConfirmPrivateVirtualInterface",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ConfirmPrivateVirtualInterfaceRequest"},
"output":{"shape":"ConfirmPrivateVirtualInterfaceResponse"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Accept ownership of a private virtual interface created by another customer.</p> <p>After the virtual interface owner calls this function, the virtual interface will be created and attached to the given virtual private gateway, and will be available for handling traffic.</p>"
},
"ConfirmPublicVirtualInterface":{
"name":"ConfirmPublicVirtualInterface",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ConfirmPublicVirtualInterfaceRequest"},
"output":{"shape":"ConfirmPublicVirtualInterfaceResponse"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Accept ownership of a public virtual interface created by another customer.</p> <p>After the virtual interface owner calls this function, the specified virtual interface will be created and made available for handling traffic.</p>"
},
"CreateBGPPeer":{
"name":"CreateBGPPeer",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateBGPPeerRequest"},
"output":{"shape":"CreateBGPPeerResponse"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Creates a new BGP peer on a specified virtual interface. The BGP peer cannot be in the same address family (IPv4/IPv6) of an existing BGP peer on the virtual interface.</p> <p>You must create a BGP peer for the corresponding address family in order to access AWS resources that also use that address family.</p> <p>When creating a IPv6 BGP peer, the Amazon address and customer address fields must be left blank. IPv6 addresses are automatically assigned from Amazon's pool of IPv6 addresses; you cannot specify custom IPv6 addresses.</p> <p>For a public virtual interface, the Autonomous System Number (ASN) must be private or already whitelisted for the virtual interface.</p>"
},
"CreateConnection":{
"name":"CreateConnection",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateConnectionRequest"},
"output":{"shape":"Connection"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Creates a new connection between the customer network and a specific AWS Direct Connect location.</p> <p>A connection links your internal network to an AWS Direct Connect location over a standard 1 gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. An AWS Direct Connect location provides access to Amazon Web Services in the region it is associated with. You can establish connections with AWS Direct Connect locations in multiple regions, but a connection in one region does not provide connectivity to other regions.</p>"
},
"CreateInterconnect":{
"name":"CreateInterconnect",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateInterconnectRequest"},
"output":{"shape":"Interconnect"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location.</p> <p>An interconnect is a connection which is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide sub-1Gbps AWS Direct Connect service to tier 2 customers who do not have their own connections. Like a standard connection, an interconnect links the AWS Direct Connect partner's network to an AWS Direct Connect location over a standard 1 Gbps or 10 Gbps Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router.</p> <p>For each end customer, the AWS Direct Connect partner provisions a connection on their interconnect by calling AllocateConnectionOnInterconnect. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect partner.</p> <note> <p>This is intended for use by AWS Direct Connect partners only.</p> </note>"
},
"CreatePrivateVirtualInterface":{
"name":"CreatePrivateVirtualInterface",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreatePrivateVirtualInterfaceRequest"},
"output":{"shape":"VirtualInterface"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Creates a new private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface supports sending traffic to a single virtual private cloud (VPC).</p>"
},
"CreatePublicVirtualInterface":{
"name":"CreatePublicVirtualInterface",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreatePublicVirtualInterfaceRequest"},
"output":{"shape":"VirtualInterface"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Creates a new public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon Simple Storage Service (Amazon S3).</p> <p>When creating an IPv6 public virtual interface (addressFamily is 'ipv6'), the customer and amazon address fields should be left blank to use auto-assigned IPv6 space. Custom IPv6 Addresses are currently not supported.</p>"
},
"DeleteBGPPeer":{
"name":"DeleteBGPPeer",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteBGPPeerRequest"},
"output":{"shape":"DeleteBGPPeerResponse"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Deletes a BGP peer on the specified virtual interface that matches the specified customer address and ASN. You cannot delete the last BGP peer from a virtual interface.</p>"
},
"DeleteConnection":{
"name":"DeleteConnection",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteConnectionRequest"},
"output":{"shape":"Connection"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Deletes the connection.</p> <p>Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. You need to cancel separately with the providers any services or charges for cross-connects or network circuits that connect you to the AWS Direct Connect location.</p>"
},
"DeleteInterconnect":{
"name":"DeleteInterconnect",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteInterconnectRequest"},
"output":{"shape":"DeleteInterconnectResponse"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Deletes the specified interconnect.</p> <note> <p>This is intended for use by AWS Direct Connect partners only.</p> </note>"
},
"DeleteVirtualInterface":{
"name":"DeleteVirtualInterface",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteVirtualInterfaceRequest"},
"output":{"shape":"DeleteVirtualInterfaceResponse"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Deletes a virtual interface.</p>"
},
"DescribeConnectionLoa":{
"name":"DescribeConnectionLoa",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeConnectionLoaRequest"},
"output":{"shape":"DescribeConnectionLoaResponse"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Returns the LOA-CFA for a Connection.</p> <p>The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or service provider uses when establishing your cross connect to AWS at the colocation facility. For more information, see <a href=\"http://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html\">Requesting Cross Connects at AWS Direct Connect Locations</a> in the AWS Direct Connect user guide.</p>"
},
"DescribeConnections":{
"name":"DescribeConnections",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeConnectionsRequest"},
"output":{"shape":"Connections"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Displays all connections in this region.</p> <p>If a connection ID is provided, the call returns only that particular connection.</p>"
},
"DescribeConnectionsOnInterconnect":{
"name":"DescribeConnectionsOnInterconnect",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeConnectionsOnInterconnectRequest"},
"output":{"shape":"Connections"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Return a list of connections that have been provisioned on the given interconnect.</p> <note> <p>This is intended for use by AWS Direct Connect partners only.</p> </note>"
},
"DescribeInterconnectLoa":{
"name":"DescribeInterconnectLoa",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeInterconnectLoaRequest"},
"output":{"shape":"DescribeInterconnectLoaResponse"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Returns the LOA-CFA for an Interconnect.</p> <p>The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see <a href=\"http://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html\">Requesting Cross Connects at AWS Direct Connect Locations</a> in the AWS Direct Connect user guide.</p>"
},
"DescribeInterconnects":{
"name":"DescribeInterconnects",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeInterconnectsRequest"},
"output":{"shape":"Interconnects"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Returns a list of interconnects owned by the AWS account.</p> <p>If an interconnect ID is provided, it will only return this particular interconnect.</p>"
},
"DescribeLocations":{
"name":"DescribeLocations",
"http":{
"method":"POST",
"requestUri":"/"
},
"output":{"shape":"Locations"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect.</p>"
},
"DescribeTags":{
"name":"DescribeTags",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeTagsRequest"},
"output":{"shape":"DescribeTagsResponse"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Describes the tags associated with the specified Direct Connect resources.</p>"
},
"DescribeVirtualGateways":{
"name":"DescribeVirtualGateways",
"http":{
"method":"POST",
"requestUri":"/"
},
"output":{"shape":"VirtualGateways"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Returns a list of virtual private gateways owned by the AWS account.</p> <p>You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateVpnGateway.html\">EC2 CreateVpnGateway</a> action.</p>"
},
"DescribeVirtualInterfaces":{
"name":"DescribeVirtualInterfaces",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeVirtualInterfacesRequest"},
"output":{"shape":"VirtualInterfaces"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also returned. If a connection ID is included then only virtual interfaces associated with this connection will be returned. If a virtual interface ID is included then only a single virtual interface will be returned.</p> <p>A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.</p> <p>If a connection ID is provided, only virtual interfaces provisioned on the specified connection will be returned. If a virtual interface ID is provided, only this particular virtual interface will be returned.</p>"
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"DuplicateTagKeysException"},
{"shape":"TooManyTagsException"},
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Adds the specified tags to the specified Direct Connect resource. Each Direct Connect resource can have a maximum of 50 tags.</p> <p>Each tag consists of a key and an optional value. If a tag with the same key is already associated with the Direct Connect resource, this action updates its value.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Removes one or more tags from the specified Direct Connect resource.</p>"
}
},
"shapes":{
"ASN":{
"type":"integer",
"documentation":"<p>Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.</p> <p>Example: 65000</p>"
},
"AddressFamily":{
"type":"string",
"documentation":"<p>Indicates the address family for the BGP peer.</p> <ul> <li> <p> <b>ipv4</b>: IPv4 address family</p> </li> <li> <p> <b>ipv6</b>: IPv6 address family</p> </li> </ul>",
"enum":[
"ipv4",
"ipv6"
]
},
"AllocateConnectionOnInterconnectRequest":{
"type":"structure",
"required":[
"bandwidth",
"connectionName",
"ownerAccount",
"interconnectId",
"vlan"
],
"members":{
"bandwidth":{
"shape":"Bandwidth",
"documentation":"<p>Bandwidth of the connection.</p> <p>Example: \"<i>500Mbps</i>\"</p> <p>Default: None</p> <p>Values: 50M, 100M, 200M, 300M, 400M, or 500M</p>"
},
"connectionName":{
"shape":"ConnectionName",
"documentation":"<p>Name of the provisioned connection.</p> <p>Example: \"<i>500M Connection to AWS</i>\"</p> <p>Default: None</p>"
},
"ownerAccount":{
"shape":"OwnerAccount",
"documentation":"<p>Numeric account Id of the customer for whom the connection will be provisioned.</p> <p>Example: 123443215678</p> <p>Default: None</p>"
},
"interconnectId":{
"shape":"InterconnectId",
"documentation":"<p>ID of the interconnect on which the connection will be provisioned.</p> <p>Example: dxcon-456abc78</p> <p>Default: None</p>"
},
"vlan":{
"shape":"VLAN",
"documentation":"<p>The dedicated VLAN provisioned to the connection.</p> <p>Example: 101</p> <p>Default: None</p>"
}
},
"documentation":"<p>Container for the parameters to the AllocateConnectionOnInterconnect operation.</p>"
},
"AllocatePrivateVirtualInterfaceRequest":{
"type":"structure",
"required":[
"connectionId",
"ownerAccount",
"newPrivateVirtualInterfaceAllocation"
],
"members":{
"connectionId":{
"shape":"ConnectionId",
"documentation":"<p>The connection ID on which the private virtual interface is provisioned.</p> <p>Default: None</p>"
},
"ownerAccount":{
"shape":"OwnerAccount",
"documentation":"<p>The AWS account that will own the new private virtual interface.</p> <p>Default: None</p>"
},
"newPrivateVirtualInterfaceAllocation":{
"shape":"NewPrivateVirtualInterfaceAllocation",
"documentation":"<p>Detailed information for the private virtual interface to be provisioned.</p> <p>Default: None</p>"
}
},
"documentation":"<p>Container for the parameters to the AllocatePrivateVirtualInterface operation.</p>"
},
"AllocatePublicVirtualInterfaceRequest":{
"type":"structure",
"required":[
"connectionId",
"ownerAccount",
"newPublicVirtualInterfaceAllocation"
],
"members":{
"connectionId":{
"shape":"ConnectionId",
"documentation":"<p>The connection ID on which the public virtual interface is provisioned.</p> <p>Default: None</p>"
},
"ownerAccount":{
"shape":"OwnerAccount",
"documentation":"<p>The AWS account that will own the new public virtual interface.</p> <p>Default: None</p>"
},
"newPublicVirtualInterfaceAllocation":{
"shape":"NewPublicVirtualInterfaceAllocation",
"documentation":"<p>Detailed information for the public virtual interface to be provisioned.</p> <p>Default: None</p>"
}
},
"documentation":"<p>Container for the parameters to the AllocatePublicVirtualInterface operation.</p>"
},
"AmazonAddress":{
"type":"string",
"documentation":"<p>IP address assigned to the Amazon interface.</p> <p>Example: 192.168.1.1/30 or 2001:db8::1/125</p>"
},
"BGPAuthKey":{
"type":"string",
"documentation":"<p>Authentication key for BGP configuration.</p> <p>Example: asdf34example</p>"
},
"BGPPeer":{
"type":"structure",
"members":{
"asn":{"shape":"ASN"},
"authKey":{"shape":"BGPAuthKey"},
"addressFamily":{"shape":"AddressFamily"},
"amazonAddress":{"shape":"AmazonAddress"},
"customerAddress":{"shape":"CustomerAddress"},
"bgpPeerState":{"shape":"BGPPeerState"},
"bgpStatus":{"shape":"BGPStatus"}
},
"documentation":"<p>A structure containing information about a BGP peer.</p>"
},
"BGPPeerList":{
"type":"list",
"member":{"shape":"BGPPeer"},
"documentation":"<p>A list of the BGP peers configured on this virtual interface.</p>"
},
"BGPPeerState":{
"type":"string",
"documentation":"<p>The state of the BGP peer.</p> <ul> <li> <p> <b>Verifying</b>: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state only applies to BGP peers on a public virtual interface. </p> </li> <li> <p> <b>Pending</b>: The BGP peer has been created, and is in this state until it is ready to be established.</p> </li> <li> <p> <b>Available</b>: The BGP peer can be established.</p> </li> <li> <p> <b>Deleting</b>: The BGP peer is in the process of being deleted.</p> </li> <li> <p> <b>Deleted</b>: The BGP peer has been deleted and cannot be established.</p> </li> </ul>",
"enum":[
"verifying",
"pending",
"available",
"deleting",
"deleted"
]
},
"BGPStatus":{
"type":"string",
"documentation":"<p>The Up/Down state of the BGP peer.</p> <ul> <li> <p> <b>Up</b>: The BGP peer is established.</p> </li> <li> <p> <b>Down</b>: The BGP peer is down.</p> </li> </ul>",
"enum":[
"up",
"down"
]
},
"Bandwidth":{
"type":"string",
"documentation":"<p>Bandwidth of the connection.</p> <p>Example: 1Gbps</p> <p>Default: None</p>"
},
"CIDR":{"type":"string"},
"ConfirmConnectionRequest":{
"type":"structure",
"required":["connectionId"],
"members":{
"connectionId":{"shape":"ConnectionId"}
},
"documentation":"<p>Container for the parameters to the ConfirmConnection operation.</p>"
},
"ConfirmConnectionResponse":{
"type":"structure",
"members":{
"connectionState":{"shape":"ConnectionState"}
},
"documentation":"<p>The response received when ConfirmConnection is called.</p>"
},
"ConfirmPrivateVirtualInterfaceRequest":{
"type":"structure",
"required":[
"virtualInterfaceId",
"virtualGatewayId"
],
"members":{
"virtualInterfaceId":{"shape":"VirtualInterfaceId"},
"virtualGatewayId":{
"shape":"VirtualGatewayId",
"documentation":"<p>ID of the virtual private gateway that will be attached to the virtual interface.</p> <p> A virtual private gateway can be managed via the Amazon Virtual Private Cloud (VPC) console or the <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateVpnGateway.html\">EC2 CreateVpnGateway</a> action.</p> <p>Default: None</p>"
}
},
"documentation":"<p>Container for the parameters to the ConfirmPrivateVirtualInterface operation.</p>"
},
"ConfirmPrivateVirtualInterfaceResponse":{
"type":"structure",
"members":{
"virtualInterfaceState":{"shape":"VirtualInterfaceState"}
},
"documentation":"<p>The response received when ConfirmPrivateVirtualInterface is called.</p>"
},
"ConfirmPublicVirtualInterfaceRequest":{
"type":"structure",
"required":["virtualInterfaceId"],
"members":{
"virtualInterfaceId":{"shape":"VirtualInterfaceId"}
},
"documentation":"<p>Container for the parameters to the ConfirmPublicVirtualInterface operation.</p>"
},
"ConfirmPublicVirtualInterfaceResponse":{
"type":"structure",
"members":{
"virtualInterfaceState":{"shape":"VirtualInterfaceState"}
},
"documentation":"<p>The response received when ConfirmPublicVirtualInterface is called.</p>"
},
"Connection":{
"type":"structure",
"members":{
"ownerAccount":{
"shape":"OwnerAccount",
"documentation":"<p>The AWS account that will own the new connection.</p>"
},
"connectionId":{"shape":"ConnectionId"},
"connectionName":{"shape":"ConnectionName"},
"connectionState":{"shape":"ConnectionState"},
"region":{"shape":"Region"},
"location":{"shape":"LocationCode"},
"bandwidth":{
"shape":"Bandwidth",
"documentation":"<p>Bandwidth of the connection.</p> <p>Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)</p> <p>Default: None</p>"
},
"vlan":{"shape":"VLAN"},
"partnerName":{
"shape":"PartnerName",
"documentation":"<p>The name of the AWS Direct Connect service provider associated with the connection.</p>"
},
"loaIssueTime":{
"shape":"LoaIssueTime",
"documentation":"<p>The time of the most recent call to DescribeConnectionLoa for this Connection.</p>"
}
},
"documentation":"<p>A connection represents the physical network connection between the AWS Direct Connect location and the customer.</p>"
},
"ConnectionId":{
"type":"string",
"documentation":"<p>ID of the connection.</p> <p>Example: dxcon-fg5678gh</p> <p>Default: None</p>"
},
"ConnectionList":{
"type":"list",
"member":{"shape":"Connection"},
"documentation":"<p>A list of connections.</p>"
},
"ConnectionName":{
"type":"string",
"documentation":"<p>The name of the connection.</p> <p>Example: \"<i>My Connection to AWS</i>\"</p> <p>Default: None</p>"
},
"ConnectionState":{
"type":"string",
"documentation":"<p>State of the connection.</p> <ul> <li> <p> <b>Ordering</b>: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.</p> </li> <li> <p> <b>Requested</b>: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.</p> </li> <li> <p> <b>Pending</b>: The connection has been approved, and is being initialized.</p> </li> <li> <p> <b>Available</b>: The network link is up, and the connection is ready for use.</p> </li> <li> <p> <b>Down</b>: The network link is down.</p> </li> <li> <p> <b>Deleting</b>: The connection is in the process of being deleted.</p> </li> <li> <p> <b>Deleted</b>: The connection has been deleted.</p> </li> <li> <p> <b>Rejected</b>: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.</p> </li> </ul>",
"enum":[
"ordering",
"requested",
"pending",
"available",
"down",
"deleting",
"deleted",
"rejected"
]
},
"Connections":{
"type":"structure",
"members":{
"connections":{
"shape":"ConnectionList",
"documentation":"<p>A list of connections.</p>"
}
},
"documentation":"<p>A structure containing a list of connections.</p>"
},
"CreateBGPPeerRequest":{
"type":"structure",
"members":{
"virtualInterfaceId":{
"shape":"VirtualInterfaceId",
"documentation":"<p>The ID of the virtual interface on which the BGP peer will be provisioned.</p> <p>Example: dxvif-456abc78</p> <p>Default: None</p>"
},
"newBGPPeer":{
"shape":"NewBGPPeer",
"documentation":"<p>Detailed information for the BGP peer to be created.</p> <p>Default: None</p>"
}
},
"documentation":"<p>Container for the parameters to the CreateBGPPeer operation.</p>"
},
"CreateBGPPeerResponse":{
"type":"structure",
"members":{
"virtualInterface":{"shape":"VirtualInterface"}
},
"documentation":"<p>The response received when CreateBGPPeer is called.</p>"
},
"CreateConnectionRequest":{
"type":"structure",
"required":[
"location",
"bandwidth",
"connectionName"
],
"members":{
"location":{"shape":"LocationCode"},
"bandwidth":{"shape":"Bandwidth"},
"connectionName":{"shape":"ConnectionName"}
},
"documentation":"<p>Container for the parameters to the CreateConnection operation.</p>"
},
"CreateInterconnectRequest":{
"type":"structure",
"required":[
"interconnectName",
"bandwidth",
"location"
],
"members":{
"interconnectName":{
"shape":"InterconnectName",
"documentation":"<p>The name of the interconnect.</p> <p>Example: \"<i>1G Interconnect to AWS</i>\"</p> <p>Default: None</p>"
},
"bandwidth":{
"shape":"Bandwidth",
"documentation":"<p>The port bandwidth</p> <p>Example: 1Gbps</p> <p>Default: None</p> <p>Available values: 1Gbps,10Gbps</p>"
},
"location":{
"shape":"LocationCode",
"documentation":"<p>Where the interconnect is located</p> <p>Example: EqSV5</p> <p>Default: None</p>"
}
},
"documentation":"<p>Container for the parameters to the CreateInterconnect operation.</p>"
},
"CreatePrivateVirtualInterfaceRequest":{
"type":"structure",
"required":[
"connectionId",
"newPrivateVirtualInterface"
],
"members":{
"connectionId":{"shape":"ConnectionId"},
"newPrivateVirtualInterface":{
"shape":"NewPrivateVirtualInterface",
"documentation":"<p>Detailed information for the private virtual interface to be created.</p> <p>Default: None</p>"
}
},
"documentation":"<p>Container for the parameters to the CreatePrivateVirtualInterface operation.</p>"
},
"CreatePublicVirtualInterfaceRequest":{
"type":"structure",
"required":[
"connectionId",
"newPublicVirtualInterface"
],
"members":{
"connectionId":{"shape":"ConnectionId"},
"newPublicVirtualInterface":{
"shape":"NewPublicVirtualInterface",
"documentation":"<p>Detailed information for the public virtual interface to be created.</p> <p>Default: None</p>"
}
},
"documentation":"<p>Container for the parameters to the CreatePublicVirtualInterface operation.</p>"
},
"CustomerAddress":{
"type":"string",
"documentation":"<p>IP address assigned to the customer interface.</p> <p>Example: 192.168.1.2/30 or 2001:db8::2/125</p>"
},
"DeleteBGPPeerRequest":{
"type":"structure",
"members":{
"virtualInterfaceId":{
"shape":"VirtualInterfaceId",
"documentation":"<p>The ID of the virtual interface from which the BGP peer will be deleted.</p> <p>Example: dxvif-456abc78</p> <p>Default: None</p>"
},
"asn":{"shape":"ASN"},
"customerAddress":{"shape":"CustomerAddress"}
},
"documentation":"<p>Container for the parameters to the DeleteBGPPeer operation.</p>"
},
"DeleteBGPPeerResponse":{
"type":"structure",
"members":{
"virtualInterface":{"shape":"VirtualInterface"}
},
"documentation":"<p>The response received when DeleteBGPPeer is called.</p>"
},
"DeleteConnectionRequest":{
"type":"structure",
"required":["connectionId"],
"members":{
"connectionId":{"shape":"ConnectionId"}
},
"documentation":"<p>Container for the parameters to the DeleteConnection operation.</p>"
},
"DeleteInterconnectRequest":{
"type":"structure",
"required":["interconnectId"],
"members":{
"interconnectId":{"shape":"InterconnectId"}
},
"documentation":"<p>Container for the parameters to the DeleteInterconnect operation.</p>"
},
"DeleteInterconnectResponse":{
"type":"structure",
"members":{
"interconnectState":{"shape":"InterconnectState"}
},
"documentation":"<p>The response received when DeleteInterconnect is called.</p>"
},
"DeleteVirtualInterfaceRequest":{
"type":"structure",
"required":["virtualInterfaceId"],
"members":{
"virtualInterfaceId":{"shape":"VirtualInterfaceId"}
},
"documentation":"<p>Container for the parameters to the DeleteVirtualInterface operation.</p>"
},
"DeleteVirtualInterfaceResponse":{
"type":"structure",
"members":{
"virtualInterfaceState":{"shape":"VirtualInterfaceState"}
},
"documentation":"<p>The response received when DeleteVirtualInterface is called.</p>"
},
"DescribeConnectionLoaRequest":{
"type":"structure",
"required":["connectionId"],
"members":{
"connectionId":{"shape":"ConnectionId"},
"providerName":{
"shape":"ProviderName",
"documentation":"<p>The name of the APN partner or service provider who establishes connectivity on your behalf. If you supply this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.</p> <p>Default: None</p>"
},
"loaContentType":{"shape":"LoaContentType"}
},
"documentation":"<p>Container for the parameters to the DescribeConnectionLoa operation.</p>"
},
"DescribeConnectionLoaResponse":{
"type":"structure",
"members":{
"loa":{"shape":"Loa"}
},
"documentation":"<p>The response received when DescribeConnectionLoa is called.</p>"
},
"DescribeConnectionsOnInterconnectRequest":{
"type":"structure",
"required":["interconnectId"],
"members":{
"interconnectId":{
"shape":"InterconnectId",
"documentation":"<p>ID of the interconnect on which a list of connection is provisioned.</p> <p>Example: dxcon-abc123</p> <p>Default: None</p>"
}
},
"documentation":"<p>Container for the parameters to the DescribeConnectionsOnInterconnect operation.</p>"
},
"DescribeConnectionsRequest":{
"type":"structure",
"members":{
"connectionId":{"shape":"ConnectionId"}
},
"documentation":"<p>Container for the parameters to the DescribeConnections operation.</p>"
},
"DescribeInterconnectLoaRequest":{
"type":"structure",
"required":["interconnectId"],
"members":{
"interconnectId":{"shape":"InterconnectId"},
"providerName":{
"shape":"ProviderName",
"documentation":"<p>The name of the service provider who establishes connectivity on your behalf. If you supply this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.</p> <p>Default: None</p>"
},
"loaContentType":{"shape":"LoaContentType"}
},
"documentation":"<p>Container for the parameters to the DescribeInterconnectLoa operation.</p>"
},
"DescribeInterconnectLoaResponse":{
"type":"structure",
"members":{
"loa":{"shape":"Loa"}
},
"documentation":"<p>The response received when DescribeInterconnectLoa is called.</p>"
},
"DescribeInterconnectsRequest":{
"type":"structure",
"members":{
"interconnectId":{"shape":"InterconnectId"}
},
"documentation":"<p>Container for the parameters to the DescribeInterconnects operation.</p>"
},
"DescribeTagsRequest":{
"type":"structure",
"required":["resourceArns"],
"members":{
"resourceArns":{
"shape":"ResourceArnList",
"documentation":"<p>The Amazon Resource Names (ARNs) of the Direct Connect resources.</p>"
}
},
"documentation":"<p>Container for the parameters to the DescribeTags operation.</p>"
},
"DescribeTagsResponse":{
"type":"structure",
"members":{
"resourceTags":{
"shape":"ResourceTagList",
"documentation":"<p>Information about the tags.</p>"
}
},
"documentation":"<p>The response received when DescribeTags is called.</p>"
},
"DescribeVirtualInterfacesRequest":{
"type":"structure",
"members":{
"connectionId":{"shape":"ConnectionId"},
"virtualInterfaceId":{"shape":"VirtualInterfaceId"}
},
"documentation":"<p>Container for the parameters to the DescribeVirtualInterfaces operation.</p>"
},
"DirectConnectClientException":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"<p>This is an exception thrown when there is an issue with the input provided by the API call. For example, the name provided for a connection contains a pound sign (#). This can also occur when a valid value is provided, but is otherwise constrained. For example, the valid VLAN tag range is 1-4096 but each can only be used once per connection.</p>"
}
},
"documentation":"<p>The API was called with invalid parameters. The error message will contain additional details about the cause.</p>",
"exception":true
},
"DirectConnectServerException":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"<p>This is an exception thrown when there is a backend issue on the server side.</p>"
}
},
"documentation":"<p>A server-side error occurred during the API call. The error message will contain additional details about the cause.</p>",
"exception":true
},
"DuplicateTagKeysException":{
"type":"structure",
"members":{
},
"documentation":"<p>A tag key was specified more than once.</p>",
"exception":true
},
"ErrorMessage":{"type":"string"},
"Interconnect":{
"type":"structure",
"members":{
"interconnectId":{"shape":"InterconnectId"},
"interconnectName":{"shape":"InterconnectName"},
"interconnectState":{"shape":"InterconnectState"},
"region":{"shape":"Region"},
"location":{"shape":"LocationCode"},
"bandwidth":{"shape":"Bandwidth"},
"loaIssueTime":{
"shape":"LoaIssueTime",
"documentation":"<p>The time of the most recent call to DescribeInterconnectLoa for this Interconnect.</p>"
}
},
"documentation":"<p>An interconnect is a connection that can host other connections.</p> <p>Like a standard AWS Direct Connect connection, an interconnect represents the physical connection between an AWS Direct Connect partner's network and a specific Direct Connect location. An AWS Direct Connect partner who owns an interconnect can provision hosted connections on the interconnect for their end customers, thereby providing the end customers with connectivity to AWS services.</p> <p>The resources of the interconnect, including bandwidth and VLAN numbers, are shared by all of the hosted connections on the interconnect, and the owner of the interconnect determines how these resources are assigned.</p>"
},
"InterconnectId":{
"type":"string",
"documentation":"<p>The ID of the interconnect.</p> <p>Example: dxcon-abc123</p>"
},
"InterconnectList":{
"type":"list",
"member":{"shape":"Interconnect"},
"documentation":"<p>A list of interconnects.</p>"
},
"InterconnectName":{
"type":"string",
"documentation":"<p>The name of the interconnect.</p> <p>Example: \"<i>1G Interconnect to AWS</i>\"</p>"
},
"InterconnectState":{
"type":"string",
"documentation":"<p>State of the interconnect.</p> <ul> <li> <p> <b>Requested</b>: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.</p> </li> <li> <p> <b>Pending</b>>: The interconnect has been approved, and is being initialized.</p> </li> <li> <p> <b>Available</b>: The network link is up, and the interconnect is ready for use.</p> </li> <li> <p> <b>Down</b>: The network link is down.</p> </li> <li> <p> <b>Deleting</b>: The interconnect is in the process of being deleted.</p> </li> <li> <p> <b>Deleted</b>: The interconnect has been deleted.</p> </li> </ul>",
"enum":[
"requested",
"pending",
"available",
"down",
"deleting",
"deleted"
]
},
"Interconnects":{
"type":"structure",
"members":{
"interconnects":{
"shape":"InterconnectList",
"documentation":"<p>A list of interconnects.</p>"
}
},
"documentation":"<p>A structure containing a list of interconnects.</p>"
},
"Loa":{
"type":"structure",
"members":{
"loaContent":{"shape":"LoaContent"},
"loaContentType":{"shape":"LoaContentType"}
},
"documentation":"<p>A structure containing the Letter of Authorization - Connecting Facility Assignment (LOA-CFA) for a connection.</p>"
},
"LoaContent":{
"type":"blob",
"documentation":"<p>The binary contents of the LOA-CFA document.</p>"
},
"LoaContentType":{
"type":"string",
"documentation":"<p>A standard media type indicating the content type of the LOA-CFA document. Currently, the only supported value is \"application/pdf\".</p> <p>Default: application/pdf</p>",
"enum":["application/pdf"]
},
"LoaIssueTime":{"type":"timestamp"},
"Location":{
"type":"structure",
"members":{
"locationCode":{
"shape":"LocationCode",
"documentation":"<p>The code used to indicate the AWS Direct Connect location.</p>"
},
"locationName":{
"shape":"LocationName",
"documentation":"<p>The name of the AWS Direct Connect location. The name includes the colocation partner name and the physical site of the lit building.</p>"
}
},
"documentation":"<p>An AWS Direct Connect location where connections and interconnects can be requested.</p>"
},
"LocationCode":{
"type":"string",
"documentation":"<p>Where the connection is located.</p> <p>Example: EqSV5</p> <p>Default: None</p>"
},
"LocationList":{
"type":"list",
"member":{"shape":"Location"}