get_network_routes¶

NetworkManager.Client.get_network_routes(**kwargs)¶

Gets the network routes of the specified global network.

Request Syntax

response = client.get_network_routes(
    GlobalNetworkId='string',
    RouteTableIdentifier={
        'TransitGatewayRouteTableArn': 'string',
        'CoreNetworkSegmentEdge': {
            'CoreNetworkId': 'string',
            'SegmentName': 'string',
            'EdgeLocation': 'string'
        }
    },
    ExactCidrMatches=[
        'string',
    ],
    LongestPrefixMatches=[
        'string',
    ],
    SubnetOfMatches=[
        'string',
    ],
    SupernetOfMatches=[
        'string',
    ],
    PrefixListIds=[
        'string',
    ],
    States=[
        'ACTIVE'|'BLACKHOLE',
    ],
    Types=[
        'PROPAGATED'|'STATIC',
    ],
    DestinationFilters={
        'string': [
            'string',
        ]
    }
)

Parameters

GlobalNetworkId (string) --
[REQUIRED]

The ID of the global network.
RouteTableIdentifier (dict) --
[REQUIRED]

The ID of the route table.
- TransitGatewayRouteTableArn (string) --
  The ARN of the transit gateway route table.
- CoreNetworkSegmentEdge (dict) --
  The segment edge in a core network.
  - CoreNetworkId (string) --
    The ID of a core network.
  - SegmentName (string) --
    The name of the segment edge.
  - EdgeLocation (string) --
    The Region where the segment edge is located.
ExactCidrMatches (list) --
An exact CIDR block.
- (string) --
LongestPrefixMatches (list) --
The most specific route that matches the traffic (longest prefix match).
- (string) --
SubnetOfMatches (list) --
The routes with a subnet that match the specified CIDR filter.
- (string) --
SupernetOfMatches (list) --
The routes with a CIDR that encompasses the CIDR filter. Example: If you specify 10.0.1.0/30, then the result returns 10.0.1.0/29.
- (string) --
PrefixListIds (list) --
The IDs of the prefix lists.
- (string) --
States (list) --
The route states.
- (string) --
Types (list) --
The route types.
- (string) --
DestinationFilters (dict) --
Filter by route table destination. Possible Values: TRANSIT_GATEWAY_ATTACHMENT_ID, RESOURCE_ID, or RESOURCE_TYPE.
- (string) --
  - (list) --
    - (string) --

Return type

dict

Returns

Response Syntax

{
    'RouteTableArn': 'string',
    'CoreNetworkSegmentEdge': {
        'CoreNetworkId': 'string',
        'SegmentName': 'string',
        'EdgeLocation': 'string'
    },
    'RouteTableType': 'TRANSIT_GATEWAY_ROUTE_TABLE'|'CORE_NETWORK_SEGMENT',
    'RouteTableTimestamp': datetime(2015, 1, 1),
    'NetworkRoutes': [
        {
            'DestinationCidrBlock': 'string',
            'Destinations': [
                {
                    'CoreNetworkAttachmentId': 'string',
                    'TransitGatewayAttachmentId': 'string',
                    'SegmentName': 'string',
                    'EdgeLocation': 'string',
                    'ResourceType': 'string',
                    'ResourceId': 'string'
                },
            ],
            'PrefixListId': 'string',
            'State': 'ACTIVE'|'BLACKHOLE',
            'Type': 'PROPAGATED'|'STATIC'
        },
    ]
}

Response Structure

(dict) --
- RouteTableArn (string) --
  
  The ARN of the route table.
- CoreNetworkSegmentEdge (dict) --
  
  Describes a core network segment edge.
  - CoreNetworkId (string) --
    
    The ID of a core network.
  - SegmentName (string) --
    
    The name of the segment edge.
  - EdgeLocation (string) --
    
    The Region where the segment edge is located.
- RouteTableType (string) --
  
  The route table type.
- RouteTableTimestamp (datetime) --
  
  The route table creation time.
- NetworkRoutes (list) --
  
  The network routes.
  - (dict) --
    
    Describes a network route.
    - DestinationCidrBlock (string) --
      
      A unique identifier for the route, such as a CIDR block.
    - Destinations (list) --
      
      The destinations.
      - (dict) --
        
        Describes the destination of a network route.
        
        CoreNetworkAttachmentId (string) --
        
        The ID of a core network attachment.
        
        TransitGatewayAttachmentId (string) --
        
        The ID of the transit gateway attachment.
        
        SegmentName (string) --
        
        The name of the segment.
        
        EdgeLocation (string) --
        
        The edge location for the network destination.
        
        ResourceType (string) --
        
        The resource type.
        
        ResourceId (string) --
        
        The ID of the resource.
    - PrefixListId (string) --
      
      The ID of the prefix list.
    - State (string) --
      
      The route state. The possible values are active and blackhole .
    - Type (string) --
      
      The route type. The possible values are propagated and static .

Exceptions

NetworkManager.Client.exceptions.ValidationException
NetworkManager.Client.exceptions.AccessDeniedException
NetworkManager.Client.exceptions.ResourceNotFoundException
NetworkManager.Client.exceptions.ThrottlingException
NetworkManager.Client.exceptions.InternalServerException

Table Of Contents

get_network_routes¶