Skip to content
AWS for Query.Farm

aws.networkmanager.get_route_analysis

Example SQL Queries

SELECT * FROM
aws.networkmanager.get_route_analysis
WHERE
"global_network_id" = 'VALUE'
AND "route_analysis_id" = 'VALUE';

Description

Gets information about the specified route analysis.

Table Definition

Column NameColumn Data Type
global_network_id Required Input Column

The ID of the global network.

VARCHAR
route_analysis_id Required Input Column

The ID of the route analysis.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

route_analysis

The route analysis.

STRUCT(
    "global_network_id" VARCHAR,
    "owner_account_id" VARCHAR,
    "route_analysis_id" VARCHAR,
    "start_timestamp" TIMESTAMP_S,
    "status" VARCHAR,
    "source" STRUCT(
        "transit_gateway_attachment_arn" VARCHAR,
        "transit_gateway_arn" VARCHAR,
        "ip_address" VARCHAR
    ),
    "destination" STRUCT(
        "transit_gateway_attachment_arn" VARCHAR,
        "transit_gateway_arn" VARCHAR,
        "ip_address" VARCHAR
    ),
    "include_return_path" BOOLEAN,
    "use_middleboxes" BOOLEAN,
    "forward_path" STRUCT(
        "completion_status" STRUCT(
            "result_code" VARCHAR,
            "reason_code" VARCHAR,
            "reason_context" MAP(VARCHAR, VARCHAR)
        ),
        "path" STRUCT(
            "sequence" BIGINT,
            "resource" STRUCT(
                "registered_gateway_arn" VARCHAR,
                "resource_arn" VARCHAR,
                "resource_type" VARCHAR,
                "definition" VARCHAR,
                "name_tag" VARCHAR,
                "is_middlebox" BOOLEAN
            ),
            "destination_cidr_block" VARCHAR
        )[]
    ),
    "return_path" STRUCT(
        "completion_status" STRUCT(
            "result_code" VARCHAR,
            "reason_code" VARCHAR,
            "reason_context" MAP(VARCHAR, VARCHAR)
        ),
        "path" STRUCT(
            "sequence" BIGINT,
            "resource" STRUCT(
                "registered_gateway_arn" VARCHAR,
                "resource_arn" VARCHAR,
                "resource_type" VARCHAR,
                "definition" VARCHAR,
                "name_tag" VARCHAR,
                "is_middlebox" BOOLEAN
            ),
            "destination_cidr_block" VARCHAR
        )[]
    )
)
Show child fields
route_analysis.destination

The destination.

Show child fields
route_analysis.destination.ip_address

The IP address.

route_analysis.destination.transit_gateway_arn

The ARN of the transit gateway.

route_analysis.destination.transit_gateway_attachment_arn

The ARN of the transit gateway attachment.

route_analysis.forward_path

The forward path.

Show child fields
route_analysis.forward_path.completion_status

The status of the analysis at completion.

Show child fields
route_analysis.forward_path.completion_status.reason_code

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.

route_analysis.forward_path.completion_status.reason_context

Additional information about the path. Available only if a connection is not found.

route_analysis.forward_path.completion_status.result_code

The result of the analysis. If the status is NOT_CONNECTED, check the reason code.

route_analysis.forward_path.path[]
Show child fields
route_analysis.forward_path.path[].destination_cidr_block

The destination CIDR block in the route table.

route_analysis.forward_path.path[].resource

The resource.

Show child fields
route_analysis.forward_path.path[].resource.definition

Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

route_analysis.forward_path.path[].resource.is_middlebox

Indicates whether this is a middlebox appliance.

route_analysis.forward_path.path[].resource.name_tag

The value for the Name tag.

route_analysis.forward_path.path[].resource.registered_gateway_arn

The ARN of the gateway.

route_analysis.forward_path.path[].resource.resource_arn

The ARN of the resource.

route_analysis.forward_path.path[].resource.resource_type

The resource type.

route_analysis.forward_path.path[].sequence

The sequence number in the path. The destination is 0.

route_analysis.global_network_id

The ID of the global network.

route_analysis.include_return_path

Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.

route_analysis.owner_account_id

The ID of the AWS account that created the route analysis.

route_analysis.return_path

The return path.

Show child fields
route_analysis.return_path.completion_status

The status of the analysis at completion.

Show child fields
route_analysis.return_path.completion_status.reason_code

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.

route_analysis.return_path.completion_status.reason_context

Additional information about the path. Available only if a connection is not found.

route_analysis.return_path.completion_status.result_code

The result of the analysis. If the status is NOT_CONNECTED, check the reason code.

route_analysis.return_path.path[]
Show child fields
route_analysis.return_path.path[].destination_cidr_block

The destination CIDR block in the route table.

route_analysis.return_path.path[].resource

The resource.

Show child fields
route_analysis.return_path.path[].resource.definition

Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

route_analysis.return_path.path[].resource.is_middlebox

Indicates whether this is a middlebox appliance.

route_analysis.return_path.path[].resource.name_tag

The value for the Name tag.

route_analysis.return_path.path[].resource.registered_gateway_arn

The ARN of the gateway.

route_analysis.return_path.path[].resource.resource_arn

The ARN of the resource.

route_analysis.return_path.path[].resource.resource_type

The resource type.

route_analysis.return_path.path[].sequence

The sequence number in the path. The destination is 0.

route_analysis.route_analysis_id

The ID of the route analysis.

route_analysis.source

The source.

Show child fields
route_analysis.source.ip_address

The IP address.

route_analysis.source.transit_gateway_arn

The ARN of the transit gateway.

route_analysis.source.transit_gateway_attachment_arn

The ARN of the transit gateway attachment.

route_analysis.start_timestamp

The time that the analysis started.

route_analysis.status

The status of the route analysis.

route_analysis.use_middleboxes

Indicates whether to include the location of middlebox appliances in the route analysis.