Skip to content

get_ipam_route_protection_findings

get_ipam_route_protection_findings(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    ipam_id: Optional[IpamId] = None,
    filters: Optional[FilterList] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[IpamMaxResults] = None,
) -> GetIpamRouteProtectionFindingsResult

Retrieves route protection findings for an IPAM. Route protection findings show the Resource Public Key Infrastructure (RPKI) validation status of your Bring Your Own IP (BYOIP) routes. Findings identify routes that have valid, invalid, or unknown validation states. We recommend using pagination to ensure that the operation returns quickly and successfully.

Parameters:

  • dry_run (Optional[Boolean], default: None ) –

    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 DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • ipam_id (Optional[IpamId], default: None ) –

    The ID of the IPAM to retrieve route protection findings for.

  • filters (Optional[FilterList], default: None ) –

    One or more filters to apply to the results.

  • next_token (Optional[NextToken], default: None ) –

    The token for the next page of results.

  • max_results (Optional[IpamMaxResults], default: None ) –

    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 nextToken value.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def get_ipam_route_protection_findings(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    ipam_id: Optional["capo_ec2.types.ipam_id.IpamId"] = 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_route_protection_findings_result.GetIpamRouteProtectionFindingsResult":
    """<p>Retrieves route protection findings for an IPAM. Route protection findings show the Resource Public Key Infrastructure (RPKI) validation status of your Bring Your Own IP (BYOIP) routes. Findings identify routes that have valid, invalid, or unknown validation states. 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_id: <p>The ID of the IPAM to retrieve route protection findings 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_route_protection_findings_request.GetIpamRouteProtectionFindingsRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.get_ipam_route_protection_findings_result.GetIpamRouteProtectionFindingsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.get_ipam_route_protection_findings

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetIpamRouteProtectionFindings")
    )
    input_: capo_ec2.types.get_ipam_route_protection_findings_request.GetIpamRouteProtectionFindingsRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if ipam_id is not None:
        input_["ipam_id"] = ipam_id
    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