Skip to content
AWS for Query.Farm

aws.migration_hub_refactor_spaces.get_route

Example SQL Queries

SELECT * FROM
aws.migration_hub_refactor_spaces.get_route
WHERE
"application_identifier" = 'VALUE'
AND "environment_identifier" = 'VALUE'
AND "route_identifier" = 'VALUE';

Description

Gets an Amazon Web Services Migration Hub Refactor Spaces route.

Table Definition

Column NameColumn Data Type
application_identifier Required Input Column

The ID of the application. 

VARCHAR
environment_identifier Required Input Column

The ID of the environment.

VARCHAR
route_identifier Required Input Column

The ID of the route.

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.

append_source_path

If set to true, this option appends the source path to the service URL endpoint.

BOOLEAN
application_id

The ID of the application that the route belongs to. 

VARCHAR
arn

The Amazon Resource Name (ARN) of the route.

VARCHAR
created_by_account_id

The Amazon Web Services account ID of the route creator.

VARCHAR
created_time

The timestamp of when the route is created. 

TIMESTAMP_S
environment_id

Unique identifier of the environment.

VARCHAR
error

Any error associated with the route resource. 

STRUCT(
    "account_id" VARCHAR,
    "additional_details" MAP(VARCHAR, VARCHAR),
    "code" VARCHAR,
    "message" VARCHAR,
    "resource_identifier" VARCHAR,
    "resource_type" VARCHAR
)
Show child fields
error.account_id

The Amazon Web Services account ID of the resource owner.

error.additional_details

Additional details about the error.

error.code

The error code associated with the error.

error.message

The message associated with the error.

error.resource_identifier

The ID of the resource.

error.resource_type

The type of resource.

include_child_paths

Indicates whether to match all subpaths of the given source path. If this value is false, requests must match the source path exactly before they are forwarded to this route's service. 

BOOLEAN
last_updated_time

A timestamp that indicates when the route was last updated. 

TIMESTAMP_S
methods

A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service. 

VARCHAR[]
Show child fields
methods[]
owner_account_id

The Amazon Web Services account ID of the route owner.

VARCHAR
path_resource_to_id

A mapping of Amazon API Gateway path resources to resource IDs. 

MAP(VARCHAR, VARCHAR)
route_id

The unique identifier of the route.

DEFAULT: All traffic that does not match another route is forwarded to the default route. Applications must have a default route before any other routes can be created.

URI_PATH: A route that is based on a URI path.

VARCHAR
route_type

The type of route.

VARCHAR
service_id

The unique identifier of the service.

VARCHAR
source_path

This is the path that Refactor Spaces uses to match traffic. Paths must start with / and are relative to the base of the application. To use path parameters in the source path, add a variable in curly braces. For example, the resource path {user} represents a path parameter called 'user'.

VARCHAR
state

The current state of the route. 

VARCHAR
tags

The tags assigned to the route. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair. 

MAP(VARCHAR, VARCHAR)