Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetRoute

Gets an AWS Migration Hub Refactor Spaces route.

Request Syntax


GET /environments/EnvironmentIdentifier/applications/ApplicationIdentifier/routes/RouteIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ApplicationIdentifier

The ID of the application.

Length Constraints: Fixed length of 14.

Pattern: ^app-[0-9A-Za-z]{10}$

Required: Yes

EnvironmentIdentifier

The ID of the environment.

Length Constraints: Fixed length of 14.

Pattern: ^env-[0-9A-Za-z]{10}$

Required: Yes

RouteIdentifier

The ID of the route.

Length Constraints: Fixed length of 14.

Pattern: ^rte-[0-9A-Za-z]{10}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AppendSourcePath": boolean,
   "ApplicationId": "string",
   "Arn": "string",
   "CreatedByAccountId": "string",
   "CreatedTime": number,
   "EnvironmentId": "string",
   "Error": { 
      "AccountId": "string",
      "AdditionalDetails": { 
         "string" : "string" 
      },
      "Code": "string",
      "Message": "string",
      "ResourceIdentifier": "string",
      "ResourceType": "string"
   },
   "IncludeChildPaths": boolean,
   "LastUpdatedTime": number,
   "Methods": [ "string" ],
   "OwnerAccountId": "string",
   "PathResourceToId": { 
      "string" : "string" 
   },
   "RouteId": "string",
   "RouteType": "string",
   "ServiceId": "string",
   "SourcePath": "string",
   "State": "string",
   "Tags": { 
      "string" : "string" 
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AppendSourcePath

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

Type: Boolean

ApplicationId

The ID of the application that the route belongs to.

Type: String

Length Constraints: Fixed length of 14.

Pattern: ^app-[0-9A-Za-z]{10}$

Arn

The Amazon Resource Name (ARN) of the route.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+$

CreatedByAccountId

The AWS account ID of the route creator.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^\d{12}$

CreatedTime

The timestamp of when the route is created.

Type: Timestamp

EnvironmentId

Unique identifier of the environment.

Type: String

Length Constraints: Fixed length of 14.

Pattern: ^env-[0-9A-Za-z]{10}$

Error

Any error associated with the route resource.

Type: ErrorResponse object

IncludeChildPaths

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.

Type: Boolean

LastUpdatedTime

A timestamp that indicates when the route was last updated.

Type: Timestamp

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.

Type: Array of strings

OwnerAccountId

The AWS account ID of the route owner.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^\d{12}$

PathResourceToId

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

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 2048.

Value Length Constraints: Fixed length of 10.

Value Pattern: ^[a-z0-9]{10}$

RouteId

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.

Type: String

Length Constraints: Fixed length of 14.

Pattern: ^rte-[0-9A-Za-z]{10}$

RouteType

The type of route.

Type: String

Valid Values: DEFAULT | URI_PATH

ServiceId

The unique identifier of the service.

Type: String

Length Constraints: Fixed length of 14.

Pattern: ^svc-[0-9A-Za-z]{10}$

SourcePath

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'.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^(/([a-zA-Z0-9._:-]+|\{[a-zA-Z0-9._:-]+\}))+$

State

The current state of the route.

Type: String

Tags

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

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:).+

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The user does not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

Request was denied because the request was throttled.

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints specified by an AWS service.

HTTP Status Code: 400