Skip to content

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

Description

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.

Usage

networkmanager_get_links(GlobalNetworkId, LinkIds, SiteId, Type,
  Provider, MaxResults, NextToken)

Arguments

  • GlobalNetworkId

    [required] The ID of the global network.

  • LinkIds

    One or more link IDs. The maximum is 10.

  • SiteId

    The ID of the site.

  • Type

    The link type.

  • Provider

    The link provider.

  • MaxResults

    The maximum number of results to return.

  • NextToken

    The token for the next page of results.

Value

A list with the following syntax:

list(
  Links = list(
    list(
      LinkId = "string",
      LinkArn = "string",
      GlobalNetworkId = "string",
      SiteId = "string",
      Description = "string",
      Type = "string",
      Bandwidth = list(
        UploadSpeed = 123,
        DownloadSpeed = 123
      ),
      Provider = "string",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      State = "PENDING"|"AVAILABLE"|"DELETING"|"UPDATING",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$get_links(
  GlobalNetworkId = "string",
  LinkIds = list(
    "string"
  ),
  SiteId = "string",
  Type = "string",
  Provider = "string",
  MaxResults = 123,
  NextToken = "string"
)