Skip to content
AWS for Query.Farm

aws.backup_gateway.get_virtual_machine

Example SQL Queries

SELECT * FROM
aws.backup_gateway.get_virtual_machine
WHERE
"resource_arn" = 'VALUE';

Description

By providing the ARN (Amazon Resource Name), this API returns the virtual machine.

Table Definition

Column NameColumn Data Type
resource_arn Required Input Column

The Amazon Resource Name (ARN) of the virtual machine.

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_machine

This object contains the basic attributes of VirtualMachine contained by the output of GetVirtualMachine 

STRUCT(
    "host_name" VARCHAR,
    "hypervisor_id" VARCHAR,
    "last_backup_date" TIMESTAMP_S,
    "name" VARCHAR,
    "path" VARCHAR,
    "resource_arn" VARCHAR,
    "vmware_tags" STRUCT(
        "vmware_category" VARCHAR,
        "vmware_tag_description" VARCHAR,
        "vmware_tag_name" VARCHAR
    )[]
)
Show child fields
virtual_machine.host_name

The host name of the virtual machine.

virtual_machine.hypervisor_id

The ID of the virtual machine's hypervisor.

virtual_machine.last_backup_date

The most recent date a virtual machine was backed up, in Unix format and UTC time.

virtual_machine.name

The name of the virtual machine.

virtual_machine.path

The path of the virtual machine.

virtual_machine.resource_arn

The Amazon Resource Name (ARN) of the virtual machine. For example, arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL.

virtual_machine.vmware_tags[]
Show child fields
virtual_machine.vmware_tags[].vmware_category

The is the category of VMware.

virtual_machine.vmware_tags[].vmware_tag_description

This is a user-defined description of a VMware tag.

virtual_machine.vmware_tags[].vmware_tag_name

This is the user-defined name of a VMware tag.