Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

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

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

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

The ID of the link for the second device.

Type: String

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

Pattern: [\s\S]*

Required: No

Description

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

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

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

The tags to apply to the resource during creation.

Type: Array of Tag objects

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "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"
         }
      ]
   }
}

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.

Connection

Information about the connection.

Type: Connection object

Errors

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

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.

ResourceId: The ID of the resource.
ResourceType: The resource type.

HTTP Status Code: 409

InternalServerException

The request has failed due to an internal error.

RetryAfterSeconds: Indicates when to retry the request.

HTTP Status Code: 500

ServiceQuotaExceededException

A service limit was exceeded.

LimitCode: The limit code.
Message: The error message.
ResourceId: The ID of the resource.
ResourceType: The resource type.
ServiceCode: The service code.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

RetryAfterSeconds: Indicates when to retry the request.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints.

Fields: The fields that caused the error, if applicable.
Reason: The reason for the error.

HTTP Status Code: 400