BackupGateway / Client / get_virtual_machine



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

See also: AWS API Documentation

Request Syntax

response = client.get_virtual_machine(

ResourceArn (string) –


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

Return type:



Response Syntax

    'VirtualMachine': {
        'HostName': 'string',
        'HypervisorId': 'string',
        'LastBackupDate': datetime(2015, 1, 1),
        'Name': 'string',
        'Path': 'string',
        'ResourceArn': 'string',
        'VmwareTags': [
                'VmwareCategory': 'string',
                'VmwareTagDescription': 'string',
                'VmwareTagName': 'string'

Response Structure

  • (dict) –

    • VirtualMachine (dict) –

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

      • HostName (string) –

        The host name of the virtual machine.

      • HypervisorId (string) –

        The ID of the virtual machine’s hypervisor.

      • LastBackupDate (datetime) –

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

      • Name (string) –

        The name of the virtual machine.

      • Path (string) –

        The path of the virtual machine.

      • ResourceArn (string) –

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

      • VmwareTags (list) –

        These are the details of the VMware tags associated with the specified virtual machine.

        • (dict) –

          A VMware tag is a tag attached to a specific virtual machine. A tag is a key-value pair you can use to manage, filter, and search for your resources.

          The content of VMware tags can be matched to Amazon Web Services tags.

          • VmwareCategory (string) –

            The is the category of VMware.

          • VmwareTagDescription (string) –

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

          • VmwareTagName (string) –

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