GetIpamDiscoveredRoutes
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.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- DryRun
-
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 isUnauthorizedOperation.Type: Boolean
Required: No
- Filter.N
-
One or more filters to apply to the results.
Type: Array of Filter objects
Required: No
- IpamResourceDiscoveryId
-
The ID of the IPAM resource discovery.
Type: String
Required: Yes
- MaxResults
-
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
nextTokenvalue.Type: Integer
Valid Range: Minimum value of 5. Maximum value of 1000.
Required: No
- NextToken
-
The token for the next page of results.
Type: String
Required: No
- ResourceRegion
-
The AWS Region to retrieve discovered routes for.
Type: String
Required: Yes
Response Elements
The following elements are returned by the service.
- ipamDiscoveredRouteSet
-
The discovered BGP routes.
Type: Array of IpamDiscoveredRoute objects
- nextToken
-
The token to use to retrieve the next page of results.
Type: String
- requestId
-
The ID of the request.
Type: String
Errors
For information about the errors that are common to all actions, see Common Error Types.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: