CreateLink
Creates a new link for a specified site.
Request Syntax
POST /global-networks/globalNetworkId/links HTTP/1.1
Content-type: application/json
{
"Bandwidth": {
"DownloadSpeed": number,
"UploadSpeed": number
},
"Description": "string",
"Provider": "string",
"SiteId": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"Type": "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.
- Bandwidth
-
The upload speed and download speed in Mbps.
Type: Bandwidth object
Required: Yes
- Description
-
A description of the link.
Constraints: Maximum length of 256 characters.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
[\s\S]*Required: No
- Provider
-
The provider of the link.
Constraints: Maximum length of 128 characters. Cannot include the following characters: | \ ^
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
[\s\S]*Required: No
- SiteId
-
The ID of the site.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern:
[\s\S]*Required: Yes
- Tags
-
The tags to apply to the resource during creation.
Type: Array of Tag objects
Required: No
- Type
-
The type of the link.
Constraints: Maximum length of 128 characters. Cannot include the following characters: | \ ^
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
[\s\S]*Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Link": {
"Bandwidth": {
"DownloadSpeed": number,
"UploadSpeed": number
},
"CreatedAt": number,
"Description": "string",
"GlobalNetworkId": "string",
"LinkArn": "string",
"LinkId": "string",
"Provider": "string",
"SiteId": "string",
"State": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"Type": "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.
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.
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:
