AWS API Changes

2021/11/01 - AWS Network Manager - 8 new api methods

Changes This release adds API support to aggregate resources, routes, and telemetry data across a Global Network.

GetNetworkTelemetry (new)

Gets the network telemetry of the specified global network.

Request Syntax

client.get_network_telemetry(
    GlobalNetworkId='string',
    RegisteredGatewayArn='string',
    AwsRegion='string',
    AccountId='string',
    ResourceType='string',
    ResourceArn='string',
    MaxResults=123,
    NextToken='string'
)

type GlobalNetworkId

string

param GlobalNetworkId

[REQUIRED]

The ID of the global network.

type RegisteredGatewayArn

string

param RegisteredGatewayArn

The ARN of the gateway.

type AwsRegion

string

param AwsRegion

The Amazon Web Services Region.

type AccountId

string

param AccountId

The Amazon Web Services account ID.

type ResourceType

string

param ResourceType

The resource type.

The following are the supported resource types for Direct Connect:

dxcon
dx-gateway
dx-vif

The following are the supported resource types for Network Manager:

connection
device
link
site

The following are the supported resource types for Amazon VPC:

customer-gateway
transit-gateway
transit-gateway-attachment
transit-gateway-connect-peer
transit-gateway-route-table
vpn-connection

type ResourceArn

string

param ResourceArn

The ARN of the resource.

type MaxResults

integer

param MaxResults

The maximum number of results to return.

type NextToken

string

param NextToken

The token for the next page of results.

rtype

dict

returns

Response Syntax

{
    'NetworkTelemetry': [
        {
            'RegisteredGatewayArn': 'string',
            'AwsRegion': 'string',
            'AccountId': 'string',
            'ResourceType': 'string',
            'ResourceId': 'string',
            'ResourceArn': 'string',
            'Address': 'string',
            'Health': {
                'Type': 'BGP'|'IPSEC',
                'Status': 'UP'|'DOWN',
                'Timestamp': datetime(2015, 1, 1)
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- NetworkTelemetry (list) --
  
  The network telemetry.
  - (dict) --
    
    Describes the telemetry information for a resource.
    - RegisteredGatewayArn (string) --
      
      The ARN of the gateway.
    - AwsRegion (string) --
      
      The Amazon Web Services Region.
    - AccountId (string) --
      
      The Amazon Web Services account ID.
    - ResourceType (string) --
      
      The resource type.
    - ResourceId (string) --
      
      The ID of the resource.
    - ResourceArn (string) --
      
      The ARN of the resource.
    - Address (string) --
      
      The address.
    - Health (dict) --
      
      The connection health.
      - Type (string) --
        
        The connection type.
      - Status (string) --
        
        The connection status.
      - Timestamp (datetime) --
        
        The time the status was last updated.
- NextToken (string) --
  
  The token for the next page of results.

GetNetworkResources (new)

Link ¶

Describes the network resources for the specified global network.

The results include information from the corresponding Describe call for the resource, minus any sensitive information such as pre-shared keys.

See also: AWS API Documentation

Request Syntax

client.get_network_resources(
    GlobalNetworkId='string',
    RegisteredGatewayArn='string',
    AwsRegion='string',
    AccountId='string',
    ResourceType='string',
    ResourceArn='string',
    MaxResults=123,
    NextToken='string'
)

type GlobalNetworkId

string

param GlobalNetworkId

[REQUIRED]

The ID of the global network.

type RegisteredGatewayArn

string

param RegisteredGatewayArn

The ARN of the gateway.

type AwsRegion

string

param AwsRegion

The Amazon Web Services Region.

type AccountId

string

param AccountId

The Amazon Web Services account ID.

type ResourceType

string

param ResourceType

The resource type.

The following are the supported resource types for Direct Connect:

dxcon - The definition model is Connection.
dx-gateway - The definition model is DirectConnectGateway.
dx-vif - The definition model is VirtualInterface.

The following are the supported resource types for Network Manager:

connection - The definition model is Connection.
device - The definition model is Device.
link - The definition model is Link.
site - The definition model is Site.

The following are the supported resource types for Amazon VPC:

customer-gateway - The definition model is CustomerGateway.
transit-gateway - The definition model is TransitGateway.
transit-gateway-attachment - The definition model is TransitGatewayAttachment.
transit-gateway-connect-peer - The definition model is TransitGatewayConnectPeer.
transit-gateway-route-table - The definition model is TransitGatewayRouteTable.
vpn-connection - The definition model is VpnConnection.

type ResourceArn

string

param ResourceArn

The ARN of the resource.

type MaxResults

integer

param MaxResults

The maximum number of results to return.

type NextToken

string

param NextToken

The token for the next page of results.

rtype

dict

returns

Response Syntax

{
    'NetworkResources': [
        {
            'RegisteredGatewayArn': 'string',
            'AwsRegion': 'string',
            'AccountId': 'string',
            'ResourceType': 'string',
            'ResourceId': 'string',
            'ResourceArn': 'string',
            'Definition': 'string',
            'DefinitionTimestamp': datetime(2015, 1, 1),
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'Metadata': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- NetworkResources (list) --
  
  The network resources.
  - (dict) --
    
    Describes a network resource.
    - RegisteredGatewayArn (string) --
      
      The ARN of the gateway.
    - AwsRegion (string) --
      
      The Amazon Web Services Region.
    - AccountId (string) --
      
      The Amazon Web Services account ID.
    - ResourceType (string) --
      
      The resource type.
      
      The following are the supported resource types for Direct Connect:
      - dxcon
      - dx-gateway
      - dx-vif
      The following are the supported resource types for Network Manager:
      - connection
      - device
      - link
      - site
      The following are the supported resource types for Amazon VPC:
      - customer-gateway
      - transit-gateway
      - transit-gateway-attachment
      - transit-gateway-connect-peer
      - transit-gateway-route-table
      - vpn-connection
    - ResourceId (string) --
      
      The ID of the resource.
    - ResourceArn (string) --
      
      The ARN of the resource.
    - Definition (string) --
      
      Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.
    - DefinitionTimestamp (datetime) --
      
      The time that the resource definition was retrieved.
    - Tags (list) --
      
      The tags.
      - (dict) --
        
        Describes a tag.
        
        Key (string) --
        
        The tag key.
        
        Constraints: Maximum length of 128 characters.
        
        Value (string) --
        
        The tag value.
        
        Constraints: Maximum length of 256 characters.
    - Metadata (dict) --
      
      The resource metadata.
      - (string) --
        
        (string) --
- NextToken (string) --
  
  The token for the next page of results.

GetNetworkResourceCounts (new)

Link ¶

Gets the count of network resources, by resource type, for the specified global network.

See also: AWS API Documentation

Request Syntax

client.get_network_resource_counts(
    GlobalNetworkId='string',
    ResourceType='string',
    MaxResults=123,
    NextToken='string'
)

type GlobalNetworkId

string

param GlobalNetworkId

[REQUIRED]

The ID of the global network.

type ResourceType

string

param ResourceType

The resource type.

The following are the supported resource types for Direct Connect:

dxcon
dx-gateway
dx-vif

The following are the supported resource types for Network Manager:

connection
device
link
site

The following are the supported resource types for Amazon VPC:

customer-gateway
transit-gateway
transit-gateway-attachment
transit-gateway-connect-peer
transit-gateway-route-table
vpn-connection

type MaxResults

integer

param MaxResults

The maximum number of results to return.

type NextToken

string

param NextToken

The token for the next page of results.

rtype

dict

returns

Response Syntax

{
    'NetworkResourceCounts': [
        {
            'ResourceType': 'string',
            'Count': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- NetworkResourceCounts (list) --
  
  The count of resources.
  - (dict) --
    
    Describes a resource count.
    - ResourceType (string) --
      
      The resource type.
    - Count (integer) --
      
      The resource count.
- NextToken (string) --
  
  The token for the next page of results.

StartRouteAnalysis (new)

Link ¶

Starts analyzing the routing path between the specified source and destination. For more information, see Route Analyzer.

See also: AWS API Documentation

Request Syntax

client.start_route_analysis(
    GlobalNetworkId='string',
    Source={
        'TransitGatewayAttachmentArn': 'string',
        'IpAddress': 'string'
    },
    Destination={
        'TransitGatewayAttachmentArn': 'string',
        'IpAddress': 'string'
    },
    IncludeReturnPath=True|False,
    UseMiddleboxes=True|False
)

type GlobalNetworkId

string

param GlobalNetworkId

[REQUIRED]

The ID of the global network.

type Source

dict

param Source

[REQUIRED]

The source from which traffic originates.

TransitGatewayAttachmentArn (string) --

The ARN of the transit gateway attachment.
IpAddress (string) --

The IP address.

type Destination

dict

param Destination

[REQUIRED]

The destination.

TransitGatewayAttachmentArn (string) --

The ARN of the transit gateway attachment.
IpAddress (string) --

The IP address.

type IncludeReturnPath

boolean

param IncludeReturnPath

Indicates whether to analyze the return path. The default is false .

type UseMiddleboxes

boolean

param UseMiddleboxes

Indicates whether to include the location of middlebox appliances in the route analysis. The default is false .

rtype

dict

returns

Response Syntax

{
    'RouteAnalysis': {
        'GlobalNetworkId': 'string',
        'OwnerAccountId': 'string',
        'RouteAnalysisId': 'string',
        'StartTimestamp': datetime(2015, 1, 1),
        'Status': 'RUNNING'|'COMPLETED'|'FAILED',
        'Source': {
            'TransitGatewayAttachmentArn': 'string',
            'TransitGatewayArn': 'string',
            'IpAddress': 'string'
        },
        'Destination': {
            'TransitGatewayAttachmentArn': 'string',
            'TransitGatewayArn': 'string',
            'IpAddress': 'string'
        },
        'IncludeReturnPath': True|False,
        'UseMiddleboxes': True|False,
        'ForwardPath': {
            'CompletionStatus': {
                'ResultCode': 'CONNECTED'|'NOT_CONNECTED',
                'ReasonCode': 'TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND'|'TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY'|'CYCLIC_PATH_DETECTED'|'TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND'|'ROUTE_NOT_FOUND'|'BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND'|'INACTIVE_ROUTE_FOR_DESTINATION_FOUND'|'TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH'|'MAX_HOPS_EXCEEDED'|'POSSIBLE_MIDDLEBOX'|'NO_DESTINATION_ARN_PROVIDED',
                'ReasonContext': {
                    'string': 'string'
                }
            },
            'Path': [
                {
                    'Sequence': 123,
                    'Resource': {
                        'RegisteredGatewayArn': 'string',
                        'ResourceArn': 'string',
                        'ResourceType': 'string',
                        'Definition': 'string',
                        'NameTag': 'string',
                        'IsMiddlebox': True|False
                    },
                    'DestinationCidrBlock': 'string'
                },
            ]
        },
        'ReturnPath': {
            'CompletionStatus': {
                'ResultCode': 'CONNECTED'|'NOT_CONNECTED',
                'ReasonCode': 'TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND'|'TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY'|'CYCLIC_PATH_DETECTED'|'TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND'|'ROUTE_NOT_FOUND'|'BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND'|'INACTIVE_ROUTE_FOR_DESTINATION_FOUND'|'TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH'|'MAX_HOPS_EXCEEDED'|'POSSIBLE_MIDDLEBOX'|'NO_DESTINATION_ARN_PROVIDED',
                'ReasonContext': {
                    'string': 'string'
                }
            },
            'Path': [
                {
                    'Sequence': 123,
                    'Resource': {
                        'RegisteredGatewayArn': 'string',
                        'ResourceArn': 'string',
                        'ResourceType': 'string',
                        'Definition': 'string',
                        'NameTag': 'string',
                        'IsMiddlebox': True|False
                    },
                    'DestinationCidrBlock': 'string'
                },
            ]
        }
    }
}

Response Structure

(dict) --
- RouteAnalysis (dict) --
  
  The route analysis.
  - GlobalNetworkId (string) --
    
    The ID of the global network.
  - OwnerAccountId (string) --
    
    The ID of the AWS account that created the route analysis.
  - RouteAnalysisId (string) --
    
    The ID of the route analysis.
  - StartTimestamp (datetime) --
    
    The time that the analysis started.
  - Status (string) --
    
    The status of the route analysis.
  - Source (dict) --
    
    The source.
    - TransitGatewayAttachmentArn (string) --
      
      The ARN of the transit gateway attachment.
    - TransitGatewayArn (string) --
      
      The ARN of the transit gateway.
    - IpAddress (string) --
      
      The IP address.
  - Destination (dict) --
    
    The destination.
    - TransitGatewayAttachmentArn (string) --
      
      The ARN of the transit gateway attachment.
    - TransitGatewayArn (string) --
      
      The ARN of the transit gateway.
    - IpAddress (string) --
      
      The IP address.
  - IncludeReturnPath (boolean) --
    
    Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.
  - UseMiddleboxes (boolean) --
    
    Indicates whether to include the location of middlebox appliances in the route analysis.
  - ForwardPath (dict) --
    
    The forward path.
    - CompletionStatus (dict) --
      
      The status of the analysis at completion.
      - ResultCode (string) --
        
        The result of the analysis. If the status is NOT_CONNECTED , check the reason code.
      - ReasonCode (string) --
        
        The reason code. Available only if a connection is not found.
        
        BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.
        
        CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.
        
        INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.
        
        MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.
        
        ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.
        
        TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.
        
        TGW_ATTACH_NOT_FOUND - Cannot find an attachment.
        
        TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.
        
        TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not associated.
      - ReasonContext (dict) --
        
        Additional information about the path. Available only if a connection is not found.
        
        (string) --
        
        (string) --
    - Path (list) --
      
      The route analysis path.
      - (dict) --
        
        Describes a path component.
        
        Sequence (integer) --
        
        The sequence number in the path. The destination is 0.
        
        Resource (dict) --
        
        The resource.
        
        RegisteredGatewayArn (string) --
        
        The ARN of the gateway.
        
        ResourceArn (string) --
        
        The ARN of the resource.
        
        ResourceType (string) --
        
        The resource type.
        
        Definition (string) --
        
        Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.
        
        NameTag (string) --
        
        The value for the Name tag.
        
        IsMiddlebox (boolean) --
        
        Indicates whether this is a middlebox appliance.
        
        DestinationCidrBlock (string) --
        
        The destination CIDR block in the route table.
  - ReturnPath (dict) --
    
    The return path.
    - CompletionStatus (dict) --
      
      The status of the analysis at completion.
      - ResultCode (string) --
        
        The result of the analysis. If the status is NOT_CONNECTED , check the reason code.
      - ReasonCode (string) --
        
        The reason code. Available only if a connection is not found.
        
        BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.
        
        CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.
        
        INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.
        
        MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.
        
        ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.
        
        TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.
        
        TGW_ATTACH_NOT_FOUND - Cannot find an attachment.
        
        TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.
        
        TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not associated.
      - ReasonContext (dict) --
        
        Additional information about the path. Available only if a connection is not found.
        
        (string) --
        
        (string) --
    - Path (list) --
      
      The route analysis path.
      - (dict) --
        
        Describes a path component.
        
        Sequence (integer) --
        
        The sequence number in the path. The destination is 0.
        
        Resource (dict) --
        
        The resource.
        
        RegisteredGatewayArn (string) --
        
        The ARN of the gateway.
        
        ResourceArn (string) --
        
        The ARN of the resource.
        
        ResourceType (string) --
        
        The resource type.
        
        Definition (string) --
        
        Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.
        
        NameTag (string) --
        
        The value for the Name tag.
        
        IsMiddlebox (boolean) --
        
        Indicates whether this is a middlebox appliance.
        
        DestinationCidrBlock (string) --
        
        The destination CIDR block in the route table.

UpdateNetworkResourceMetadata (new)

Link ¶

Updates the resource metadata for the specified global network.

See also: AWS API Documentation

Request Syntax

client.update_network_resource_metadata(
    GlobalNetworkId='string',
    ResourceArn='string',
    Metadata={
        'string': 'string'
    }
)

type GlobalNetworkId

string

param GlobalNetworkId

[REQUIRED]

The ID of the global network.

type ResourceArn

string

param ResourceArn

[REQUIRED]

The ARN of the resource.

type Metadata

dict

param Metadata

[REQUIRED]

The resource metadata.

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{
    'ResourceArn': 'string',
    'Metadata': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- ResourceArn (string) --
  
  The ARN of the resource.
- Metadata (dict) --
  
  The updated resource metadata.
  - (string) --
    - (string) --

GetNetworkResourceRelationships (new)

Link ¶

Gets the network resource relationships for the specified global network.

See also: AWS API Documentation

Request Syntax

client.get_network_resource_relationships(
    GlobalNetworkId='string',
    RegisteredGatewayArn='string',
    AwsRegion='string',
    AccountId='string',
    ResourceType='string',
    ResourceArn='string',
    MaxResults=123,
    NextToken='string'
)

type GlobalNetworkId

string

param GlobalNetworkId

[REQUIRED]

The ID of the global network.

type RegisteredGatewayArn

string

param RegisteredGatewayArn

The ARN of the registered gateway.

type AwsRegion

string

param AwsRegion

The Amazon Web Services Region.

type AccountId

string

param AccountId

The Amazon Web Services account ID.

type ResourceType

string

param ResourceType

The resource type.

The following are the supported resource types for Direct Connect:

dxcon
dx-gateway
dx-vif

The following are the supported resource types for Network Manager:

connection
device
link
site

The following are the supported resource types for Amazon VPC:

customer-gateway
transit-gateway
transit-gateway-attachment
transit-gateway-connect-peer
transit-gateway-route-table
vpn-connection

type ResourceArn

string

param ResourceArn

The ARN of the gateway.

type MaxResults

integer

param MaxResults

The maximum number of results to return.

type NextToken

string

param NextToken

The token for the next page of results.

rtype

dict

returns

Response Syntax

{
    'Relationships': [
        {
            'From': 'string',
            'To': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Relationships (list) --
  
  The resource relationships.
  - (dict) --
    
    Describes a resource relationship.
    - From (string) --
      
      The ARN of the resource.
    - To (string) --
      
      The ARN of the resource.
- NextToken (string) --
  
  The token for the next page of results.

GetNetworkRoutes (new)

Link ¶

Gets the network routes of the specified global network.

See also: AWS API Documentation

Request Syntax

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

type GlobalNetworkId

string

param GlobalNetworkId

[REQUIRED]

The ID of the global network.

type RouteTableIdentifier

dict

param RouteTableIdentifier

[REQUIRED]

The ID of the route table.

TransitGatewayRouteTableArn (string) --

The ARN of the transit gateway route table.

type ExactCidrMatches

list

param ExactCidrMatches

An exact CIDR block.

(string) --

type LongestPrefixMatches

list

param LongestPrefixMatches

The most specific route that matches the traffic (longest prefix match).

(string) --

type SubnetOfMatches

list

param SubnetOfMatches

The routes with a subnet that match the specified CIDR filter.

(string) --

type SupernetOfMatches

list

param SupernetOfMatches

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) --

type PrefixListIds

list

param PrefixListIds

The IDs of the prefix lists.

(string) --

type States

list

param States

The route states.

(string) --

type Types

list

param Types

The route types.

(string) --

type DestinationFilters

dict

param DestinationFilters

Filter by route table destination. Possible Values: TRANSIT_GATEWAY_ATTACHMENT_ID, RESOURCE_ID, or RESOURCE_TYPE.

(string) --
- (list) --
  - (string) --

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- RouteTableArn (string) --
  
  The ARN of the route table.
- 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.
        
        TransitGatewayAttachmentId (string) --
        
        The ID of the transit gateway attachment.
        
        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 .

GetRouteAnalysis (new)

Link ¶

Gets information about the specified route analysis.

See also: AWS API Documentation

Request Syntax

client.get_route_analysis(
    GlobalNetworkId='string',
    RouteAnalysisId='string'
)

type GlobalNetworkId

string

param GlobalNetworkId

[REQUIRED]

The ID of the global network.

type RouteAnalysisId

string

param RouteAnalysisId

[REQUIRED]

The ID of the route analysis.

rtype

dict

returns

Response Syntax

{
    'RouteAnalysis': {
        'GlobalNetworkId': 'string',
        'OwnerAccountId': 'string',
        'RouteAnalysisId': 'string',
        'StartTimestamp': datetime(2015, 1, 1),
        'Status': 'RUNNING'|'COMPLETED'|'FAILED',
        'Source': {
            'TransitGatewayAttachmentArn': 'string',
            'TransitGatewayArn': 'string',
            'IpAddress': 'string'
        },
        'Destination': {
            'TransitGatewayAttachmentArn': 'string',
            'TransitGatewayArn': 'string',
            'IpAddress': 'string'
        },
        'IncludeReturnPath': True|False,
        'UseMiddleboxes': True|False,
        'ForwardPath': {
            'CompletionStatus': {
                'ResultCode': 'CONNECTED'|'NOT_CONNECTED',
                'ReasonCode': 'TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND'|'TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY'|'CYCLIC_PATH_DETECTED'|'TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND'|'ROUTE_NOT_FOUND'|'BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND'|'INACTIVE_ROUTE_FOR_DESTINATION_FOUND'|'TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH'|'MAX_HOPS_EXCEEDED'|'POSSIBLE_MIDDLEBOX'|'NO_DESTINATION_ARN_PROVIDED',
                'ReasonContext': {
                    'string': 'string'
                }
            },
            'Path': [
                {
                    'Sequence': 123,
                    'Resource': {
                        'RegisteredGatewayArn': 'string',
                        'ResourceArn': 'string',
                        'ResourceType': 'string',
                        'Definition': 'string',
                        'NameTag': 'string',
                        'IsMiddlebox': True|False
                    },
                    'DestinationCidrBlock': 'string'
                },
            ]
        },
        'ReturnPath': {
            'CompletionStatus': {
                'ResultCode': 'CONNECTED'|'NOT_CONNECTED',
                'ReasonCode': 'TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND'|'TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY'|'CYCLIC_PATH_DETECTED'|'TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND'|'ROUTE_NOT_FOUND'|'BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND'|'INACTIVE_ROUTE_FOR_DESTINATION_FOUND'|'TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH'|'MAX_HOPS_EXCEEDED'|'POSSIBLE_MIDDLEBOX'|'NO_DESTINATION_ARN_PROVIDED',
                'ReasonContext': {
                    'string': 'string'
                }
            },
            'Path': [
                {
                    'Sequence': 123,
                    'Resource': {
                        'RegisteredGatewayArn': 'string',
                        'ResourceArn': 'string',
                        'ResourceType': 'string',
                        'Definition': 'string',
                        'NameTag': 'string',
                        'IsMiddlebox': True|False
                    },
                    'DestinationCidrBlock': 'string'
                },
            ]
        }
    }
}

Response Structure

(dict) --
- RouteAnalysis (dict) --
  
  The route analysis.
  - GlobalNetworkId (string) --
    
    The ID of the global network.
  - OwnerAccountId (string) --
    
    The ID of the AWS account that created the route analysis.
  - RouteAnalysisId (string) --
    
    The ID of the route analysis.
  - StartTimestamp (datetime) --
    
    The time that the analysis started.
  - Status (string) --
    
    The status of the route analysis.
  - Source (dict) --
    
    The source.
    - TransitGatewayAttachmentArn (string) --
      
      The ARN of the transit gateway attachment.
    - TransitGatewayArn (string) --
      
      The ARN of the transit gateway.
    - IpAddress (string) --
      
      The IP address.
  - Destination (dict) --
    
    The destination.
    - TransitGatewayAttachmentArn (string) --
      
      The ARN of the transit gateway attachment.
    - TransitGatewayArn (string) --
      
      The ARN of the transit gateway.
    - IpAddress (string) --
      
      The IP address.
  - IncludeReturnPath (boolean) --
    
    Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.
  - UseMiddleboxes (boolean) --
    
    Indicates whether to include the location of middlebox appliances in the route analysis.
  - ForwardPath (dict) --
    
    The forward path.
    - CompletionStatus (dict) --
      
      The status of the analysis at completion.
      - ResultCode (string) --
        
        The result of the analysis. If the status is NOT_CONNECTED , check the reason code.
      - ReasonCode (string) --
        
        The reason code. Available only if a connection is not found.
        
        BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.
        
        CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.
        
        INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.
        
        MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.
        
        ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.
        
        TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.
        
        TGW_ATTACH_NOT_FOUND - Cannot find an attachment.
        
        TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.
        
        TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not associated.
      - ReasonContext (dict) --
        
        Additional information about the path. Available only if a connection is not found.
        
        (string) --
        
        (string) --
    - Path (list) --
      
      The route analysis path.
      - (dict) --
        
        Describes a path component.
        
        Sequence (integer) --
        
        The sequence number in the path. The destination is 0.
        
        Resource (dict) --
        
        The resource.
        
        RegisteredGatewayArn (string) --
        
        The ARN of the gateway.
        
        ResourceArn (string) --
        
        The ARN of the resource.
        
        ResourceType (string) --
        
        The resource type.
        
        Definition (string) --
        
        Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.
        
        NameTag (string) --
        
        The value for the Name tag.
        
        IsMiddlebox (boolean) --
        
        Indicates whether this is a middlebox appliance.
        
        DestinationCidrBlock (string) --
        
        The destination CIDR block in the route table.
  - ReturnPath (dict) --
    
    The return path.
    - CompletionStatus (dict) --
      
      The status of the analysis at completion.
      - ResultCode (string) --
        
        The result of the analysis. If the status is NOT_CONNECTED , check the reason code.
      - ReasonCode (string) --
        
        The reason code. Available only if a connection is not found.
        
        BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.
        
        CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.
        
        INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.
        
        MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.
        
        ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.
        
        TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.
        
        TGW_ATTACH_NOT_FOUND - Cannot find an attachment.
        
        TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.
        
        TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not associated.
      - ReasonContext (dict) --
        
        Additional information about the path. Available only if a connection is not found.
        
        (string) --
        
        (string) --
    - Path (list) --
      
      The route analysis path.
      - (dict) --
        
        Describes a path component.
        
        Sequence (integer) --
        
        The sequence number in the path. The destination is 0.
        
        Resource (dict) --
        
        The resource.
        
        RegisteredGatewayArn (string) --
        
        The ARN of the gateway.
        
        ResourceArn (string) --
        
        The ARN of the resource.
        
        ResourceType (string) --
        
        The resource type.
        
        Definition (string) --
        
        Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.
        
        NameTag (string) --
        
        The value for the Name tag.
        
        IsMiddlebox (boolean) --
        
        Indicates whether this is a middlebox appliance.
        
        DestinationCidrBlock (string) --
        
        The destination CIDR block in the route table.