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

ListRoutes

Lists all the AWS Migration Hub Refactor Spaces routes within an application.

Request Syntax


GET /environments/EnvironmentIdentifier/applications/ApplicationIdentifier/routes?maxResults=MaxResults&nextToken=NextToken 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

MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

The token for the next page of results.

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

Pattern: ^[a-zA-Z0-9/\+\=]{0,2048}$

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "RouteSummaryList": [ 
      { 
         "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.

NextToken

The token for the next page of results.

Type: String

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

Pattern: ^[a-zA-Z0-9/\+\=]{0,2048}$

RouteSummaryList

The list of RouteSummary objects.

Type: Array of RouteSummary objects

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

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

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

ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

HTTP Status Code: 402

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