Skip to content

List Peerings

networkmanager_list_peerings R Documentation

Lists the peerings for a core network

Description

Lists the peerings for a core network.

Usage

networkmanager_list_peerings(CoreNetworkId, PeeringType, EdgeLocation,
  State, MaxResults, NextToken)

Arguments

CoreNetworkId

The ID of a core network.

PeeringType

Returns a list of a peering requests.

EdgeLocation

Returns a list edge locations for the

State

Returns a list of the peering request states.

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(
  Peerings = list(
    list(
      CoreNetworkId = "string",
      CoreNetworkArn = "string",
      PeeringId = "string",
      OwnerAccountId = "string",
      PeeringType = "TRANSIT_GATEWAY",
      State = "CREATING"|"FAILED"|"AVAILABLE"|"DELETING",
      EdgeLocation = "string",
      ResourceArn = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      LastModificationErrors = list(
        list(
          Code = "TRANSIT_GATEWAY_NOT_FOUND"|"TRANSIT_GATEWAY_PEERS_LIMIT_EXCEEDED"|"MISSING_PERMISSIONS"|"INTERNAL_ERROR"|"EDGE_LOCATION_PEER_DUPLICATE"|"INVALID_TRANSIT_GATEWAY_STATE",
          Message = "string",
          ResourceArn = "string",
          RequestId = "string",
          MissingPermissionsContext = list(
            MissingPermission = "string"
          )
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_peerings(
  CoreNetworkId = "string",
  PeeringType = "TRANSIT_GATEWAY",
  EdgeLocation = "string",
  State = "CREATING"|"FAILED"|"AVAILABLE"|"DELETING",
  MaxResults = 123,
  NextToken = "string"
)