v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1438333248.1 KB

Returns a list of existing gateway routes that are associated to a virtual gateway.

get/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes

Path parameters

meshNamestring required

The name of the service mesh to list gateway routes in.

virtualGatewayNamestring required

The name of the virtual gateway to list gateway routes in.

Query parameters

limitinteger

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

meshOwnerstring

The Amazon Web Services 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 <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.

nextTokenstring

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

Response

Success

nextTokenstring

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

All 38 operations