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.

UpdateVirtualRouter

Updates an existing virtual router in a specified service mesh.

Request Syntax

PUT /v20190125/meshes/meshName/virtualRouters/virtualRouterName HTTP/1.1 Content-type: application/json { "clientToken": "string", "spec": { "listeners": [ { "portMapping": { "port": number, "protocol": "string" } } ] } }

URI Request Parameters

The request requires the following URI parameters.

meshName

The name of the service mesh that the virtual router resides in.

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

virtualRouterName

The name of the virtual router to update.

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

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 virtual router specification to apply. This overwrites the existing data.

Type: VirtualRouterSpec object

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "virtualRouter": { "meshName": "string", "metadata": { "arn": "string", "createdAt": number, "lastUpdatedAt": number, "uid": "string", "version": number }, "spec": { "listeners": [ { "portMapping": { "port": number, "protocol": "string" } } ] }, "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.

virtualRouter

A full description of the virtual router that was updated.

Type: VirtualRouterData object

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 AWS 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

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 updates a virtual router named colorteller-vr in the ecs-mesh service mesh.

Sample Request

PUT /v20190125/meshes/ecs-mesh/virtualRouters/colorteller-vr 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: 20190228T002506Z Authorization: AUTHPARAMS { "spec": {}, "clientToken": "6029e873-0ef2-41b9-957e-2742048c92c3" }

Sample Response

HTTP/1.1 200 OK x-amzn-requestid: fba0cb49-d242-46e5-aacd-c4a0fad60413 content-type: application/json content-length: 336 date: Thu, 28 Feb 2019 00:25:06 GMT x-envoy-upstream-service-time: 70 server: envoy Connection: keep-alive { "meshName": "ecs-mesh", "metadata": { "arn": "arn:aws:appmesh:us-east-1:012345678910:mesh/ecs-mesh/virtualRouter/colorteller-vr", "createdAt": 1551311805.476, "lastUpdatedAt": 1551313507.39, "uid": "79628d34-8c17-42ba-83a5-8a42fd17ec5a", "version": 2 }, "spec": { "listeners": [ { "portMapping": { "port": 9080, "protocol": "http" } } ] }, "status": { "status": "ACTIVE" }, "virtualRouterName": "colorteller-vr" }

See Also

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