AWS Network Manager

(1)

AWS Network Manager

API Reference

API Version 2019-07-05

(2)

AWS Network Manager: API Reference

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

(3)

Welcome

Amazon Web Services enables you to centrally manage your AWS Cloud WAN core network and your Transit Gateway network across AWS accounts, Regions, and on-premises locations.

This document was last published on March 6, 2022.

(18)

Actions

The following actions are supported:

• AcceptAttachment (p. 4)

• AssociateConnectPeer (p. 7)

• AssociateCustomerGateway (p. 10)

• AssociateLink (p. 13)

• AssociateTransitGatewayConnectPeer (p. 16)

• CreateConnectAttachment (p. 19)

• CreateConnection (p. 23)

• CreateConnectPeer (p. 27)

• CreateCoreNetwork (p. 31)

• CreateDevice (p. 35)

• CreateGlobalNetwork (p. 40)

• CreateLink (p. 43)

• CreateSite (p. 47)

• CreateSiteToSiteVpnAttachment (p. 51)

• CreateVpcAttachment (p. 55)

• DeleteAttachment (p. 59)

• DeleteConnection (p. 62)

• DeleteConnectPeer (p. 65)

• DeleteCoreNetwork (p. 68)

• DeleteCoreNetworkPolicyVersion (p. 71)

• DeleteDevice (p. 74)

• DeleteGlobalNetwork (p. 77)

• DeleteLink (p. 80)

• DeleteResourcePolicy (p. 83)

• DeleteSite (p. 85)

• DeregisterTransitGateway (p. 88)

• DescribeGlobalNetworks (p. 91)

• DisassociateConnectPeer (p. 94)

• DisassociateCustomerGateway (p. 97)

• DisassociateLink (p. 100)

• DisassociateTransitGatewayConnectPeer (p. 103)

• ExecuteCoreNetworkChangeSet (p. 106)

• GetConnectAttachment (p. 108)

• GetConnections (p. 111)

• GetConnectPeer (p. 114)

• GetConnectPeerAssociations (p. 117)

• GetCoreNetwork (p. 120)

• GetCoreNetworkChangeSet (p. 123)

• GetCoreNetworkPolicy (p. 126)

• GetCustomerGatewayAssociations (p. 129)

(19)

• GetDevices (p. 132)

• GetLinkAssociations (p. 135)

• GetLinks (p. 138)

• GetNetworkResourceCounts (p. 141)

• GetNetworkResourceRelationships (p. 144)

• GetNetworkResources (p. 148)

• GetNetworkRoutes (p. 152)

• GetNetworkTelemetry (p. 157)

• GetResourcePolicy (p. 161)

• GetRouteAnalysis (p. 163)

• GetSites (p. 166)

• GetSiteToSiteVpnAttachment (p. 169)

• GetTransitGatewayConnectPeerAssociations (p. 172)

• GetTransitGatewayRegistrations (p. 175)

• GetVpcAttachment (p. 178)

• ListAttachments (p. 181)

• ListConnectPeers (p. 184)

• ListCoreNetworkPolicyVersions (p. 187)

• ListCoreNetworks (p. 190)

• ListTagsForResource (p. 193)

• PutCoreNetworkPolicy (p. 195)

• PutResourcePolicy (p. 198)

• RegisterTransitGateway (p. 200)

• RejectAttachment (p. 203)

• RestoreCoreNetworkPolicyVersion (p. 206)

• StartRouteAnalysis (p. 209)

• TagResource (p. 213)

• UntagResource (p. 216)

• UpdateConnection (p. 218)

• UpdateCoreNetwork (p. 221)

• UpdateDevice (p. 224)

• UpdateGlobalNetwork (p. 229)

• UpdateLink (p. 232)

• UpdateNetworkResourceMetadata (p. 236)

• UpdateSite (p. 239)

• UpdateVpcAttachment (p. 242)

(20)

AcceptAttachment

Accepts 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 network.

Request Syntax

POST /attachments/attachmentId/accept HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

attachmentId (p. 4)

The ID of the attachment.

Length Constraints: Minimum length of 0. Maximum length of 50.

Pattern: ^attachment-([0-9a-f]{8,17})$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

Content-type: application/json { "Attachment": {

"AttachmentId": "string",

"AttachmentPolicyRuleNumber": number, "AttachmentType": "string",

"CoreNetworkArn": "string", "CoreNetworkId": "string", "CreatedAt": number, "EdgeLocation": "string", "OwnerAccountId": "string", "ProposedSegmentChange": {

"AttachmentPolicyRuleNumber": number, "SegmentName": "string",

"Tags": [ {

"Key": "string", "Value": "string"

} ] },

"ResourceArn": "string", "SegmentName": "string",

(21)

Response Elements

"State": "string", "Tags": [

{

} ],

"UpdatedAt": number }

}

Response Elements

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

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

Attachment (p. 4)

The response to the attachment request.

Type: Attachment (p. 248) object

Errors

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

AccessDeniedException

You do not have suﬃcient access to perform this action.

HTTP Status Code: 403 ConﬂictException

There was a conﬂict processing the request. Updating or deleting the resource can cause an inconsistent state.

HTTP Status Code: 409 InternalServerException

The request has failed due to an internal error.

HTTP Status Code: 500 ResourceNotFoundException

The speciﬁed resource could not be found.

HTTP Status Code: 404 ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429 ValidationException

The input fails to satisfy the constraints.

HTTP Status Code: 400

(22)

See Also

AssociateConnectPeer

Associates a core network Connect peer with a device and optionally, with a link.

If you specify a link, it must be associated with the speciﬁed device. You can only associate core network Connect peers that have been created on a core network Connect attachment on a core network.

Request Syntax

POST /global-networks/globalNetworkId/connect-peer-associations HTTP/1.1 Content-type: application/json

{

"ConnectPeerId": "string", "DeviceId": "string", "LinkId": "string"

}

URI Request Parameters

globalNetworkId (p. 7)

The ID of your global network.

Pattern: [\s\S]*

Required: Yes

Request Body

The request accepts the following data in JSON format.

ConnectPeerId (p. 7)

The ID of the Connect peer.

Type: String

Pattern: ^connect-peer-([0-9a-f]{8,17})$

Required: Yes DeviceId (p. 7)

The ID of the device.

Type: String

Pattern: [\s\S]*

(24)

Response Syntax

Required: Yes LinkId (p. 7)

The ID of the link.

Type: String

Pattern: [\s\S]*

Required: No

Response Syntax

HTTP/1.1 200

Content-type: application/json { "ConnectPeerAssociation": { "ConnectPeerId": "string", "DeviceId": "string", "GlobalNetworkId": "string", "LinkId": "string",

"State": "string"

}}

Response Elements

ConnectPeerAssociation (p. 8)

The response to the Connect peer request.

Type: ConnectPeerAssociation (p. 262) object

Errors

(25)

See Also

InternalServerException

HTTP Status Code: 404 ServiceQuotaExceededException

A service limit was exceeded.

AssociateCustomerGateway

Associates a customer gateway with a device and optionally, with a link. If you specify a link, it must be associated with the speciﬁed device.

You can only associate customer gateways that are connected to a VPN attachment on a transit gateway or core network registered in your global network. When you register a transit gateway or core network, customer gateways that are connected to the transit gateway are automatically included in the global network. To list customer gateways that are connected to a transit gateway, use the DescribeVpnConnections EC2 API and ﬁlter by transit-gateway-id.

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

Request Syntax

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

{

"CustomerGatewayArn": "string", "DeviceId": "string",

"LinkId": "string"

}

URI Request Parameters

The ID of the global network.

Pattern: [\s\S]*

Required: Yes

Request Body

CustomerGatewayArn (p. 10)

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

Type: String

Pattern: [\s\S]*

Required: Yes DeviceId (p. 10)

(27)

Response Syntax

Type: String

Pattern: [\s\S]*

The ID of the link.

Type: String

Pattern: [\s\S]*

Required: No

Response Syntax

HTTP/1.1 200

Content-type: application/json { "CustomerGatewayAssociation": { "CustomerGatewayArn": "string", "DeviceId": "string",

"GlobalNetworkId": "string", "LinkId": "string",

"State": "string"

}}

Response Elements

CustomerGatewayAssociation (p. 11)

The customer gateway association.

Type: CustomerGatewayAssociation (p. 285) object

Errors

(28)

See Also

ConﬂictException

AssociateLink

Associates 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 the same global network and the same site.

Request Syntax

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

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

}

URI Request Parameters

Pattern: [\s\S]*

Required: Yes

Request Body

DeviceId (p. 13)

Type: String

Pattern: [\s\S]*

The ID of the link.

Type: String

Pattern: [\s\S]*

Required: Yes

(30)

Response Syntax

HTTP/1.1 200

Content-type: application/json { "LinkAssociation": { "DeviceId": "string", "GlobalNetworkId": "string", "LinkAssociationState": "string", "LinkId": "string"

} }

Response Elements

LinkAssociation (p. 14) The link association.

Type: LinkAssociation (p. 295) object

Errors

(31)

See Also

ThrottlingException

AssociateTransitGatewayConnectPeer

Associates a transit gateway Connect peer with a device, and optionally, with a link. If you specify a link, it must be associated with the speciﬁed device.

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

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

Request Syntax

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

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

"TransitGatewayConnectPeerArn": "string"

}

URI Request Parameters

Pattern: [\s\S]*

Required: Yes

Request Body

DeviceId (p. 16)

Type: String

Pattern: [\s\S]*

The ID of the link.

Type: String

(33)

Response Syntax

Pattern: [\s\S]*

Required: No

TransitGatewayConnectPeerArn (p. 16)

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

Type: String

Pattern: [\s\S]*

Required: Yes

Response Syntax

HTTP/1.1 200

Content-type: application/json

{ "TransitGatewayConnectPeerAssociation": { "DeviceId": "string",

"GlobalNetworkId": "string", "LinkId": "string",

"State": "string",

"TransitGatewayConnectPeerArn": "string"

}}

Response Elements

TransitGatewayConnectPeerAssociation (p. 17) The transit gateway Connect peer association.

Type: TransitGatewayConnectPeerAssociation (p. 325) object

Errors

(34)

See Also

CreateConnectAttachment

Creates a core network Connect attachment from a speciﬁed core network attachment.

A core network Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a core network and an appliance. A core network Connect attachment uses an existing VPC attachment as the underlying transport mechanism.

Request Syntax

POST /connect-attachments HTTP/1.1 Content-type: application/json { "ClientToken": "string", "CoreNetworkId": "string", "EdgeLocation": "string", "Options": {

"Protocol": "string"

},

"Tags": [ {

} ],

"TransportAttachmentId": "string"

}

URI Request Parameters

The request does not use any URI parameters.

Request Body

ClientToken (p. 19)

The client token associated with the request.

Type: String

Pattern: [\s\S]*

Required: No CoreNetworkId (p. 19)

The ID of a core network where you want to create the attachment.

Type: String

Pattern: ^core-network-([0-9a-f]{8,17})$

(36)

Response Syntax

Required: Yes EdgeLocation (p. 19)

The Region where the edge is located.

Type: String

Pattern: [\s\S]*

Required: Yes Options (p. 19)

Options for creating an attachment.

Type: ConnectAttachmentOptions (p. 255) object Required: Yes

Tags (p. 19)

The list of key-value tags associated with the request.

Type: Array of Tag (p. 324) objects Required: No

TransportAttachmentId (p. 19)

The ID of the attachment between the two connections.

Type: String

Required: Yes

Response Syntax

HTTP/1.1 200

Content-type: application/json { "ConnectAttachment": { "Attachment": {

"AttachmentId": "string",

"AttachmentPolicyRuleNumber": number, "AttachmentType": "string",

"CoreNetworkArn": "string", "CoreNetworkId": "string", "CreatedAt": number, "EdgeLocation": "string", "OwnerAccountId": "string", "ProposedSegmentChange": {

"AttachmentPolicyRuleNumber": number, "SegmentName": "string",

"Tags": [ {

"Key": "string",

(37)

Response Elements

"Value": "string"

} ] },

"ResourceArn": "string", "SegmentName": "string", "State": "string", "Tags": [

{

} ],

"UpdatedAt": number },

"Options": {

},

"TransportAttachmentId": "string"

}}

Response Elements

ConnectAttachment (p. 20)

The response to a Connect attachment request.

Type: ConnectAttachment (p. 254) object

Errors

(38)

See Also

ThrottlingException

CreateConnection

Creates 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 appliance that connects to another physical appliance in an on-premises network.

Request Syntax

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

{ "ConnectedDeviceId": "string", "ConnectedLinkId": "string", "Description": "string", "DeviceId": "string", "LinkId": "string", "Tags": [

{

} ]}

URI Request Parameters

Pattern: [\s\S]*

Required: Yes

Request Body

ConnectedDeviceId (p. 23)

The ID of the second device in the connection.

Type: String

Pattern: [\s\S]*

Required: Yes ConnectedLinkId (p. 23)

The ID of the link for the second device.

(40)

Response Syntax

Type: String

Pattern: [\s\S]*

Required: No Description (p. 23)

A description of the connection.

Length Constraints: Maximum length of 256 characters.

Type: String

Pattern: [\s\S]*

Required: No DeviceId (p. 23)

The ID of the ﬁrst device in the connection.

Type: String

Pattern: [\s\S]*

The ID of the link for the ﬁrst device.

Type: String

Pattern: [\s\S]*

Required: No Tags (p. 23)

The tags to apply to the resource during creation.

Response Syntax

HTTP/1.1 200

Content-type: application/json {

"Connection": {

"ConnectedDeviceId": "string",

(41)

Response Elements

"ConnectedLinkId": "string", "ConnectionArn": "string", "ConnectionId": "string", "CreatedAt": number, "Description": "string", "DeviceId": "string", "GlobalNetworkId": "string", "LinkId": "string",

{

} ] } }

Response Elements

Connection (p. 24)

Information about the connection.

Type: Connection (p. 256) object

Errors

(42)

See Also

CreateConnectPeer

Creates a core network Connect peer for a speciﬁed core network connect attachment between a core network and an appliance. The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

Request Syntax

POST /connect-peers HTTP/1.1 Content-type: application/json { "BgpOptions": {

"PeerAsn": number },

"ClientToken": "string",

"ConnectAttachmentId": "string", "CoreNetworkAddress": "string", "InsideCidrBlocks": [ "string" ], "PeerAddress": "string",

"Tags": [ {

} ] }

URI Request Parameters

Request Body

BgpOptions (p. 27)

The Connect peer BGP options.

Type: BgpOptions (p. 253) object Required: No

The client token associated with the request.

Type: String

Pattern: [\s\S]*

Required: No

ConnectAttachmentId (p. 27)

The ID of the connection attachment.

(44)

Response Syntax

Type: String

Required: Yes

CoreNetworkAddress (p. 27)

A Connect peer core network address.

Type: String

Pattern: [\s\S]*

Required: No InsideCidrBlocks (p. 27)

The inside IP addresses used for BGP peering.

Type: Array of strings

Pattern: [\s\S]*

Required: Yes PeerAddress (p. 27)

The Connect peer address.

Type: String

Pattern: [\s\S]*

Required: Yes Tags (p. 27)

The tags associated with the peer request.

Response Syntax

HTTP/1.1 200

Content-type: application/json { "ConnectPeer": {

"Configuration": { "BgpConfigurations": [ {

"CoreNetworkAddress": "string", "CoreNetworkAsn": number,

(45)

Response Elements

"PeerAddress": "string", "PeerAsn": number }

],

"CoreNetworkAddress": "string", "InsideCidrBlocks": [ "string" ], "PeerAddress": "string",

},

"ConnectAttachmentId": "string", "ConnectPeerId": "string", "CoreNetworkId": "string", "CreatedAt": number, "EdgeLocation": "string", "State": "string",

"Tags": [ {

} ] }}

Response Elements

ConnectPeer (p. 28)

The response to the request.

Type: ConnectPeer (p. 260) object

Errors

(46)

See Also

CreateCoreNetwork

Creates a core network as part of your global network, and optionally, with a core network policy.

Request Syntax

POST /core-networks HTTP/1.1 Content-type: application/json { "ClientToken": "string", "Description": "string", "GlobalNetworkId": "string", "PolicyDocument": "string", "Tags": [

{

} ]}

URI Request Parameters

Request Body

The client token associated with a core network request.

Type: String

Pattern: [\s\S]*

The description of a core network.

Type: String

Pattern: [\s\S]*

Required: No GlobalNetworkId (p. 31)

The ID of the global network that a core network will be a part of.

(48)

Response Syntax

Type: String

Pattern: [\s\S]*

Required: Yes PolicyDocument (p. 31)

The policy document for creating a core network.

Type: String

Pattern: [\s\S]*

Key-value tags associated with a core network request.

Response Syntax

HTTP/1.1 200

Content-type: application/json { "CoreNetwork": {

"CoreNetworkArn": "string", "CoreNetworkId": "string", "CreatedAt": number, "Description": "string", "Edges": [

{

"Asn": number,

"EdgeLocation": "string", "InsideCidrBlocks": [ "string" ] }

],

"GlobalNetworkId": "string", "Segments": [

{

"EdgeLocations": [ "string" ], "Name": "string",

"SharedSegments": [ "string" ] }

],

{

} ] }}

(49)

Response Elements

CoreNetwork (p. 32)

Returns details about a core network.

Type: CoreNetwork (p. 269) object

Errors

HTTP Status Code: 409 CoreNetworkPolicyException

Describes a core network policy exception.

CreateDevice

Creates 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 Manager console.

Request Syntax

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

{ "AWSLocation": {

"SubnetArn": "string", "Zone": "string"

},

"Description": "string", "Location": {

"Address": "string", "Latitude": "string", "Longitude": "string"

},

"Model": "string", "SerialNumber": "string", "SiteId": "string", "Tags": [

{

} ],

"Type": "string", "Vendor": "string"

}

URI Request Parameters

Pattern: [\s\S]*

Required: Yes

Request Body

AWSLocation (p. 35)

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

Type: AWSLocation (p. 251) object

(52)

Request Body

A description of the device.

Constraints: Maximum length of 256 characters.

Type: String

Pattern: [\s\S]*

Required: No Location (p. 35)

The location of the device.

Type: Location (p. 297) object Required: No

Model (p. 35)

The model of the device.

Type: String

Pattern: [\s\S]*

Required: No SerialNumber (p. 35)

The serial number of the device.

Type: String

Pattern: [\s\S]*

Required: No SiteId (p. 35)

The ID of the site.

Type: String

Pattern: [\s\S]*

The tags to apply to the resource during creation.

(53)

Response Syntax

Type (p. 35)

The type of the device.

Type: String

Pattern: [\s\S]*

Required: No Vendor (p. 35)

The vendor of the device.

Type: String

Pattern: [\s\S]*

Required: No

Response Syntax

HTTP/1.1 200

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": [

{

} ],

"Type": "string",

(54)

Response Elements

"Vendor": "string"

}}

Response Elements

Device (p. 37)

Information about the device.

Type: Device (p. 287) object

Errors

(55)

See Also

AWS Network Manager

AWS Network Manager

API Reference

API Version 2019-07-05

AWS Network Manager: API Reference

Table of Contents

Welcome

Actions

AcceptAttachment

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

AssociateConnectPeer

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

AssociateCustomerGateway

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

AssociateLink

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

AssociateTransitGatewayConnectPeer

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

CreateConnectAttachment

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

CreateConnection

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

CreateConnectPeer

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

CreateCoreNetwork

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also