Skip to content

get_ipam_discovered_routes

Operation

get_ipam_discovered_routes

get_ipam_discovered_routes(request: GetIpamDiscoveredRoutesInput | GetIpamDiscoveredRoutesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIpamDiscoveredRoutesInputDict]) -> GetIpamDiscoveredRoutesOutput

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.

Parameters:

Name Type Description Default
request GetIpamDiscoveredRoutesInput | GetIpamDiscoveredRoutesInputDict | 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[GetIpamDiscoveredRoutesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetIpamDiscoveredRoutesOutput

An instance of GetIpamDiscoveredRoutesOutput.

get_ipam_discovered_routes async

get_ipam_discovered_routes(request: GetIpamDiscoveredRoutesInput | GetIpamDiscoveredRoutesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIpamDiscoveredRoutesInputDict]) -> GetIpamDiscoveredRoutesOutput

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.

Parameters:

Name Type Description Default
request GetIpamDiscoveredRoutesInput | GetIpamDiscoveredRoutesInputDict | 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[GetIpamDiscoveredRoutesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetIpamDiscoveredRoutesOutput

An instance of GetIpamDiscoveredRoutesOutput.

Input

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

GetIpamDiscoveredRoutesInputDict

Bases: TypedDict

Dictionary form of GetIpamDiscoveredRoutesInput.

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_resource_discovery_id instance-attribute
ipam_resource_discovery_id: Required[str]

The ID of the IPAM resource discovery.

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.

resource_region instance-attribute
resource_region: Required[str]

The Amazon Web Services Region to retrieve discovered routes for.

GetIpamDiscoveredRoutesInput dataclass

Bases: _SerdeShape

Dataclass for GetIpamDiscoveredRoutesInput 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_resource_discovery_id class-attribute instance-attribute
ipam_resource_discovery_id: str | None = ...

The ID of the IPAM resource discovery.

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.

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

The Amazon Web Services Region to retrieve discovered routes for.

Output

GetIpamDiscoveredRoutesOutput dataclass

Bases: _SerdeShape

Dataclass for GetIpamDiscoveredRoutesOutput structure.

Attributes

ipam_discovered_routes class-attribute instance-attribute
ipam_discovered_routes: list[IpamDiscoveredRoute] | None = ...

The discovered BGP routes.

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.