get_ipam_discovered_routes ¶

def get_ipam_discovered_routes(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    ipam_resource_discovery_id: Optional[
        "capo_ec2.types.ipam_resource_discovery_id.IpamResourceDiscoveryId"
    ] = None,
    resource_region: Optional["capo_ec2.types.string.String"] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    next_token: Optional["capo_ec2.types.next_token.NextToken"] = None,
    max_results: Optional["capo_ec2.types.ipam_max_results.IpamMaxResults"] = None,
) -> (
    "capo_ec2.types.get_ipam_discovered_routes_result.GetIpamDiscoveredRoutesResult"
):
    """<p>Retrieves Border Gateway Protocol (BGP) routes discovered by IPAM resource discovery for a specified Region. Use this operation to view the Bring Your Own IP (BYOIP) address ranges that are currently advertised through BGP. We recommend using pagination to ensure that the operation returns quickly and successfully.</p>

    Args:
        dry_run: <p>Checks whether you have the required permissions for the operation, 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>
        ipam_resource_discovery_id: <p>The ID of the IPAM resource discovery.</p>
        resource_region: <p>The Amazon Web Services Region to retrieve discovered routes for.</p>
        filters: <p>One or more filters to apply to the results.</p>
        next_token: <p>The token for the next page of results.</p>
        max_results: <p>The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>

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

    def _handler(
        req: "OperationRequest[capo_ec2.types.get_ipam_discovered_routes_request.GetIpamDiscoveredRoutesRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.get_ipam_discovered_routes_result.GetIpamDiscoveredRoutesResult"
    ]:
        import capo_ec2._operations.amazon_ec2.get_ipam_discovered_routes

        output, http_response = (
            capo_ec2._operations.amazon_ec2.get_ipam_discovered_routes.get_ipam_discovered_routes(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetIpamDiscoveredRoutes")
    )
    input_: capo_ec2.types.get_ipam_discovered_routes_request.GetIpamDiscoveredRoutesRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if ipam_resource_discovery_id is not None:
        input_["ipam_resource_discovery_id"] = ipam_resource_discovery_id
    if resource_region is not None:
        input_["resource_region"] = resource_region
    if filters is not None:
        input_["filters"] = filters
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output