Required: Yes LinkId (p. 7)
The ID of the link.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 50.
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
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
ConnectPeerAssociation (p. 8)
The response to the Connect peer request.
Type: ConnectPeerAssociation (p. 262) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 334).
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 403 ConflictException
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
HTTP Status Code: 409
See Also
InternalServerException
The request has failed due to an internal error.
HTTP Status Code: 500 ResourceNotFoundException
The specified resource could not be found.
HTTP Status Code: 404 ServiceQuotaExceededException
A service limit was exceeded.
HTTP Status Code: 402 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
See Also
For 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
AssociateCustomerGateway
AssociateCustomerGateway
Associates 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 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 filter 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 request uses the following URI parameters.
globalNetworkId (p. 10)
The ID of the global network.
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern: [\s\S]*
Required: Yes
Request Body
The request accepts the following data in JSON format.
CustomerGatewayArn (p. 10)
The Amazon Resource Name (ARN) of the customer gateway.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
Pattern: [\s\S]*
Required: Yes DeviceId (p. 10)
The ID of the device.
Response Syntax
Type: String
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern: [\s\S]*
Required: Yes LinkId (p. 10)
The ID of the link.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 50.
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
If 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. 11)
The customer gateway association.
Type: CustomerGatewayAssociation (p. 285) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 334).
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 403
See Also
ConflictException
There was a conflict 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 specified resource could not be found.
HTTP Status Code: 404 ServiceQuotaExceededException
A service limit was exceeded.
HTTP Status Code: 402 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
See Also
For 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
AssociateLink
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
The request uses the following URI parameters.
globalNetworkId (p. 13)
The ID of the global network.
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern: [\s\S]*
Required: Yes
Request Body
The request accepts the following data in JSON format.
DeviceId (p. 13)
The ID of the device.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern: [\s\S]*
Required: Yes LinkId (p. 13)
The ID of the link.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern: [\s\S]*
Required: Yes
Response Syntax
Response Syntax
HTTP/1.1 200
Content-type: application/json { "LinkAssociation": { "DeviceId": "string", "GlobalNetworkId": "string", "LinkAssociationState": "string", "LinkId": "string"
} }
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.
LinkAssociation (p. 14) The link association.
Type: LinkAssociation (p. 295) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 334).
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 403 ConflictException
There was a conflict 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 specified resource could not be found.
HTTP Status Code: 404 ServiceQuotaExceededException
A service limit was exceeded.
HTTP Status Code: 402
See Also
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
See Also
For 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
AssociateTransitGatewayConnectPeer
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 specified 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
The request uses the following URI parameters.
globalNetworkId (p. 16)
The ID of the global network.
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern: [\s\S]*
Required: Yes
Request Body
The request accepts the following data in JSON format.
DeviceId (p. 16)
The ID of the device.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern: [\s\S]*
Required: Yes LinkId (p. 16)
The ID of the link.
Type: String
Response Syntax
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern: [\s\S]*
Required: No
TransitGatewayConnectPeerArn (p. 16)
The Amazon Resource Name (ARN) of the Connect peer.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
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
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
TransitGatewayConnectPeerAssociation (p. 17) The transit gateway Connect peer association.
Type: TransitGatewayConnectPeerAssociation (p. 325) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 334).
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 403 ConflictException
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
See Also
HTTP Status Code: 409 InternalServerException
The request has failed due to an internal error.
HTTP Status Code: 500 ResourceNotFoundException
The specified resource could not be found.
HTTP Status Code: 404 ServiceQuotaExceededException
A service limit was exceeded.
HTTP Status Code: 402 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
See Also
For 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
CreateConnectAttachment
CreateConnectAttachment
Creates a core network Connect attachment from a specified 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": {
"TransportAttachmentId": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
ClientToken (p. 19)
The client token associated with the request.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern: [\s\S]*
Required: No CoreNetworkId (p. 19)
The ID of a core network where you want to create the attachment.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern: ^core-network-([0-9a-f]{8,17})$
Response Syntax
Required: Yes EdgeLocation (p. 19)
The Region where the edge is located.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
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
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern: ^attachment-([0-9a-f]{8,17})$
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json { "ConnectAttachment": { "Attachment": {
"AttachmentId": "string",
"AttachmentPolicyRuleNumber": number, "AttachmentType": "string",
Response Elements
"TransportAttachmentId": "string"
}}
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.
ConnectAttachment (p. 20)
The response to a Connect attachment request.
Type: ConnectAttachment (p. 254) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 334).
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 403 ConflictException
There was a conflict 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 specified resource could not be found.
HTTP Status Code: 404
See Also
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
See Also
For 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
CreateConnection
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": [
{
"Key": "string", "Value": "string"
} ]}
URI Request Parameters
The request uses the following URI parameters.
globalNetworkId (p. 23)
The ID of the global network.
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern: [\s\S]*
Required: Yes
Request Body
The request accepts the following data in JSON format.
ConnectedDeviceId (p. 23)
The ID of the second device in the connection.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern: [\s\S]*
Required: Yes ConnectedLinkId (p. 23)
The ID of the link for the second device.
Response Syntax
Type: String
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern: [\s\S]*
Required: No Description (p. 23)
A description of the connection.
Length Constraints: Maximum length of 256 characters.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern: [\s\S]*
Required: No DeviceId (p. 23)
The ID of the first device in the connection.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern: [\s\S]*
Required: Yes LinkId (p. 23)
The ID of the link for the first device.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern: [\s\S]*
Required: No Tags (p. 23)
The tags to apply to the resource during creation.
Type: Array of Tag (p. 324) objects Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"Connection": {
"ConnectedDeviceId": "string",
Response Elements
"ConnectedLinkId": "string", "ConnectionArn": "string", "ConnectionId": "string", "CreatedAt": number, "Description": "string", "DeviceId": "string", "GlobalNetworkId": "string", "LinkId": "string",
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Connection (p. 24)
Information about the connection.
Type: Connection (p. 256) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 334).
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 403 ConflictException
There was a conflict 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 ServiceQuotaExceededException
A service limit was exceeded.
HTTP Status Code: 402 ThrottlingException
The request was denied due to request throttling.
See Also
HTTP Status Code: 429 ValidationException
The input fails to satisfy the constraints.
HTTP Status Code: 400
See Also
For 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
CreateConnectPeer
CreateConnectPeer
Creates a core network Connect peer for a specified 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
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
BgpOptions (p. 27)
The Connect peer BGP options.
Type: BgpOptions (p. 253) object Required: No
ClientToken (p. 27)
The client token associated with the request.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern: [\s\S]*
Required: No
ConnectAttachmentId (p. 27)
The ID of the connection attachment.
Response Syntax
Type: String
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern: ^attachment-([0-9a-f]{8,17})$
Required: Yes
CoreNetworkAddress (p. 27)
A Connect peer core network address.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern: [\s\S]*
Required: No InsideCidrBlocks (p. 27)
The inside IP addresses used for BGP peering.
Type: Array of strings
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern: [\s\S]*
Required: Yes PeerAddress (p. 27)
The Connect peer address.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern: [\s\S]*
Required: Yes Tags (p. 27)
The tags associated with the peer request.
Type: Array of Tag (p. 324) objects Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json { "ConnectPeer": {
"Configuration": { "BgpConfigurations": [ {
"CoreNetworkAddress": "string", "CoreNetworkAsn": number,
Response Elements
"ConnectAttachmentId": "string", "ConnectPeerId": "string", "CoreNetworkId": "string", "CreatedAt": number, "EdgeLocation": "string", "State": "string",
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
ConnectPeer (p. 28)
The response to the request.
Type: ConnectPeer (p. 260) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 334).
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 403 ConflictException
There was a conflict 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 specified resource could not be found.
See Also
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
See Also
For 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
CreateCoreNetwork
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": [
{
"Key": "string", "Value": "string"
} ]}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
ClientToken (p. 31)
The client token associated with a core network request.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern: [\s\S]*
Required: No Description (p. 31)
The description of a core network.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern: [\s\S]*
Required: No GlobalNetworkId (p. 31)
The ID of the global network that a core network will be a part of.
Response Syntax
Type: String
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern: [\s\S]*
Required: Yes PolicyDocument (p. 31)
The policy document for creating a core network.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10000000.
Pattern: [\s\S]*
Required: No Tags (p. 31)
Key-value tags associated with a core network request.
Type: Array of Tag (p. 324) objects Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json { "CoreNetwork": {
"CoreNetworkArn": "string", "CoreNetworkId": "string", "CreatedAt": number, "Description": "string", "Edges": [
"GlobalNetworkId": "string", "Segments": [
Response Elements
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.
CoreNetwork (p. 32)
Returns details about a core network.
Type: CoreNetwork (p. 269) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 334).
AccessDeniedException
You do not have sufficient access to perform this action.
HTTP Status Code: 403 ConflictException
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
HTTP Status Code: 409 CoreNetworkPolicyException
Describes a core network policy exception.
HTTP Status Code: 400 InternalServerException
The request has failed due to an internal error.
HTTP Status Code: 500 ServiceQuotaExceededException
A service limit was exceeded.
HTTP Status Code: 402 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
See Also
• 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 PHP V3