CreateConnection
Initiates the process to create a Connection across the specified Environment.
The Environment dictates the specified partner and location to which the other end of the connection should attach. You can see a list of the available Environments by calling ListEnvironments
The AttachPoint specifies where within the AWS Network your connection will logically connect.
After a successful call to this method, the resulting Connection will return an Activation Key which will need to be brought to the specific partner's portal to confirm the Connection on both sides. (See Environment:activationPageUrl for a direct link to the partner portal).
Request Parameters
- attachPoint
-
The AttachPoint to which the connection should be associated."
Type: AttachPoint object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
- bandwidth
-
The desired bandwidth of the requested Connection
Type: String
Length Constraints: Minimum length of 1. Maximum length of 8.
Pattern:
\d+[MG]bpsRequired: Yes
- clientToken
-
Idempotency token used for the request.
Type: String
Required: No
- description
-
A description to distinguish this Connection.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[-a-zA-Z0-9_ ]+Required: No
- environmentId
-
The identifier of the Environment across which this Connection should be created.
The available Environment objects can be determined using ListEnvironments.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: Yes
- remoteAccount
-
Account and/or principal identifying information that can be verified by the partner of this specific Environment.
Type: RemoteAccountIdentifier object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- tags
-
The tag to associate with the resulting Connection.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
Response Elements
The following element is returned by the service.
- connection
-
The resulting Connection.
Type: Connection object
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
The calling principal is not allowed to access the specified resource, or the resource does not exist.
HTTP Status Code: 403
- InterconnectClientException
-
The request was denied due to incorrect client supplied parameters.
HTTP Status Code: 400
- InterconnectServerException
-
The request resulted in an exception internal to the service.
HTTP Status Code: 500
- InterconnectValidationException
-
The input fails to satisfy the constraints specified.
HTTP Status Code: 400
- ResourceNotFoundException
-
The request specifies a resource that does not exist on the server.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
The requested operation would result in the calling principal exceeding their allotted quota.
HTTP Status Code: 402
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
