AWS App Mesh
API Reference (API Version 2019-01-25)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

DeleteRoute

Deletes an existing route.

Request Syntax

DELETE /v20190125/meshes/meshName/virtualRouter/virtualRouterName/routes/routeName HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

meshName

The name of the service mesh to delete the route in.

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

routeName

The name of the route to delete.

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

virtualRouterName

The name of the virtual router to delete the route in.

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "route": { "meshName": "string", "metadata": { "arn": "string", "createdAt": number, "lastUpdatedAt": number, "uid": "string", "version": number }, "routeName": "string", "spec": { "httpRoute": { "action": { "weightedTargets": [ { "virtualNode": "string", "weight": number } ] }, "match": { "headers": [ { "invert": boolean, "match": { "exact": "string", "prefix": "string", "range": { "end": number, "start": number }, "regex": "string", "suffix": "string" }, "name": "string" } ], "method": "string", "prefix": "string", "scheme": "string" }, "retryPolicy": { "httpRetryEvents": [ "string" ], "maxRetries": number, "perRetryTimeout": { "unit": "string", "value": number }, "tcpRetryEvents": [ "string" ] } }, "priority": number, "tcpRoute": { "action": { "weightedTargets": [ { "virtualNode": "string", "weight": number } ] } } }, "status": { "status": "string" }, "virtualRouterName": "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.

route

The route that was deleted.

Type: RouteData object

Errors

BadRequestException

The request syntax was malformed. Check your request syntax and try again.

HTTP Status Code: 400

ForbiddenException

You don't have permissions to perform this action.

HTTP Status Code: 403

InternalServerErrorException

The request processing has failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

NotFoundException

The specified resource doesn't exist. Check your request syntax and try again.

HTTP Status Code: 404

ResourceInUseException

You can't delete the specified resource because it's in use or required by another resource.

HTTP Status Code: 409

ServiceUnavailableException

The request has failed due to a temporary failure of the service.

HTTP Status Code: 503

TooManyRequestsException

The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.

HTTP Status Code: 429

Example

In the following example or examples, the Authorization header contents ( AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example

The following example deletes a route named colorgateway-route for the colorgateway-vr virtual router in the ecs-mesh service mesh.

Sample Request

DELETE /v20190125/meshes/ecs-mesh/virtualRouter/colorgateway-vr/routes/colorgateway-route HTTP/1.1 Host: appmesh.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.56 Python/3.7.0 Darwin/17.7.0 botocore/1.12.46 X-Amz-Date: 20190227T203328Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-requestid: 59fda333-ead1-4fbd-ba64-b7150e52d29a content-type: application/json content-length: 512 date: Wed, 27 Feb 2019 20:33:28 GMT x-envoy-upstream-service-time: 95 server: envoy Connection: keep-alive { "meshName": "ecs-mesh", "metadata": { "arn": "arn:aws:appmesh:us-east-1:012345678910:mesh/ecs-mesh/virtualRouter/colorgateway-vr/route/colorgateway-route", "createdAt": 1.551295495004E9, "lastUpdatedAt": 1.551299608556E9, "uid": "3251bf37-2d01-4b79-be96-d0c36c61511f", "version": 2 }, "routeName": "colorgateway-route", "spec": { "httpRoute": { "action": { "weightedTargets": [{ "virtualNode": "colorgateway-vn", "weight": 100 }] }, "match": { "prefix": "/" } }, "tcpRoute": null }, "status": { "status": "DELETED" }, "virtualRouterName": "colorgateway-vr" }

See Also

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