describe_route_server_endpoints¶
Operation¶
describe_route_server_endpoints
async
¶
describe_route_server_endpoints(request: DescribeRouteServerEndpointsInput | DescribeRouteServerEndpointsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeRouteServerEndpointsOutput
describe_route_server_endpoints(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeRouteServerEndpointsInputDict]) -> DescribeRouteServerEndpointsOutput
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.
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 |
|---|---|
DescribeRouteServerEndpointsOutput
|
An instance of |
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¶
DescribeRouteServerEndpointsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeRouteServerEndpointsInput 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
¶
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.
Dictionaries¶
DescribeRouteServerEndpointsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeRouteServerEndpointsInput.
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.
Output¶
DescribeRouteServerEndpointsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeRouteServerEndpointsOutput 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
¶
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_endpoints
class-attribute
instance-attribute
¶
route_server_endpoints: list[RouteServerEndpoint] | None = ...
Information about the described route server endpoints.