GetLinks - AWS Network Manager

GetLinks

Gets information about one or more links in a specified global network.

If you specify the site ID, you cannot specify the type or provider in the same request. You can specify the type and provider in the same request.

GET /global-networks/globalNetworkId/links?linkIds=LinkIds&maxResults=MaxResults&nextToken=NextToken&provider=Provider&siteId=SiteId&type=Type HTTP/1.1

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

LinkIds

One or more link IDs. The maximum is 10.

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

Pattern: [\s\S]*

MaxResults

The maximum number of results to return.

Valid Range: Minimum value of 1. Maximum value of 500.

NextToken

The token for the next page of results.

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

Pattern: [\s\S]*

Provider

The link provider.

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

Pattern: [\s\S]*

SiteId

The ID of the site.

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

Pattern: [\s\S]*

Type

The link type.

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

Pattern: [\s\S]*

The request does not have a request body.

HTTP/1.1 200 Content-type: application/json { "Links": [ { "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" } ], "NextToken": "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.

Links

The links.

Type: Array of Link objects

NextToken

The token for the next page of results.

Type: String

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

Pattern: [\s\S]*

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

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

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: