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

UpdateRoute

Updates an AWS Migration Hub Refactor Spaces route.

Request Syntax


PATCH /environments/EnvironmentIdentifier/applications/ApplicationIdentifier/routes/RouteIdentifier HTTP/1.1
Content-type: application/json

{
   "ActivationState": "string"
}

URI Request Parameters

The request uses the following URI parameters.

ApplicationIdentifier

The ID of the application within which the route is being updated.

Length Constraints: Fixed length of 14.

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

Required: Yes

EnvironmentIdentifier

The ID of the environment in which the route is being updated.

Length Constraints: Fixed length of 14.

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

Required: Yes

RouteIdentifier

The unique identifier of the route to update.

Length Constraints: Fixed length of 14.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

ActivationState

If set to ACTIVE, traffic is forwarded to this route’s service after the route is updated.

Type: String

Valid Values: ACTIVE | INACTIVE

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ApplicationId": "string",
   "Arn": "string",
   "LastUpdatedTime": number,
   "RouteId": "string",
   "ServiceId": "string",
   "State": "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.

ApplicationId

The ID of the application in which the route is being updated.

Type: String

Length Constraints: Fixed length of 14.

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

Arn

The Amazon Resource Name (ARN) of the route. The format for this ARN is arn:aws:refactor-spaces:region:account-id:resource-type/resource-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

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+=,.@\-_/]+$

LastUpdatedTime

A timestamp that indicates when the route was last updated.

Type: Timestamp

RouteId

The unique identifier of the route.

Type: String

Length Constraints: Fixed length of 14.

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

ServiceId

The ID of service in which the route was created. Traffic that matches this route is forwarded to this service.

Type: String

Length Constraints: Fixed length of 14.

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

State

The current state of the route.

Type: String

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