Get Network Telemetry

networkmanager_get_network_telemetry

R Documentation

Gets the network telemetry of the specified global network

Description

Gets the network telemetry of the specified global network.

Usage

networkmanager_get_network_telemetry(GlobalNetworkId, CoreNetworkId,
  RegisteredGatewayArn, AwsRegion, AccountId, ResourceType, ResourceArn,
  MaxResults, NextToken)

Arguments

GlobalNetworkId	[required] The ID of the global network.
CoreNetworkId	The ID of a core network.
RegisteredGatewayArn	The ARN of the gateway.
AwsRegion	The Amazon Web Services Region.
AccountId	The Amazon Web Services account ID.
ResourceType	The resource type. The following are the supported resource types: connect-peer transit-gateway-connect-peer vpn-connection
ResourceArn	The ARN of the resource.
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(
  NetworkTelemetry = list(
    list(
      RegisteredGatewayArn = "string",
      CoreNetworkId = "string",
      AwsRegion = "string",
      AccountId = "string",
      ResourceType = "string",
      ResourceId = "string",
      ResourceArn = "string",
      Address = "string",
      Health = list(
        Type = "BGP"|"IPSEC",
        Status = "UP"|"DOWN",
        Timestamp = as.POSIXct(
          "2015-01-01"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$get_network_telemetry(
  GlobalNetworkId = "string",
  CoreNetworkId = "string",
  RegisteredGatewayArn = "string",
  AwsRegion = "string",
  AccountId = "string",
  ResourceType = "string",
  ResourceArn = "string",
  MaxResults = 123,
  NextToken = "string"
)