get_hypervisor

BackupGateway.Client.get_hypervisor(**kwargs)

This action requests information about the specified hypervisor to which the gateway will connect. A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.

See also: AWS API Documentation

Request Syntax

response = client.get_hypervisor(
    HypervisorArn='string'
)

Parameters

HypervisorArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the hypervisor.

Return type

dict

Returns

Response Syntax

{
    'Hypervisor': {
        'Host': 'string',
        'HypervisorArn': 'string',
        'KmsKeyArn': 'string',
        'LastSuccessfulMetadataSyncTime': datetime(2015, 1, 1),
        'LatestMetadataSyncStatus': 'CREATED'|'RUNNING'|'FAILED'|'PARTIALLY_FAILED'|'SUCCEEDED',
        'LatestMetadataSyncStatusMessage': 'string',
        'LogGroupArn': 'string',
        'Name': 'string',
        'State': 'PENDING'|'ONLINE'|'OFFLINE'|'ERROR'
    }
}

Response Structure

• (dict) --
  • Hypervisor (dict) --

    Details about the requested hypervisor.

    • 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 KMS used to encrypt the hypervisor.

    • LastSuccessfulMetadataSyncTime (datetime) --

      This is the time when the most recent successful sync of metadata occurred.

    • LatestMetadataSyncStatus (string) --

      This is the most recent status for the indicated metadata sync.

    • LatestMetadataSyncStatusMessage (string) --

      This is the most recent status for the indicated metadata sync.

    • LogGroupArn (string) --

      The Amazon Resource Name (ARN) of the group of gateways within the requested log.

    • Name (string) --

      This is the name of the specified hypervisor.

    • State (string) --

      This is the current state of the specified hypervisor.

      The possible states are PENDING , ONLINE , OFFLINE , or ERROR .

Exceptions

• BackupGateway.Client.exceptions.ValidationException
• BackupGateway.Client.exceptions.InternalServerException
• BackupGateway.Client.exceptions.ResourceNotFoundException
• BackupGateway.Client.exceptions.ThrottlingException