UpdateRoute - Amazon App Mesh
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

UpdateRoute

Updates an existing route for a specified service mesh and virtual router.

Request Syntax

PUT /v20190125/meshes/meshName/virtualRouter/virtualRouterName/routes/routeName?meshOwner=meshOwner HTTP/1.1 Content-type: application/json { "clientToken": "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 } } } } }

URI Request Parameters

The request uses the following URI parameters.

meshName

The name of the service mesh that the route resides in.

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

Required: Yes

meshOwner

The Amazon 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 update.

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

Required: Yes

virtualRouterName

The name of the virtual router that the route is associated with.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

Type: String

Required: No

spec

The new route specification to apply. This overwrites the existing data.

Type: RouteSpec object

Required: Yes

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

ConflictException

The request contains a client token that was used for a previous update resource call with different specifications. Try the request again with a new client token.

HTTP Status Code: 409

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

LimitExceededException

You have exceeded a service limit for your account. For more information, see Service Limits in the Amazon App Mesh User Guide.

HTTP Status Code: 400

NotFoundException

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

HTTP Status Code: 404

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 Amazon Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the Amazon General Reference.

You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the Amazon Command Line Interface (Amazon CLI) or one of the Amazon SDKs to make requests to Amazon, 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 updates a route for the virtual router named colorteller-vr in the ecs-mesh service mesh. The route directs traffic to two weighted targets: 80% to colorteller-blue-vn and 20% to colorteller-red-vn.

Sample Request

PUT /v20190125/meshes/ecs-mesh/virtualRouter/colorteller-vr/routes/colorteller-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: 20190228T001532Z Authorization: AUTHPARAMS { "spec": { "httpRoute": { "action": { "weightedTargets": [ { "virtualNode": "colorteller-blue-vn", "weight": 8 }, { "virtualNode": "colorteller-red-vn", "weight": 2 } ] }, "match": { "prefix": "/" } } }, "clientToken": "e8bbfdff-5d3a-4e5c-9c32-571bad83b021" }

Sample Response

HTTP/1.1 200 OK x-amzn-requestid: 3375b176-77ba-4f76-be44-98ec4a839b8c content-type: application/json content-length: 557 date: Thu, 28 Feb 2019 00:15:32 GMT x-envoy-upstream-service-time: 56 server: envoy Connection: keep-alive { "meshName": "ecs-mesh", "metadata": { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/ecs-mesh/virtualRouter/colorteller-vr/route/colorteller-route", "createdAt": 1.551311817276E9, "lastUpdatedAt": 1.551312932979E9, "uid": "1cf3109a-0d7f-438c-b17d-a3785f14ff7b", "version": 2 }, "routeName": "colorteller-route", "spec": { "httpRoute": { "action": { "weightedTargets": [{ "virtualNode": "colorteller-blue-vn", "weight": 8 }, { "virtualNode": "colorteller-red-vn", "weight": 2 }] }, "match": { "prefix": "/" } }, "tcpRoute": null }, "status": { "status": "ACTIVE" }, "virtualRouterName": "colorteller-vr" }

See Also

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