aws direct connect · aws direct connect links your internal network to an aws direct connect...

AWS Direct ConnectAPI Reference

API Version 2012-10-25

AWS Direct Connect API Reference

AWS Direct Connect: API ReferenceCopyright © 2020 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

Amazon's trademarks and trade dress may not be used in connection with any product or service that is notAmazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages ordiscredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who mayor may not be affiliated with, connected to, or sponsored by Amazon.


Table of ContentsWelcome .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Actions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

AcceptDirectConnectGatewayAssociationProposal ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

AllocateConnectionOnInterconnect ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

AllocateHostedConnection .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

AllocatePrivateVirtualInterface .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

AllocatePublicVirtualInterface .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

AllocateTransitVirtualInterface .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

AssociateConnectionWithLag .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

AssociateHostedConnection .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

API Version 2012-10-25iii


Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

AssociateVirtualInterface .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

ConfirmConnection .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

ConfirmPrivateVirtualInterface .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

ConfirmPublicVirtualInterface .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

ConfirmTransitVirtualInterface .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

CreateBGPPeer .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

CreateConnection .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

CreateDirectConnectGateway .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

API Version 2012-10-25iv


Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

CreateDirectConnectGatewayAssociation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

CreateDirectConnectGatewayAssociationProposal ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

CreateInterconnect ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

CreateLag .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

CreatePrivateVirtualInterface .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

CreatePublicVirtualInterface .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

CreateTransitVirtualInterface .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

DeleteBGPPeer .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

API Version 2012-10-25v


Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

DeleteConnection .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

DeleteDirectConnectGateway .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

DeleteDirectConnectGatewayAssociation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

DeleteDirectConnectGatewayAssociationProposal ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

DeleteInterconnect ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

DeleteLag .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

DeleteVirtualInterface .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

DescribeConnectionLoa .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

API Version 2012-10-25vi


See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119DescribeConnections .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

DescribeConnectionsOnInterconnect ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

DescribeDirectConnectGatewayAssociationProposals ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

DescribeDirectConnectGatewayAssociations .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

DescribeDirectConnectGatewayAttachments .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

DescribeDirectConnectGateways .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

DescribeHostedConnections .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

DescribeInterconnectLoa .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

API Version 2012-10-25vii


DescribeInterconnects ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

DescribeLags .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

DescribeLoa .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

DescribeLocations .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

DescribeTags .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

DescribeVirtualGateways .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

DescribeVirtualInterfaces .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

DisassociateConnectionFromLag .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

ListVirtualInterfaceTestHistory .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

API Version 2012-10-25viii


Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

StartBgpFailoverTest ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

StopBgpFailoverTest ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

TagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

UntagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

UpdateDirectConnectGatewayAssociation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

UpdateLag .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

UpdateVirtualInterfaceAttributes .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

Data Types .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183AssociatedGateway .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

BGPPeer .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

Connection .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

API Version 2012-10-25ix



DirectConnectGateway .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

DirectConnectGatewayAssociation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

DirectConnectGatewayAssociationProposal ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

DirectConnectGatewayAttachment .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

Interconnect ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

Lag .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

Loa .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

Location .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

NewBGPPeer .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

NewPrivateVirtualInterface .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

NewPrivateVirtualInterfaceAllocation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

NewPublicVirtualInterface .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

NewPublicVirtualInterfaceAllocation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

NewTransitVirtualInterface .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

NewTransitVirtualInterfaceAllocation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

ResourceTag .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

RouteFilterPrefix .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

Tag .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

VirtualGateway .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

API Version 2012-10-25x



VirtualInterface .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

VirtualInterfaceTestHistory .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228

Common Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229Common Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

API Version 2012-10-25xi


WelcomeAWS Direct Connect links your internal network to an AWS Direct Connect location over a standardEthernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS DirectConnect router. With this connection in place, you can create virtual interfaces directly to the AWS cloud(for example, to Amazon EC2 and Amazon S3) and to Amazon VPC, bypassing Internet service providersin your network path. A connection provides access to all AWS Regions except the China (Beijing) and(China) Ningxia Regions. AWS resources in the China Regions can only be accessed through locationsassociated with those Regions.

This document was last published on August 13, 2020.



ActionsThe following actions are supported:

• AcceptDirectConnectGatewayAssociationProposal (p. 4)• AllocateConnectionOnInterconnect (p. 7)• AllocateHostedConnection (p. 12)• AllocatePrivateVirtualInterface (p. 17)• AllocatePublicVirtualInterface (p. 23)• AllocateTransitVirtualInterface (p. 29)• AssociateConnectionWithLag (p. 32)• AssociateHostedConnection (p. 36)• AssociateVirtualInterface (p. 40)• ConfirmConnection (p. 45)• ConfirmPrivateVirtualInterface (p. 47)• ConfirmPublicVirtualInterface (p. 50)• ConfirmTransitVirtualInterface (p. 52)• CreateBGPPeer (p. 54)• CreateConnection (p. 57)• CreateDirectConnectGateway (p. 62)• CreateDirectConnectGatewayAssociation (p. 64)• CreateDirectConnectGatewayAssociationProposal (p. 67)• CreateInterconnect (p. 70)• CreateLag (p. 75)• CreatePrivateVirtualInterface (p. 81)• CreatePublicVirtualInterface (p. 87)• CreateTransitVirtualInterface (p. 93)• DeleteBGPPeer (p. 96)• DeleteConnection (p. 99)• DeleteDirectConnectGateway (p. 103)• DeleteDirectConnectGatewayAssociation (p. 105)• DeleteDirectConnectGatewayAssociationProposal (p. 108)• DeleteInterconnect (p. 110)• DeleteLag (p. 112)• DeleteVirtualInterface (p. 116)• DescribeConnectionLoa (p. 118)• DescribeConnections (p. 120)• DescribeConnectionsOnInterconnect (p. 122)• DescribeDirectConnectGatewayAssociationProposals (p. 124)• DescribeDirectConnectGatewayAssociations (p. 127)• DescribeDirectConnectGatewayAttachments (p. 130)• DescribeDirectConnectGateways (p. 133)• DescribeHostedConnections (p. 135)• DescribeInterconnectLoa (p. 137)



• DescribeInterconnects (p. 139)• DescribeLags (p. 141)• DescribeLoa (p. 144)• DescribeLocations (p. 146)• DescribeTags (p. 148)• DescribeVirtualGateways (p. 150)• DescribeVirtualInterfaces (p. 152)• DisassociateConnectionFromLag (p. 155)• ListVirtualInterfaceTestHistory (p. 159)• StartBgpFailoverTest (p. 162)• StopBgpFailoverTest (p. 164)• TagResource (p. 166)• UntagResource (p. 168)• UpdateDirectConnectGatewayAssociation (p. 170)• UpdateLag (p. 173)• UpdateVirtualInterfaceAttributes (p. 178)


AWS Direct Connect API ReferenceAcceptDirectConnectGatewayAssociationProposal

AcceptDirectConnectGatewayAssociationProposalAccepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connectgateway.

Request Syntax{ "associatedGatewayOwnerAccount": "string", "directConnectGatewayId": "string", "overrideAllowedPrefixesToDirectConnectGateway": [ { "cidr": "string" } ], "proposalId": "string"}

Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 229).

The request accepts the following data in JSON format.

associatedGatewayOwnerAccount (p. 4)

The ID of the AWS account that owns the virtual private gateway or transit gateway.

Type: String

Required: YesdirectConnectGatewayId (p. 4)

The ID of the Direct Connect gateway.

Type: String

Required: YesoverrideAllowedPrefixesToDirectConnectGateway (p. 4)

Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway.

For information about how to set the prefixes, see Allowed Prefixes in the AWS Direct Connect UserGuide.

Type: Array of RouteFilterPrefix (p. 220) objects

Required: NoproposalId (p. 4)

The ID of the request proposal.

Type: String

Required: Yes


https://docs.aws.amazon.com/directconnect/latest/UserGuide/multi-account-associate-vgw.html#allowed-prefixes

AWS Direct Connect API ReferenceResponse Syntax

Response Syntax{ "directConnectGatewayAssociation": { "allowedPrefixesToDirectConnectGateway": [ { "cidr": "string" } ], "associatedGateway": { "id": "string", "ownerAccount": "string", "region": "string", "type": "string" }, "associationId": "string", "associationState": "string", "directConnectGatewayId": "string", "directConnectGatewayOwnerAccount": "string", "stateChangeError": "string", "virtualGatewayId": "string", "virtualGatewayOwnerAccount": "string", "virtualGatewayRegion": "string" }}

Response ElementsIf the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

directConnectGatewayAssociation (p. 5)

Information about an association between a Direct Connect gateway and a virtual private gatewayor transit gateway.

Type: DirectConnectGatewayAssociation (p. 192) object

ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 231).

DirectConnectClientException

One or more parameters are not valid.

HTTP Status Code: 400DirectConnectServerException

A server-side error occurred.

HTTP Status Code: 400

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:


AWS Direct Connect API ReferenceSee Also

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/AcceptDirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/AcceptDirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/AcceptDirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/AcceptDirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/AcceptDirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/AcceptDirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/AcceptDirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/AcceptDirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/AcceptDirectConnectGatewayAssociationProposal

AWS Direct Connect API ReferenceAllocateConnectionOnInterconnect

AllocateConnectionOnInterconnectDeprecated. Use AllocateHostedConnection (p. 12) instead.

Creates a hosted connection on an interconnect.

Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on thespecified interconnect.

NoteIntended for use by AWS Direct Connect Partners only.

Request Syntax{ "bandwidth": "string", "connectionName": "string", "interconnectId": "string", "ownerAccount": "string", "vlan": number}



bandwidth (p. 7)

The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps,400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those AWS Direct ConnectPartners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or10Gbps hosted connection.

Type: String

Required: YesconnectionName (p. 7)

The name of the provisioned connection.

Type: String

Required: YesinterconnectId (p. 7)

The ID of the interconnect on which the connection will be provisioned.

Type: String

Required: YesownerAccount (p. 7)

The ID of the AWS account of the customer for whom the connection will be provisioned.



Type: String

Required: Yesvlan (p. 7)

The dedicated VLAN provisioned to the connection.

Type: Integer

Required: Yes

Response Syntax{ "awsDevice": "string", "awsDeviceV2": "string", "bandwidth": "string", "connectionId": "string", "connectionName": "string", "connectionState": "string", "hasLogicalRedundancy": "string", "jumboFrameCapable": boolean, "lagId": "string", "loaIssueTime": number, "location": "string", "ownerAccount": "string", "partnerName": "string", "providerName": "string", "region": "string", "tags": [ { "key": "string", "value": "string" } ], "vlan": number}



awsDevice (p. 8)

This parameter has been deprecated.

The Direct Connect endpoint on which the physical connection terminates.

Type: StringawsDeviceV2 (p. 8)


Type: Stringbandwidth (p. 8)

The bandwidth of the connection.


AWS Direct Connect API ReferenceResponse Elements

Type: StringconnectionId (p. 8)

The ID of the connection.

Type: StringconnectionName (p. 8)

The name of the connection.

Type: StringconnectionState (p. 8)

The state of the connection. The following are the possible values:• ordering: 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 ordeclines the connection order.

• requested: The initial state of a standard connection. The connection stays in the requested stateuntil the Letter of Authorization (LOA) is sent to the customer.

• pending: The connection has been approved and is being initialized.• available: The network link is up and the connection is ready for use.• down: The network link is down.• deleting: The connection is being deleted.• deleted: The connection has been deleted.• rejected: A hosted connection in the ordering state enters the rejected state if it is deleted

by the customer.• unknown: The state of the connection is not available.

Type: String

Valid Values: ordering | requested | pending | available | down | deleting |deleted | rejected | unknown

hasLogicalRedundancy (p. 8)

Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

Type: String

Valid Values: unknown | yes | nojumboFrameCapable (p. 8)

Indicates whether jumbo frames (9001 MTU) are supported.

Type: BooleanlagId (p. 8)

The ID of the LAG.

Type: StringloaIssueTime (p. 8)

The time of the most recent call to DescribeLoa (p. 144) for this connection.

Type: Timestamp


AWS Direct Connect API ReferenceErrors

location (p. 8)

The location of the connection.

Type: StringownerAccount (p. 8)

The ID of the AWS account that owns the connection.

Type: StringpartnerName (p. 8)

The name of the AWS Direct Connect service provider associated with the connection.

Type: StringproviderName (p. 8)

The name of the service provider associated with the connection.

Type: Stringregion (p. 8)

The AWS Region where the connection is located.

Type: Stringtags (p. 8)

The tags associated with the connection.

Type: Array of Tag (p. 221) objects

Array Members: Minimum number of 1 item.vlan (p. 8)

The ID of the VLAN.

Type: Integer












https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/AllocateConnectionOnInterconnect

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/AllocateConnectionOnInterconnect

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/AllocateConnectionOnInterconnect

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/AllocateConnectionOnInterconnect

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/AllocateConnectionOnInterconnect

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/AllocateConnectionOnInterconnect

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/AllocateConnectionOnInterconnect

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/AllocateConnectionOnInterconnect

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/AllocateConnectionOnInterconnect

AWS Direct Connect API ReferenceAllocateHostedConnection

AllocateHostedConnectionCreates a hosted connection on the specified interconnect or a link aggregation group (LAG) ofinterconnects.

Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connectionon the specified interconnect or LAG of interconnects. AWS polices the hosted connection for thespecified capacity and the AWS Direct Connect Partner must also police the hosted connection for thespecified capacity.


Request Syntax{ "bandwidth": "string", "connectionId": "string", "connectionName": "string", "ownerAccount": "string", "tags": [ { "key": "string", "value": "string" } ], "vlan": number}



bandwidth (p. 12)

The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps,400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those AWS Direct ConnectPartners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or10Gbps hosted connection.

Type: String

Required: Yes

connectionId (p. 12)

The ID of the interconnect or LAG.

Type: String

Required: Yes

connectionName (p. 12)

The name of the hosted connection.



Type: String


The ID of the AWS account ID of the customer for the connection.

Type: String

Required: Yestags (p. 12)



Array Members: Minimum number of 1 item.

Required: Novlan (p. 12)

The dedicated VLAN provisioned to the hosted connection.

Type: Integer

Required: Yes






awsDevice (p. 13)

















Type: String




Type: String

Valid Values: unknown | yes | no



jumboFrameCapable (p. 13)



The ID of the LAG.



Type: Timestamplocation (p. 13)














The ID of the VLAN.

Type: Integer








HTTP Status Code: 400DuplicateTagKeysException

A tag key was specified more than once.

HTTP Status Code: 400TooManyTagsException

You have reached the limit on the number of tags that can be assigned.





https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/AllocateHostedConnection

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/AllocateHostedConnection

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/AllocateHostedConnection

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/AllocateHostedConnection

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/AllocateHostedConnection

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/AllocateHostedConnection

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/AllocateHostedConnection

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/AllocateHostedConnection

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/AllocateHostedConnection

AWS Direct Connect API ReferenceAllocatePrivateVirtualInterface

AllocatePrivateVirtualInterfaceProvisions a private virtual interface to be owned by the specified AWS account.

Virtual interfaces created using this action must be confirmed by the owner usingConfirmPrivateVirtualInterface (p. 47). Until then, the virtual interface is in the Confirming state andis not available to handle traffic.

Request Syntax{ "connectionId": "string", "newPrivateVirtualInterfaceAllocation": { "addressFamily": "string", "amazonAddress": "string", "asn": number, "authKey": "string", "customerAddress": "string", "mtu": number, "tags": [ { "key": "string", "value": "string" } ], "virtualInterfaceName": "string", "vlan": number }, "ownerAccount": "string"}




The ID of the connection on which the private virtual interface is provisioned.

Type: String

Required: YesnewPrivateVirtualInterfaceAllocation (p. 17)

Information about the private virtual interface.

Type: NewPrivateVirtualInterfaceAllocation (p. 209) object


The ID of the AWS account that owns the virtual private interface.

Type: String



Required: Yes

Response Syntax{ "addressFamily": "string", "amazonAddress": "string", "amazonSideAsn": number, "asn": number, "authKey": "string", "awsDeviceV2": "string", "bgpPeers": [ { "addressFamily": "string", "amazonAddress": "string", "asn": number, "authKey": "string", "awsDeviceV2": "string", "bgpPeerId": "string", "bgpPeerState": "string", "bgpStatus": "string", "customerAddress": "string" } ], "connectionId": "string", "customerAddress": "string", "customerRouterConfig": "string", "directConnectGatewayId": "string", "jumboFrameCapable": boolean, "location": "string", "mtu": number, "ownerAccount": "string", "region": "string", "routeFilterPrefixes": [ { "cidr": "string" } ], "tags": [ { "key": "string", "value": "string" } ], "virtualGatewayId": "string", "virtualInterfaceId": "string", "virtualInterfaceName": "string", "virtualInterfaceState": "string", "virtualInterfaceType": "string", "vlan": number}



addressFamily (p. 18)

The address family for the BGP peer.



Type: String

Valid Values: ipv4 | ipv6amazonAddress (p. 18)

The IP address assigned to the Amazon interface.

Type: StringamazonSideAsn (p. 18)

The autonomous system number (ASN) for the Amazon side of the connection.

Type: Longasn (p. 18)

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

Type: IntegerauthKey (p. 18)

The authentication key for BGP configuration. This string has a minimum length of 6 characters andand a maximun lenth of 80 characters.


The Direct Connect endpoint on which the virtual interface terminates.

Type: StringbgpPeers (p. 18)

The BGP peers configured on this virtual interface.

Type: Array of BGPPeer (p. 185) objectsconnectionId (p. 18)


Type: StringcustomerAddress (p. 18)

The IP address assigned to the customer interface.

Type: StringcustomerRouterConfig (p. 18)

The customer router configuration.

Type: StringdirectConnectGatewayId (p. 18)


Type: StringjumboFrameCapable (p. 18)




Type: Booleanlocation (p. 18)


Type: Stringmtu (p. 18)

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. Thedefault value is 1500.

Type: IntegerownerAccount (p. 18)

The ID of the AWS account that owns the virtual interface.


The AWS Region where the virtual interface is located.

Type: StringrouteFilterPrefixes (p. 18)

The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

Type: Array of RouteFilterPrefix (p. 220) objectstags (p. 18)

The tags associated with the virtual interface.


Array Members: Minimum number of 1 item.virtualGatewayId (p. 18)

The ID of the virtual private gateway. Applies only to private virtual interfaces.

Type: StringvirtualInterfaceId (p. 18)

The ID of the virtual interface.

Type: StringvirtualInterfaceName (p. 18)

The name of the virtual interface assigned by the customer network. The name has a maximum of100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

Type: StringvirtualInterfaceState (p. 18)

The state of the virtual interface. The following are the possible values:• confirming: The creation of the virtual interface is pending confirmation from the virtual

interface owner. If the owner of the virtual interface is different from the owner of the connectionon which it is provisioned, then the virtual interface will remain in this state until it is confirmed bythe virtual interface owner.

• verifying: This state only applies to public virtual interfaces. Each public virtual interface needsvalidation before the virtual interface can be created.



• pending: A virtual interface is in this state from the time that it is created until the virtualinterface is ready to forward traffic.

• available: A virtual interface that is able to forward traffic.• down: A virtual interface that is BGP down.• deleting: A virtual interface is in this state immediately after calling

DeleteVirtualInterface (p. 116) until it can no longer forward traffic.• deleted: A virtual interface that cannot forward traffic.• rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual

interface in the Confirming state is deleted by the virtual interface owner, the virtual interfaceenters the Rejected state.

• unknown: The state of the virtual interface is not available.

Type: String

Valid Values: confirming | verifying | pending | available | down | deleting |deleted | rejected | unknown

virtualInterfaceType (p. 18)

The type of virtual interface. The possible values are private and public.

Type: Stringvlan (p. 18)

The ID of the VLAN.

Type: Integer
















https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/AllocatePrivateVirtualInterface

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/AllocatePrivateVirtualInterface

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/AllocatePrivateVirtualInterface

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/AllocatePrivateVirtualInterface

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/AllocatePrivateVirtualInterface

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/AllocatePrivateVirtualInterface

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/AllocatePrivateVirtualInterface

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/AllocatePrivateVirtualInterface

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/AllocatePrivateVirtualInterface

AWS Direct Connect API ReferenceAllocatePublicVirtualInterface

AllocatePublicVirtualInterfaceProvisions a public virtual interface to be owned by the specified AWS account.

The owner of a connection calls this function to provision a public virtual interface to be owned by thespecified AWS account.

Virtual interfaces created using this function must be confirmed by the owner usingConfirmPublicVirtualInterface (p. 50). Until this step has been completed, the virtual interface is inthe confirming state and is not available to handle traffic.

When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specifycustom IPv6 addresses.

Request Syntax{ "connectionId": "string", "newPublicVirtualInterfaceAllocation": { "addressFamily": "string", "amazonAddress": "string", "asn": number, "authKey": "string", "customerAddress": "string", "routeFilterPrefixes": [ { "cidr": "string" } ], "tags": [ { "key": "string", "value": "string" } ], "virtualInterfaceName": "string", "vlan": number }, "ownerAccount": "string"}




The ID of the connection on which the public virtual interface is provisioned.

Type: String

Required: YesnewPublicVirtualInterfaceAllocation (p. 23)

Information about the public virtual interface.



Type: NewPublicVirtualInterfaceAllocation (p. 213) object

Required: Yes

ownerAccount (p. 23)

The ID of the AWS account that owns the public virtual interface.

Type: String

Required: Yes

Response Syntax

{ "addressFamily": "string", "amazonAddress": "string", "amazonSideAsn": number, "asn": number, "authKey": "string", "awsDeviceV2": "string", "bgpPeers": [ { "addressFamily": "string", "amazonAddress": "string", "asn": number, "authKey": "string", "awsDeviceV2": "string", "bgpPeerId": "string", "bgpPeerState": "string", "bgpStatus": "string", "customerAddress": "string" } ], "connectionId": "string", "customerAddress": "string", "customerRouterConfig": "string", "directConnectGatewayId": "string", "jumboFrameCapable": boolean, "location": "string", "mtu": number, "ownerAccount": "string", "region": "string", "routeFilterPrefixes": [ { "cidr": "string" } ], "tags": [ { "key": "string", "value": "string" } ], "virtualGatewayId": "string", "virtualInterfaceId": "string", "virtualInterfaceName": "string", "virtualInterfaceState": "string", "virtualInterfaceType": "string", "vlan": number}







Type: String































Type: String





The ID of the VLAN.

Type: Integer
















https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/AllocatePublicVirtualInterface

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/AllocatePublicVirtualInterface

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/AllocatePublicVirtualInterface

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/AllocatePublicVirtualInterface

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/AllocatePublicVirtualInterface

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/AllocatePublicVirtualInterface

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/AllocatePublicVirtualInterface

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/AllocatePublicVirtualInterface

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/AllocatePublicVirtualInterface

AWS Direct Connect API ReferenceAllocateTransitVirtualInterface

AllocateTransitVirtualInterfaceProvisions a transit virtual interface to be owned by the specified AWS account. Use this type of interfaceto connect a transit gateway to your Direct Connect gateway.

The owner of a connection provisions a transit virtual interface to be owned by the specified AWSaccount.

After you create a transit virtual interface, it must be confirmed by the owner usingConfirmTransitVirtualInterface (p. 52). Until this step has been completed, the transit virtual interfaceis in the requested state and is not available to handle traffic.

Request Syntax{ "connectionId": "string", "newTransitVirtualInterfaceAllocation": { "addressFamily": "string", "amazonAddress": "string", "asn": number, "authKey": "string", "customerAddress": "string", "mtu": number, "tags": [ { "key": "string", "value": "string" } ], "virtualInterfaceName": "string", "vlan": number }, "ownerAccount": "string"}




The ID of the connection on which the transit virtual interface is provisioned.

Type: String

Required: YesnewTransitVirtualInterfaceAllocation (p. 29)

Information about the transit virtual interface.

Type: NewTransitVirtualInterfaceAllocation (p. 217) object


The ID of the AWS account that owns the transit virtual interface.



Type: String

Required: Yes

Response Syntax{ "virtualInterface": { "addressFamily": "string", "amazonAddress": "string", "amazonSideAsn": number, "asn": number, "authKey": "string", "awsDeviceV2": "string", "bgpPeers": [ { "addressFamily": "string", "amazonAddress": "string", "asn": number, "authKey": "string", "awsDeviceV2": "string", "bgpPeerId": "string", "bgpPeerState": "string", "bgpStatus": "string", "customerAddress": "string" } ], "connectionId": "string", "customerAddress": "string", "customerRouterConfig": "string", "directConnectGatewayId": "string", "jumboFrameCapable": boolean, "location": "string", "mtu": number, "ownerAccount": "string", "region": "string", "routeFilterPrefixes": [ { "cidr": "string" } ], "tags": [ { "key": "string", "value": "string" } ], "virtualGatewayId": "string", "virtualInterfaceId": "string", "virtualInterfaceName": "string", "virtualInterfaceState": "string", "virtualInterfaceType": "string", "vlan": number }}





virtualInterface (p. 30)

Information about a virtual interface.

Type: VirtualInterface (p. 223) object














https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/AllocateTransitVirtualInterface

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/AllocateTransitVirtualInterface

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/AllocateTransitVirtualInterface

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/AllocateTransitVirtualInterface

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/AllocateTransitVirtualInterface

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/AllocateTransitVirtualInterface

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/AllocateTransitVirtualInterface

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/AllocateTransitVirtualInterface

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/AllocateTransitVirtualInterface

AWS Direct Connect API ReferenceAssociateConnectionWithLag

AssociateConnectionWithLagAssociates an existing connection with a link aggregation group (LAG). The connection is interruptedand re-established as a member of the LAG (connectivity to AWS is interrupted). The connection mustbe hosted on the same AWS Direct Connect endpoint as the LAG, and its bandwidth must match thebandwidth for the LAG. You can re-associate a connection that's currently associated with a differentLAG; however, if removing the connection would cause the original LAG to fall below its setting forminimum number of operational connections, the request fails.

Any virtual interfaces that are directly associated with the connection are automatically re-associatedwith the LAG. If the connection was originally associated with a different LAG, the virtual interfacesremain associated with the original LAG.

For interconnects, any hosted connections are automatically re-associated with the LAG. If theinterconnect was originally associated with a different LAG, the hosted connections remain associatedwith the original LAG.

Request Syntax{ "connectionId": "string", "lagId": "string"}





Type: String

Required: YeslagId (p. 32)

The ID of the LAG with which to associate the connection.

Type: String

Required: Yes

Response Syntax{ "awsDevice": "string", "awsDeviceV2": "string", "bandwidth": "string", "connectionId": "string", "connectionName": "string", "connectionState": "string",



"hasLogicalRedundancy": "string", "jumboFrameCapable": boolean, "lagId": "string", "loaIssueTime": number, "location": "string", "ownerAccount": "string", "partnerName": "string", "providerName": "string", "region": "string", "tags": [ { "key": "string", "value": "string" } ], "vlan": number}



awsDevice (p. 32)



















Type: String




Type: String




The ID of the LAG.











Type: String



region (p. 32)






The ID of the VLAN.

Type: Integer










https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/AssociateConnectionWithLag

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/AssociateConnectionWithLag

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/AssociateConnectionWithLag

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/AssociateConnectionWithLag

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/AssociateConnectionWithLag

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/AssociateConnectionWithLag

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/AssociateConnectionWithLag

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/AssociateConnectionWithLag

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/AssociateConnectionWithLag

AWS Direct Connect API ReferenceAssociateHostedConnection

AssociateHostedConnectionAssociates a hosted connection and its virtual interfaces with a link aggregation group (LAG) orinterconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLANnumber or IP address, the operation fails. This action temporarily interrupts the hosted connection'sconnectivity to AWS as it is being migrated.


Request Syntax{ "connectionId": "string", "parentConnectionId": "string"}




The ID of the hosted connection.

Type: String

Required: YesparentConnectionId (p. 36)

The ID of the interconnect or the LAG.

Type: String

Required: Yes

Response Syntax{ "awsDevice": "string", "awsDeviceV2": "string", "bandwidth": "string", "connectionId": "string", "connectionName": "string", "connectionState": "string", "hasLogicalRedundancy": "string", "jumboFrameCapable": boolean, "lagId": "string", "loaIssueTime": number, "location": "string", "ownerAccount": "string", "partnerName": "string", "providerName": "string",



"region": "string", "tags": [ { "key": "string", "value": "string" } ], "vlan": number}



awsDevice (p. 36)















• pending: The connection has been approved and is being initialized.• available: The network link is up and the connection is ready for use.• down: The network link is down.• deleting: The connection is being deleted.• deleted: The connection has been deleted.



• rejected: A hosted connection in the ordering state enters the rejected state if it is deletedby the customer.

• unknown: The state of the connection is not available.

Type: String




Type: String




The ID of the LAG.



















The ID of the VLAN.

Type: Integer










https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/AssociateHostedConnection

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/AssociateHostedConnection

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/AssociateHostedConnection

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/AssociateHostedConnection

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/AssociateHostedConnection

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/AssociateHostedConnection

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/AssociateHostedConnection

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/AssociateHostedConnection

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/AssociateHostedConnection

AWS Direct Connect API ReferenceAssociateVirtualInterface

AssociateVirtualInterfaceAssociates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivityto AWS is temporarily interrupted as the virtual interface is being migrated. If the target connection orLAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, theoperation fails.

Virtual interfaces associated with a hosted connection cannot be associated with aLAG; hosted connections must be migrated along with their virtual interfaces usingAssociateHostedConnection (p. 36).

To reassociate a virtual interface to a new connection or LAG, the requester must own either the virtualinterface itself or the connection to which the virtual interface is currently associated. Additionally, therequester must own the connection or LAG for the association.

Request Syntax{ "connectionId": "string", "virtualInterfaceId": "string"}




The ID of the LAG or connection.

Type: String

Required: YesvirtualInterfaceId (p. 40)


Type: String

Required: Yes

Response Syntax{ "addressFamily": "string", "amazonAddress": "string", "amazonSideAsn": number, "asn": number, "authKey": "string", "awsDeviceV2": "string", "bgpPeers": [ {



"addressFamily": "string", "amazonAddress": "string", "asn": number, "authKey": "string", "awsDeviceV2": "string", "bgpPeerId": "string", "bgpPeerState": "string", "bgpStatus": "string", "customerAddress": "string" } ], "connectionId": "string", "customerAddress": "string", "customerRouterConfig": "string", "directConnectGatewayId": "string", "jumboFrameCapable": boolean, "location": "string", "mtu": number, "ownerAccount": "string", "region": "string", "routeFilterPrefixes": [ { "cidr": "string" } ], "tags": [ { "key": "string", "value": "string" } ], "virtualGatewayId": "string", "virtualInterfaceId": "string", "virtualInterfaceName": "string", "virtualInterfaceState": "string", "virtualInterfaceType": "string", "vlan": number}





Type: String





Type: Long



asn (p. 40)























Type: Integer



ownerAccount (p. 40)


























Type: String





The ID of the VLAN.

Type: Integer










https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/AssociateVirtualInterface

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/AssociateVirtualInterface

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/AssociateVirtualInterface

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/AssociateVirtualInterface

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/AssociateVirtualInterface

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/AssociateVirtualInterface

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/AssociateVirtualInterface

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/AssociateVirtualInterface

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/AssociateVirtualInterface

AWS Direct Connect API ReferenceConfirmConnection

ConfirmConnectionConfirms the creation of the specified hosted connection on an interconnect.

Upon creation, the hosted connection is initially in the Ordering state, and remains in this state untilthe owner confirms creation of the hosted connection.

Request Syntax{ "connectionId": "string"}




The ID of the hosted connection.

Type: String

Required: Yes

Response Syntax{ "connectionState": "string"}



connectionState (p. 45)




• pending: The connection has been approved and is being initialized.• available: The network link is up and the connection is ready for use.• down: The network link is down.• deleting: The connection is being deleted.



• deleted: The connection has been deleted.• rejected: A hosted connection in the ordering state enters the rejected state if it is deleted


Type: String











https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/ConfirmConnection

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/ConfirmConnection

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/ConfirmConnection

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/ConfirmConnection

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/ConfirmConnection

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/ConfirmConnection

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/ConfirmConnection

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/ConfirmConnection

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/ConfirmConnection

AWS Direct Connect API ReferenceConfirmPrivateVirtualInterface

ConfirmPrivateVirtualInterfaceAccepts ownership of a private virtual interface created by another AWS account.

After the virtual interface owner makes this call, the virtual interface is created and attached to thespecified virtual private gateway or Direct Connect gateway, and is made available to handle traffic.

Request Syntax{ "directConnectGatewayId": "string", "virtualGatewayId": "string", "virtualInterfaceId": "string"}



directConnectGatewayId (p. 47)


Type: String

Required: NovirtualGatewayId (p. 47)

The ID of the virtual private gateway.

Type: String

Required: NovirtualInterfaceId (p. 47)


Type: String

Required: Yes

Response Syntax{ "virtualInterfaceState": "string"}





virtualInterfaceState (p. 47)









Type: String









• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java


https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/ConfirmPrivateVirtualInterface

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/ConfirmPrivateVirtualInterface

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/ConfirmPrivateVirtualInterface

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/ConfirmPrivateVirtualInterface

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/ConfirmPrivateVirtualInterface


• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/ConfirmPrivateVirtualInterface

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/ConfirmPrivateVirtualInterface

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/ConfirmPrivateVirtualInterface

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/ConfirmPrivateVirtualInterface

AWS Direct Connect API ReferenceConfirmPublicVirtualInterface

ConfirmPublicVirtualInterfaceAccepts ownership of a public virtual interface created by another AWS account.

After the virtual interface owner makes this call, the specified virtual interface is created and madeavailable to handle traffic.

Request Syntax{ "virtualInterfaceId": "string"}



virtualInterfaceId (p. 50)


Type: String

Required: Yes









• available: A virtual interface that is able to forward traffic.



• down: A virtual interface that is BGP down.• deleting: A virtual interface is in this state immediately after calling




Type: String











https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/ConfirmPublicVirtualInterface

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/ConfirmPublicVirtualInterface

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/ConfirmPublicVirtualInterface

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/ConfirmPublicVirtualInterface

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/ConfirmPublicVirtualInterface

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/ConfirmPublicVirtualInterface

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/ConfirmPublicVirtualInterface

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/ConfirmPublicVirtualInterface

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/ConfirmPublicVirtualInterface

AWS Direct Connect API ReferenceConfirmTransitVirtualInterface

ConfirmTransitVirtualInterfaceAccepts ownership of a transit virtual interface created by another AWS account.

After the owner of the transit virtual interface makes this call, the specified transit virtual interface iscreated and made available to handle traffic.

Request Syntax{ "directConnectGatewayId": "string", "virtualInterfaceId": "string"}





Type: String

Required: YesvirtualInterfaceId (p. 52)


Type: String

Required: Yes






interface owner. If the owner of the virtual interface is different from the owner of the connection



on which it is provisioned, then the virtual interface will remain in this state until it is confirmed bythe virtual interface owner.







Type: String











https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/ConfirmTransitVirtualInterface

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/ConfirmTransitVirtualInterface

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/ConfirmTransitVirtualInterface

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/ConfirmTransitVirtualInterface

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/ConfirmTransitVirtualInterface

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/ConfirmTransitVirtualInterface

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/ConfirmTransitVirtualInterface

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/ConfirmTransitVirtualInterface

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/ConfirmTransitVirtualInterface

AWS Direct Connect API ReferenceCreateBGPPeer

CreateBGPPeerCreates a BGP peer on the specified virtual interface.

You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access AWSresources that also use that address family.

If logical redundancy is not supported by the connection, interconnect, or LAG, the BGP peer cannot bein the same address family as an existing BGP peer on the virtual interface.

When creating a IPv6 BGP peer, omit the Amazon address and customer address. IPv6 addresses areautomatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6addresses.

For a public virtual interface, the Autonomous System Number (ASN) must be private or alreadywhitelisted for the virtual interface.

Request Syntax{ "newBGPPeer": { "addressFamily": "string", "amazonAddress": "string", "asn": number, "authKey": "string", "customerAddress": "string" }, "virtualInterfaceId": "string"}



newBGPPeer (p. 54)

Information about the BGP peer.

Type: NewBGPPeer (p. 206) object



Type: String

Required: No

Response Syntax{ "virtualInterface": { "addressFamily": "string",



"amazonAddress": "string", "amazonSideAsn": number, "asn": number, "authKey": "string", "awsDeviceV2": "string", "bgpPeers": [ { "addressFamily": "string", "amazonAddress": "string", "asn": number, "authKey": "string", "awsDeviceV2": "string", "bgpPeerId": "string", "bgpPeerState": "string", "bgpStatus": "string", "customerAddress": "string" } ], "connectionId": "string", "customerAddress": "string", "customerRouterConfig": "string", "directConnectGatewayId": "string", "jumboFrameCapable": boolean, "location": "string", "mtu": number, "ownerAccount": "string", "region": "string", "routeFilterPrefixes": [ { "cidr": "string" } ], "tags": [ { "key": "string", "value": "string" } ], "virtualGatewayId": "string", "virtualInterfaceId": "string", "virtualInterfaceName": "string", "virtualInterfaceState": "string", "virtualInterfaceType": "string", "vlan": number }}




The virtual interface.













https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/CreateBGPPeer

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/CreateBGPPeer

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/CreateBGPPeer

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/CreateBGPPeer

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/CreateBGPPeer

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/CreateBGPPeer

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/CreateBGPPeer

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/CreateBGPPeer

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/CreateBGPPeer

AWS Direct Connect API ReferenceCreateConnection

CreateConnectionCreates a connection between a customer network and a specific AWS Direct Connect location.

A connection links your internal network to an AWS Direct Connect location over a standard Ethernetfiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connectrouter.

To find the locations for your Region, use DescribeLocations (p. 146).

You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAGID in the request. This ensures that the new connection is allocated on the same AWS Direct Connectendpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request failsand no connection is created.

Request Syntax{ "bandwidth": "string", "connectionName": "string", "lagId": "string", "location": "string", "providerName": "string", "tags": [ { "key": "string", "value": "string" } ]}



bandwidth (p. 57)


Type: String

Required: YesconnectionName (p. 57)


Type: String


The ID of the LAG.

Type: String



Required: No

location (p. 57)


Type: String

Required: Yes

providerName (p. 57)

The name of the service provider associated with the requested connection.

Type: String

Required: No

tags (p. 57)

The tags to associate with the lag.



Required: No






awsDevice (p. 58)

















Type: String




Type: String







The ID of the LAG.

















The ID of the VLAN.

Type: Integer
















https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/CreateConnection

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/CreateConnection

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/CreateConnection

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/CreateConnection

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/CreateConnection

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/CreateConnection

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/CreateConnection

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/CreateConnection

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/CreateConnection

AWS Direct Connect API ReferenceCreateDirectConnectGateway

CreateDirectConnectGatewayCreates a Direct Connect gateway, which is an intermediate object that enables you to connect a set ofvirtual interfaces and virtual private gateways. A Direct Connect gateway is global and visible in any AWSRegion after it is created. The virtual interfaces and virtual private gateways that are connected througha Direct Connect gateway can be in different AWS Regions. This enables you to connect to a VPC in anyRegion, regardless of the Region in which the virtual interfaces are located, and pass traffic betweenthem.

Request Syntax{ "amazonSideAsn": number, "directConnectGatewayName": "string"}



amazonSideAsn (p. 62)

The autonomous system number (ASN) for Border Gateway Protocol (BGP) to be configured onthe Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or4,200,000,000 to 4,294,967,294. The default is 64512.

Type: Long

Required: NodirectConnectGatewayName (p. 62)

The name of the Direct Connect gateway.

Type: String

Required: Yes

Response Syntax{ "directConnectGateway": { "amazonSideAsn": number, "directConnectGatewayId": "string", "directConnectGatewayName": "string", "directConnectGatewayState": "string", "ownerAccount": "string", "stateChangeError": "string" }}





directConnectGateway (p. 62)

The Direct Connect gateway.

Type: DirectConnectGateway (p. 190) object










https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/CreateDirectConnectGateway

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/CreateDirectConnectGateway

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/CreateDirectConnectGateway

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/CreateDirectConnectGateway

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/CreateDirectConnectGateway

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/CreateDirectConnectGateway

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/CreateDirectConnectGateway

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/CreateDirectConnectGateway

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/CreateDirectConnectGateway

AWS Direct Connect API ReferenceCreateDirectConnectGatewayAssociation

CreateDirectConnectGatewayAssociationCreates an association between a Direct Connect gateway and a virtual private gateway. The virtualprivate gateway must be attached to a VPC and must not be associated with another Direct Connectgateway.

Request Syntax{ "addAllowedPrefixesToDirectConnectGateway": [ { "cidr": "string" } ], "directConnectGatewayId": "string", "gatewayId": "string", "virtualGatewayId": "string"}



addAllowedPrefixesToDirectConnectGateway (p. 64)

The Amazon VPC prefixes to advertise to the Direct Connect gateway

This parameter is required when you create an association to a transit gateway.

For information about how to set the prefixes, see Allowed Prefixes in the AWS Direct Connect UserGuide.


Required: NodirectConnectGatewayId (p. 64)


Type: String

Required: YesgatewayId (p. 64)

The ID of the virtual private gateway or transit gateway.

Type: String



Type: String

Required: No


https://docs.aws.amazon.com/directconnect/latest/UserGuide/multi-account-associate-vgw.html#allowed-prefixes


Response Syntax{ "directConnectGatewayAssociation": { "allowedPrefixesToDirectConnectGateway": [ { "cidr": "string" } ], "associatedGateway": { "id": "string", "ownerAccount": "string", "region": "string", "type": "string" }, "associationId": "string", "associationState": "string", "directConnectGatewayId": "string", "directConnectGatewayOwnerAccount": "string", "stateChangeError": "string", "virtualGatewayId": "string", "virtualGatewayOwnerAccount": "string", "virtualGatewayRegion": "string" }}




The association to be created.













https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/CreateDirectConnectGatewayAssociation

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/CreateDirectConnectGatewayAssociation

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/CreateDirectConnectGatewayAssociation

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/CreateDirectConnectGatewayAssociation

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/CreateDirectConnectGatewayAssociation

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/CreateDirectConnectGatewayAssociation

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/CreateDirectConnectGatewayAssociation

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/CreateDirectConnectGatewayAssociation

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/CreateDirectConnectGatewayAssociation

AWS Direct Connect API ReferenceCreateDirectConnectGatewayAssociationProposal

CreateDirectConnectGatewayAssociationProposalCreates a proposal to associate the specified virtual private gateway or transit gateway with the specifiedDirect Connect gateway.

You can associate a Direct Connect gateway and virtual private gateway or transit gateway that is ownedby any AWS account.

Request Syntax{ "addAllowedPrefixesToDirectConnectGateway": [ { "cidr": "string" } ], "directConnectGatewayId": "string", "directConnectGatewayOwnerAccount": "string", "gatewayId": "string", "removeAllowedPrefixesToDirectConnectGateway": [ { "cidr": "string" } ]}




The Amazon VPC prefixes to advertise to the Direct Connect gateway.




Type: String

Required: YesdirectConnectGatewayOwnerAccount (p. 67)

The ID of the AWS account that owns the Direct Connect gateway.

Type: String

Required: YesgatewayId (p. 67)

The ID of the virtual private gateway or transit gateway.



Type: String

Required: YesremoveAllowedPrefixesToDirectConnectGateway (p. 67)

The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.


Required: No

Response Syntax{ "directConnectGatewayAssociationProposal": { "associatedGateway": { "id": "string", "ownerAccount": "string", "region": "string", "type": "string" }, "directConnectGatewayId": "string", "directConnectGatewayOwnerAccount": "string", "existingAllowedPrefixesToDirectConnectGateway": [ { "cidr": "string" } ], "proposalId": "string", "proposalState": "string", "requestedAllowedPrefixesToDirectConnectGateway": [ { "cidr": "string" } ] }}



directConnectGatewayAssociationProposal (p. 68)

Information about the Direct Connect gateway proposal.

Type: DirectConnectGatewayAssociationProposal (p. 194) object












https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/CreateDirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/CreateDirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/CreateDirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/CreateDirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/CreateDirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/CreateDirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/CreateDirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/CreateDirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/CreateDirectConnectGatewayAssociationProposal

AWS Direct Connect API ReferenceCreateInterconnect

CreateInterconnectCreates an interconnect between an AWS Direct Connect Partner's network and a specific AWS DirectConnect location.

An interconnect is a connection that is capable of hosting other connections. The AWS Direct Connectpartner can use an interconnect to provide AWS Direct Connect hosted connections to customersthrough their own network services. Like a standard connection, an interconnect links the partner'snetwork to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. One end isconnected to the partner's router, the other to an AWS Direct Connect router.

You can automatically add the new interconnect to a link aggregation group (LAG) by specifying a LAGID in the request. This ensures that the new interconnect is allocated on the same AWS Direct Connectendpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request failsand no interconnect is created.

For each end customer, the AWS Direct Connect Partner provisions a connection on their interconnectby calling AllocateHostedConnection (p. 12). The end customer can then connect to AWS resources bycreating a virtual interface on their connection, using the VLAN assigned to them by the AWS DirectConnect Partner.


Request Syntax{ "bandwidth": "string", "interconnectName": "string", "lagId": "string", "location": "string", "providerName": "string", "tags": [ { "key": "string", "value": "string" } ]}



bandwidth (p. 70)

The port bandwidth, in Gbps. The possible values are 1 and 10.

Type: String

Required: YesinterconnectName (p. 70)

The name of the interconnect.

Type: String




The ID of the LAG.

Type: String

Required: Nolocation (p. 70)

The location of the interconnect.

Type: String

Required: YesproviderName (p. 70)

The name of the service provider associated with the interconnect.

Type: String

Required: Notags (p. 70)

The tags to associate with the interconnect.



Required: No

Response Syntax{ "awsDevice": "string", "awsDeviceV2": "string", "bandwidth": "string", "hasLogicalRedundancy": "string", "interconnectId": "string", "interconnectName": "string", "interconnectState": "string", "jumboFrameCapable": boolean, "lagId": "string", "loaIssueTime": number, "location": "string", "providerName": "string", "region": "string", "tags": [ { "key": "string", "value": "string" } ]}





awsDevice (p. 71)







Type: StringhasLogicalRedundancy (p. 71)

Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).

Type: String

Valid Values: unknown | yes | nointerconnectId (p. 71)

The ID of the interconnect.

Type: StringinterconnectName (p. 71)


Type: StringinterconnectState (p. 71)

The state of the interconnect. The following are the possible values:• requested: The initial state of an interconnect. The interconnect stays in the requested state

until the Letter of Authorization (LOA) is sent to the customer.• pending: The interconnect is approved, and is being initialized.• available: The network link is up, and the interconnect is ready for use.• down: The network link is down.• deleting: The interconnect is being deleted.• deleted: The interconnect is deleted.• unknown: The state of the interconnect is not available.

Type: String

Valid Values: requested | pending | available | down | deleting | deleted |unknown






The ID of the LAG.










The tags associated with the interconnect.


















https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/CreateInterconnect

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/CreateInterconnect

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/CreateInterconnect

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/CreateInterconnect

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/CreateInterconnect

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/CreateInterconnect

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/CreateInterconnect

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/CreateInterconnect

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/CreateInterconnect

AWS Direct Connect API ReferenceCreateLag

CreateLagCreates a link aggregation group (LAG) with the specified number of bundled physical connectionsbetween the customer network and a specific AWS Direct Connect location. A LAG is a logical interfacethat uses the Link Aggregation Control Protocol (LACP) to aggregate multiple interfaces, enabling you totreat them as a single interface.

All connections in a LAG must use the same bandwidth and must terminate at the same AWS DirectConnect endpoint.

You can have up to 10 connections per LAG. Regardless of this limit, if you request more connections forthe LAG than AWS Direct Connect can allocate on a single endpoint, no LAG is created.

You can specify an existing physical connection or interconnect to include in the LAG (which countstowards the total number of connections). Doing so interrupts the current physical connection or hostedconnections, and re-establishes them as a member of the LAG. The LAG will be created on the same AWSDirect Connect endpoint to which the connection terminates. Any virtual interfaces associated with theconnection are automatically disassociated and re-associated with the LAG. The connection ID does notchange.

If the AWS account used to create a LAG is a registered AWS Direct Connect Partner, the LAG isautomatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtualinterfaces cannot be directly configured.

Request Syntax{ "childConnectionTags": [ { "key": "string", "value": "string" } ], "connectionId": "string", "connectionsBandwidth": "string", "lagName": "string", "location": "string", "numberOfConnections": number, "providerName": "string", "tags": [ { "key": "string", "value": "string" } ]}



childConnectionTags (p. 75)

The tags to associate with the automtically created LAGs.





Required: NoconnectionId (p. 75)

The ID of an existing connection to migrate to the LAG.

Type: String

Required: NoconnectionsBandwidth (p. 75)

The bandwidth of the individual physical connections bundled by the LAG. The possible values are50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps.

Type: String

Required: YeslagName (p. 75)

The name of the LAG.

Type: String

Required: Yeslocation (p. 75)

The location for the LAG.

Type: String

Required: YesnumberOfConnections (p. 75)

The number of physical connections initially provisioned and bundled by the LAG.

Type: Integer

Required: YesproviderName (p. 75)

The name of the service provider associated with the LAG.

Type: String

Required: Notags (p. 75)

The tags to associate with the LAG.



Required: No

Response Syntax{



"allowsHostedConnections": boolean, "awsDevice": "string", "awsDeviceV2": "string", "connections": [ { "awsDevice": "string", "awsDeviceV2": "string", "bandwidth": "string", "connectionId": "string", "connectionName": "string", "connectionState": "string", "hasLogicalRedundancy": "string", "jumboFrameCapable": boolean, "lagId": "string", "loaIssueTime": number, "location": "string", "ownerAccount": "string", "partnerName": "string", "providerName": "string", "region": "string", "tags": [ { "key": "string", "value": "string" } ], "vlan": number } ], "connectionsBandwidth": "string", "hasLogicalRedundancy": "string", "jumboFrameCapable": boolean, "lagId": "string", "lagName": "string", "lagState": "string", "location": "string", "minimumLinks": number, "numberOfConnections": number, "ownerAccount": "string", "providerName": "string", "region": "string", "tags": [ { "key": "string", "value": "string" } ]}



allowsHostedConnections (p. 76)

Indicates whether the LAG can host other connections.

Type: BooleanawsDevice (p. 76)




The AWS Direct Connect endpoint that hosts the LAG.



Type: Stringconnections (p. 76)

The connections bundled by the LAG.

Type: Array of Connection (p. 187) objectsconnectionsBandwidth (p. 76)

The individual bandwidth of the physical connections bundled by the LAG. The possible values are1Gbps and 10Gbps.


Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

Type: String




The ID of the LAG.

Type: StringlagName (p. 76)


Type: StringlagState (p. 76)

The state of the LAG. The following are the possible values:• requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of

Authorization (LOA) is available.• pending: The LAG has been approved and is being initialized.• available: The network link is established and the LAG is ready for use.• down: The network link is down.• deleting: The LAG is being deleted.• deleted: The LAG is deleted.• unknown: The state of the LAG is not available.

Type: String




location (p. 76)

The location of the LAG.

Type: StringminimumLinks (p. 76)

The minimum number of physical connections that must be operational for the LAG itself to beoperational.

Type: IntegernumberOfConnections (p. 76)

The number of physical connections bundled by the LAG, up to a maximum of 10.


The ID of the AWS account that owns the LAG.






The tags associated with the LAG.













TooManyTagsException






https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/CreateLag

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/CreateLag

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/CreateLag

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/CreateLag

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/CreateLag

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/CreateLag

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/CreateLag

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/CreateLag

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/CreateLag

AWS Direct Connect API ReferenceCreatePrivateVirtualInterface

CreatePrivateVirtualInterfaceCreates a private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connecttraffic. A private virtual interface can be connected to either a Direct Connect gateway or a VirtualPrivate Gateway (VGW). Connecting the private virtual interface to a Direct Connect gateway enablesthe possibility for connecting to multiple VPCs, including VPCs in different AWS Regions. Connecting theprivate virtual interface to a VGW only provides access to a single VPC within the same Region.

Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlyingphysical connection if it wasn't updated to support jumbo frames. Updating the connection disruptsnetwork connectivity for all virtual interfaces associated with the connection for up to 30 seconds. Tocheck whether your connection supports jumbo frames, call DescribeConnections (p. 120). To checkwhether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces (p. 152).

Request Syntax{ "connectionId": "string", "newPrivateVirtualInterface": { "addressFamily": "string", "amazonAddress": "string", "asn": number, "authKey": "string", "customerAddress": "string", "directConnectGatewayId": "string", "mtu": number, "tags": [ { "key": "string", "value": "string" } ], "virtualGatewayId": "string", "virtualInterfaceName": "string", "vlan": number }}





Type: String

Required: Yes

newPrivateVirtualInterface (p. 81)

Information about the private virtual interface.

Type: NewPrivateVirtualInterface (p. 207) object



Required: Yes

Response Syntax{ "addressFamily": "string", "amazonAddress": "string", "amazonSideAsn": number, "asn": number, "authKey": "string", "awsDeviceV2": "string", "bgpPeers": [ { "addressFamily": "string", "amazonAddress": "string", "asn": number, "authKey": "string", "awsDeviceV2": "string", "bgpPeerId": "string", "bgpPeerState": "string", "bgpStatus": "string", "customerAddress": "string" } ], "connectionId": "string", "customerAddress": "string", "customerRouterConfig": "string", "directConnectGatewayId": "string", "jumboFrameCapable": boolean, "location": "string", "mtu": number, "ownerAccount": "string", "region": "string", "routeFilterPrefixes": [ { "cidr": "string" } ], "tags": [ { "key": "string", "value": "string" } ], "virtualGatewayId": "string", "virtualInterfaceId": "string", "virtualInterfaceName": "string", "virtualInterfaceState": "string", "virtualInterfaceType": "string", "vlan": number}







Type: String































Type: String





The ID of the VLAN.

Type: Integer
















https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/CreatePrivateVirtualInterface

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/CreatePrivateVirtualInterface

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/CreatePrivateVirtualInterface

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/CreatePrivateVirtualInterface

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/CreatePrivateVirtualInterface

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/CreatePrivateVirtualInterface

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/CreatePrivateVirtualInterface

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/CreatePrivateVirtualInterface

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/CreatePrivateVirtualInterface

AWS Direct Connect API ReferenceCreatePublicVirtualInterface

CreatePublicVirtualInterfaceCreates a public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connecttraffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon S3.

When creating an IPv6 public virtual interface (addressFamily is ipv6), leave the customer andamazon address fields blank to use auto-assigned IPv6 space. Custom IPv6 addresses are not supported.

Request Syntax

{ "connectionId": "string", "newPublicVirtualInterface": { "addressFamily": "string", "amazonAddress": "string", "asn": number, "authKey": "string", "customerAddress": "string", "routeFilterPrefixes": [ { "cidr": "string" } ], "tags": [ { "key": "string", "value": "string" } ], "virtualInterfaceName": "string", "vlan": number }}





Type: String

Required: Yes

newPublicVirtualInterface (p. 87)

Information about the public virtual interface.

Type: NewPublicVirtualInterface (p. 211) object

Required: Yes



Response Syntax

{ "addressFamily": "string", "amazonAddress": "string", "amazonSideAsn": number, "asn": number, "authKey": "string", "awsDeviceV2": "string", "bgpPeers": [ { "addressFamily": "string", "amazonAddress": "string", "asn": number, "authKey": "string", "awsDeviceV2": "string", "bgpPeerId": "string", "bgpPeerState": "string", "bgpStatus": "string", "customerAddress": "string" } ], "connectionId": "string", "customerAddress": "string", "customerRouterConfig": "string", "directConnectGatewayId": "string", "jumboFrameCapable": boolean, "location": "string", "mtu": number, "ownerAccount": "string", "region": "string", "routeFilterPrefixes": [ { "cidr": "string" } ], "tags": [ { "key": "string", "value": "string" } ], "virtualGatewayId": "string", "virtualInterfaceId": "string", "virtualInterfaceName": "string", "virtualInterfaceState": "string", "virtualInterfaceType": "string", "vlan": number}





Type: String


























Type: Boolean



location (p. 88)






























Type: String





The ID of the VLAN.

Type: Integer
















https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/CreatePublicVirtualInterface

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/CreatePublicVirtualInterface

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/CreatePublicVirtualInterface

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/CreatePublicVirtualInterface

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/CreatePublicVirtualInterface

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/CreatePublicVirtualInterface

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/CreatePublicVirtualInterface

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/CreatePublicVirtualInterface

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/CreatePublicVirtualInterface

AWS Direct Connect API ReferenceCreateTransitVirtualInterface

CreateTransitVirtualInterfaceCreates a transit virtual interface. A transit virtual interface should be used to access one or more transitgateways associated with Direct Connect gateways. A transit virtual interface enables the connection ofmultiple VPCs attached to a transit gateway to a Direct Connect gateway.

ImportantIf you associate your transit gateway with one or more Direct Connect gateways, theAutonomous System Number (ASN) used by the transit gateway and the Direct Connect gatewaymust be different. For example, if you use the default ASN 64512 for both your the transitgateway and Direct Connect gateway, the association request fails.

Setting the MTU of a virtual interface to 8500 (jumbo frames) can cause an update to the underlyingphysical connection if it wasn't updated to support jumbo frames. Updating the connection disruptsnetwork connectivity for all virtual interfaces associated with the connection for up to 30 seconds. Tocheck whether your connection supports jumbo frames, call DescribeConnections (p. 120). To checkwhether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces (p. 152).

Request Syntax{ "connectionId": "string", "newTransitVirtualInterface": { "addressFamily": "string", "amazonAddress": "string", "asn": number, "authKey": "string", "customerAddress": "string", "directConnectGatewayId": "string", "mtu": number, "tags": [ { "key": "string", "value": "string" } ], "virtualInterfaceName": "string", "vlan": number }}





Type: String

Required: YesnewTransitVirtualInterface (p. 93)

Information about the transit virtual interface.



Type: NewTransitVirtualInterface (p. 215) object

Required: Yes

Response Syntax{ "virtualInterface": { "addressFamily": "string", "amazonAddress": "string", "amazonSideAsn": number, "asn": number, "authKey": "string", "awsDeviceV2": "string", "bgpPeers": [ { "addressFamily": "string", "amazonAddress": "string", "asn": number, "authKey": "string", "awsDeviceV2": "string", "bgpPeerId": "string", "bgpPeerState": "string", "bgpStatus": "string", "customerAddress": "string" } ], "connectionId": "string", "customerAddress": "string", "customerRouterConfig": "string", "directConnectGatewayId": "string", "jumboFrameCapable": boolean, "location": "string", "mtu": number, "ownerAccount": "string", "region": "string", "routeFilterPrefixes": [ { "cidr": "string" } ], "tags": [ { "key": "string", "value": "string" } ], "virtualGatewayId": "string", "virtualInterfaceId": "string", "virtualInterfaceName": "string", "virtualInterfaceState": "string", "virtualInterfaceType": "string", "vlan": number }}






Information about a virtual interface.















https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/CreateTransitVirtualInterface

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/CreateTransitVirtualInterface

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/CreateTransitVirtualInterface

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/CreateTransitVirtualInterface

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/CreateTransitVirtualInterface

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/CreateTransitVirtualInterface

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/CreateTransitVirtualInterface

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/CreateTransitVirtualInterface

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/CreateTransitVirtualInterface

AWS Direct Connect API ReferenceDeleteBGPPeer

DeleteBGPPeerDeletes the specified BGP peer on the specified virtual interface with the specified customer address andASN.

You cannot delete the last BGP peer from a virtual interface.

Request Syntax{ "asn": number, "bgpPeerId": "string", "customerAddress": "string", "virtualInterfaceId": "string"}



asn (p. 96)


Type: Integer

Required: NobgpPeerId (p. 96)

The ID of the BGP peer.

Type: String

Required: NocustomerAddress (p. 96)


Type: String



Type: String

Required: No

Response Syntax{ "virtualInterface": { "addressFamily": "string",



"amazonAddress": "string", "amazonSideAsn": number, "asn": number, "authKey": "string", "awsDeviceV2": "string", "bgpPeers": [ { "addressFamily": "string", "amazonAddress": "string", "asn": number, "authKey": "string", "awsDeviceV2": "string", "bgpPeerId": "string", "bgpPeerState": "string", "bgpStatus": "string", "customerAddress": "string" } ], "connectionId": "string", "customerAddress": "string", "customerRouterConfig": "string", "directConnectGatewayId": "string", "jumboFrameCapable": boolean, "location": "string", "mtu": number, "ownerAccount": "string", "region": "string", "routeFilterPrefixes": [ { "cidr": "string" } ], "tags": [ { "key": "string", "value": "string" } ], "virtualGatewayId": "string", "virtualInterfaceId": "string", "virtualInterfaceName": "string", "virtualInterfaceState": "string", "virtualInterfaceType": "string", "vlan": number }}




The virtual interface.













https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/DeleteBGPPeer

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/DeleteBGPPeer

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DeleteBGPPeer

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DeleteBGPPeer

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DeleteBGPPeer

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/DeleteBGPPeer

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/DeleteBGPPeer

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/DeleteBGPPeer

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DeleteBGPPeer

AWS Direct Connect API ReferenceDeleteConnection

DeleteConnectionDeletes the specified connection.

Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. If you arepartnering with any third parties to connect with the AWS Direct Connect location, you must cancel yourservice with them separately.






Type: String

Required: Yes






awsDevice (p. 99)



Type: String

awsDeviceV2 (p. 99)


Type: String

bandwidth (p. 99)


Type: String



Type: String

connectionName (p. 99)


Type: String

connectionState (p. 99)

The state of the connection. The following are the possible values:

• ordering: The initial state of a hosted connection provisioned on an interconnect. Theconnection stays in the ordering state until the owner of the hosted connection confirms ordeclines the connection order.


• pending: The connection has been approved and is being initialized.

• available: The network link is up and the connection is ready for use.

• down: The network link is down.

• deleting: The connection is being deleted.

• deleted: The connection has been deleted.

• rejected: A hosted connection in the ordering state enters the rejected state if it is deletedby the customer.

• unknown: The state of the connection is not available.

Type: String






Type: String




The ID of the LAG.

















The ID of the VLAN.



Type: Integer










https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/DeleteConnection

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/DeleteConnection

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DeleteConnection

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DeleteConnection

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DeleteConnection

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/DeleteConnection

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/DeleteConnection

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/DeleteConnection

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DeleteConnection

AWS Direct Connect API ReferenceDeleteDirectConnectGateway

DeleteDirectConnectGatewayDeletes the specified Direct Connect gateway. You must first delete all virtual interfaces that areattached to the Direct Connect gateway and disassociate all virtual private gateways associated with theDirect Connect gateway.

Request Syntax{ "directConnectGatewayId": "string"}





Type: String

Required: Yes

Response Syntax{ "directConnectGateway": { "amazonSideAsn": number, "directConnectGatewayId": "string", "directConnectGatewayName": "string", "directConnectGatewayState": "string", "ownerAccount": "string", "stateChangeError": "string" }}



directConnectGateway (p. 103)

The Direct Connect gateway.

Type: DirectConnectGateway (p. 190) object












https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/DeleteDirectConnectGateway

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/DeleteDirectConnectGateway

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DeleteDirectConnectGateway

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DeleteDirectConnectGateway

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DeleteDirectConnectGateway

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/DeleteDirectConnectGateway

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/DeleteDirectConnectGateway

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/DeleteDirectConnectGateway

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DeleteDirectConnectGateway

AWS Direct Connect API ReferenceDeleteDirectConnectGatewayAssociation

DeleteDirectConnectGatewayAssociationDeletes the association between the specified Direct Connect gateway and virtual private gateway.

We recommend that you specify the associationID to delete the association. Alternatively, if you ownvirtual gateway and a Direct Connect gateway association, you can specify the virtualGatewayId anddirectConnectGatewayId to delete an association.

Request Syntax{ "associationId": "string", "directConnectGatewayId": "string", "virtualGatewayId": "string"}



associationId (p. 105)

The ID of the Direct Connect gateway association.

Type: String



Type: String



Type: String

Required: No

Response Syntax{ "directConnectGatewayAssociation": { "allowedPrefixesToDirectConnectGateway": [ { "cidr": "string" } ], "associatedGateway": {



"id": "string", "ownerAccount": "string", "region": "string", "type": "string" }, "associationId": "string", "associationState": "string", "directConnectGatewayId": "string", "directConnectGatewayOwnerAccount": "string", "stateChangeError": "string", "virtualGatewayId": "string", "virtualGatewayOwnerAccount": "string", "virtualGatewayRegion": "string" }}




Information about the deleted association.









• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python


https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/DeleteDirectConnectGatewayAssociation

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/DeleteDirectConnectGatewayAssociation

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DeleteDirectConnectGatewayAssociation

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DeleteDirectConnectGatewayAssociation

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DeleteDirectConnectGatewayAssociation

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/DeleteDirectConnectGatewayAssociation

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/DeleteDirectConnectGatewayAssociation

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/DeleteDirectConnectGatewayAssociation


• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DeleteDirectConnectGatewayAssociation

AWS Direct Connect API ReferenceDeleteDirectConnectGatewayAssociationProposal

DeleteDirectConnectGatewayAssociationProposalDeletes the association proposal request between the specified Direct Connect gateway and virtualprivate gateway or transit gateway.

Request Syntax{ "proposalId": "string"}



proposalId (p. 108)

The ID of the proposal.

Type: String

Required: Yes

Response Syntax{ "directConnectGatewayAssociationProposal": { "associatedGateway": { "id": "string", "ownerAccount": "string", "region": "string", "type": "string" }, "directConnectGatewayId": "string", "directConnectGatewayOwnerAccount": "string", "existingAllowedPrefixesToDirectConnectGateway": [ { "cidr": "string" } ], "proposalId": "string", "proposalState": "string", "requestedAllowedPrefixesToDirectConnectGateway": [ { "cidr": "string" } ] }}





directConnectGatewayAssociationProposal (p. 108)

The ID of the associated gateway.

Type: DirectConnectGatewayAssociationProposal (p. 194) object










https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/DeleteDirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/DeleteDirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DeleteDirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DeleteDirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DeleteDirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/DeleteDirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/DeleteDirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/DeleteDirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DeleteDirectConnectGatewayAssociationProposal

AWS Direct Connect API ReferenceDeleteInterconnect

DeleteInterconnectDeletes the specified interconnect.


Request Syntax{ "interconnectId": "string"}



interconnectId (p. 110)


Type: String

Required: Yes

Response Syntax{ "interconnectState": "string"}



interconnectState (p. 110)


until the Letter of Authorization (LOA) is sent to the customer.• pending: The interconnect is approved, and is being initialized.• available: The network link is up, and the interconnect is ready for use.• down: The network link is down.• deleting: The interconnect is being deleted.• deleted: The interconnect is deleted.• unknown: The state of the interconnect is not available.



Type: String











https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/DeleteInterconnect

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/DeleteInterconnect

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DeleteInterconnect

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DeleteInterconnect

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DeleteInterconnect

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/DeleteInterconnect

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/DeleteInterconnect

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/DeleteInterconnect

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DeleteInterconnect

AWS Direct Connect API ReferenceDeleteLag

DeleteLagDeletes the specified link aggregation group (LAG). You cannot delete a LAG if it has active virtualinterfaces or hosted connections.

Request Syntax{ "lagId": "string"}



lagId (p. 112)

The ID of the LAG.

Type: String

Required: Yes

Response Syntax{ "allowsHostedConnections": boolean, "awsDevice": "string", "awsDeviceV2": "string", "connections": [ { "awsDevice": "string", "awsDeviceV2": "string", "bandwidth": "string", "connectionId": "string", "connectionName": "string", "connectionState": "string", "hasLogicalRedundancy": "string", "jumboFrameCapable": boolean, "lagId": "string", "loaIssueTime": number, "location": "string", "ownerAccount": "string", "partnerName": "string", "providerName": "string", "region": "string", "tags": [ { "key": "string", "value": "string" } ], "vlan": number }



], "connectionsBandwidth": "string", "hasLogicalRedundancy": "string", "jumboFrameCapable": boolean, "lagId": "string", "lagName": "string", "lagState": "string", "location": "string", "minimumLinks": number, "numberOfConnections": number, "ownerAccount": "string", "providerName": "string", "region": "string", "tags": [ { "key": "string", "value": "string" } ]}
















Type: String






The ID of the LAG.






Type: String


location (p. 112)



























https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/DeleteLag

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/DeleteLag

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DeleteLag

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DeleteLag

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DeleteLag

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/DeleteLag

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/DeleteLag

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/DeleteLag

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DeleteLag

AWS Direct Connect API ReferenceDeleteVirtualInterface

DeleteVirtualInterfaceDeletes a virtual interface.






Type: String

Required: Yes










DeleteVirtualInterface (p. 116) until it can no longer forward traffic.



• deleted: A virtual interface that cannot forward traffic.• rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual



Type: String











https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/DeleteVirtualInterface

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/DeleteVirtualInterface

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DeleteVirtualInterface

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DeleteVirtualInterface

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DeleteVirtualInterface

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/DeleteVirtualInterface

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/DeleteVirtualInterface

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/DeleteVirtualInterface

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DeleteVirtualInterface

AWS Direct Connect API ReferenceDescribeConnectionLoa

DescribeConnectionLoaDeprecated. Use DescribeLoa (p. 144) instead.

Gets the LOA-CFA for a connection.

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APNpartner or service provider uses when establishing your cross connect to AWS at the colocation facility.For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS DirectConnect User Guide.

Request Syntax{ "connectionId": "string", "loaContentType": "string", "providerName": "string"}





Type: String

Required: YesloaContentType (p. 118)

The standard media type for the LOA-CFA document. The only supported value is application/pdf.

Type: String

Valid Values: application/pdf

Required: NoproviderName (p. 118)

The name of the APN partner or service provider who establishes connectivity on your behalf. If youspecify this parameter, the LOA-CFA lists the provider name alongside your company name as therequester of the cross connect.

Type: String

Required: No

Response Syntax{


https://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html


"loa": { "loaContent": blob, "loaContentType": "string" }}



loa (p. 118)

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA).

Type: Loa (p. 204) object










https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/DescribeConnectionLoa

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/DescribeConnectionLoa

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DescribeConnectionLoa

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DescribeConnectionLoa

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DescribeConnectionLoa

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/DescribeConnectionLoa

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/DescribeConnectionLoa

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/DescribeConnectionLoa

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DescribeConnectionLoa

AWS Direct Connect API ReferenceDescribeConnections

DescribeConnectionsDisplays the specified connection or all connections in this Region.

Request Syntax

{ "connectionId": "string"}





Type: String

Required: No

Response Syntax

{ "connections": [ { "awsDevice": "string", "awsDeviceV2": "string", "bandwidth": "string", "connectionId": "string", "connectionName": "string", "connectionState": "string", "hasLogicalRedundancy": "string", "jumboFrameCapable": boolean, "lagId": "string", "loaIssueTime": number, "location": "string", "ownerAccount": "string", "partnerName": "string", "providerName": "string", "region": "string", "tags": [ { "key": "string", "value": "string" } ], "vlan": number } ]}





connections (p. 120)

The connections.

Type: Array of Connection (p. 187) objects










https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/DescribeConnections

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/DescribeConnections

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DescribeConnections

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DescribeConnections

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DescribeConnections

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/DescribeConnections

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/DescribeConnections

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/DescribeConnections

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DescribeConnections

AWS Direct Connect API ReferenceDescribeConnectionsOnInterconnect

DescribeConnectionsOnInterconnectDeprecated. Use DescribeHostedConnections (p. 135) instead.

Lists the connections that have been provisioned on the specified interconnect.







Type: String

Required: Yes

Response Syntax{ "connections": [ { "awsDevice": "string", "awsDeviceV2": "string", "bandwidth": "string", "connectionId": "string", "connectionName": "string", "connectionState": "string", "hasLogicalRedundancy": "string", "jumboFrameCapable": boolean, "lagId": "string", "loaIssueTime": number, "location": "string", "ownerAccount": "string", "partnerName": "string", "providerName": "string", "region": "string", "tags": [ { "key": "string", "value": "string" } ], "vlan": number



} ]}




The connections.











https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/DescribeConnectionsOnInterconnect

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/DescribeConnectionsOnInterconnect

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DescribeConnectionsOnInterconnect

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DescribeConnectionsOnInterconnect

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DescribeConnectionsOnInterconnect

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/DescribeConnectionsOnInterconnect

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/DescribeConnectionsOnInterconnect

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/DescribeConnectionsOnInterconnect

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DescribeConnectionsOnInterconnect

AWS Direct Connect API ReferenceDescribeDirectConnectGatewayAssociationProposals

DescribeDirectConnectGatewayAssociationProposalsDescribes one or more association proposals for connection between a virtual private gateway or transitgateway and a Direct Connect gateway.

Request Syntax{ "associatedGatewayId": "string", "directConnectGatewayId": "string", "maxResults": number, "nextToken": "string", "proposalId": "string"}



associatedGatewayId (p. 124)


Type: String



Type: String

Required: NomaxResults (p. 124)

The maximum number of results to return with a single call. To retrieve the remaining results, makeanother call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

Type: Integer

Required: NonextToken (p. 124)

The token for the next page of results.

Type: String

Required: NoproposalId (p. 124)

The ID of the proposal.

Type: String



Required: No

Response Syntax{ "directConnectGatewayAssociationProposals": [ { "associatedGateway": { "id": "string", "ownerAccount": "string", "region": "string", "type": "string" }, "directConnectGatewayId": "string", "directConnectGatewayOwnerAccount": "string", "existingAllowedPrefixesToDirectConnectGateway": [ { "cidr": "string" } ], "proposalId": "string", "proposalState": "string", "requestedAllowedPrefixesToDirectConnectGateway": [ { "cidr": "string" } ] } ], "nextToken": "string"}



directConnectGatewayAssociationProposals (p. 125)

Describes the Direct Connect gateway association proposals.

Type: Array of DirectConnectGatewayAssociationProposal (p. 194) objectsnextToken (p. 125)

The token to use to retrieve the next page of results. This value is null when there are no moreresults to return.

Type: String












https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/DescribeDirectConnectGatewayAssociationProposals

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/DescribeDirectConnectGatewayAssociationProposals

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DescribeDirectConnectGatewayAssociationProposals

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DescribeDirectConnectGatewayAssociationProposals

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DescribeDirectConnectGatewayAssociationProposals

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/DescribeDirectConnectGatewayAssociationProposals

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/DescribeDirectConnectGatewayAssociationProposals

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/DescribeDirectConnectGatewayAssociationProposals

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DescribeDirectConnectGatewayAssociationProposals

AWS Direct Connect API ReferenceDescribeDirectConnectGatewayAssociations

DescribeDirectConnectGatewayAssociationsLists the associations between your Direct Connect gateways and virtual private gateways. You mustspecify a Direct Connect gateway, a virtual private gateway, or both. If you specify a Direct Connectgateway, the response contains all virtual private gateways associated with the Direct Connect gateway.If you specify a virtual private gateway, the response contains all Direct Connect gateways associatedwith the virtual private gateway. If you specify both, the response contains the association between theDirect Connect gateway and the virtual private gateway.

Request Syntax{ "associatedGatewayId": "string", "associationId": "string", "directConnectGatewayId": "string", "maxResults": number, "nextToken": "string", "virtualGatewayId": "string"}



associatedGatewayId (p. 127)


Type: String

Required: NoassociationId (p. 127)


Type: String



Type: String




Type: Integer




The token provided in the previous call to retrieve the next page.

Type: String



Type: String

Required: No

Response Syntax{ "directConnectGatewayAssociations": [ { "allowedPrefixesToDirectConnectGateway": [ { "cidr": "string" } ], "associatedGateway": { "id": "string", "ownerAccount": "string", "region": "string", "type": "string" }, "associationId": "string", "associationState": "string", "directConnectGatewayId": "string", "directConnectGatewayOwnerAccount": "string", "stateChangeError": "string", "virtualGatewayId": "string", "virtualGatewayOwnerAccount": "string", "virtualGatewayRegion": "string" } ], "nextToken": "string"}



directConnectGatewayAssociations (p. 128)

Information about the associations.

Type: Array of DirectConnectGatewayAssociation (p. 192) objectsnextToken (p. 128)

The token to retrieve the next page.



Type: String










https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/DescribeDirectConnectGatewayAssociations

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/DescribeDirectConnectGatewayAssociations

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DescribeDirectConnectGatewayAssociations

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DescribeDirectConnectGatewayAssociations

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DescribeDirectConnectGatewayAssociations

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/DescribeDirectConnectGatewayAssociations

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/DescribeDirectConnectGatewayAssociations

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/DescribeDirectConnectGatewayAssociations

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DescribeDirectConnectGatewayAssociations

AWS Direct Connect API ReferenceDescribeDirectConnectGatewayAttachments

DescribeDirectConnectGatewayAttachmentsLists the attachments between your Direct Connect gateways and virtual interfaces. You must specifya Direct Connect gateway, a virtual interface, or both. If you specify a Direct Connect gateway, theresponse contains all virtual interfaces attached to the Direct Connect gateway. If you specify a virtualinterface, the response contains all Direct Connect gateways attached to the virtual interface. If youspecify both, the response contains the attachment between the Direct Connect gateway and the virtualinterface.

Request Syntax{ "directConnectGatewayId": "string", "maxResults": number, "nextToken": "string", "virtualInterfaceId": "string"}





Type: String




Type: Integer



Type: String



Type: String

Required: No



Response Syntax{ "directConnectGatewayAttachments": [ { "attachmentState": "string", "attachmentType": "string", "directConnectGatewayId": "string", "stateChangeError": "string", "virtualInterfaceId": "string", "virtualInterfaceOwnerAccount": "string", "virtualInterfaceRegion": "string" } ], "nextToken": "string"}



directConnectGatewayAttachments (p. 131)

The attachments.

Type: Array of DirectConnectGatewayAttachment (p. 196) objectsnextToken (p. 131)


Type: String








• AWS Command Line Interface• AWS SDK for .NET


https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/DescribeDirectConnectGatewayAttachments

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/DescribeDirectConnectGatewayAttachments


• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DescribeDirectConnectGatewayAttachments

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DescribeDirectConnectGatewayAttachments

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DescribeDirectConnectGatewayAttachments

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/DescribeDirectConnectGatewayAttachments

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/DescribeDirectConnectGatewayAttachments

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/DescribeDirectConnectGatewayAttachments

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DescribeDirectConnectGatewayAttachments

AWS Direct Connect API ReferenceDescribeDirectConnectGateways

DescribeDirectConnectGatewaysLists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted DirectConnect gateways are not returned.

Request Syntax{ "directConnectGatewayId": "string", "maxResults": number, "nextToken": "string"}





Type: String




Type: Integer



Type: String

Required: No

Response Syntax{ "directConnectGateways": [ { "amazonSideAsn": number, "directConnectGatewayId": "string", "directConnectGatewayName": "string", "directConnectGatewayState": "string", "ownerAccount": "string",



"stateChangeError": "string" } ], "nextToken": "string"}



directConnectGateways (p. 133)

The Direct Connect gateways.

Type: Array of DirectConnectGateway (p. 190) objectsnextToken (p. 133)


Type: String










https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/DescribeDirectConnectGateways

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/DescribeDirectConnectGateways

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DescribeDirectConnectGateways

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DescribeDirectConnectGateways

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DescribeDirectConnectGateways

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/DescribeDirectConnectGateways

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/DescribeDirectConnectGateways

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/DescribeDirectConnectGateways

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DescribeDirectConnectGateways

AWS Direct Connect API ReferenceDescribeHostedConnections

DescribeHostedConnectionsLists the hosted connections that have been provisioned on the specified interconnect or linkaggregation group (LAG).






The ID of the interconnect or LAG.

Type: String

Required: Yes

Response Syntax{ "connections": [ { "awsDevice": "string", "awsDeviceV2": "string", "bandwidth": "string", "connectionId": "string", "connectionName": "string", "connectionState": "string", "hasLogicalRedundancy": "string", "jumboFrameCapable": boolean, "lagId": "string", "loaIssueTime": number, "location": "string", "ownerAccount": "string", "partnerName": "string", "providerName": "string", "region": "string", "tags": [ { "key": "string", "value": "string" } ], "vlan": number }



]}




The connections.











https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/DescribeHostedConnections

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/DescribeHostedConnections

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DescribeHostedConnections

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DescribeHostedConnections

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DescribeHostedConnections

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/DescribeHostedConnections

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/DescribeHostedConnections

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/DescribeHostedConnections

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DescribeHostedConnections

AWS Direct Connect API ReferenceDescribeInterconnectLoa

DescribeInterconnectLoaDeprecated. Use DescribeLoa (p. 144) instead.

Gets the LOA-CFA for the specified interconnect.

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used whenestablishing your cross connect to AWS at the colocation facility. For more information, see RequestingCross Connects at AWS Direct Connect Locations in the AWS Direct Connect User Guide.

Request Syntax{ "interconnectId": "string", "loaContentType": "string", "providerName": "string"}





Type: String



Type: String



The name of the service provider who establishes connectivity on your behalf. If you supply thisparameter, the LOA-CFA lists the provider name alongside your company name as the requester ofthe cross connect.

Type: String

Required: No

Response Syntax{ "loa": {





"loaContent": blob, "loaContentType": "string" }}



loa (p. 137)

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA).

Type: Loa (p. 204) object










https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/DescribeInterconnectLoa

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/DescribeInterconnectLoa

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DescribeInterconnectLoa

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DescribeInterconnectLoa

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DescribeInterconnectLoa

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/DescribeInterconnectLoa

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/DescribeInterconnectLoa

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/DescribeInterconnectLoa

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DescribeInterconnectLoa

AWS Direct Connect API ReferenceDescribeInterconnects

DescribeInterconnectsLists the interconnects owned by the AWS account or only the specified interconnect.






Type: String

Required: No

Response Syntax{ "interconnects": [ { "awsDevice": "string", "awsDeviceV2": "string", "bandwidth": "string", "hasLogicalRedundancy": "string", "interconnectId": "string", "interconnectName": "string", "interconnectState": "string", "jumboFrameCapable": boolean, "lagId": "string", "loaIssueTime": number, "location": "string", "providerName": "string", "region": "string", "tags": [ { "key": "string", "value": "string" } ] } ]}





interconnects (p. 139)

The interconnects.

Type: Array of Interconnect (p. 198) objects










https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/DescribeInterconnects

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/DescribeInterconnects

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DescribeInterconnects

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DescribeInterconnects

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DescribeInterconnects

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/DescribeInterconnects

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/DescribeInterconnects

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/DescribeInterconnects

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DescribeInterconnects

AWS Direct Connect API ReferenceDescribeLags

DescribeLagsDescribes all your link aggregation groups (LAG) or the specified LAG.

Request Syntax{ "lagId": "string"}



lagId (p. 141)

The ID of the LAG.

Type: String

Required: No

Response Syntax{ "lags": [ { "allowsHostedConnections": boolean, "awsDevice": "string", "awsDeviceV2": "string", "connections": [ { "awsDevice": "string", "awsDeviceV2": "string", "bandwidth": "string", "connectionId": "string", "connectionName": "string", "connectionState": "string", "hasLogicalRedundancy": "string", "jumboFrameCapable": boolean, "lagId": "string", "loaIssueTime": number, "location": "string", "ownerAccount": "string", "partnerName": "string", "providerName": "string", "region": "string", "tags": [ { "key": "string", "value": "string" } ], "vlan": number



} ], "connectionsBandwidth": "string", "hasLogicalRedundancy": "string", "jumboFrameCapable": boolean, "lagId": "string", "lagName": "string", "lagState": "string", "location": "string", "minimumLinks": number, "numberOfConnections": number, "ownerAccount": "string", "providerName": "string", "region": "string", "tags": [ { "key": "string", "value": "string" } ] } ]}



lags (p. 141)

The LAGs.

Type: Array of Lag (p. 201) objects








• AWS Command Line Interface• AWS SDK for .NET


https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/DescribeLags

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/DescribeLags


• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DescribeLags

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DescribeLags

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DescribeLags

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/DescribeLags

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/DescribeLags

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/DescribeLags

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DescribeLags

AWS Direct Connect API ReferenceDescribeLoa

DescribeLoaGets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used whenestablishing your cross connect to AWS at the colocation facility. For more information, see RequestingCross Connects at AWS Direct Connect Locations in the AWS Direct Connect User Guide.

Request Syntax{ "connectionId": "string", "loaContentType": "string", "providerName": "string"}




The ID of a connection, LAG, or interconnect.

Type: String



Type: String



The name of the service provider who establishes connectivity on your behalf. If you specify thisparameter, the LOA-CFA lists the provider name alongside your company name as the requester ofthe cross connect.

Type: String

Required: No

Response Syntax{ "loaContent": blob, "loaContentType": "string"





}



loaContent (p. 144)

The binary contents of the LOA-CFA document.

Type: Base64-encoded binary data objectloaContentType (p. 144)


Type: String











https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/DescribeLoa

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/DescribeLoa

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DescribeLoa

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DescribeLoa

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DescribeLoa

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/DescribeLoa

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/DescribeLoa

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/DescribeLoa

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DescribeLoa

AWS Direct Connect API ReferenceDescribeLocations

DescribeLocationsLists the AWS Direct Connect locations in the current AWS Region. These are the locations that can beselected when calling CreateConnection (p. 57) or CreateInterconnect (p. 70).

Response Syntax{ "locations": [ { "availablePortSpeeds": [ "string" ], "availableProviders": [ "string" ], "locationCode": "string", "locationName": "string", "region": "string" } ]}



locations (p. 146)

The locations.

Type: Array of Location (p. 205) objects








• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++


https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/DescribeLocations

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/DescribeLocations

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DescribeLocations


• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DescribeLocations

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DescribeLocations

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/DescribeLocations

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/DescribeLocations

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/DescribeLocations

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DescribeLocations

AWS Direct Connect API ReferenceDescribeTags

DescribeTagsDescribes the tags associated with the specified AWS Direct Connect resources.

Request Syntax

{ "resourceArns": [ "string" ]}



resourceArns (p. 148)

The Amazon Resource Names (ARNs) of the resources.

Type: Array of strings

Required: Yes

Response Syntax

{ "resourceTags": [ { "resourceArn": "string", "tags": [ { "key": "string", "value": "string" } ] } ]}



resourceTags (p. 148)

Information about the tags.

Type: Array of ResourceTag (p. 219) objects












https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/DescribeTags

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/DescribeTags

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DescribeTags

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DescribeTags

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DescribeTags

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/DescribeTags

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/DescribeTags

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/DescribeTags

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DescribeTags

AWS Direct Connect API ReferenceDescribeVirtualGateways

DescribeVirtualGatewaysLists the virtual private gateways owned by the AWS account.

You can create one or more AWS Direct Connect private virtual interfaces linked to a virtual privategateway.

Response Syntax{ "virtualGateways": [ { "virtualGatewayId": "string", "virtualGatewayState": "string" } ]}



virtualGateways (p. 150)

The virtual private gateways.

Type: Array of VirtualGateway (p. 222) objects








• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go


https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/DescribeVirtualGateways

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/DescribeVirtualGateways

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DescribeVirtualGateways

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DescribeVirtualGateways


• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DescribeVirtualGateways

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/DescribeVirtualGateways

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/DescribeVirtualGateways

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/DescribeVirtualGateways

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DescribeVirtualGateways

AWS Direct Connect API ReferenceDescribeVirtualInterfaces

DescribeVirtualInterfacesDisplays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutesbefore you make the request are also returned. If you specify a connection ID, only the virtual interfacesassociated with the connection are returned. If you specify a virtual interface ID, then only a singlevirtual interface is returned.

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and thecustomer network.

Request Syntax{ "connectionId": "string", "virtualInterfaceId": "string"}





Type: String



Type: String

Required: No

Response Syntax{ "virtualInterfaces": [ { "addressFamily": "string", "amazonAddress": "string", "amazonSideAsn": number, "asn": number, "authKey": "string", "awsDeviceV2": "string", "bgpPeers": [ { "addressFamily": "string", "amazonAddress": "string", "asn": number, "authKey": "string",



"awsDeviceV2": "string", "bgpPeerId": "string", "bgpPeerState": "string", "bgpStatus": "string", "customerAddress": "string" } ], "connectionId": "string", "customerAddress": "string", "customerRouterConfig": "string", "directConnectGatewayId": "string", "jumboFrameCapable": boolean, "location": "string", "mtu": number, "ownerAccount": "string", "region": "string", "routeFilterPrefixes": [ { "cidr": "string" } ], "tags": [ { "key": "string", "value": "string" } ], "virtualGatewayId": "string", "virtualInterfaceId": "string", "virtualInterfaceName": "string", "virtualInterfaceState": "string", "virtualInterfaceType": "string", "vlan": number } ]}



virtualInterfaces (p. 152)

The virtual interfaces

Type: Array of VirtualInterface (p. 223) objects












https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/DescribeVirtualInterfaces

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/DescribeVirtualInterfaces

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DescribeVirtualInterfaces

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DescribeVirtualInterfaces

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DescribeVirtualInterfaces

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/DescribeVirtualInterfaces

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/DescribeVirtualInterfaces

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/DescribeVirtualInterfaces

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DescribeVirtualInterfaces

AWS Direct Connect API ReferenceDisassociateConnectionFromLag

DisassociateConnectionFromLagDisassociates a connection from a link aggregation group (LAG). The connection is interrupted and re-established as a standalone connection (the connection is not deleted; to delete the connection, use theDeleteConnection (p. 99) request). If the LAG has associated virtual interfaces or hosted connections,they remain associated with the LAG. A disassociated connection owned by an AWS Direct ConnectPartner is automatically converted to an interconnect.

If disassociating the connection would cause the LAG to fall below its setting for minimum number ofoperational connections, the request fails, except when it's the last member of the LAG. If all connectionsare disassociated, the LAG continues to exist as an empty LAG with no physical connections.

Request Syntax{ "connectionId": "string", "lagId": "string"}





Type: String


The ID of the LAG.

Type: String

Required: Yes

Response Syntax{ "awsDevice": "string", "awsDeviceV2": "string", "bandwidth": "string", "connectionId": "string", "connectionName": "string", "connectionState": "string", "hasLogicalRedundancy": "string", "jumboFrameCapable": boolean, "lagId": "string", "loaIssueTime": number, "location": "string",



"ownerAccount": "string", "partnerName": "string", "providerName": "string", "region": "string", "tags": [ { "key": "string", "value": "string" } ], "vlan": number}



awsDevice (p. 155)















• pending: The connection has been approved and is being initialized.• available: The network link is up and the connection is ready for use.• down: The network link is down.



• deleting: The connection is being deleted.• deleted: The connection has been deleted.• rejected: A hosted connection in the ordering state enters the rejected state if it is deleted


Type: String




Type: String




The ID of the LAG.













Type: String



tags (p. 155)




The ID of the VLAN.

Type: Integer










https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/DisassociateConnectionFromLag

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/DisassociateConnectionFromLag

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DisassociateConnectionFromLag

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DisassociateConnectionFromLag

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DisassociateConnectionFromLag

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/DisassociateConnectionFromLag

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/DisassociateConnectionFromLag

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/DisassociateConnectionFromLag

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DisassociateConnectionFromLag

AWS Direct Connect API ReferenceListVirtualInterfaceTestHistory

ListVirtualInterfaceTestHistoryLists the virtual interface failover test history.

Request Syntax{ "bgpPeers": [ "string" ], "maxResults": number, "nextToken": "string", "status": "string", "testId": "string", "virtualInterfaceId": "string"}



bgpPeers (p. 159)

The BGP peers that were placed in the DOWN state during the virtual interface failover test.





Type: Integer


The token for the next page of results.

Type: String

Required: Nostatus (p. 159)

The status of the virtual interface failover test.

Type: String

Required: NotestId (p. 159)

The ID of the virtual interface failover test.



Type: String


The ID of the virtual interface that was tested.

Type: String

Required: No

Response Syntax{ "nextToken": "string", "virtualInterfaceTestHistory": [ { "bgpPeers": [ "string" ], "endTime": number, "ownerAccount": "string", "startTime": number, "status": "string", "testDurationInMinutes": number, "testId": "string", "virtualInterfaceId": "string" } ]}



nextToken (p. 160)

The token to use to retrieve the next page of results. This value is null when there are no moreresults to return.

Type: StringvirtualInterfaceTestHistory (p. 160)

The ID of the tested virtual interface.

Type: Array of VirtualInterfaceTestHistory (p. 227) objects







DirectConnectServerException






https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/ListVirtualInterfaceTestHistory

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/ListVirtualInterfaceTestHistory

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/ListVirtualInterfaceTestHistory

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/ListVirtualInterfaceTestHistory

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/ListVirtualInterfaceTestHistory

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/ListVirtualInterfaceTestHistory

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/ListVirtualInterfaceTestHistory

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/ListVirtualInterfaceTestHistory

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/ListVirtualInterfaceTestHistory

AWS Direct Connect API ReferenceStartBgpFailoverTest

StartBgpFailoverTestStarts the virtual interface failover test that verifies your configuration meets your resiliencyrequirements by placing the BGP peering session in the DOWN state. You can then send traffic to verifythat there are no outages.

You can run the test on public, private, transit, and hosted virtual interfaces.

You can use ListVirtualInterfaceTestHistory to view the virtual interface test history.

If you need to stop the test before the test interval completes, use StopBgpFailoverTest.

Request Syntax{ "bgpPeers": [ "string" ], "testDurationInMinutes": number, "virtualInterfaceId": "string"}



bgpPeers (p. 162)

The BGP peers to place in the DOWN state.


Required: NotestDurationInMinutes (p. 162)

The time in minutes that the virtual interface failover test will last.

Maximum value: 180 minutes (3 hours).

Default: 180 minutes (3 hours).

Type: Integer


The ID of the virtual interface you want to test.

Type: String

Required: Yes

Response Syntax{


https://docs.aws.amazon.com/directconnect/latest/APIReference/API_ListVirtualInterfaceTestHistory.html

https://docs.aws.amazon.com/directconnect/latest/APIReference/API_StopBgpFailoverTest.html


"virtualInterfaceTest": { "bgpPeers": [ "string" ], "endTime": number, "ownerAccount": "string", "startTime": number, "status": "string", "testDurationInMinutes": number, "testId": "string", "virtualInterfaceId": "string" }}



virtualInterfaceTest (p. 162)

Information about the virtual interface failover test.

Type: VirtualInterfaceTestHistory (p. 227) object










https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/StartBgpFailoverTest

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/StartBgpFailoverTest

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/StartBgpFailoverTest

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/StartBgpFailoverTest

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/StartBgpFailoverTest

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/StartBgpFailoverTest

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/StartBgpFailoverTest

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/StartBgpFailoverTest

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/StartBgpFailoverTest

AWS Direct Connect API ReferenceStopBgpFailoverTest

StopBgpFailoverTestStops the virtual interface failover test.





The ID of the virtual interface you no longer want to test.

Type: String

Required: Yes

Response Syntax{ "virtualInterfaceTest": { "bgpPeers": [ "string" ], "endTime": number, "ownerAccount": "string", "startTime": number, "status": "string", "testDurationInMinutes": number, "testId": "string", "virtualInterfaceId": "string" }}



virtualInterfaceTest (p. 164)

Information about the virtual interface failover test.

Type: VirtualInterfaceTestHistory (p. 227) object












https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/StopBgpFailoverTest

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/StopBgpFailoverTest

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/StopBgpFailoverTest

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/StopBgpFailoverTest

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/StopBgpFailoverTest

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/StopBgpFailoverTest

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/StopBgpFailoverTest

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/StopBgpFailoverTest

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/StopBgpFailoverTest

AWS Direct Connect API ReferenceTagResource

TagResourceAdds the specified tags to the specified AWS Direct Connect resource. Each resource can have amaximum of 50 tags.

Each tag consists of a key and an optional value. If a tag with the same key is already associated with theresource, this action updates its value.

Request Syntax{ "resourceArn": "string", "tags": [ { "key": "string", "value": "string" } ]}



resourceArn (p. 166)

The Amazon Resource Name (ARN) of the resource.

Type: String

Required: Yestags (p. 166)

The tags to add.



Required: Yes

Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
















https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/TagResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/TagResource

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/TagResource

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/TagResource

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/TagResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/TagResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/TagResource

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/TagResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/TagResource

AWS Direct Connect API ReferenceUntagResource

UntagResourceRemoves one or more tags from the specified AWS Direct Connect resource.

Request Syntax{ "resourceArn": "string", "tagKeys": [ "string" ]}



resourceArn (p. 168)


Type: String

Required: YestagKeys (p. 168)

The tag keys of the tags to remove.


Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: Yes

Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.












https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/UntagResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/UntagResource

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/UntagResource

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/UntagResource

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/UntagResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/UntagResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/UntagResource

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/UntagResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/UntagResource

AWS Direct Connect API ReferenceUpdateDirectConnectGatewayAssociation

UpdateDirectConnectGatewayAssociationUpdates the specified attributes of the Direct Connect gateway association.

Add or remove prefixes from the association.

Request Syntax{ "addAllowedPrefixesToDirectConnectGateway": [ { "cidr": "string" } ], "associationId": "string", "removeAllowedPrefixesToDirectConnectGateway": [ { "cidr": "string" } ]}






Required: NoassociationId (p. 170)


Type: String

Required: NoremoveAllowedPrefixesToDirectConnectGateway (p. 170)

The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.


Required: No

Response Syntax{ "directConnectGatewayAssociation": {



"allowedPrefixesToDirectConnectGateway": [ { "cidr": "string" } ], "associatedGateway": { "id": "string", "ownerAccount": "string", "region": "string", "type": "string" }, "associationId": "string", "associationState": "string", "directConnectGatewayId": "string", "directConnectGatewayOwnerAccount": "string", "stateChangeError": "string", "virtualGatewayId": "string", "virtualGatewayOwnerAccount": "string", "virtualGatewayRegion": "string" }}




Information about an association between a Direct Connect gateway and a virtual private gatewayor transit gateway.









• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++


https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/UpdateDirectConnectGatewayAssociation

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/UpdateDirectConnectGatewayAssociation

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/UpdateDirectConnectGatewayAssociation


• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/UpdateDirectConnectGatewayAssociation

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/UpdateDirectConnectGatewayAssociation

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/UpdateDirectConnectGatewayAssociation

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/UpdateDirectConnectGatewayAssociation

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/UpdateDirectConnectGatewayAssociation

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/UpdateDirectConnectGatewayAssociation

AWS Direct Connect API ReferenceUpdateLag

UpdateLagUpdates the attributes of the specified link aggregation group (LAG).

You can update the following attributes:

• The name of the LAG.

• The value for the minimum number of connections that must be operational for the LAG itself to beoperational.

When you create a LAG, the default value for the minimum number of operational connections is zero(0). If you update this value and the number of operational connections falls below the specified value,the LAG automatically goes down to avoid over-utilization of the remaining connections. Adjust thisvalue with care, as it could force the LAG down if it is set higher than the current number of operationalconnections.

Request Syntax

{ "lagId": "string", "lagName": "string", "minimumLinks": number}



lagId (p. 173)

The ID of the LAG.

Type: String

Required: Yes

lagName (p. 173)


Type: String

Required: No

minimumLinks (p. 173)


Type: Integer

Required: No



Response Syntax

{ "allowsHostedConnections": boolean, "awsDevice": "string", "awsDeviceV2": "string", "connections": [ { "awsDevice": "string", "awsDeviceV2": "string", "bandwidth": "string", "connectionId": "string", "connectionName": "string", "connectionState": "string", "hasLogicalRedundancy": "string", "jumboFrameCapable": boolean, "lagId": "string", "loaIssueTime": number, "location": "string", "ownerAccount": "string", "partnerName": "string", "providerName": "string", "region": "string", "tags": [ { "key": "string", "value": "string" } ], "vlan": number } ], "connectionsBandwidth": "string", "hasLogicalRedundancy": "string", "jumboFrameCapable": boolean, "lagId": "string", "lagName": "string", "lagState": "string", "location": "string", "minimumLinks": number, "numberOfConnections": number, "ownerAccount": "string", "providerName": "string", "region": "string", "tags": [ { "key": "string", "value": "string" } ]}


















Type: String




The ID of the LAG.








Type: String


location (p. 174)



























https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/UpdateLag

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/UpdateLag

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/UpdateLag

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/UpdateLag

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/UpdateLag

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/UpdateLag

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/UpdateLag

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/UpdateLag

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/UpdateLag

AWS Direct Connect API ReferenceUpdateVirtualInterfaceAttributes

UpdateVirtualInterfaceAttributesUpdates the specified attributes of the specified virtual private interface.

Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlyingphysical connection if it wasn't updated to support jumbo frames. Updating the connection disruptsnetwork connectivity for all virtual interfaces associated with the connection for up to 30 seconds. Tocheck whether your connection supports jumbo frames, call DescribeConnections (p. 120). To checkwhether your virtual q interface supports jumbo frames, call DescribeVirtualInterfaces (p. 152).

Request Syntax{ "mtu": number, "virtualInterfaceId": "string"}



mtu (p. 178)


Type: Integer


The ID of the virtual private interface.

Type: String

Required: Yes

Response Syntax{ "addressFamily": "string", "amazonAddress": "string", "amazonSideAsn": number, "asn": number, "authKey": "string", "awsDeviceV2": "string", "bgpPeers": [ { "addressFamily": "string", "amazonAddress": "string", "asn": number, "authKey": "string",



"awsDeviceV2": "string", "bgpPeerId": "string", "bgpPeerState": "string", "bgpStatus": "string", "customerAddress": "string" } ], "connectionId": "string", "customerAddress": "string", "customerRouterConfig": "string", "directConnectGatewayId": "string", "jumboFrameCapable": boolean, "location": "string", "mtu": number, "ownerAccount": "string", "region": "string", "routeFilterPrefixes": [ { "cidr": "string" } ], "tags": [ { "key": "string", "value": "string" } ], "virtualGatewayId": "string", "virtualInterfaceId": "string", "virtualInterfaceName": "string", "virtualInterfaceState": "string", "virtualInterfaceType": "string", "vlan": number}





Type: String































Type: String







The ID of the VLAN.

Type: Integer










https://docs.aws.amazon.com/goto/aws-cli/directconnect-2012-10-25/UpdateVirtualInterfaceAttributes

https://docs.aws.amazon.com/goto/DotNetSDKV3/directconnect-2012-10-25/UpdateVirtualInterfaceAttributes

https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/UpdateVirtualInterfaceAttributes

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/UpdateVirtualInterfaceAttributes

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/UpdateVirtualInterfaceAttributes

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/directconnect-2012-10-25/UpdateVirtualInterfaceAttributes

https://docs.aws.amazon.com/goto/SdkForPHPV3/directconnect-2012-10-25/UpdateVirtualInterfaceAttributes

https://docs.aws.amazon.com/goto/boto3/directconnect-2012-10-25/UpdateVirtualInterfaceAttributes

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/UpdateVirtualInterfaceAttributes


Data TypesThe AWS Direct Connect API contains several data types that various actions use. This section describeseach data type in detail.

NoteThe order of each element in a data type structure is not guaranteed. Applications should notassume a particular order.

The following data types are supported:

• AssociatedGateway (p. 184)• BGPPeer (p. 185)• Connection (p. 187)• DirectConnectGateway (p. 190)• DirectConnectGatewayAssociation (p. 192)• DirectConnectGatewayAssociationProposal (p. 194)• DirectConnectGatewayAttachment (p. 196)• Interconnect (p. 198)• Lag (p. 201)• Loa (p. 204)• Location (p. 205)• NewBGPPeer (p. 206)• NewPrivateVirtualInterface (p. 207)• NewPrivateVirtualInterfaceAllocation (p. 209)• NewPublicVirtualInterface (p. 211)• NewPublicVirtualInterfaceAllocation (p. 213)• NewTransitVirtualInterface (p. 215)• NewTransitVirtualInterfaceAllocation (p. 217)• ResourceTag (p. 219)• RouteFilterPrefix (p. 220)• Tag (p. 221)• VirtualGateway (p. 222)• VirtualInterface (p. 223)• VirtualInterfaceTestHistory (p. 227)


AWS Direct Connect API ReferenceAssociatedGateway

AssociatedGatewayInformation about the associated gateway.

Contentsid


Type: String

Required: NoownerAccount

The ID of the AWS account that owns the associated virtual private gateway or transit gateway.

Type: String

Required: Noregion

The Region where the associated gateway is located.

Type: String

Required: Notype

The type of associated gateway.

Type: String

Valid Values: virtualPrivateGateway | transitGateway

Required: No


• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/AssociatedGateway

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/AssociatedGateway

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/AssociatedGateway

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/AssociatedGateway

AWS Direct Connect API ReferenceBGPPeer

BGPPeerInformation about a BGP peer.

ContentsaddressFamily


Type: String

Valid Values: ipv4 | ipv6

Required: NoamazonAddress


Type: String

Required: Noasn


Type: Integer

Required: NoauthKey


Type: String

Required: NoawsDeviceV2

The Direct Connect endpoint on which the BGP peer terminates.

Type: String

Required: NobgpPeerId

The ID of the BGP peer.

Type: String

Required: NobgpPeerState

The state of the BGP peer. The following are the possible values:• verifying: The BGP peering addresses or ASN require validation before the BGP peer can be

created. This state applies only to public virtual interfaces.• pending: The BGP peer is created, and remains in this state until it is ready to be established.



• available: The BGP peer is ready to be established.• deleting: The BGP peer is being deleted.• deleted: The BGP peer is deleted and cannot be established.

Type: String

Valid Values: verifying | pending | available | deleting | deleted

Required: NobgpStatus

The status of the BGP peer. The following are the possible values:• up: The BGP peer is established. This state does not indicate the state of the routing function.

Ensure that you are receiving routes over the BGP session.• down: The BGP peer is down.• unknown: The BGP peer status is not available.

Type: String

Valid Values: up | down | unknown

Required: NocustomerAddress


Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/BGPPeer

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/BGPPeer

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/BGPPeer

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/BGPPeer

AWS Direct Connect API ReferenceConnection

ConnectionInformation about an AWS Direct Connect connection.

ContentsawsDevice

This member has been deprecated.


Type: String



Type: String

Required: Nobandwidth


Type: String

Required: NoconnectionId


Type: String

Required: NoconnectionName


Type: String

Required: NoconnectionState




• pending: The connection has been approved and is being initialized.• available: The network link is up and the connection is ready for use.• down: The network link is down.• deleting: The connection is being deleted.


AWS Direct Connect API ReferenceContents

• deleted: The connection has been deleted.• rejected: A hosted connection in the ordering state enters the rejected state if it is deleted


Type: String


Required: NohasLogicalRedundancy


Type: String


Required: NojumboFrameCapable


Type: Boolean

Required: NolagId

The ID of the LAG.

Type: String

Required: NoloaIssueTime


Type: Timestamp

Required: Nolocation


Type: String



Type: String

Required: NopartnerName




Type: String

Required: NoproviderName


Type: String

Required: Noregion


Type: String

Required: Notags




Required: Novlan

The ID of the VLAN.

Type: Integer

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/Connection

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/Connection

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/Connection

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/Connection

AWS Direct Connect API ReferenceDirectConnectGateway

DirectConnectGatewayInformation about a Direct Connect gateway, which enables you to connect virtual interfaces and virtualprivate gateway or transit gateways.

ContentsamazonSideAsn


Type: Long

Required: NodirectConnectGatewayId


Type: String

Required: NodirectConnectGatewayName

The name of the Direct Connect gateway.

Type: String

Required: NodirectConnectGatewayState

The state of the Direct Connect gateway. The following are the possible values:• pending: The initial state after calling CreateDirectConnectGateway (p. 62).• available: The Direct Connect gateway is ready for use.• deleting: The initial state after calling DeleteDirectConnectGateway (p. 103).• deleted: The Direct Connect gateway is deleted and cannot pass traffic.

Type: String

Valid Values: pending | available | deleting | deleted



Type: String

Required: NostateChangeError

The error message if the state of an object failed to advance.

Type: String

Required: No






https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DirectConnectGateway

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DirectConnectGateway

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DirectConnectGateway

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DirectConnectGateway

AWS Direct Connect API ReferenceDirectConnectGatewayAssociation

DirectConnectGatewayAssociationInformation about an association between a Direct Connect gateway and a virtual private gateway ortransit gateway.

ContentsallowedPrefixesToDirectConnectGateway



Required: NoassociatedGateway

Information about the associated gateway.

Type: AssociatedGateway (p. 184) object

Required: NoassociationId


Type: String

Required: NoassociationState

The state of the association. The following are the possible values:• associating: The initial state after calling CreateDirectConnectGatewayAssociation (p. 64).• associated: The Direct Connect gateway and virtual private gateway or transit gateway are

successfully associated and ready to pass traffic.• disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation (p. 105).• disassociated: The virtual private gateway or transit gateway is disassociated from the Direct

Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway ortransit gateway is stopped.

Type: String

Valid Values: associating | associated | disassociating | disassociated |updating



Type: String

Required: NodirectConnectGatewayOwnerAccount

The ID of the AWS account that owns the associated gateway.

Type: String





Type: String

Required: NovirtualGatewayId


Type: String

Required: NovirtualGatewayOwnerAccount

The ID of the AWS account that owns the virtual private gateway.

Type: String

Required: NovirtualGatewayRegion


The AWS Region where the virtual private gateway is located.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DirectConnectGatewayAssociation

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DirectConnectGatewayAssociation

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DirectConnectGatewayAssociation

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DirectConnectGatewayAssociation

AWS Direct Connect API ReferenceDirectConnectGatewayAssociationProposal

DirectConnectGatewayAssociationProposalInformation about the proposal request to attach a virtual private gateway to a Direct Connect gateway.

ContentsassociatedGateway

Information about the associated gateway.

Type: AssociatedGateway (p. 184) object



Type: String

Required: NodirectConnectGatewayOwnerAccount


Type: String

Required: NoexistingAllowedPrefixesToDirectConnectGateway

The existing Amazon VPC prefixes advertised to the Direct Connect gateway.


Required: NoproposalId

The ID of the association proposal.

Type: String

Required: NoproposalState

The state of the proposal. The following are possible values:• accepted: The proposal has been accepted. The Direct Connect gateway association is available

to use in this state.• deleted: The proposal has been deleted by the owner that made the proposal. The Direct

Connect gateway association cannot be used in this state.• requested: The proposal has been requested. The Direct Connect gateway association cannot be

used in this state.

Type: String

Valid Values: requested | accepted | deleted

Required: No



requestedAllowedPrefixesToDirectConnectGateway



Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DirectConnectGatewayAssociationProposal

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DirectConnectGatewayAssociationProposal

AWS Direct Connect API ReferenceDirectConnectGatewayAttachment

DirectConnectGatewayAttachmentInformation about an attachment between a Direct Connect gateway and a virtual interface.

ContentsattachmentState

The state of the attachment. The following are the possible values:• attaching: The initial state after a virtual interface is created using the Direct Connect gateway.• attached: The Direct Connect gateway and virtual interface are attached and ready to pass

traffic.• detaching: The initial state after calling DeleteVirtualInterface (p. 116).• detached: The virtual interface is detached from the Direct Connect gateway. Traffic flow

between the Direct Connect gateway and virtual interface is stopped.

Type: String

Valid Values: attaching | attached | detaching | detached

Required: NoattachmentType

The type of attachment.

Type: String

Valid Values: TransitVirtualInterface | PrivateVirtualInterface



Type: String



Type: String

Required: NovirtualInterfaceId


Type: String

Required: NovirtualInterfaceOwnerAccount


Type: String



Required: NovirtualInterfaceRegion


Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/DirectConnectGatewayAttachment

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/DirectConnectGatewayAttachment

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/DirectConnectGatewayAttachment

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/DirectConnectGatewayAttachment

AWS Direct Connect API ReferenceInterconnect

InterconnectInformation about an interconnect.

ContentsawsDevice



Type: String



Type: String

Required: Nobandwidth


Type: String


Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).

Type: String


Required: NointerconnectId


Type: String

Required: NointerconnectName


Type: String

Required: NointerconnectState


until the Letter of Authorization (LOA) is sent to the customer.



• pending: The interconnect is approved, and is being initialized.• available: The network link is up, and the interconnect is ready for use.• down: The network link is down.• deleting: The interconnect is being deleted.• deleted: The interconnect is deleted.• unknown: The state of the interconnect is not available.

Type: String




Type: Boolean

Required: NolagId

The ID of the LAG.

Type: String

Required: NoloaIssueTime


Type: Timestamp



Type: String



Type: String

Required: Noregion


Type: String

Required: Notags

The tags associated with the interconnect.





Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/Interconnect

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/Interconnect

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/Interconnect

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/Interconnect

AWS Direct Connect API ReferenceLag

LagInformation about a link aggregation group (LAG).

ContentsallowsHostedConnections


Type: Boolean

Required: NoawsDevice



Type: String



Type: String

Required: Noconnections



Required: NoconnectionsBandwidth


Type: String



Type: String




Type: Boolean



Required: NolagId

The ID of the LAG.

Type: String

Required: NolagName


Type: String

Required: NolagState



Type: String




Type: String

Required: NominimumLinks


Type: Integer

Required: NonumberOfConnections


Type: Integer





Type: String



Type: String

Required: Noregion


Type: String

Required: Notags




Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/Lag

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/Lag

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/Lag

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/Lag

AWS Direct Connect API ReferenceLoa

LoaInformation about a Letter of Authorization - Connecting Facility Assignment (LOA-CFA) for aconnection.

ContentsloaContent

The binary contents of the LOA-CFA document.

Type: Base64-encoded binary data object

Required: NoloaContentType


Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/Loa

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/Loa

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/Loa

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/Loa

AWS Direct Connect API ReferenceLocation

LocationInformation about an AWS Direct Connect location.

ContentsavailablePortSpeeds

The available port speeds for the location.


Required: NoavailableProviders

The name of the service provider for the location.


Required: NolocationCode

The code for the location.

Type: String

Required: NolocationName

The name of the location. This includes the name of the colocation partner and the physical site ofthe building.

Type: String

Required: Noregion

The AWS Region for the location.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/Location

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/Location

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/Location

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/Location

AWS Direct Connect API ReferenceNewBGPPeer

NewBGPPeerInformation about a new BGP peer.



Type: String




Type: String

Required: Noasn


Type: Integer

Required: NoauthKey


Type: String



Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/NewBGPPeer

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/NewBGPPeer

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/NewBGPPeer

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/NewBGPPeer

AWS Direct Connect API ReferenceNewPrivateVirtualInterface

NewPrivateVirtualInterfaceInformation about a private virtual interface.



Type: String




Type: String

Required: Noasn



Type: Integer

Required: YesauthKey


Type: String



Type: String



Type: String

Required: Nomtu




Type: Integer

Required: Notags

The tags associated with the private virtual interface.





Type: String

Required: NovirtualInterfaceName


Type: String

Required: Yesvlan

The ID of the VLAN.

Type: Integer

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/NewPrivateVirtualInterface

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/NewPrivateVirtualInterface

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/NewPrivateVirtualInterface

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/NewPrivateVirtualInterface

AWS Direct Connect API ReferenceNewPrivateVirtualInterfaceAllocation

NewPrivateVirtualInterfaceAllocationInformation about a private virtual interface to be provisioned on a connection.



Type: String




Type: String

Required: Noasn



Type: Integer



Type: String



Type: String

Required: Nomtu


Type: Integer

Required: Notags

The tags associated with the private virtual interface.







Type: String

Required: Yesvlan

The ID of the VLAN.

Type: Integer

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/NewPrivateVirtualInterfaceAllocation

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/NewPrivateVirtualInterfaceAllocation

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/NewPrivateVirtualInterfaceAllocation

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/NewPrivateVirtualInterfaceAllocation

AWS Direct Connect API ReferenceNewPublicVirtualInterface

NewPublicVirtualInterfaceInformation about a public virtual interface.



Type: String




Type: String

Required: Noasn



Type: Integer



Type: String



Type: String

Required: NorouteFilterPrefixes



Required: Notags

The tags associated with the public virtual interface.







Type: String

Required: Yesvlan

The ID of the VLAN.

Type: Integer

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/NewPublicVirtualInterface

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/NewPublicVirtualInterface

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/NewPublicVirtualInterface

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/NewPublicVirtualInterface

AWS Direct Connect API ReferenceNewPublicVirtualInterfaceAllocation

NewPublicVirtualInterfaceAllocationInformation about a public virtual interface to be provisioned on a connection.



Type: String




Type: String

Required: Noasn



Type: Integer



Type: String



Type: String




Required: Notags

The tags associated with the public virtual interface.







Type: String

Required: Yesvlan

The ID of the VLAN.

Type: Integer

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/NewPublicVirtualInterfaceAllocation

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/NewPublicVirtualInterfaceAllocation

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/NewPublicVirtualInterfaceAllocation

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/NewPublicVirtualInterfaceAllocation

AWS Direct Connect API ReferenceNewTransitVirtualInterface

NewTransitVirtualInterfaceInformation about a transit virtual interface.



Type: String




Type: String

Required: Noasn



Type: Integer

Required: NoauthKey


Type: String



Type: String



Type: String

Required: Nomtu




Type: Integer

Required: Notags

The tags associated with the transitive virtual interface.





Type: String

Required: Novlan

The ID of the VLAN.

Type: Integer

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/NewTransitVirtualInterface

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/NewTransitVirtualInterface

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/NewTransitVirtualInterface

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/NewTransitVirtualInterface

AWS Direct Connect API ReferenceNewTransitVirtualInterfaceAllocation

NewTransitVirtualInterfaceAllocationInformation about a transit virtual interface to be provisioned on a connection.



Type: String




Type: String

Required: Noasn



Type: Integer

Required: NoauthKey


Type: String



Type: String

Required: Nomtu


Type: Integer

Required: Notags

The tags associated with the transitive virtual interface.







Type: String

Required: Novlan

The ID of the VLAN.

Type: Integer

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/NewTransitVirtualInterfaceAllocation

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/NewTransitVirtualInterfaceAllocation

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/NewTransitVirtualInterfaceAllocation

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/NewTransitVirtualInterfaceAllocation

AWS Direct Connect API ReferenceResourceTag

ResourceTagInformation about a tag associated with an AWS Direct Connect resource.

ContentsresourceArn


Type: String

Required: Notags

The tags.



Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/ResourceTag

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/ResourceTag

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/ResourceTag

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/ResourceTag

AWS Direct Connect API ReferenceRouteFilterPrefix

RouteFilterPrefixInformation about a route filter prefix that a customer can advertise through Border Gateway Protocol(BGP) over a public virtual interface.

Contentscidr

The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR mustuse /64 or shorter.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/RouteFilterPrefix

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/RouteFilterPrefix

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/RouteFilterPrefix

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/RouteFilterPrefix

AWS Direct Connect API ReferenceTag

TagInformation about a tag.

Contentskey

The key.

Type: String


Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: Yesvalue

The value.

Type: String


Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/Tag

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/Tag

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/Tag

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/Tag

AWS Direct Connect API ReferenceVirtualGateway

VirtualGatewayInformation about a virtual private gateway for a private virtual interface.

ContentsvirtualGatewayId


Type: String

Required: NovirtualGatewayState

The state of the virtual private gateway. The following are the possible values:• pending: Initial state after creating the virtual private gateway.• available: Ready for use by a private virtual interface.• deleting: Initial state after deleting the virtual private gateway.• deleted: The virtual private gateway is deleted. The private virtual interface is unable to send

traffic over this gateway.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/VirtualGateway

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/VirtualGateway

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/VirtualGateway

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/VirtualGateway

AWS Direct Connect API ReferenceVirtualInterface

VirtualInterfaceInformation about a virtual interface.



Type: String




Type: String

Required: NoamazonSideAsn


Type: Long

Required: Noasn



Type: Integer

Required: NoauthKey


Type: String



Type: String

Required: NobgpPeers


Type: Array of BGPPeer (p. 185) objects



Required: NoconnectionId


Type: String



Type: String

Required: NocustomerRouterConfig


Type: String



Type: String



Type: Boolean



Type: String

Required: Nomtu


Type: Integer



Type: String

Required: No



region


Type: String




Required: Notags






Type: String



Type: String



Type: String

Required: NovirtualInterfaceState





• available: A virtual interface that is able to forward traffic.• down: A virtual interface that is BGP down.



• deleting: A virtual interface is in this state immediately after callingDeleteVirtualInterface (p. 116) until it can no longer forward traffic.

• deleted: A virtual interface that cannot forward traffic.• rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual



Type: String


Required: NovirtualInterfaceType


Type: String

Required: Novlan

The ID of the VLAN.

Type: Integer

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/VirtualInterface

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/VirtualInterface

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/VirtualInterface

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/VirtualInterface

AWS Direct Connect API ReferenceVirtualInterfaceTestHistory

VirtualInterfaceTestHistoryInformation about the virtual interface failover test.

ContentsbgpPeers

The BGP peers that were put in the DOWN state as part of the virtual interface failover test.


Required: NoendTime

The time that the virtual interface moves out of the DOWN state.

Type: Timestamp


The owner ID of the tested virtual interface.

Type: String

Required: NostartTime

The time that the virtual interface moves to the DOWN state.

Type: Timestamp

Required: Nostatus

The status of the virtual interface failover test.

Type: String

Required: NotestDurationInMinutes

The time that the virtual interface failover test ran in minutes.

Type: Integer

Required: NotestId

The ID of the virtual interface failover test.

Type: String


The ID of the tested virtual interface.



Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/directconnect-2012-10-25/VirtualInterfaceTestHistory

https://docs.aws.amazon.com/goto/SdkForGoV1/directconnect-2012-10-25/VirtualInterfaceTestHistory

https://docs.aws.amazon.com/goto/SdkForJava/directconnect-2012-10-25/VirtualInterfaceTestHistory

https://docs.aws.amazon.com/goto/SdkForRubyV3/directconnect-2012-10-25/VirtualInterfaceTestHistory


Common ParametersThe following list contains the parameters that all actions use for signing Signature Version 4 requestswith a query string. Any action-specific parameters are listed in the topic for that action. For moreinformation about Signature Version 4, see Signature Version 4 Signing Process in the Amazon WebServices General Reference.

Action

The action to be performed.

Type: string

Required: YesVersion

The API version that the request is written for, expressed in the format YYYY-MM-DD.

Type: string

Required: YesX-Amz-Algorithm

The hash algorithm that you used to create the request signature.

Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.

Type: string

Valid Values: AWS4-HMAC-SHA256

Required: ConditionalX-Amz-Credential

The credential scope value, which is a string that includes your access key, the date, the region youare targeting, the service you are requesting, and a termination string ("aws4_request"). The value isexpressed in the following format: access_key/YYYYMMDD/region/service/aws4_request.

For more information, see Task 2: Create a String to Sign for Signature Version 4 in the Amazon WebServices General Reference.


Type: string

Required: ConditionalX-Amz-Date

The date that is used to create the signature. The format must be ISO 8601 basic format(YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value:20120325T120000Z.

Condition: X-Amz-Date is optional for all requests; it can be used to override the date used forsigning requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is


http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html


not required. When X-Amz-Date is used, it always overrides the value of the Date header. Formore information, see Handling Dates in Signature Version 4 in the Amazon Web Services GeneralReference.

Type: string

Required: ConditionalX-Amz-Security-Token

The temporary security token that was obtained through a call to AWS Security Token Service (AWSSTS). For a list of services that support temporary security credentials from AWS Security TokenService, go to AWS Services That Work with IAM in the IAM User Guide.

Condition: If you're using temporary security credentials from the AWS Security Token Service, youmust include the security token.

Type: string

Required: ConditionalX-Amz-Signature

Specifies the hex-encoded signature that was calculated from the string to sign and the derivedsigning key.


Type: string

Required: ConditionalX-Amz-SignedHeaders

Specifies all the HTTP headers that were included as part of the canonical request. For moreinformation about specifying signed headers, see Task 1: Create a Canonical Request For SignatureVersion 4 in the Amazon Web Services General Reference.


Type: string

Required: Conditional


http://docs.aws.amazon.com/general/latest/gr/sigv4-date-handling.html

http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html


Common ErrorsThis section lists the errors common to the API actions of all AWS services. For errors specific to an APIaction for this service, see the topic for that API action.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400IncompleteSignature

The request signature does not conform to AWS standards.

HTTP Status Code: 400InternalFailure

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500InvalidAction

The action or operation requested is invalid. Verify that the action is typed correctly.

HTTP Status Code: 400InvalidClientTokenId

The X.509 certificate or AWS access key ID provided does not exist in our records.

HTTP Status Code: 403InvalidParameterCombination

Parameters that must not be used together were used together.

HTTP Status Code: 400InvalidParameterValue

An invalid or out-of-range value was supplied for the input parameter.

HTTP Status Code: 400InvalidQueryParameter

The AWS query string is malformed or does not adhere to AWS standards.

HTTP Status Code: 400MalformedQueryString

The query string contains a syntax error.

HTTP Status Code: 404MissingAction

The request is missing an action or a required parameter.




MissingAuthenticationToken

The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

HTTP Status Code: 403MissingParameter

A required parameter for the specified action is not supplied.

HTTP Status Code: 400OptInRequired

The AWS access key ID needs a subscription for the service.

HTTP Status Code: 403RequestExpired

The request reached the service more than 15 minutes after the date stamp on the request or morethan 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stampon the request is more than 15 minutes in the future.

HTTP Status Code: 400ServiceUnavailable

The request has failed due to a temporary failure of the server.

HTTP Status Code: 503ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400ValidationError

The input fails to satisfy the constraints specified by an AWS service.



aws direct connect · aws direct connect links your internal network to an aws direct connect...

Documents