Skip to content

Describe Transit Gateway Connect Peers

ec2_describe_transit_gateway_connect_peers R Documentation

Describes one or more Connect peers

Description

Describes one or more Connect peers.

Usage

ec2_describe_transit_gateway_connect_peers(TransitGatewayConnectPeerIds,
  Filters, MaxResults, NextToken, DryRun)

Arguments

TransitGatewayConnectPeerIds

The IDs of the Connect peers.

Filters

One or more filters. The possible values are:

  • state - The state of the Connect peer (pending | available | deleting | deleted).

  • transit-gateway-attachment-id - The ID of the attachment.

  • transit-gateway-connect-peer-id - The ID of the Connect peer.

MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

NextToken

The token for the next page of results.

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Value

A list with the following syntax: 

list(
  TransitGatewayConnectPeers = list(
    list(
      TransitGatewayAttachmentId = "string",
      TransitGatewayConnectPeerId = "string",
      State = "pending"|"available"|"deleting"|"deleted",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      ConnectPeerConfiguration = list(
        TransitGatewayAddress = "string",
        PeerAddress = "string",
        InsideCidrBlocks = list(
          "string"
        ),
        Protocol = "gre",
        BgpConfigurations = list(
          list(
            TransitGatewayAsn = 123,
            PeerAsn = 123,
            TransitGatewayAddress = "string",
            PeerAddress = "string",
            BgpStatus = "up"|"down"
          )
        )
      ),
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_transit_gateway_connect_peers(
  TransitGatewayConnectPeerIds = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string",
  DryRun = TRUE|FALSE
)