AWS Network Manager · 2020. 8. 31. · AWS Network Manager API Reference Welcome Transit Gateway Network Manager (Network Manager) enables you to create a global network, in which

AWS Network ManagerAPI Reference

API Version 2019-07-05

AWS Network Manager API Reference

AWS Network Manager: 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

AssociateCustomerGateway .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

AssociateLink .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

AssociateTransitGatewayConnectPeer .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

CreateConnection .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

CreateDevice .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

CreateGlobalNetwork .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

CreateLink .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

API Version 2019-07-05iii


Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

CreateSite .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

DeleteConnection .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

DeleteDevice .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

DeleteGlobalNetwork .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

DeleteLink .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

DeleteSite .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

DeregisterTransitGateway .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

API Version 2019-07-05iv


Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

DescribeGlobalNetworks .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

DisassociateCustomerGateway .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

DisassociateLink .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

DisassociateTransitGatewayConnectPeer .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

GetConnections .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

GetCustomerGatewayAssociations .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

GetDevices .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

API Version 2019-07-05v


Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

GetLinkAssociations .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

GetLinks .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

GetSites ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

GetTransitGatewayConnectPeerAssociations .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

GetTransitGatewayRegistrations .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

ListTagsForResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

RegisterTransitGateway .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

API Version 2019-07-05vi


See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83TagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

UntagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

UpdateConnection .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

UpdateDevice .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

UpdateGlobalNetwork .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

UpdateLink .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

UpdateSite .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

API Version 2019-07-05vii


Data Types .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106AWSLocation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Bandwidth .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Connection .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

CustomerGatewayAssociation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

Device .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

GlobalNetwork .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

Link .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

LinkAssociation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

Location .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

Site .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Tag .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

TransitGatewayConnectPeerAssociation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

TransitGatewayRegistration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

TransitGatewayRegistrationStateReason .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

ValidationExceptionField .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

Common Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Common Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

API Version 2019-07-05viii


WelcomeTransit Gateway Network Manager (Network Manager) enables you to create a global network, in whichyou can monitor your AWS and on-premises networks that are built around transit gateways.

The Network Manager APIs are supported in the US West (Oregon) Region only. You must specify theus-west-2 Region in all requests made to Network Manager.

This document was last published on December 24, 2020.



ActionsThe following actions are supported:

• AssociateCustomerGateway (p. 3)• AssociateLink (p. 6)• AssociateTransitGatewayConnectPeer (p. 9)• CreateConnection (p. 12)• CreateDevice (p. 16)• CreateGlobalNetwork (p. 20)• CreateLink (p. 23)• CreateSite (p. 27)• DeleteConnection (p. 30)• DeleteDevice (p. 33)• DeleteGlobalNetwork (p. 36)• DeleteLink (p. 38)• DeleteSite (p. 41)• DeregisterTransitGateway (p. 44)• DescribeGlobalNetworks (p. 46)• DisassociateCustomerGateway (p. 49)• DisassociateLink (p. 51)• DisassociateTransitGatewayConnectPeer (p. 54)• GetConnections (p. 56)• GetCustomerGatewayAssociations (p. 59)• GetDevices (p. 62)• GetLinkAssociations (p. 65)• GetLinks (p. 68)• GetSites (p. 71)• GetTransitGatewayConnectPeerAssociations (p. 74)• GetTransitGatewayRegistrations (p. 77)• ListTagsForResource (p. 80)• RegisterTransitGateway (p. 82)• TagResource (p. 85)• UntagResource (p. 87)• UpdateConnection (p. 89)• UpdateDevice (p. 92)• UpdateGlobalNetwork (p. 96)• UpdateLink (p. 99)• UpdateSite (p. 103)


AWS Network Manager API ReferenceAssociateCustomerGateway

AssociateCustomerGatewayAssociates a customer gateway with a device and optionally, with a link. If you specify a link, it must beassociated with the specified device.

You can only associate customer gateways that are connected to a VPN attachment on a transitgateway. The transit gateway must be registered in your global network. When you register a transitgateway, customer gateways that are connected to the transit gateway are automatically includedin the global network. To list customer gateways that are connected to a transit gateway, use theDescribeVpnConnections EC2 API and filter by transit-gateway-id.

You cannot associate a customer gateway with more than one device and link.

Request SyntaxPOST /global-networks/globalNetworkId/customer-gateway-associations HTTP/1.1Content-type: application/json

{ "CustomerGatewayArn": "string", "DeviceId": "string", "LinkId": "string"}

URI Request ParametersThe request uses the following URI parameters.

globalNetworkId (p. 3)

The ID of the global network.

Required: Yes

Request BodyThe request accepts the following data in JSON format.

CustomerGatewayArn (p. 3)

The Amazon Resource Name (ARN) of the customer gateway. For more information, see ResourcesDefined by Amazon EC2.

Type: String

Required: YesDeviceId (p. 3)

The ID of the device.

Type: String

Required: YesLinkId (p. 3)

The ID of the link.


https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnConnections.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html#amazonec2-resources-for-iam-policies


AWS Network Manager API ReferenceResponse Syntax

Type: String

Required: No

Response SyntaxHTTP/1.1 200Content-type: application/json

{ "CustomerGatewayAssociation": { "CustomerGatewayArn": "string", "DeviceId": "string", "GlobalNetworkId": "string", "LinkId": "string", "State": "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.

CustomerGatewayAssociation (p. 4)

The customer gateway association.

Type: CustomerGatewayAssociation (p. 111) object

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403ConflictException

There was a conflict processing the request. Updating or deleting the resource can cause aninconsistent state.

HTTP Status Code: 409InternalServerException

The request has failed due to an internal error.

HTTP Status Code: 500ResourceNotFoundException

The specified resource could not be found.

HTTP Status Code: 404


AWS Network Manager API ReferenceSee Also

ServiceQuotaExceededException

A service limit was exceeded.

HTTP Status Code: 402ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429ValidationException

The input fails to satisfy the constraints.


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

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• 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/networkmanager-2019-07-05/AssociateCustomerGateway

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/AssociateCustomerGateway

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/AssociateCustomerGateway

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/AssociateCustomerGateway

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/AssociateCustomerGateway

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/AssociateCustomerGateway

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/AssociateCustomerGateway

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/AssociateCustomerGateway

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/AssociateCustomerGateway

AWS Network Manager API ReferenceAssociateLink

AssociateLinkAssociates a link to a device. A device can be associated to multiple links and a link can be associated tomultiple devices. The device and link must be in the same global network and the same site.

Request SyntaxPOST /global-networks/globalNetworkId/link-associations HTTP/1.1Content-type: application/json

{ "DeviceId": "string", "LinkId": "string"}




Required: Yes


DeviceId (p. 6)


Type: String


The ID of the link.

Type: String

Required: Yes


{ "LinkAssociation": { "DeviceId": "string", "GlobalNetworkId": "string", "LinkAssociationState": "string",


AWS Network Manager API ReferenceResponse Elements

"LinkId": "string" }}



LinkAssociation (p. 6)

The link association.

Type: LinkAssociation (p. 118) object










HTTP Status Code: 404ServiceQuotaExceededException












https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/AssociateLink

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/AssociateLink

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/AssociateLink

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/AssociateLink

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/AssociateLink

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/AssociateLink

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/AssociateLink

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/AssociateLink

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/AssociateLink

AWS Network Manager API ReferenceAssociateTransitGatewayConnectPeer

AssociateTransitGatewayConnectPeerAssociates a transit gateway Connect peer with a device, and optionally, with a link. If you specify a link,it must be associated with the specified device.

You can only associate transit gateway Connect peers that have been created on a transit gateway that'sregistered in your global network.

You cannot associate a transit gateway Connect peer with more than one device and link.

Request SyntaxPOST /global-networks/globalNetworkId/transit-gateway-connect-peer-associations HTTP/1.1Content-type: application/json

{ "DeviceId": "string", "LinkId": "string", "TransitGatewayConnectPeerArn": "string"}




Required: Yes


DeviceId (p. 9)


Type: String


The ID of the link.

Type: String

Required: NoTransitGatewayConnectPeerArn (p. 9)

The Amazon Resource Name (ARN) of the Connect peer.

Type: String

Required: Yes




{ "TransitGatewayConnectPeerAssociation": { "DeviceId": "string", "GlobalNetworkId": "string", "LinkId": "string", "State": "string", "TransitGatewayConnectPeerArn": "string" }}



TransitGatewayConnectPeerAssociation (p. 10)

The transit gateway Connect peer association.

Type: TransitGatewayConnectPeerAssociation (p. 123) object















ThrottlingException








https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/AssociateTransitGatewayConnectPeer

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/AssociateTransitGatewayConnectPeer

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/AssociateTransitGatewayConnectPeer

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/AssociateTransitGatewayConnectPeer

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/AssociateTransitGatewayConnectPeer

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/AssociateTransitGatewayConnectPeer

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/AssociateTransitGatewayConnectPeer

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/AssociateTransitGatewayConnectPeer

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/AssociateTransitGatewayConnectPeer

AWS Network Manager API ReferenceCreateConnection

CreateConnectionCreates a connection between two devices. The devices can be a physical or virtual appliance thatconnects to a third-party appliance in a VPC, or a physical appliance that connects to another physicalappliance in an on-premises network.

Request SyntaxPOST /global-networks/globalNetworkId/connections HTTP/1.1Content-type: application/json

{ "ConnectedDeviceId": "string", "ConnectedLinkId": "string", "Description": "string", "DeviceId": "string", "LinkId": "string", "Tags": [ { "Key": "string", "Value": "string" } ]}




Required: Yes


ConnectedDeviceId (p. 12)

The ID of the second device in the connection.

Type: String

Required: YesConnectedLinkId (p. 12)

The ID of the link for the second device.

Type: String

Required: NoDescription (p. 12)

A description of the connection.



Length Constraints: Maximum length of 256 characters.

Type: String

Required: NoDeviceId (p. 12)

The ID of the first device in the connection.

Type: String


The ID of the link for the first device.

Type: String

Required: NoTags (p. 12)

The tags to apply to the resource during creation.

Type: Array of Tag (p. 122) objects

Required: No


{ "Connection": { "ConnectedDeviceId": "string", "ConnectedLinkId": "string", "ConnectionArn": "string", "ConnectionId": "string", "CreatedAt": number, "Description": "string", "DeviceId": "string", "GlobalNetworkId": "string", "LinkId": "string", "State": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }}




AWS Network Manager API ReferenceErrors

Connection (p. 13)

Information about the connection.

Type: Connection (p. 109) object
















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


https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/CreateConnection

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/CreateConnection

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/CreateConnection

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/CreateConnection

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/CreateConnection

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/CreateConnection

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/CreateConnection

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/CreateConnection


• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/CreateConnection

AWS Network Manager API ReferenceCreateDevice

CreateDeviceCreates a new device in a global network. If you specify both a site ID and a location, the location of thesite is used for visualization in the Network Manager console.

Request SyntaxPOST /global-networks/globalNetworkId/devices HTTP/1.1Content-type: application/json

{ "AWSLocation": { "SubnetArn": "string", "Zone": "string" }, "Description": "string", "Location": { "Address": "string", "Latitude": "string", "Longitude": "string" }, "Model": "string", "SerialNumber": "string", "SiteId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Type": "string", "Vendor": "string"}




Required: Yes


AWSLocation (p. 16)

The AWS location of the device, if applicable. For an on-premises device, you can omit thisparameter.

Type: AWSLocation (p. 107) object

Required: No


AWS Network Manager API ReferenceRequest Body

Description (p. 16)

A description of the device.


Type: String

Required: NoLocation (p. 16)

The location of the device.

Type: Location (p. 119) object

Required: NoModel (p. 16)

The model of the device.


Type: String

Required: NoSerialNumber (p. 16)

The serial number of the device.


Type: String

Required: NoSiteId (p. 16)

The ID of the site.

Type: String




Required: NoType (p. 16)

The type of the device.

Type: String

Required: NoVendor (p. 16)

The vendor of the device.




Type: String

Required: No


{ "Device": { "AWSLocation": { "SubnetArn": "string", "Zone": "string" }, "CreatedAt": number, "Description": "string", "DeviceArn": "string", "DeviceId": "string", "GlobalNetworkId": "string", "Location": { "Address": "string", "Latitude": "string", "Longitude": "string" }, "Model": "string", "SerialNumber": "string", "SiteId": "string", "State": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Type": "string", "Vendor": "string" }}



Device (p. 18)

Information about the device.

Type: Device (p. 112) object






















https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/CreateDevice

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/CreateDevice

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/CreateDevice

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/CreateDevice

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/CreateDevice

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/CreateDevice

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/CreateDevice

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/CreateDevice

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/CreateDevice

AWS Network Manager API ReferenceCreateGlobalNetwork

CreateGlobalNetworkCreates a new, empty global network.

Request SyntaxPOST /global-networks HTTP/1.1Content-type: application/json

{ "Description": "string", "Tags": [ { "Key": "string", "Value": "string" } ]}

URI Request ParametersThe request does not use any URI parameters.


Description (p. 20)

A description of the global network.


Type: String




Required: No


{ "GlobalNetwork": { "CreatedAt": number, "Description": "string", "GlobalNetworkArn": "string", "GlobalNetworkId": "string",



"State": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }}



GlobalNetwork (p. 20)

Information about the global network object.

Type: GlobalNetwork (p. 114) object




















https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/CreateGlobalNetwork

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/CreateGlobalNetwork

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/CreateGlobalNetwork

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/CreateGlobalNetwork

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/CreateGlobalNetwork

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/CreateGlobalNetwork

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/CreateGlobalNetwork

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/CreateGlobalNetwork

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/CreateGlobalNetwork

AWS Network Manager API ReferenceCreateLink

CreateLinkCreates a new link for a specified site.

Request SyntaxPOST /global-networks/globalNetworkId/links HTTP/1.1Content-type: application/json

{ "Bandwidth": { "DownloadSpeed": number, "UploadSpeed": number }, "Description": "string", "Provider": "string", "SiteId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Type": "string"}




Required: Yes


Bandwidth (p. 23)

The upload speed and download speed in Mbps.

Type: Bandwidth (p. 108) object

Required: YesDescription (p. 23)

A description of the link.


Type: String

Required: No



Provider (p. 23)

The provider of the link.

Constraints: Cannot include the following characters: | \ ^


Type: String


The ID of the site.

Type: String

Required: YesTags (p. 23)




The type of the link.

Constraints: Cannot include the following characters: | \ ^


Type: String

Required: No


{ "Link": { "Bandwidth": { "DownloadSpeed": number, "UploadSpeed": number }, "CreatedAt": number, "Description": "string", "GlobalNetworkId": "string", "LinkArn": "string", "LinkId": "string", "Provider": "string", "SiteId": "string", "State": "string", "Tags": [ { "Key": "string", "Value": "string"



} ], "Type": "string" }}



Link (p. 24)

Information about the link.

Type: Link (p. 116) object






















https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/CreateLink

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/CreateLink

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/CreateLink

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/CreateLink

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/CreateLink

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/CreateLink

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/CreateLink

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/CreateLink

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/CreateLink

AWS Network Manager API ReferenceCreateSite

CreateSiteCreates a new site in a global network.

Request SyntaxPOST /global-networks/globalNetworkId/sites HTTP/1.1Content-type: application/json

{ "Description": "string", "Location": { "Address": "string", "Latitude": "string", "Longitude": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ]}




Required: Yes


Description (p. 27)

A description of your site.


Type: String


The site location. This information is used for visualization in the Network Manager console. If youspecify the address, the latitude and longitude are automatically calculated.• Address: The physical address of the site.• Latitude: The latitude of the site.• Longitude: The longitude of the site.







Required: No


{ "Site": { "CreatedAt": number, "Description": "string", "GlobalNetworkId": "string", "Location": { "Address": "string", "Latitude": "string", "Longitude": "string" }, "SiteArn": "string", "SiteId": "string", "State": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }}



Site (p. 28)

Information about the site.

Type: Site (p. 120) object







ConflictException
















https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/CreateSite

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/CreateSite

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/CreateSite

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/CreateSite

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/CreateSite

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/CreateSite

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/CreateSite

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/CreateSite

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/CreateSite

AWS Network Manager API ReferenceDeleteConnection

DeleteConnectionDeletes the specified connection in your global network.

Request SyntaxDELETE /global-networks/globalNetworkId/connections/connectionId HTTP/1.1


connectionId (p. 30)

The ID of the connection.

Required: YesglobalNetworkId (p. 30)


Required: Yes

Request BodyThe request does not have a request body.







Connection (p. 30)


















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


https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/DeleteConnection

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/DeleteConnection

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/DeleteConnection

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/DeleteConnection

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/DeleteConnection

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/DeleteConnection

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/DeleteConnection


• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/DeleteConnection

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/DeleteConnection

AWS Network Manager API ReferenceDeleteDevice

DeleteDeviceDeletes an existing device. You must first disassociate the device from any links and customer gateways.

Request SyntaxDELETE /global-networks/globalNetworkId/devices/deviceId HTTP/1.1


deviceId (p. 33)




Required: Yes



{ "Device": { "AWSLocation": { "SubnetArn": "string", "Zone": "string" }, "CreatedAt": number, "Description": "string", "DeviceArn": "string", "DeviceId": "string", "GlobalNetworkId": "string", "Location": { "Address": "string", "Latitude": "string", "Longitude": "string" }, "Model": "string", "SerialNumber": "string", "SiteId": "string", "State": "string", "Tags": [ { "Key": "string",



"Value": "string" } ], "Type": "string", "Vendor": "string" }}



Device (p. 33)







ConflictException



InternalServerException



ResourceNotFoundException



ThrottlingException



ValidationException








https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/DeleteDevice

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/DeleteDevice

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/DeleteDevice

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/DeleteDevice

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/DeleteDevice

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/DeleteDevice

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/DeleteDevice

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/DeleteDevice

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/DeleteDevice

AWS Network Manager API ReferenceDeleteGlobalNetwork

DeleteGlobalNetworkDeletes an existing global network. You must first delete all global network objects (devices, links, andsites) and deregister all transit gateways.

Request SyntaxDELETE /global-networks/globalNetworkId HTTP/1.1




Required: Yes



{ "GlobalNetwork": { "CreatedAt": number, "Description": "string", "GlobalNetworkArn": "string", "GlobalNetworkId": "string", "State": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }}




Information about the global network.





















https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/DeleteGlobalNetwork

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/DeleteGlobalNetwork

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/DeleteGlobalNetwork

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/DeleteGlobalNetwork

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/DeleteGlobalNetwork

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/DeleteGlobalNetwork

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/DeleteGlobalNetwork

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/DeleteGlobalNetwork

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/DeleteGlobalNetwork

AWS Network Manager API ReferenceDeleteLink

DeleteLinkDeletes an existing link. You must first disassociate the link from any devices and customer gateways.

Request SyntaxDELETE /global-networks/globalNetworkId/links/linkId HTTP/1.1




Required: YeslinkId (p. 38)

The ID of the link.

Required: Yes



{ "Link": { "Bandwidth": { "DownloadSpeed": number, "UploadSpeed": number }, "CreatedAt": number, "Description": "string", "GlobalNetworkId": "string", "LinkArn": "string", "LinkId": "string", "Provider": "string", "SiteId": "string", "State": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Type": "string" }}





Link (p. 38)


















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


https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/DeleteLink

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/DeleteLink

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/DeleteLink


• AWS SDK for Go• AWS SDK for Java V2• 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/networkmanager-2019-07-05/DeleteLink

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/DeleteLink

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/DeleteLink

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/DeleteLink

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/DeleteLink

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/DeleteLink

AWS Network Manager API ReferenceDeleteSite

DeleteSiteDeletes an existing site. The site cannot be associated with any device or link.

Request Syntax

DELETE /global-networks/globalNetworkId/sites/siteId HTTP/1.1




Required: Yes

siteId (p. 41)

The ID of the site.

Required: Yes


Response Syntax

HTTP/1.1 200Content-type: application/json






Site (p. 41)




















https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/DeleteSite

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/DeleteSite

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/DeleteSite




https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/DeleteSite

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/DeleteSite

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/DeleteSite

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/DeleteSite

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/DeleteSite

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/DeleteSite

AWS Network Manager API ReferenceDeregisterTransitGateway

DeregisterTransitGatewayDeregisters a transit gateway from your global network. This action does not delete your transit gateway,or modify any of its attachments. This action removes any customer gateway associations.

Request SyntaxDELETE /global-networks/globalNetworkId/transit-gateway-registrations/transitGatewayArn HTTP/1.1




Required: YestransitGatewayArn (p. 44)

The Amazon Resource Name (ARN) of the transit gateway.

Required: Yes



{ "TransitGatewayRegistration": { "GlobalNetworkId": "string", "State": { "Code": "string", "Message": "string" }, "TransitGatewayArn": "string" }}



TransitGatewayRegistration (p. 44)

The transit gateway registration information.



Type: TransitGatewayRegistration (p. 124) object


















https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/DeregisterTransitGateway

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/DeregisterTransitGateway

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/DeregisterTransitGateway

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/DeregisterTransitGateway

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/DeregisterTransitGateway

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/DeregisterTransitGateway

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/DeregisterTransitGateway

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/DeregisterTransitGateway

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/DeregisterTransitGateway

AWS Network Manager API ReferenceDescribeGlobalNetworks

DescribeGlobalNetworksDescribes one or more global networks. By default, all global networks are described. To describe theobjects in your global network, you must use the appropriate Get* action. For example, to list the transitgateways in your global network, use GetTransitGatewayRegistrations (p. 77).

Request SyntaxGET /global-networks?globalNetworkIds=GlobalNetworkIds&maxResults=MaxResults&nextToken=NextToken HTTP/1.1


GlobalNetworkIds (p. 46)

The IDs of one or more global networks. The maximum is 10.MaxResults (p. 46)

The maximum number of results to return.

Valid Range: Minimum value of 1. Maximum value of 500.NextToken (p. 46)

The token for the next page of results.



{ "GlobalNetworks": [ { "CreatedAt": number, "Description": "string", "GlobalNetworkArn": "string", "GlobalNetworkId": "string", "State": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ], "NextToken": "string"}





GlobalNetworks (p. 46)

Information about the global networks.

Type: Array of GlobalNetwork (p. 114) objectsNextToken (p. 46)


Type: String














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


https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/DescribeGlobalNetworks

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/DescribeGlobalNetworks

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/DescribeGlobalNetworks

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/DescribeGlobalNetworks


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


https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/DescribeGlobalNetworks

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/DescribeGlobalNetworks

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/DescribeGlobalNetworks

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/DescribeGlobalNetworks

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/DescribeGlobalNetworks

AWS Network Manager API ReferenceDisassociateCustomerGateway

DisassociateCustomerGatewayDisassociates a customer gateway from a device and a link.

Request SyntaxDELETE /global-networks/globalNetworkId/customer-gateway-associations/customerGatewayArn HTTP/1.1


customerGatewayArn (p. 49)

The Amazon Resource Name (ARN) of the customer gateway. For more information, see ResourcesDefined by Amazon EC2.



Required: Yes



{ "CustomerGatewayAssociation": { "CustomerGatewayArn": "string", "DeviceId": "string", "GlobalNetworkId": "string", "LinkId": "string", "State": "string" }}



CustomerGatewayAssociation (p. 49)

Information about the customer gateway association.





Type: CustomerGatewayAssociation (p. 111) object


















https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/DisassociateCustomerGateway

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/DisassociateCustomerGateway

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/DisassociateCustomerGateway

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/DisassociateCustomerGateway

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/DisassociateCustomerGateway

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/DisassociateCustomerGateway

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/DisassociateCustomerGateway

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/DisassociateCustomerGateway

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/DisassociateCustomerGateway

AWS Network Manager API ReferenceDisassociateLink

DisassociateLinkDisassociates an existing device from a link. You must first disassociate any customer gateways that areassociated with the link.

Request SyntaxDELETE /global-networks/globalNetworkId/link-associations?deviceId=DeviceId&linkId=LinkId HTTP/1.1


DeviceId (p. 51)





The ID of the link.

Required: Yes



{ "LinkAssociation": { "DeviceId": "string", "GlobalNetworkId": "string", "LinkAssociationState": "string", "LinkId": "string" }}





LinkAssociation (p. 51)

Information about the link association.

Type: LinkAssociation (p. 118) object
















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


https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/DisassociateLink

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/DisassociateLink

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/DisassociateLink

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/DisassociateLink

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/DisassociateLink

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/DisassociateLink

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/DisassociateLink

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/DisassociateLink


• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/DisassociateLink

AWS Network Manager API ReferenceDisassociateTransitGatewayConnectPeer

DisassociateTransitGatewayConnectPeerDisassociates a transit gateway Connect peer from a device and link.

Request SyntaxDELETE /global-networks/globalNetworkId/transit-gateway-connect-peer-associations/transitGatewayConnectPeerArn HTTP/1.1




Required: YestransitGatewayConnectPeerArn (p. 54)

The Amazon Resource Name (ARN) of the transit gateway Connect peer.

Required: Yes



{ "TransitGatewayConnectPeerAssociation": { "DeviceId": "string", "GlobalNetworkId": "string", "LinkId": "string", "State": "string", "TransitGatewayConnectPeerArn": "string" }}



TransitGatewayConnectPeerAssociation (p. 54)

The transit gateway Connect peer association.

Type: TransitGatewayConnectPeerAssociation (p. 123) object




















https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/DisassociateTransitGatewayConnectPeer

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/DisassociateTransitGatewayConnectPeer

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/DisassociateTransitGatewayConnectPeer

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/DisassociateTransitGatewayConnectPeer

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/DisassociateTransitGatewayConnectPeer

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/DisassociateTransitGatewayConnectPeer

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/DisassociateTransitGatewayConnectPeer

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/DisassociateTransitGatewayConnectPeer

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/DisassociateTransitGatewayConnectPeer

AWS Network Manager API ReferenceGetConnections

GetConnectionsGets information about one or more of your connections in a global network.

Request SyntaxGET /global-networks/globalNetworkId/connections?connectionIds=ConnectionIds&deviceId=DeviceId&maxResults=MaxResults&nextToken=NextToken HTTP/1.1


ConnectionIds (p. 56)

One or more connection IDs.DeviceId (p. 56)

The ID of the device.globalNetworkId (p. 56)


Required: YesMaxResults (p. 56)






{ "Connections": [ { "ConnectedDeviceId": "string", "ConnectedLinkId": "string", "ConnectionArn": "string", "ConnectionId": "string", "CreatedAt": number, "Description": "string", "DeviceId": "string", "GlobalNetworkId": "string",



"LinkId": "string", "State": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ], "NextToken": "string"}



Connections (p. 56)

Information about the connections.

Type: Array of Connection (p. 109) objectsNextToken (p. 56)

The token to use for the next page of results.

Type: String


















https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/GetConnections

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/GetConnections

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/GetConnections

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/GetConnections

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/GetConnections

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/GetConnections

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/GetConnections

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/GetConnections

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/GetConnections

AWS Network Manager API ReferenceGetCustomerGatewayAssociations

GetCustomerGatewayAssociationsGets the association information for customer gateways that are associated with devices and links inyour global network.

Request SyntaxGET /global-networks/globalNetworkId/customer-gateway-associations?customerGatewayArns=CustomerGatewayArns&maxResults=MaxResults&nextToken=NextToken HTTP/1.1


CustomerGatewayArns (p. 59)

One or more customer gateway Amazon Resource Names (ARNs). For more information, seeResources Defined by Amazon EC2. The maximum is 10.









{ "CustomerGatewayAssociations": [ { "CustomerGatewayArn": "string", "DeviceId": "string", "GlobalNetworkId": "string", "LinkId": "string", "State": "string" } ], "NextToken": "string"}






CustomerGatewayAssociations (p. 59)

The customer gateway associations.

Type: Array of CustomerGatewayAssociation (p. 111) objectsNextToken (p. 59)


Type: String




















https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/GetCustomerGatewayAssociations

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/GetCustomerGatewayAssociations

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/GetCustomerGatewayAssociations

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/GetCustomerGatewayAssociations

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/GetCustomerGatewayAssociations

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/GetCustomerGatewayAssociations

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/GetCustomerGatewayAssociations

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/GetCustomerGatewayAssociations

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/GetCustomerGatewayAssociations

AWS Network Manager API ReferenceGetDevices

GetDevicesGets information about one or more of your devices in a global network.

Request SyntaxGET /global-networks/globalNetworkId/devices?deviceIds=DeviceIds&maxResults=MaxResults&nextToken=NextToken&siteId=SiteId HTTP/1.1


DeviceIds (p. 62)

One or more device IDs. The maximum is 10.globalNetworkId (p. 62)





The token for the next page of results.SiteId (p. 62)

The ID of the site.



{ "Devices": [ { "AWSLocation": { "SubnetArn": "string", "Zone": "string" }, "CreatedAt": number, "Description": "string", "DeviceArn": "string", "DeviceId": "string",



"GlobalNetworkId": "string", "Location": { "Address": "string", "Latitude": "string", "Longitude": "string" }, "Model": "string", "SerialNumber": "string", "SiteId": "string", "State": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Type": "string", "Vendor": "string" } ], "NextToken": "string"}



Devices (p. 62)

The devices.

Type: Array of Device (p. 112) objectsNextToken (p. 62)


Type: String











ThrottlingException








https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/GetDevices

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/GetDevices

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/GetDevices

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/GetDevices

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/GetDevices

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/GetDevices

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/GetDevices

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/GetDevices

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/GetDevices

AWS Network Manager API ReferenceGetLinkAssociations

GetLinkAssociationsGets the link associations for a device or a link. Either the device ID or the link ID must be specified.

Request SyntaxGET /global-networks/globalNetworkId/link-associations?deviceId=DeviceId&linkId=LinkId&maxResults=MaxResults&nextToken=NextToken HTTP/1.1


DeviceId (p. 65)

The ID of the device.globalNetworkId (p. 65)



The ID of the link.MaxResults (p. 65)






{ "LinkAssociations": [ { "DeviceId": "string", "GlobalNetworkId": "string", "LinkAssociationState": "string", "LinkId": "string" } ], "NextToken": "string"}





LinkAssociations (p. 65)

The link associations.

Type: Array of LinkAssociation (p. 118) objectsNextToken (p. 65)


Type: String
















https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/GetLinkAssociations

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/GetLinkAssociations

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/GetLinkAssociations

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/GetLinkAssociations




https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/GetLinkAssociations

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/GetLinkAssociations

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/GetLinkAssociations

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/GetLinkAssociations

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/GetLinkAssociations

AWS Network Manager API ReferenceGetLinks

GetLinksGets information about one or more links in a specified global network.

If you specify the site ID, you cannot specify the type or provider in the same request. You can specify thetype and provider in the same request.

Request SyntaxGET /global-networks/globalNetworkId/links?linkIds=LinkIds&maxResults=MaxResults&nextToken=NextToken&provider=Provider&siteId=SiteId&type=Type HTTP/1.1




Required: YesLinkIds (p. 68)

One or more link IDs. The maximum is 10.MaxResults (p. 68)



The token for the next page of results.Provider (p. 68)

The link provider.SiteId (p. 68)

The ID of the site.Type (p. 68)

The link type.



{



"Links": [ { "Bandwidth": { "DownloadSpeed": number, "UploadSpeed": number }, "CreatedAt": number, "Description": "string", "GlobalNetworkId": "string", "LinkArn": "string", "LinkId": "string", "Provider": "string", "SiteId": "string", "State": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Type": "string" } ], "NextToken": "string"}



Links (p. 68)

The links.

Type: Array of Link (p. 116) objectsNextToken (p. 68)


Type: String


















https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/GetLinks

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/GetLinks

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/GetLinks

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/GetLinks

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/GetLinks

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/GetLinks

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/GetLinks

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/GetLinks

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/GetLinks

AWS Network Manager API ReferenceGetSites

GetSitesGets information about one or more of your sites in a global network.

Request SyntaxGET /global-networks/globalNetworkId/sites?maxResults=MaxResults&nextToken=NextToken&siteIds=SiteIds HTTP/1.1







The token for the next page of results.SiteIds (p. 71)

One or more site IDs. The maximum is 10.



{ "NextToken": "string", "Sites": [ { "CreatedAt": number, "Description": "string", "GlobalNetworkId": "string", "Location": { "Address": "string", "Latitude": "string", "Longitude": "string" }, "SiteArn": "string", "SiteId": "string", "State": "string",



"Tags": [ { "Key": "string", "Value": "string" } ] } ]}



NextToken (p. 71)


Type: String

Sites (p. 71)

The sites.

Type: Array of Site (p. 120) objects








ResourceNotFoundException



ThrottlingException



ValidationException








https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/GetSites

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/GetSites

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/GetSites

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/GetSites

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/GetSites

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/GetSites

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/GetSites

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/GetSites

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/GetSites

AWS Network Manager API ReferenceGetTransitGatewayConnectPeerAssociations

GetTransitGatewayConnectPeerAssociationsGets information about one or more of your transit gateway Connect peer associations in a globalnetwork.

Request SyntaxGET /global-networks/globalNetworkId/transit-gateway-connect-peer-associations?maxResults=MaxResults&nextToken=NextToken&transitGatewayConnectPeerArns=TransitGatewayConnectPeerArns HTTP/1.1







The token for the next page of results.TransitGatewayConnectPeerArns (p. 74)

One or more transit gateway Connect peer Amazon Resource Names (ARNs).



{ "NextToken": "string", "TransitGatewayConnectPeerAssociations": [ { "DeviceId": "string", "GlobalNetworkId": "string", "LinkId": "string", "State": "string", "TransitGatewayConnectPeerArn": "string" } ]}





NextToken (p. 74)

The token to use for the next page of results.

Type: StringTransitGatewayConnectPeerAssociations (p. 74)

Information about the transit gateway Connect peer associations.

Type: Array of TransitGatewayConnectPeerAssociation (p. 123) objects




















https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/GetTransitGatewayConnectPeerAssociations

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/GetTransitGatewayConnectPeerAssociations

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/GetTransitGatewayConnectPeerAssociations

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/GetTransitGatewayConnectPeerAssociations

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/GetTransitGatewayConnectPeerAssociations

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/GetTransitGatewayConnectPeerAssociations

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/GetTransitGatewayConnectPeerAssociations

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/GetTransitGatewayConnectPeerAssociations

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/GetTransitGatewayConnectPeerAssociations

AWS Network Manager API ReferenceGetTransitGatewayRegistrations

GetTransitGatewayRegistrationsGets information about the transit gateway registrations in a specified global network.

Request SyntaxGET /global-networks/globalNetworkId/transit-gateway-registrations?maxResults=MaxResults&nextToken=NextToken&transitGatewayArns=TransitGatewayArns HTTP/1.1




Required: Yes

MaxResults (p. 77)


Valid Range: Minimum value of 1. Maximum value of 500.

NextToken (p. 77)


TransitGatewayArns (p. 77)

The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is 10.



{ "NextToken": "string", "TransitGatewayRegistrations": [ { "GlobalNetworkId": "string", "State": { "Code": "string", "Message": "string" }, "TransitGatewayArn": "string" } ]}





NextToken (p. 77)


Type: StringTransitGatewayRegistrations (p. 77)

The transit gateway registrations.

Type: Array of TransitGatewayRegistration (p. 124) objects
















https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/GetTransitGatewayRegistrations

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/GetTransitGatewayRegistrations

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/GetTransitGatewayRegistrations

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/GetTransitGatewayRegistrations




https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/GetTransitGatewayRegistrations

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/GetTransitGatewayRegistrations

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/GetTransitGatewayRegistrations

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/GetTransitGatewayRegistrations

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/GetTransitGatewayRegistrations

AWS Network Manager API ReferenceListTagsForResource

ListTagsForResourceLists the tags for a specified resource.

Request SyntaxGET /tags/resourceArn HTTP/1.1


resourceArn (p. 80)

The Amazon Resource Name (ARN) of the resource.

Required: Yes



{ "TagList": [ { "Key": "string", "Value": "string" } ]}



TagList (p. 80)

The list of tags.



















https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/ListTagsForResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/ListTagsForResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/ListTagsForResource

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/ListTagsForResource

AWS Network Manager API ReferenceRegisterTransitGateway

RegisterTransitGatewayRegisters a transit gateway in your global network. The transit gateway can be in any AWS Region, butit must be owned by the same AWS account that owns the global network. You cannot register a transitgateway in more than one global network.

Request SyntaxPOST /global-networks/globalNetworkId/transit-gateway-registrations HTTP/1.1Content-type: application/json

{ "TransitGatewayArn": "string"}




Required: Yes


TransitGatewayArn (p. 82)

The Amazon Resource Name (ARN) of the transit gateway. For more information, see ResourcesDefined by Amazon EC2.

Type: String

Required: Yes


{ "TransitGatewayRegistration": { "GlobalNetworkId": "string", "State": { "Code": "string", "Message": "string" }, "TransitGatewayArn": "string" }}







TransitGatewayRegistration (p. 82)

Information about the transit gateway registration.

Type: TransitGatewayRegistration (p. 124) object


















https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/RegisterTransitGateway

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/RegisterTransitGateway

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/RegisterTransitGateway




https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/RegisterTransitGateway

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/RegisterTransitGateway

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/RegisterTransitGateway

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/RegisterTransitGateway

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/RegisterTransitGateway

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/RegisterTransitGateway

AWS Network Manager API ReferenceTagResource

TagResourceTags a specified resource.

Request SyntaxPOST /tags/resourceArn HTTP/1.1Content-type: application/json

{ "Tags": [ { "Key": "string", "Value": "string" } ]}


resourceArn (p. 85)


Required: Yes


Tags (p. 85)

The tags to apply to the specified resource.


Required: Yes

Response SyntaxHTTP/1.1 200

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/networkmanager-2019-07-05/TagResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/TagResource

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/TagResource

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/TagResource

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/TagResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/TagResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/TagResource

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/TagResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/TagResource

AWS Network Manager API ReferenceUntagResource

UntagResourceRemoves tags from a specified resource.

Request SyntaxDELETE /tags/resourceArn?tagKeys=TagKeys HTTP/1.1


resourceArn (p. 87)


Required: YesTagKeys (p. 87)

The tag keys to remove from the specified resource.

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/networkmanager-2019-07-05/UntagResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/UntagResource

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/UntagResource

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/UntagResource

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/UntagResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/UntagResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/UntagResource

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/UntagResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/UntagResource

AWS Network Manager API ReferenceUpdateConnection

UpdateConnectionUpdates the information for an existing connection. To remove information for any of the parameters,specify an empty string.

Request SyntaxPATCH /global-networks/globalNetworkId/connections/connectionId HTTP/1.1Content-type: application/json

{ "ConnectedLinkId": "string", "Description": "string", "LinkId": "string"}


connectionId (p. 89)




Required: Yes


ConnectedLinkId (p. 89)

The ID of the link for the second device in the connection.

Type: String


A description of the connection.


Type: String

Required: NoLinkId (p. 89)

The ID of the link for the first device in the connection.



Type: String

Required: No





Connection (p. 90)























https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/UpdateConnection

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/UpdateConnection

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/UpdateConnection

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/UpdateConnection

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/UpdateConnection

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/UpdateConnection

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/UpdateConnection

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/UpdateConnection

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/UpdateConnection

AWS Network Manager API ReferenceUpdateDevice

UpdateDeviceUpdates the details for an existing device. To remove information for any of the parameters, specify anempty string.

Request SyntaxPATCH /global-networks/globalNetworkId/devices/deviceId HTTP/1.1Content-type: application/json

{ "AWSLocation": { "SubnetArn": "string", "Zone": "string" }, "Description": "string", "Location": { "Address": "string", "Latitude": "string", "Longitude": "string" }, "Model": "string", "SerialNumber": "string", "SiteId": "string", "Type": "string", "Vendor": "string"}


deviceId (p. 92)


Required: Yes



Required: Yes


AWSLocation (p. 92)

The AWS location of the device, if applicable. For an on-premises device, you can omit thisparameter.


Required: No



Description (p. 92)

A description of the device.


Type: String


Describes a location.


Required: NoModel (p. 92)

The model of the device.


Type: String

Required: NoSerialNumber (p. 92)

The serial number of the device.


Type: String


The ID of the site.

Type: String


The type of the device.

Type: String

Required: NoVendor (p. 92)

The vendor of the device.


Type: String

Required: No




Content-type: application/json

{ "Device": { "AWSLocation": { "SubnetArn": "string", "Zone": "string" }, "CreatedAt": number, "Description": "string", "DeviceArn": "string", "DeviceId": "string", "GlobalNetworkId": "string", "Location": { "Address": "string", "Latitude": "string", "Longitude": "string" }, "Model": "string", "SerialNumber": "string", "SiteId": "string", "State": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Type": "string", "Vendor": "string" }}



Device (p. 93)























https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/UpdateDevice

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/UpdateDevice

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/UpdateDevice

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/UpdateDevice

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/UpdateDevice

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/UpdateDevice

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/UpdateDevice

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/UpdateDevice

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/UpdateDevice

AWS Network Manager API ReferenceUpdateGlobalNetwork

UpdateGlobalNetworkUpdates an existing global network. To remove information for any of the parameters, specify an emptystring.

Request SyntaxPATCH /global-networks/globalNetworkId HTTP/1.1Content-type: application/json

{ "Description": "string"}



The ID of your global network.

Required: Yes


Description (p. 96)

A description of the global network.


Type: String

Required: No


{ "GlobalNetwork": { "CreatedAt": number, "Description": "string", "GlobalNetworkArn": "string", "GlobalNetworkId": "string", "State": "string", "Tags": [ { "Key": "string", "Value": "string" }



] }}




Information about the global network object.





















https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/UpdateGlobalNetwork

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/UpdateGlobalNetwork

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/UpdateGlobalNetwork

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/UpdateGlobalNetwork

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/UpdateGlobalNetwork

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/UpdateGlobalNetwork

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/UpdateGlobalNetwork

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/UpdateGlobalNetwork

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/UpdateGlobalNetwork

AWS Network Manager API ReferenceUpdateLink

UpdateLinkUpdates the details for an existing link. To remove information for any of the parameters, specify anempty string.

Request SyntaxPATCH /global-networks/globalNetworkId/links/linkId HTTP/1.1Content-type: application/json

{ "Bandwidth": { "DownloadSpeed": number, "UploadSpeed": number }, "Description": "string", "Provider": "string", "Type": "string"}




Required: YeslinkId (p. 99)

The ID of the link.

Required: Yes


Bandwidth (p. 99)

The upload and download speed in Mbps.



A description of the link.


Type: String

Required: No



Provider (p. 99)



Type: String




Type: String

Required: No


{ "Link": { "Bandwidth": { "DownloadSpeed": number, "UploadSpeed": number }, "CreatedAt": number, "Description": "string", "GlobalNetworkId": "string", "LinkArn": "string", "LinkId": "string", "Provider": "string", "SiteId": "string", "State": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Type": "string" }}



Link (p. 100)
























https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/UpdateLink

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/UpdateLink

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/UpdateLink

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/UpdateLink

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/UpdateLink

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/UpdateLink

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/UpdateLink

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/UpdateLink

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/UpdateLink



AWS Network Manager API ReferenceUpdateSite

UpdateSiteUpdates the information for an existing site. To remove information for any of the parameters, specify anempty string.

Request SyntaxPATCH /global-networks/globalNetworkId/sites/siteId HTTP/1.1Content-type: application/json

{ "Description": "string", "Location": { "Address": "string", "Latitude": "string", "Longitude": "string" }}




Required: Yes

siteId (p. 103)

The ID of your site.

Required: Yes


Description (p. 103)

A description of your site.


Type: String

Required: No

Location (p. 103)

The site location:

• Address: The physical address of the site.

• Latitude: The latitude of the site.

• Longitude: The longitude of the site.




Required: No





Site (p. 104)























https://docs.aws.amazon.com/goto/aws-cli/networkmanager-2019-07-05/UpdateSite

https://docs.aws.amazon.com/goto/DotNetSDKV3/networkmanager-2019-07-05/UpdateSite

https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/UpdateSite

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/UpdateSite

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/UpdateSite

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/networkmanager-2019-07-05/UpdateSite

https://docs.aws.amazon.com/goto/SdkForPHPV3/networkmanager-2019-07-05/UpdateSite

https://docs.aws.amazon.com/goto/boto3/networkmanager-2019-07-05/UpdateSite

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/UpdateSite


Data TypesThe AWS Network Manager API contains several data types that various actions use. This sectiondescribes each 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:

• AWSLocation (p. 107)• Bandwidth (p. 108)• Connection (p. 109)• CustomerGatewayAssociation (p. 111)• Device (p. 112)• GlobalNetwork (p. 114)• Link (p. 116)• LinkAssociation (p. 118)• Location (p. 119)• Site (p. 120)• Tag (p. 122)• TransitGatewayConnectPeerAssociation (p. 123)• TransitGatewayRegistration (p. 124)• TransitGatewayRegistrationStateReason (p. 125)• ValidationExceptionField (p. 126)


AWS Network Manager API ReferenceAWSLocation

AWSLocationSpecifies a location in AWS.

ContentsSubnetArn

The Amazon Resource Name (ARN) of the subnet that the device is located in.

Type: String

Required: NoZone

The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, WavelengthZone, or an Outpost.

Type: String

Required: No


• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/AWSLocation

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/AWSLocation

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/AWSLocation

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/AWSLocation

AWS Network Manager API ReferenceBandwidth

BandwidthDescribes bandwidth information.

ContentsDownloadSpeed

Download speed in Mbps.

Type: Integer

Required: NoUploadSpeed

Upload speed in Mbps.

Type: Integer

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/Bandwidth

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/Bandwidth

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/Bandwidth

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/Bandwidth

AWS Network Manager API ReferenceConnection

ConnectionDescribes a connection.

ContentsConnectedDeviceId

The ID of the second device in the connection.

Type: String

Required: NoConnectedLinkId

The ID of the link for the second device in the connection.

Type: String

Required: NoConnectionArn

The Amazon Resource Name (ARN) of the connection.

Type: String

Required: NoConnectionId


Type: String

Required: NoCreatedAt

The date and time that the connection was created.

Type: Timestamp

Required: NoDescription

The description of the connection.

Type: String

Required: NoDeviceId

The ID of the first device in the connection.

Type: String

Required: NoGlobalNetworkId




Type: String

Required: NoLinkId

The ID of the link for the first device in the connection.

Type: String

Required: NoState

The state of the connection.

Type: String

Valid Values: PENDING | AVAILABLE | DELETING | UPDATING

Required: NoTags

The tags for the connection.


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/Connection

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/Connection

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/Connection

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/Connection

AWS Network Manager API ReferenceCustomerGatewayAssociation

CustomerGatewayAssociationDescribes the association between a customer gateway, a device, and a link.

ContentsCustomerGatewayArn

The Amazon Resource Name (ARN) of the customer gateway.

Type: String



Type: String



Type: String

Required: NoLinkId

The ID of the link.

Type: String

Required: NoState

The association state.

Type: String

Valid Values: PENDING | AVAILABLE | DELETING | DELETED

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/CustomerGatewayAssociation

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/CustomerGatewayAssociation

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/CustomerGatewayAssociation

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/CustomerGatewayAssociation

AWS Network Manager API ReferenceDevice

DeviceDescribes a device.

ContentsAWSLocation

The AWS location of the device.



The date and time that the site was created.

Type: Timestamp


The description of the device.

Type: String

Required: NoDeviceArn

The Amazon Resource Name (ARN) of the device.

Type: String



Type: String



Type: String

Required: NoLocation

The site location.


Required: NoModel

The device model.



Type: String

Required: NoSerialNumber

The device serial number.

Type: String

Required: NoSiteId

The site ID.

Type: String

Required: NoState

The device state.

Type: String


Required: NoTags

The tags for the device.


Required: NoType

The device type.

Type: String

Required: NoVendor

The device vendor.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/Device

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/Device

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/Device

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/Device

AWS Network Manager API ReferenceGlobalNetwork

GlobalNetworkDescribes a global network.

ContentsCreatedAt

The date and time that the global network was created.

Type: Timestamp


The description of the global network.

Type: String

Required: NoGlobalNetworkArn

The Amazon Resource Name (ARN) of the global network.

Type: String



Type: String

Required: NoState

The state of the global network.

Type: String


Required: NoTags

The tags for the global network.


Required: No


• AWS SDK for C++


https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/GlobalNetwork


• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/GlobalNetwork

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/GlobalNetwork

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/GlobalNetwork

AWS Network Manager API ReferenceLink

LinkDescribes a link.

ContentsBandwidth

The bandwidth for the link.



The date and time that the link was created.

Type: Timestamp


The description of the link.

Type: String



Type: String

Required: NoLinkArn

The Amazon Resource Name (ARN) of the link.

Type: String

Required: NoLinkId

The ID of the link.

Type: String

Required: NoProvider


Type: String

Required: NoSiteId

The ID of the site.



Type: String

Required: NoState

The state of the link.

Type: String


Required: NoTags

The tags for the link.


Required: NoType


Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/Link

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/Link

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/Link

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/Link

AWS Network Manager API ReferenceLinkAssociation

LinkAssociationDescribes the association between a device and a link.

ContentsDeviceId

The device ID for the link association.

Type: String



Type: String

Required: NoLinkAssociationState

The state of the association.

Type: String


Required: NoLinkId

The ID of the link.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/LinkAssociation

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/LinkAssociation

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/LinkAssociation

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/LinkAssociation

AWS Network Manager API ReferenceLocation

LocationDescribes a location.

ContentsAddress

The physical address.

Type: String

Required: NoLatitude

The latitude.

Type: String

Required: NoLongitude

The longitude.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/Location

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/Location

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/Location

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/Location

AWS Network Manager API ReferenceSite

SiteDescribes a site.

ContentsCreatedAt

The date and time that the site was created.

Type: Timestamp


The description of the site.

Type: String



Type: String

Required: NoLocation

The location of the site.


Required: NoSiteArn

The Amazon Resource Name (ARN) of the site.

Type: String

Required: NoSiteId

The ID of the site.

Type: String

Required: NoState

The state of the site.

Type: String


Required: No



Tags

The tags for the site.


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/Site

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/Site

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/Site

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/Site

AWS Network Manager API ReferenceTag

TagDescribes a tag.

ContentsKey

The tag key.


Type: String

Required: NoValue

The tag value.


Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/Tag

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/Tag

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/Tag

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/Tag

AWS Network Manager API ReferenceTransitGatewayConnectPeerAssociation

TransitGatewayConnectPeerAssociationDescribes a transit gateway Connect peer association.

ContentsDeviceId


Type: String



Type: String

Required: NoLinkId

The ID of the link.

Type: String

Required: NoState

The state of the association.

Type: String


Required: NoTransitGatewayConnectPeerArn

The Amazon Resource Name (ARN) of the transit gateway Connect peer.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/TransitGatewayConnectPeerAssociation

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/TransitGatewayConnectPeerAssociation

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/TransitGatewayConnectPeerAssociation

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/TransitGatewayConnectPeerAssociation

AWS Network Manager API ReferenceTransitGatewayRegistration

TransitGatewayRegistrationDescribes the registration of a transit gateway to a global network.

ContentsGlobalNetworkId


Type: String

Required: NoState

The state of the transit gateway registration.

Type: TransitGatewayRegistrationStateReason (p. 125) object

Required: NoTransitGatewayArn

The Amazon Resource Name (ARN) of the transit gateway.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/TransitGatewayRegistration

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/TransitGatewayRegistration

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/TransitGatewayRegistration

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/TransitGatewayRegistration

AWS Network Manager API ReferenceTransitGatewayRegistrationStateReason

TransitGatewayRegistrationStateReasonDescribes the status of a transit gateway registration.

ContentsCode

The code for the state reason.

Type: String

Valid Values: PENDING | AVAILABLE | DELETING | DELETED | FAILED

Required: NoMessage

The message for the state reason.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/TransitGatewayRegistrationStateReason

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/TransitGatewayRegistrationStateReason

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/TransitGatewayRegistrationStateReason

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/TransitGatewayRegistrationStateReason

AWS Network Manager API ReferenceValidationExceptionField

ValidationExceptionFieldDescribes a validation exception for a field.

ContentsMessage

The message for the field.

Type: String

Required: YesName

The name of the field.

Type: String

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/networkmanager-2019-07-05/ValidationExceptionField

https://docs.aws.amazon.com/goto/SdkForGoV1/networkmanager-2019-07-05/ValidationExceptionField

https://docs.aws.amazon.com/goto/SdkForJavaV2/networkmanager-2019-07-05/ValidationExceptionField

https://docs.aws.amazon.com/goto/SdkForRubyV3/networkmanager-2019-07-05/ValidationExceptionField


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.



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: 400NotAuthorized

You do not have permission to perform this action.

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: 400ValidationError

The input fails to satisfy the constraints specified by an AWS service.



Documents

AWS Network Manager · 2020. 8. 31. · AWS Network Manager API Reference Welcome Transit Gateway Network Manager (Network Manager) enables you to create a global network, in which