Skip to content

get_ipam_route_protection_findings

Operation

get_ipam_route_protection_findings

get_ipam_route_protection_findings(request: GetIpamRouteProtectionFindingsInput | GetIpamRouteProtectionFindingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIpamRouteProtectionFindingsInputDict]) -> GetIpamRouteProtectionFindingsOutput

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:

Name Type Description Default
request GetIpamRouteProtectionFindingsInput | GetIpamRouteProtectionFindingsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetIpamRouteProtectionFindingsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetIpamRouteProtectionFindingsOutput

An instance of GetIpamRouteProtectionFindingsOutput.

get_ipam_route_protection_findings async

get_ipam_route_protection_findings(request: GetIpamRouteProtectionFindingsInput | GetIpamRouteProtectionFindingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIpamRouteProtectionFindingsInputDict]) -> GetIpamRouteProtectionFindingsOutput

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:

Name Type Description Default
request GetIpamRouteProtectionFindingsInput | GetIpamRouteProtectionFindingsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetIpamRouteProtectionFindingsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetIpamRouteProtectionFindingsOutput

An instance of GetIpamRouteProtectionFindingsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetIpamRouteProtectionFindingsInputDict

Bases: TypedDict

Dictionary form of GetIpamRouteProtectionFindingsInput.

Attributes

dry_run instance-attribute
dry_run: bool | 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.

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

One or more filters to apply to the results.

ipam_id instance-attribute
ipam_id: Required[str]

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

max_results instance-attribute
max_results: int | 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.

next_token instance-attribute
next_token: str | None

The token for the next page of results.

GetIpamRouteProtectionFindingsInput dataclass

Bases: _SerdeShape

Dataclass for GetIpamRouteProtectionFindingsInput structure.

Attributes

dry_run class-attribute instance-attribute
dry_run: bool | 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.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

One or more filters to apply to the results.

ipam_id class-attribute instance-attribute
ipam_id: str | None = ...

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

max_results class-attribute instance-attribute
max_results: int | 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.

next_token class-attribute instance-attribute
next_token: str | None = ...

The token for the next page of results.

Output

GetIpamRouteProtectionFindingsOutput dataclass

Bases: _SerdeShape

Dataclass for GetIpamRouteProtectionFindingsOutput structure.

Attributes

ipam_id class-attribute instance-attribute
ipam_id: str | None = ...

The ID of the IPAM.

next_token class-attribute instance-attribute
next_token: str | None = ...

The token to use to retrieve the next page of results.

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_protection_findings class-attribute instance-attribute
route_protection_findings: list[IpamRouteProtectionFinding] | None = ...

The route protection findings.