Skip to content

Describe Route Server Endpoints

ec2_describe_route_server_endpoints R Documentation

Describes one or more route server endpoints

Description

Describes one or more route server endpoints.

A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers.

For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

Usage

ec2_describe_route_server_endpoints(RouteServerEndpointIds, NextToken,
  MaxResults, Filters, DryRun)

Arguments

RouteServerEndpointIds

The IDs of the route server endpoints to describe.

NextToken

The token for the next page of results.

MaxResults

The maximum number of results to return with a single call.

Filters

One or more filters to apply to the describe request.

DryRun

A check for 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(
  RouteServerEndpoints = list(
    list(
      RouteServerId = "string",
      RouteServerEndpointId = "string",
      VpcId = "string",
      SubnetId = "string",
      EniId = "string",
      EniAddress = "string",
      State = "pending"|"available"|"deleting"|"deleted"|"failing"|"failed"|"delete-failed",
      FailureReason = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

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