Get Network Resources

networkmanager_get_network_resources

R Documentation

Describes the network resources for the specified global network

Description

Describes the network resources for the specified global network.

The results include information from the corresponding Describe call for the resource, minus any sensitive information such as pre-shared keys.

Usage

networkmanager_get_network_resources(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 for Direct Connect:

• dxcon - The definition model is Connection.

• dx-gateway - The definition model is DirectConnectGateway.

• dx-vif - The definition model is VirtualInterface.

The following are the supported resource types for Network Manager:

• connection - The definition model is Connection.

• device - The definition model is Device.

• link - The definition model is Link.

• site - The definition model is Site.

The following are the supported resource types for Amazon VPC:

• customer-gateway - The definition model is CustomerGateway.

• transit-gateway - The definition model is TransitGateway.

• transit-gateway-attachment - The definition model is TransitGatewayAttachment.

• transit-gateway-connect-peer - The definition model is TransitGatewayConnectPeer.

• transit-gateway-route-table - The definition model is TransitGatewayRouteTable.

• vpn-connection - The definition model is VpnConnection.

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(
  NetworkResources = list(
    list(
      RegisteredGatewayArn = "string",
      CoreNetworkId = "string",
      AwsRegion = "string",
      AccountId = "string",
      ResourceType = "string",
      ResourceId = "string",
      ResourceArn = "string",
      Definition = "string",
      DefinitionTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      Metadata = list(
        "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

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