Skip to content

Describe Virtual Service

appmesh_describe_virtual_service R Documentation

Describes an existing virtual service

Description

Describes an existing virtual service.

Usage

appmesh_describe_virtual_service(meshName, meshOwner,
  virtualServiceName)

Arguments

meshName

[required] The name of the service mesh that the virtual service resides 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.

virtualServiceName

[required] The name of the virtual service to describe.

Value

A list with the following syntax:

list(
  virtualService = list(
    meshName = "string",
    metadata = list(
      arn = "string",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      lastUpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      meshOwner = "string",
      resourceOwner = "string",
      uid = "string",
      version = 123
    ),
    spec = list(
      provider = list(
        virtualNode = list(
          virtualNodeName = "string"
        ),
        virtualRouter = list(
          virtualRouterName = "string"
        )
      )
    ),
    status = list(
      status = "ACTIVE"|"INACTIVE"|"DELETED"
    ),
    virtualServiceName = "string"
  )
)

Request syntax

svc$describe_virtual_service(
  meshName = "string",
  meshOwner = "string",
  virtualServiceName = "string"
)