describe_route_server_peers `async` ¶

describe_route_server_peers(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    route_server_peer_ids: Optional[RouteServerPeerIdsList] = None,
    next_token: Optional[String] = None,
    max_results: Optional[RouteServerMaxResults] = None,
    filters: Optional[FilterList] = None,
    dry_run: Optional[Boolean] = None,
) -> DescribeRouteServerPeersResult

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:

route_server_peer_ids (Optional[RouteServerPeerIdsList], default: None ) –

The IDs of the route server peers to describe.
next_token (Optional[String], default: None ) –

The token for the next page of results.
max_results (Optional[RouteServerMaxResults], default: None ) –

The maximum number of results to return with a single call.
filters (Optional[FilterList], default: None ) –

One or more filters to apply to the describe request.
dry_run (Optional[Boolean], default: 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.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_ec2/_services/async_ec2.py

async def describe_route_server_peers(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    route_server_peer_ids: Optional[
        "capo_ec2.types.route_server_peer_ids_list.RouteServerPeerIdsList"
    ] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    max_results: Optional[
        "capo_ec2.types.route_server_max_results.RouteServerMaxResults"
    ] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.describe_route_server_peers_result.DescribeRouteServerPeersResult":
    """<p>Describes one or more route server peers.</p> <p>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:</p> <ul> <li> <p>Have an elastic network interface in the VPC</p> </li> <li> <p>Support BGP (Border Gateway Protocol)</p> </li> <li> <p>Can initiate BGP sessions</p> </li> </ul> <p>For more information see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html">Dynamic routing in your VPC with VPC Route Server</a> in the <i>Amazon VPC User Guide</i>.</p>

    Args:
        route_server_peer_ids: <p>The IDs of the route server peers to describe.</p>
        next_token: <p>The token for the next page of results.</p>
        max_results: <p>The maximum number of results to return with a single call.</p>
        filters: <p>One or more filters to apply to the describe request.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.describe_route_server_peers_request.DescribeRouteServerPeersRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.describe_route_server_peers_result.DescribeRouteServerPeersResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_route_server_peers

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.describe_route_server_peers.async_describe_route_server_peers(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeRouteServerPeers")
    )
    input_: capo_ec2.types.describe_route_server_peers_request.DescribeRouteServerPeersRequest = {}
    if route_server_peer_ids is not None:
        input_["route_server_peer_ids"] = route_server_peer_ids
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if filters is not None:
        input_["filters"] = filters
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_route_server_peers async ¶

describe_route_server_peers `async` ¶