ListVirtualGateways - AWS App Mesh


Returns a list of existing virtual gateways in a service mesh.

Request Syntax

GET /v20190125/meshes/meshName/virtualGateways?limit=limit&meshOwner=meshOwner&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The maximum number of results returned by ListVirtualGateways in paginated output. When you use this parameter, ListVirtualGateways returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualGateways request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualGateways returns up to 100 results and a nextToken value if applicable.

Valid Range: Minimum value of 1. Maximum value of 100.


The name of the service mesh to list virtual gateways in.

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

Required: Yes


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.


The nextToken value returned from a previous paginated ListVirtualGateways request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "virtualGateways": [ { "arn": "string", "createdAt": number, "lastUpdatedAt": number, "meshName": "string", "meshOwner": "string", "resourceOwner": "string", "version": number, "virtualGatewayName": "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.


The nextToken value to include in a future ListVirtualGateways request. When the results of a ListVirtualGateways request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

Type: String


The list of existing virtual gateways for the specified service mesh.

Type: Array of VirtualGatewayRef objects



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

HTTP Status Code: 400


You don't have permissions to perform this action.

HTTP Status Code: 403


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

HTTP Status Code: 500


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

HTTP Status Code: 404


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

HTTP Status Code: 503


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


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.


The following example lists the virtual gateways that are in the apps service mesh.

Sample Request

GET /v20190125/meshes/apps/virtualGateways HTTP/1.1 Host: Accept-Encoding: identity User-Agent: aws-cli/1.16.298 Python/3.6.0 Windows/10 botocore/1.13.34 X-Amz-Date: 20200608T185502Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-requestid: 3add7f54-944b-464a-93ed-57589ed5158d content-type: application/json content-length: 331 date: Mon, 08 Jun 2020 20:53:50 GMT x-envoy-upstream-service-time: 24 server: envoy Connection: keep-alive { "nextToken": null, "virtualGateways": [{ "arn": "arn:aws:appmesh:us-west-2:123456789012:mesh/apps/virtualGateway/myVirtualGateway", "createdAt": 1.591630673505E9, "lastUpdatedAt": 1.591630673505E9, "meshName": "apps", "meshOwner": "123456789012", "resourceOwner": "123456789012", "version": 1, "virtualGatewayName": "myVirtualGateway" }] }

See Also

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