Skip to content

Gets information about one or more of your connections in a global network

Description

Gets information about one or more of your connections in a global network.

Usage

networkmanager_get_connections(GlobalNetworkId, ConnectionIds, DeviceId,
  MaxResults, NextToken)

Arguments

  • GlobalNetworkId

    [required] The ID of the global network.

  • ConnectionIds

    One or more connection IDs.

  • DeviceId

    The ID of the device.

  • 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(
  Connections = list(
    list(
      ConnectionId = "string",
      ConnectionArn = "string",
      GlobalNetworkId = "string",
      DeviceId = "string",
      ConnectedDeviceId = "string",
      LinkId = "string",
      ConnectedLinkId = "string",
      Description = "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_connections(
  GlobalNetworkId = "string",
  ConnectionIds = list(
    "string"
  ),
  DeviceId = "string",
  MaxResults = 123,
  NextToken = "string"
)