BackupGateway / Client / list_hypervisors

list_hypervisors#

BackupGateway.Client.list_hypervisors(**kwargs)#

Lists your hypervisors.

See also: AWS API Documentation

Request Syntax

response = client.list_hypervisors(
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • MaxResults (integer) – The maximum number of hypervisors to list.

  • NextToken (string) – The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Return type:

dict

Returns:

Response Syntax

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

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.

    • NextToken (string) –

      The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Exceptions

  • BackupGateway.Client.exceptions.ValidationException

  • BackupGateway.Client.exceptions.InternalServerException

  • BackupGateway.Client.exceptions.ThrottlingException