Skip to content

aws.appmesh.describe_virtual_service

Example SQL Queries

SELECT * FROM
aws.appmesh.describe_virtual_service
WHERE
"mesh_name" = 'VALUE'
AND "virtual_service_name" = 'VALUE';

Description

Describes an existing virtual service.

Table Definition

Column NameColumn Data Type
mesh_name Required Input Column

The name of the service mesh that the virtual service resides in.

VARCHAR
virtual_service_name Required Input Column

The name of the virtual service to describe.

VARCHAR
mesh_owner Input Column

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.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
virtual_service

The full description of your virtual service.

STRUCT(
"mesh_name" VARCHAR,
"metadata" STRUCT(
"arn" VARCHAR,
"created_at" TIMESTAMP_S,
"last_updated_at" TIMESTAMP_S,
"mesh_owner" VARCHAR,
"resource_owner" VARCHAR,
"uid" VARCHAR,
"version" BIGINT
),
"spec" STRUCT(
"provider" STRUCT(
"virtual_node" STRUCT(
"virtual_node_name" VARCHAR
),
"virtual_router" STRUCT(
"virtual_router_name" VARCHAR
)
)
),
"status" STRUCT(
"status" VARCHAR
),
"virtual_service_name" VARCHAR
)
Show child fields
virtual_service.mesh_name

The name of the service mesh that the virtual service resides in.

virtual_service.metadata

An object that represents metadata for a resource.

Show child fields
virtual_service.metadata.arn

The full Amazon Resource Name (ARN) for the resource.

virtual_service.metadata.created_at

The Unix epoch timestamp in seconds for when the resource was created.

virtual_service.metadata.last_updated_at

The Unix epoch timestamp in seconds for when the resource was last updated.

virtual_service.metadata.mesh_owner

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.

virtual_service.metadata.resource_owner

The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.

virtual_service.metadata.uid

The unique identifier for the resource.

virtual_service.metadata.version

The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

virtual_service.spec

The specifications of the virtual service.

Show child fields
virtual_service.spec.provider

The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.

Show child fields
virtual_service.spec.provider.virtual_node

The virtual node associated with a virtual service.

Show child fields
virtual_service.spec.provider.virtual_node.virtual_node_name

The name of the virtual node that is acting as a service provider.

virtual_service.spec.provider.virtual_router

The virtual router associated with a virtual service.

Show child fields
virtual_service.spec.provider.virtual_router.virtual_router_name

The name of the virtual router that is acting as a service provider.

virtual_service.status

The current status of the virtual service.

Show child fields
virtual_service.status.status

The current status of the virtual service.

virtual_service.virtual_service_name

The name of the virtual service.