List Virtual Gateways

appmesh_list_virtual_gateways

R Documentation

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

Description¶

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

Usage¶

appmesh_list_virtual_gateways(limit, meshName, meshOwner, nextToken)

Arguments¶

limit: The maximum number of results returned by list_virtual_gateways in paginated output. When you use this parameter, list_virtual_gateways 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_virtual_gateways request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, list_virtual_gateways returns up to 100 results and a nextToken value if applicable.
meshName: [required] The name of the service mesh to list virtual gateways 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_virtual_gateways 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.

Value¶

A list with the following syntax:

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

Request syntax¶

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