DeleteRoute
Deletes an existing route.
Request Syntax
DELETE /v20190125/meshes/meshName/virtualRouter/virtualRouterName/routes/routeName?meshOwner=meshOwner HTTP/1.1
URI Request Parameters
The request uses 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.
Required: Yes
- meshOwner
-
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
Length Constraints: Fixed length of 12.
- routeName
-
The name of the route to delete.
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- virtualRouterName
-
The name of the virtual router to delete the route in.
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"meshName": "string",
"metadata": {
"arn": "string",
"createdAt": number,
"lastUpdatedAt": number,
"meshOwner": "string",
"resourceOwner": "string",
"uid": "string",
"version": number
},
"routeName": "string",
"spec": {
"grpcRoute": {
"action": {
"weightedTargets": [
{
"port": number,
"virtualNode": "string",
"weight": number
}
]
},
"match": {
"metadata": [
{
"invert": boolean,
"match": { ... },
"name": "string"
}
],
"methodName": "string",
"port": number,
"serviceName": "string"
},
"retryPolicy": {
"grpcRetryEvents": [ "string" ],
"httpRetryEvents": [ "string" ],
"maxRetries": number,
"perRetryTimeout": {
"unit": "string",
"value": number
},
"tcpRetryEvents": [ "string" ]
},
"timeout": {
"idle": {
"unit": "string",
"value": number
},
"perRequest": {
"unit": "string",
"value": number
}
}
},
"http2Route": {
"action": {
"weightedTargets": [
{
"port": number,
"virtualNode": "string",
"weight": number
}
]
},
"match": {
"headers": [
{
"invert": boolean,
"match": { ... },
"name": "string"
}
],
"method": "string",
"path": {
"exact": "string",
"regex": "string"
},
"port": number,
"prefix": "string",
"queryParameters": [
{
"match": {
"exact": "string"
},
"name": "string"
}
],
"scheme": "string"
},
"retryPolicy": {
"httpRetryEvents": [ "string" ],
"maxRetries": number,
"perRetryTimeout": {
"unit": "string",
"value": number
},
"tcpRetryEvents": [ "string" ]
},
"timeout": {
"idle": {
"unit": "string",
"value": number
},
"perRequest": {
"unit": "string",
"value": number
}
}
},
"httpRoute": {
"action": {
"weightedTargets": [
{
"port": number,
"virtualNode": "string",
"weight": number
}
]
},
"match": {
"headers": [
{
"invert": boolean,
"match": { ... },
"name": "string"
}
],
"method": "string",
"path": {
"exact": "string",
"regex": "string"
},
"port": number,
"prefix": "string",
"queryParameters": [
{
"match": {
"exact": "string"
},
"name": "string"
}
],
"scheme": "string"
},
"retryPolicy": {
"httpRetryEvents": [ "string" ],
"maxRetries": number,
"perRetryTimeout": {
"unit": "string",
"value": number
},
"tcpRetryEvents": [ "string" ]
},
"timeout": {
"idle": {
"unit": "string",
"value": number
},
"perRequest": {
"unit": "string",
"value": number
}
}
},
"priority": number,
"tcpRoute": {
"action": {
"weightedTargets": [
{
"port": number,
"virtualNode": "string",
"weight": number
}
]
},
"match": {
"port": number
},
"timeout": {
"idle": {
"unit": "string",
"value": 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.
- meshName
-
The name of the service mesh that the route resides in.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
- metadata
-
The associated metadata for the route.
Type: ResourceMetadata object
- routeName
-
The name of the route.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
- spec
-
The specifications of the route.
Type: RouteSpec object
- status
-
The status of the route.
Type: RouteStatus object
- virtualRouterName
-
The virtual router that the route is associated with.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
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
Examples
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)
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: AUTHPARAMSSample 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:123456789012: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:
