DeleteRoute - AWS Migration Hub Refactor Spaces

DeleteRoute

Deletes an AWS Migration Hub Refactor Spaces route.

Request Syntax

DELETE /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 to delete the route from.

Length Constraints: Fixed length of 14.

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

Required: Yes

EnvironmentIdentifier

The ID of the environment to delete the route from.

Length Constraints: Fixed length of 14.

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

Required: Yes

RouteIdentifier

The ID of the route to delete.

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

LastUpdatedTime

A timestamp that indicates when the route was last updated.

Type: Timestamp

RouteId

The ID of the route to delete.

Type: String

Length Constraints: Fixed length of 14.

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

ServiceId

The ID of the service that the route belongs to.

Type: String

Length Constraints: Fixed length of 14.

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

State

The current state of the route.

Type: String

Valid Values: CREATING | ACTIVE | DELETING | FAILED | UPDATING | INACTIVE

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

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: