:doc:`BackupGateway <../../backup-gateway>` / Paginator / ListHypervisors

***************
ListHypervisors
***************



.. py:class:: BackupGateway.Paginator.ListHypervisors

  ::

    
    paginator = client.get_paginator('list_hypervisors')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`BackupGateway.Client.list_hypervisors`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ListHypervisors>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'Hypervisors': [
                {
                    'Host': 'string',
                    'HypervisorArn': 'string',
                    'KmsKeyArn': 'string',
                    'Name': 'string',
                    'State': 'PENDING'|'ONLINE'|'OFFLINE'|'ERROR'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Hypervisors** *(list) --* 

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

          
          

          - *(dict) --* 

            Represents the hypervisor's permissions to which the gateway will connect.

             

            A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.

            
            

            - **Host** *(string) --* 

              The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).

              
            

            - **HypervisorArn** *(string) --* 

              The Amazon Resource Name (ARN) of the hypervisor.

              
            

            - **KmsKeyArn** *(string) --* 

              The Amazon Resource Name (ARN) of the Key Management Service used to encrypt the hypervisor.

              
            

            - **Name** *(string) --* 

              The name of the hypervisor.

              
            

            - **State** *(string) --* 

              The state of the hypervisor.

              
        
      
    