Skip to content

List Gateway Routes

appmesh_list_gateway_routes R Documentation

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

Description

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

Usage

appmesh_list_gateway_routes(limit, meshName, meshOwner, nextToken,
  virtualGatewayName)

Arguments

limit

The maximum number of results returned by list_gateway_routes in paginated output. When you use this parameter, list_gateway_routes 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 list_gateway_routes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, list_gateway_routes returns up to 100 results and a nextToken value if applicable.

meshName

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

meshOwner

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 Working with shared meshes.

nextToken

The nextToken value returned from a previous paginated list_gateway_routes 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.

virtualGatewayName

[required] The name of the virtual gateway to list gateway routes in.

Value

A list with the following syntax: 

list(
  gatewayRoutes = list(
    list(
      arn = "string",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      gatewayRouteName = "string",
      lastUpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      meshName = "string",
      meshOwner = "string",
      resourceOwner = "string",
      version = 123,
      virtualGatewayName = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_gateway_routes(
  limit = 123,
  meshName = "string",
  meshOwner = "string",
  nextToken = "string",
  virtualGatewayName = "string"
)