Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1424136125.4 KB

Gets an Amazon Web Services Migration Hub Refactor Spaces route.

get/environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}/routes/{RouteIdentifier}

Path parameters

ApplicationIdentifierstring required

The ID of the application.

EnvironmentIdentifierstring required

The ID of the environment.

RouteIdentifierstring required

The ID of the route.

Response

Success

AppendSourcePathboolean

If set to <code>true</code>, this option appends the source path to the service URL endpoint.

ApplicationIdstring

The ID of the application that the route belongs to.

Arnstring

The Amazon Resource Name (ARN) of the route.

CreatedByAccountIdstring

The Amazon Web Services account ID of the route creator.

CreatedTimestring date-time

The timestamp of when the route is created.

EnvironmentIdstring

Unique identifier of the environment.

IncludeChildPathsboolean

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

LastUpdatedTimestring date-time

A timestamp that indicates when the route was last updated.

MethodsHttpMethod[]

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.

OwnerAccountIdstring

The Amazon Web Services account ID of the route owner.

PathResourceToIdobject

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

RouteIdstring
<p>The unique identifier of the route.</p> <p> <b>DEFAULT</b>: 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.</p> <p> <b>URI_PATH</b>: A route that is based on a URI path.</p>
RouteType'DEFAULT' | 'URI_PATH'

The type of route.

ServiceIdstring

The unique identifier of the service.

SourcePathstring

This is the path that Refactor Spaces uses to match traffic. Paths must start with <code>/</code> 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'.

State'CREATING' | 'ACTIVE' | 'DELETING' | 'FAILED' | 'UPDATING' | 'INACTIVE'

The current state of the route.

Tagsobject

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.