UpdateLink - AWS Network Manager

UpdateLink

Updates the details for an existing link. To remove information for any of the parameters, specify an empty string.

PATCH /global-networks/globalNetworkId/links/linkId HTTP/1.1 Content-type: application/json { "Bandwidth": { "DownloadSpeed": number, "UploadSpeed": number }, "Description": "string", "Provider": "string", "Type": "string" }

The request uses the following URI parameters.

globalNetworkId

The ID of the global network.

Required: Yes

linkId

The ID of the link.

Required: Yes

The request accepts the following data in JSON format.

Bandwidth

The upload and download speed in Mbps.

Type: Bandwidth object

Required: No

Description

A description of the link.

Length Constraints: Maximum length of 256 characters.

Type: String

Required: No

Provider

The provider of the link.

Length Constraints: Maximum length of 128 characters.

Type: String

Required: No

Type

The type of the link.

Length Constraints: Maximum length of 128 characters.

Type: String

Required: No

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

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

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

Link

Information about the link.

Type: Link object

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

For more information about using this API in one of the language-specific AWS SDKs, see the following: