Skip to content

EC2  >  Operations  >  describe_route_server_peers

describe_route_server_peers

Operation

describe_route_server_peers async

describe_route_server_peers(request: DescribeRouteServerPeersInput | DescribeRouteServerPeersInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeRouteServerPeersOutput
describe_route_server_peers(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeRouteServerPeersInputDict]) -> DescribeRouteServerPeersOutput

Describes one or more route server peers.

A route server peer is a session between a route server endpoint and the device deployed in Amazon Web Services (such as a firewall appliance or other network security function running on an EC2 instance). The device must meet these requirements:

  • Have an elastic network interface in the VPC

  • Support BGP (Border Gateway Protocol)

  • Can initiate BGP sessions

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

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeRouteServerPeersOutput

An instance of DescribeRouteServerPeersOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeRouteServerPeersInput dataclass

Bases: _SerdeShape

Dataclass for DescribeRouteServerPeersInput structure.

Attributes
dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

One or more filters to apply to the describe request.

max_results class-attribute instance-attribute
max_results: int | None = ...

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

next_token class-attribute instance-attribute
next_token: str | None = ...

The token for the next page of results.

route_server_peer_ids class-attribute instance-attribute
route_server_peer_ids: list[str] | None = ...

The IDs of the route server peers to describe.

Dictionaries

DescribeRouteServerPeersInputDict

Bases: TypedDict

Dictionary form of DescribeRouteServerPeersInput.

Attributes
dry_run instance-attribute
dry_run: bool | None

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.

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

One or more filters to apply to the describe request.

max_results instance-attribute
max_results: int | None

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

next_token instance-attribute
next_token: str | None

The token for the next page of results.

route_server_peer_ids instance-attribute
route_server_peer_ids: Sequence[str] | None

The IDs of the route server peers to describe.

Output

DescribeRouteServerPeersOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeRouteServerPeersOutput structure.

Attributes

next_token class-attribute instance-attribute
next_token: str | None = ...

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

route_server_peers class-attribute instance-attribute
route_server_peers: list[RouteServerPeer] | None = ...

Information about the described route server peers.