GetHypervisor - Amazon Backup
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


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.

Request Syntax

{ "HypervisorArn": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


The Amazon Resource Name (ARN) of the hypervisor.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Pattern: ^arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+$

Required: Yes

Response Syntax

{ "Hypervisor": { "Host": "string", "HypervisorArn": "string", "KmsKeyArn": "string", "LastSuccessfulMetadataSyncTime": number, "LatestMetadataSyncStatus": "string", "LatestMetadataSyncStatusMessage": "string", "LogGroupArn": "string", "Name": "string", "State": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


Details about the requested hypervisor.

Type: HypervisorDetails object


For information about the errors that are common to all actions, see Common Errors.


The operation did not succeed because an internal error occurred. Try again later.

HTTP Status Code: 500


A resource that is required for the action wasn't found.

HTTP Status Code: 400


TPS has been limited to protect against intentional or unintentional high request volumes.

HTTP Status Code: 400


The operation did not succeed because a validation error occurred.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: