AWS Network Manager
Amazon Web Services enables you to centrally manage your Amazon Web Services Cloud WAN core network and your Transit Gateway network across Amazon Web…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Amazon Web Services enables you to centrally manage your Amazon Web Services Cloud WAN core network and your Transit Gateway network across Amazon Web Services accounts, Regions, and on-premises locations.
Endpoints 109
- POSTAccept attachment
/attachments/:AttachmentId/acceptAccepts a core network attachment request. Once the attachment request is accepted by a core network owner, the attachment is created and connected to a core… - GETGet connect peer associations
/global-networks/:GlobalNetworkId/connect-peer-associations?connectPeerIds=&maxResults=0&nextToken=stringReturns information about a core network Connect peer associations. - POSTAssociate connect peer
/global-networks/:GlobalNetworkId/connect-peer-associationsAssociates a core network Connect peer with a device and optionally, with a link. If you specify a link, it must be associated with the specified device. You… - GETList context store associations
/context-stores/:ContextStoreId/associations?maxResults=0&nextToken=stringReturns the transit gateway associations of a context store. - POSTAssociate context store
/context-stores/:ContextStoreId/associationsAssociates a transit gateway with a context store. The transit gateway must be registered with the global network of the context store, and can't be… - GETGet customer gateway associations
/global-networks/:GlobalNetworkId/customer-gateway-associations?customerGatewayArns=&maxResults=0&nextToken=stringGets the association information for customer gateways that are associated with devices and links in your global network. - POSTAssociate customer gateway
/global-networks/:GlobalNetworkId/customer-gateway-associationsAssociates a customer gateway with a device and optionally, with a link. If you specify a link, it must be associated with the specified device. You can only… - GETGet link associations
/global-networks/:GlobalNetworkId/link-associations?deviceId=string&linkId=string&maxResults=0&nextToken=stringGets the link associations for a device or a link. Either the device ID or the link ID must be specified. - POSTAssociate link
/global-networks/:GlobalNetworkId/link-associationsAssociates a link to a device. A device can be associated to multiple links and a link can be associated to multiple devices. The device and link must be in… - DELETEDisassociate link
/global-networks/:GlobalNetworkId/link-associations?deviceId=string&linkId=stringDisassociates an existing device from a link. You must first disassociate any customer gateways that are associated with the link. - GETGet transit gateway connect peer associations
/global-networks/:GlobalNetworkId/transit-gateway-connect-peer-associations?transitGatewayConnectPeerArns=&maxResults=0&nextToken=stringGets information about one or more of your transit gateway Connect peer associations in a global network. - POSTAssociate transit gateway connect peer
/global-networks/:GlobalNetworkId/transit-gateway-connect-peer-associationsAssociates 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.… - POSTCreate connect attachment
/connect-attachmentsCreates a core network Connect attachment from a specified core network attachment. A core network Connect attachment is a GRE-based tunnel attachment that… - GETList connect peers
/connect-peers?coreNetworkId=string&connectAttachmentId=string&maxResults=0&nextToken=stringReturns a list of core network Connect peers. - POSTCreate connect peer
/connect-peersCreates a core network Connect peer for a specified core network connect attachment between a core network and an appliance. The peer address and transit… - GETGet connections
/global-networks/:GlobalNetworkId/connections?connectionIds=&deviceId=string&maxResults=0&nextToken=stringGets information about one or more of your connections in a global network. - POSTCreate connection
/global-networks/:GlobalNetworkId/connectionsCreates a connection between two devices. The devices can be a physical or virtual appliance that connects to a third-party appliance in a VPC, or a physical… - POSTCreate context store
/global-networks/:GlobalNetworkId/context-storesCreates a context store in a global network. A context store maintains context entries, such as security groups, subnets, and attachments, for the resources… - GETList core networks
/core-networks?maxResults=0&nextToken=stringReturns a list of owned and shared core networks. - POSTCreate core network
/core-networksCreates a core network as part of your global network, and optionally, with a core network policy. - POSTCreate core network prefix list association
/prefix-listCreates an association between a core network and a prefix list for routing control. - GETGet devices
/global-networks/:GlobalNetworkId/devices?deviceIds=&siteId=string&maxResults=0&nextToken=stringGets information about one or more of your devices in a global network. - POSTCreate device
/global-networks/:GlobalNetworkId/devicesCreates a new device in a global network. If you specify both a site ID and a location, the location of the site is used for visualization in the Network… - POSTCreate direct connect gateway attachment
/direct-connect-gateway-attachmentsCreates an Amazon Web Services Direct Connect gateway attachment - GETDescribe global networks
/global-networks?globalNetworkIds=&maxResults=0&nextToken=stringDescribes one or more global networks. By default, all global networks are described. To describe the objects in your global network, you must use the… - POSTCreate global network
/global-networksCreates a new, empty global network. - GETGet links
/global-networks/:GlobalNetworkId/links?linkIds=&siteId=string&type=string&provider=string&maxResults=0&nextToken=stringGets 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… - POSTCreate link
/global-networks/:GlobalNetworkId/linksCreates a new link for a specified site. - GETGet sites
/global-networks/:GlobalNetworkId/sites?siteIds=&maxResults=0&nextToken=stringGets information about one or more of your sites in a global network. - POSTCreate site
/global-networks/:GlobalNetworkId/sitesCreates a new site in a global network. - POSTCreate site to site vpn attachment
/site-to-site-vpn-attachmentsCreates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network. - POSTCreate transit gateway peering
/transit-gateway-peeringsCreates a transit gateway peering connection. - POSTCreate transit gateway route table attachment
/transit-gateway-route-table-attachmentsCreates a transit gateway route table attachment. - POSTCreate vpc attachment
/vpc-attachmentsCreates a VPC attachment on an edge location of a core network. - DELETEDelete attachment
/attachments/:AttachmentIdDeletes an attachment. Supports all attachment types. - GETGet connect peer
/connect-peers/:ConnectPeerIdReturns information about a core network Connect peer. - DELETEDelete connect peer
/connect-peers/:ConnectPeerIdDeletes a Connect peer. - DELETEDelete connection
/global-networks/:GlobalNetworkId/connections/:ConnectionIdDeletes the specified connection in your global network. - PATCHUpdate connection
/global-networks/:GlobalNetworkId/connections/:ConnectionIdUpdates the information for an existing connection. To remove information for any of the parameters, specify an empty string. - GETGet context store
/context-stores/:ContextStoreIdReturns information about a context store. - DELETEDelete context store
/context-stores/:ContextStoreIdDeletes a context store. The context store must be in the AVAILABLE state. You must disassociate all transit gateways from the context store before you can… - PATCHUpdate context store
/context-stores/:ContextStoreIdUpdates the description of a context store. The context store must be in the AVAILABLE state. - GETGet core network
/core-networks/:CoreNetworkIdReturns information about the LIVE policy for a core network. - DELETEDelete core network
/core-networks/:CoreNetworkIdDeletes a core network along with all core network policies. This can only be done if there are no attachments on a core network. - PATCHUpdate core network
/core-networks/:CoreNetworkIdUpdates the description of a core network. - DELETEDelete core network policy version
/core-networks/:CoreNetworkId/core-network-policy-versions/:PolicyVersionIdDeletes a policy version from a core network. You can't delete the current LIVE policy. - DELETEDelete core network prefix list association
/prefix-list/:PrefixListArn/core-network/:CoreNetworkIdDeletes an association between a core network and a prefix list. - DELETEDelete device
/global-networks/:GlobalNetworkId/devices/:DeviceIdDeletes an existing device. You must first disassociate the device from any links and customer gateways. - PATCHUpdate device
/global-networks/:GlobalNetworkId/devices/:DeviceIdUpdates the details for an existing device. To remove information for any of the parameters, specify an empty string. - DELETEDelete global network
/global-networks/:GlobalNetworkIdDeletes an existing global network. You must first delete all global network objects (devices, links, and sites), deregister all transit gateways, and delete… - PATCHUpdate global network
/global-networks/:GlobalNetworkIdUpdates an existing global network. To remove information for any of the parameters, specify an empty string. - DELETEDelete link
/global-networks/:GlobalNetworkId/links/:LinkIdDeletes an existing link. You must first disassociate the link from any devices and customer gateways. - PATCHUpdate link
/global-networks/:GlobalNetworkId/links/:LinkIdUpdates the details for an existing link. To remove information for any of the parameters, specify an empty string. - DELETEDelete peering
/peerings/:PeeringIdDeletes an existing peering connection. - GETGet resource policy
/resource-policy/:ResourceArnReturns information about a resource policy. - POSTPut resource policy
/resource-policy/:ResourceArnCreates or updates a resource policy. - DELETEDelete resource policy
/resource-policy/:ResourceArnDeletes a resource policy for the specified resource. This revokes the access of the principals specified in the resource policy. - DELETEDelete site
/global-networks/:GlobalNetworkId/sites/:SiteIdDeletes an existing site. The site cannot be associated with any device or link. - PATCHUpdate site
/global-networks/:GlobalNetworkId/sites/:SiteIdUpdates the information for an existing site. To remove information for any of the parameters, specify an empty string. - DELETEDeregister transit gateway
/global-networks/:GlobalNetworkId/transit-gateway-registrations/:TransitGatewayArnDeregisters a transit gateway from your global network. This action does not delete your transit gateway, or modify any of its attachments. This action… - DELETEDisassociate connect peer
/global-networks/:GlobalNetworkId/connect-peer-associations/:ConnectPeerIdDisassociates a core network Connect peer from a device and a link. - GETGet context store association
/context-stores/:ContextStoreId/associations/:TransitGatewayArnReturns information about the association between a context store and a transit gateway. - DELETEDisassociate context store
/context-stores/:ContextStoreId/associations/:TransitGatewayArnDisassociates a transit gateway from a context store. The association must be in the ASSOCIATED or FAILED state. The association stays in the DISASSOCIATING… - DELETEDisassociate customer gateway
/global-networks/:GlobalNetworkId/customer-gateway-associations/:CustomerGatewayArnDisassociates a customer gateway from a device and a link. - DELETEDisassociate transit gateway connect peer
/global-networks/:GlobalNetworkId/transit-gateway-connect-peer-associations/:TransitGatewayConnectPeerArnDisassociates a transit gateway Connect peer from a device and link. - POSTExecute core network change set
/core-networks/:CoreNetworkId/core-network-change-sets/:PolicyVersionId/executeExecutes a change set on your core network. Deploys changes globally based on the policy submitted.. - GETGet connect attachment
/connect-attachments/:AttachmentIdReturns information about a core network Connect attachment. - GETGet context version
/context-stores/:ContextStoreId/context-versionReturns the current version of the context entries of a context store. The context store must be in the AVAILABLE state. - GETGet core network change events
/core-networks/:CoreNetworkId/core-network-change-events/:PolicyVersionId?maxResults=0&nextToken=stringReturns information about a core network change event. - GETGet core network change set
/core-networks/:CoreNetworkId/core-network-change-sets/:PolicyVersionId?maxResults=0&nextToken=stringReturns a change set between the LIVE core network policy and a submitted policy. - GETGet core network policy
/core-networks/:CoreNetworkId/core-network-policy?policyVersionId=0&alias=stringReturns details about a core network policy. You can get details about your current live policy or any previous policy version. - POSTPut core network policy
/core-networks/:CoreNetworkId/core-network-policyCreates a new, immutable version of a core network policy. A subsequent change set is created showing the differences between the LIVE policy and the… - GETGet direct connect gateway attachment
/direct-connect-gateway-attachments/:AttachmentIdReturns information about a specific Amazon Web Services Direct Connect gateway attachment. - PATCHUpdate direct connect gateway attachment
/direct-connect-gateway-attachments/:AttachmentIdUpdates the edge locations associated with an Amazon Web Services Direct Connect gateway attachment. - GETGet network resource counts
/global-networks/:GlobalNetworkId/network-resource-count?resourceType=string&maxResults=0&nextToken=stringGets the count of network resources, by resource type, for the specified global network. - GETGet network resource relationships
/global-networks/:GlobalNetworkId/network-resource-relationships?coreNetworkId=string®isteredGatewayArn=string&awsRegion=string&accountId=string&resourceType=string&resourceArn=string&maxResults=0&nextToken=stringGets the network resource relationships for the specified global network. - GETGet network resources
/global-networks/:GlobalNetworkId/network-resources?coreNetworkId=string®isteredGatewayArn=string&awsRegion=string&accountId=string&resourceType=string&resourceArn=string&maxResults=0&nextToken=stringDescribes the network resources for the specified global network. The results include information from the corresponding Describe call for the resource, minus… - POSTGet network routes
/global-networks/:GlobalNetworkId/network-routesGets the network routes of the specified global network. - GETGet network telemetry
/global-networks/:GlobalNetworkId/network-telemetry?coreNetworkId=string®isteredGatewayArn=string&awsRegion=string&accountId=string&resourceType=string&resourceArn=string&maxResults=0&nextToken=stringGets the network telemetry of the specified global network. - GETGet route analysis
/global-networks/:GlobalNetworkId/route-analyses/:RouteAnalysisIdGets information about the specified route analysis. - GETGet site to site vpn attachment
/site-to-site-vpn-attachments/:AttachmentIdReturns information about a site-to-site VPN attachment. - GETGet transit gateway peering
/transit-gateway-peerings/:PeeringIdReturns information about a transit gateway peer. - GETGet transit gateway registrations
/global-networks/:GlobalNetworkId/transit-gateway-registrations?transitGatewayArns=&maxResults=0&nextToken=stringGets information about the transit gateway registrations in a specified global network. - POSTRegister transit gateway
/global-networks/:GlobalNetworkId/transit-gateway-registrationsRegisters a transit gateway in your global network. Not all Regions support transit gateways for global networks. For a list of the supported Regions, see… - GETGet transit gateway route table attachment
/transit-gateway-route-table-attachments/:AttachmentIdReturns information about a transit gateway route table attachment. - GETGet vpc attachment
/vpc-attachments/:AttachmentIdReturns information about a VPC attachment. - PATCHUpdate vpc attachment
/vpc-attachments/:AttachmentIdUpdates a VPC attachment. - POSTList attachment nat configurations
/nat-configurationsReturns the NAT configurations of core network attachments. You must specify either a core network ID or an attachment ID. Only the core network owner can… - GETList attachment routing policy associations
/routing-policy-label/core-network/:CoreNetworkId?attachmentId=string&maxResults=0&nextToken=stringLists the routing policy associations for attachments in a core network. - GETList attachments
/attachments?coreNetworkId=string&attachmentType=string&edgeLocation=string&state=string&maxResults=0&nextToken=stringReturns a list of core network attachments. - GETList context changes
/context-stores/:ContextStoreId/context-changes?fromVersionId=string&maxResults=0&nextToken=stringReturns the context entries that were added to or removed from a context store after the specified version. The context store must be in the AVAILABLE state. - GETList context stores
/context-stores?globalNetworkId=string&maxResults=0&nextToken=stringReturns the context stores in your account. You can optionally return only the context stores in a specific global network. - GETList contexts
/context-stores/:ContextStoreId/contexts?maxResults=0&nextToken=stringReturns the context entries of a context store, and the version of the context entries. To get the context entries that were added or removed after this… - GETList core network policy versions
/core-networks/:CoreNetworkId/core-network-policy-versions?maxResults=0&nextToken=stringReturns a list of core network policy versions. - GETList core network prefix list associations
/prefix-list/core-network/:CoreNetworkId?prefixListArn=string&maxResults=0&nextToken=stringLists the prefix list associations for a core network. - POSTList core network routing information
/core-networks/:CoreNetworkId/core-network-routing-information?maxResults=0&nextToken=stringLists routing information for a core network, including routes and their attributes. - GETList organization service access status
/organizations/service-access?maxResults=0&nextToken=stringGets the status of the Service Linked Role (SLR) deployment for the accounts in a given Amazon Web Services Organization. - POSTStart organization service access update
/organizations/service-accessEnables the Network Manager service for an Amazon Web Services Organization. This can only be called by a management account within the organization. - GETList peerings
/peerings?coreNetworkId=string&peeringType=string&edgeLocation=string&state=string&maxResults=0&nextToken=stringLists the peerings for a core network. - GETList tags for resource
/tags/:ResourceArnLists the tags for a specified resource. - POSTTag resource
/tags/:ResourceArnTags a specified resource. - DELETEUntag resource
/tags/:ResourceArn?tagKeys=Removes tags from a specified resource. - POSTPut attachment routing policy label
/routing-policy-labelApplies a routing policy label to an attachment for traffic routing decisions. - POSTReject attachment
/attachments/:AttachmentId/rejectRejects a core network attachment request. - DELETERemove attachment routing policy label
/routing-policy-label/core-network/:CoreNetworkId/attachment/:AttachmentIdRemoves a routing policy label from an attachment. - POSTRestore core network policy version
/core-networks/:CoreNetworkId/core-network-policy-versions/:PolicyVersionId/restoreRestores a previous policy version as a new, immutable version of a core network policy. A subsequent change set is created showing the differences between… - POSTStart route analysis
/global-networks/:GlobalNetworkId/route-analysesStarts analyzing the routing path between the specified source and destination. For more information, see Route Analyzer . - PATCHUpdate attachment nat configuration
/attachments/:AttachmentId/nat-configurationUpdates the NAT configuration of a core network attachment. You can enable or disable NAT gateway support, specify whether the core network installs system… - PATCHUpdate network resource metadata
/global-networks/:GlobalNetworkId/network-resources/:ResourceArn/metadataUpdates the resource metadata for the specified global network.
API details
- Base URL
https://networkmanager.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 109 operations on 76 pathsGET 43POST 34DELETE 21PATCH 11
- Description format
- AWS Smithy model, API version
2019-07-05 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Network Manager in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Network Manager collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Accept attachment” (POST /attachments/:AttachmentId/accept), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Network Manager?
Amazon Web Services enables you to centrally manage your Amazon Web Services Cloud WAN core network and your Transit Gateway network across Amazon Web… It is listed under Developer tools and has 109 endpoints.
Who publishes the AWS Network Manager?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS Network Manager?
Requests go to https://networkmanager.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Network Manager?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Network Manager have?
109 operations on 76 paths (43 GET, 34 POST, 21 DELETE, 11 PATCH).
Is forking the AWS Network Manager free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.