TestHypervisorConfiguration
Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
Request Syntax
{
"GatewayArn": "string",
"Host": "string",
"Password": "string",
"Username": "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.
- GatewayArn
-
The Amazon Resource Name (ARN) of the gateway to the hypervisor to test.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 180.
Pattern:
^arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+$Required: Yes
- Host
-
The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
Type: String
Length Constraints: Minimum length of 3. Maximum length of 128.
Pattern:
^.+$Required: Yes
- Password
-
The password for the hypervisor.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[ -~]+$Required: No
- Username
-
The username for the hypervisor.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$Required: No
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
The operation cannot proceed because it is not supported.
HTTP Status Code: 400
- InternalServerException
-
The operation did not succeed because an internal error occurred. Try again later.
HTTP Status Code: 500
- ResourceNotFoundException
-
A resource that is required for the action wasn't found.
HTTP Status Code: 400
- ThrottlingException
-
TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400
- ValidationException
-
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 AWS SDKs, see the following:
