AWS CLI Command Reference

[ aws . ec2 ]

get-ipam-discovered-routes

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.

See also: AWS API Documentation

Synopsis

  get-ipam-discovered-routes
[--dry-run | --no-dry-run]
--ipam-resource-discovery-id <value>
--resource-region <value>
[--filters <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--dry-run | --no-dry-run (boolean)

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-resource-discovery-id (string) [required]

The ID of the IPAM resource discovery.

--resource-region (string) [required]

The Amazon Web Services Region to retrieve discovered routes for.

--filters (list)

One or more filters to apply to the results.

(structure)

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

If you specify multiple filters, the filters are joined with an AND , and the request returns only results that match all of the specified filters.

For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide .

Name -> (string)

The name of the filter. Filter names are case-sensitive.

Values -> (list)

The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--next-token (string)

The token for the next page of results.

--max-results (integer)

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.

Constraints:

  • min: 5
  • max: 1000

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

IpamDiscoveredRoutes -> (list)

The discovered BGP routes.

(structure)

Contains information about a BGP route discovered by IPAM resource discovery.

IpamResourceDiscoveryId -> (string)

The ID of the IPAM resource discovery that discovered the route.

ResourceRegion -> (string)

The Amazon Web Services Region where the route was discovered.

ResourceOwnerId -> (string)

The ID of the resource owner.

Cidr -> (string)

The IP address prefix of the discovered route in CIDR notation.

Asn -> (string)

The Autonomous System Number (ASN) that originates the route.

State -> (string)

The state of the BYOIP CIDR. Possible values:

  • advertised - The CIDR is being advertised.
  • deprovisioned - The CIDR has been deprovisioned.
  • failed-deprovision - Deprovisioning failed.
  • failed-provision - Provisioning failed.
  • pending-deprovision - Deprovisioning is in progress.
  • pending-provision - Provisioning is in progress.
  • provisioned - The CIDR is provisioned.
  • provisioned-not-publicly-advertisable - The CIDR is provisioned but not publicly advertisable.

Possible values:

  • advertised
  • deprovisioned
  • failed-deprovision
  • failed-provision
  • pending-advertising
  • pending-deprovision
  • pending-provision
  • pending-withdrawal
  • provisioned
  • provisioned-not-publicly-advertisable

AdvertisementType -> (string)

The advertisement type of the route. Possible values:

  • regional - The IP address is advertised from a single location (regional services such as Amazon EC2).
  • global - The IP address is advertised from multiple global locations simultaneously (global services such as Amazon CloudFront).

Possible values:

  • regional
  • global

NetworkBorderGroup -> (string)

The network border group for the route.

PoolId -> (string)

The ID of the BYOIP pool associated with the route.

IpamPoolId -> (string)

The ID of the IPAM pool associated with the route.

SampleTime -> (timestamp)

The time when the route was last sampled.

NextToken -> (string)

The token to use to retrieve the next page of results.
© Copyright 2026, Amazon Web Services. Created using Sphinx.