Skip to content

EC2  >  Operations  >  describe_route_servers

describe_route_servers

Operation

describe_route_servers async

describe_route_servers(request: DescribeRouteServersInput | DescribeRouteServersInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeRouteServersOutput
describe_route_servers(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeRouteServersInputDict]) -> DescribeRouteServersOutput

Describes one or more route servers.

Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.

Route server supports the follow route table types:

  • VPC route tables not associated with subnets

  • Subnet route tables

  • Internet gateway route tables

Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.

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
DescribeRouteServersOutput

An instance of DescribeRouteServersOutput.

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

DescribeRouteServersInput dataclass

Bases: _SerdeShape

Dataclass for DescribeRouteServersInput 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_ids class-attribute instance-attribute
route_server_ids: list[str] | None = ...

The IDs of the route servers to describe.

Dictionaries

DescribeRouteServersInputDict

Bases: TypedDict

Dictionary form of DescribeRouteServersInput.

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_ids instance-attribute
route_server_ids: Sequence[str] | None

The IDs of the route servers to describe.

Output

DescribeRouteServersOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeRouteServersOutput 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_servers class-attribute instance-attribute
route_servers: list[RouteServer] | None = ...

Information about the described route servers.