BackupGateway / Paginator / ListVirtualMachines


class BackupGateway.Paginator.ListVirtualMachines#
paginator = client.get_paginator('list_virtual_machines')

Creates an iterator that will paginate through responses from BackupGateway.Client.list_virtual_machines().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • HypervisorArn (string) – The Amazon Resource Name (ARN) of the hypervisor connected to your virtual machine.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



Response Syntax

    'VirtualMachines': [
            'HostName': 'string',
            'HypervisorId': 'string',
            'LastBackupDate': datetime(2015, 1, 1),
            'Name': 'string',
            'Path': 'string',
            'ResourceArn': 'string'

Response Structure

  • (dict) –

    • VirtualMachines (list) –

      A list of your VirtualMachine objects, ordered by their Amazon Resource Names (ARNs).

      • (dict) –

        A virtual machine that is on a hypervisor.

        • 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.