Retrieves Border Gateway Protocol (BGP) routes discovered by IPAM resource discovery for a specified Region¶

Description¶

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.

Usage¶

ec2_get_ipam_discovered_routes(DryRun, IpamResourceDiscoveryId,
  ResourceRegion, Filters, NextToken, MaxResults)

Arguments¶

• 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 is UnauthorizedOperation.

• IpamResourceDiscoveryId

  [required] The ID of the IPAM resource discovery.

• ResourceRegion

  [required] The Amazon Web Services Region to retrieve discovered routes for.

• Filters

  One or more filters to apply to the results.

• NextToken

  The token for the next page of results.

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

Value¶

A list with the following syntax:

list(
  IpamDiscoveredRoutes = list(
    list(
      IpamResourceDiscoveryId = "string",
      ResourceRegion = "string",
      ResourceOwnerId = "string",
      Cidr = "string",
      Asn = "string",
      State = "advertised"|"deprovisioned"|"failed-deprovision"|"failed-provision"|"pending-advertising"|"pending-deprovision"|"pending-provision"|"pending-withdrawal"|"provisioned"|"provisioned-not-publicly-advertisable",
      AdvertisementType = "regional"|"global",
      NetworkBorderGroup = "string",
      PoolId = "string",
      IpamPoolId = "string",
      SampleTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$get_ipam_discovered_routes(
  DryRun = TRUE|FALSE,
  IpamResourceDiscoveryId = "string",
  ResourceRegion = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  MaxResults = 123
)