EC2 / Client / get_ipam_discovered_routes

get_ipam_discovered_routes¶

EC2.Client.get_ipam_discovered_routes(**kwargs)¶

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 Syntax

response = client.get_ipam_discovered_routes(
    DryRun=True|False,
    IpamResourceDiscoveryId='string',
    ResourceRegion='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)

Parameters:

DryRun (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.
IpamResourceDiscoveryId (string) –
[REQUIRED]

The ID of the IPAM resource discovery.
ResourceRegion (string) –
[REQUIRED]

The Amazon Web Services Region to retrieve discovered routes for.
Filters (list) –
One or more filters to apply to the results.
- (dict) –
  
  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) –
NextToken (string) – The token for the next page of results.
MaxResults (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.

Return type:

dict

Returns:

Response Syntax

{
    'IpamDiscoveredRoutes': [
        {
            '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': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- IpamDiscoveredRoutes (list) –
  
  The discovered BGP routes.
  - (dict) –
    
    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.
    - 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).
    - 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 (datetime) –
      
      The time when the route was last sampled.
- NextToken (string) –
  
  The token to use to retrieve the next page of results.