Updates a hypervisor metadata, including its host, username, and password. Specify which hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your request.
Request Syntax
{
"Host": "string",
"HypervisorArn": "string",
"LogGroupArn": "string",
"Name": "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.
- Host
-
The updated 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: No
- HypervisorArn
-
The Amazon Resource Name (ARN) of the hypervisor to update.
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
- LogGroupArn
-
The Amazon Resource Name (ARN) of the group of gateways within the requested log.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
^$|^arn:(aws|aws-cn|aws-us-gov):logs:([a-zA-Z0-9-]+):([0-9]+):log-group:[a-zA-Z0-9_\-\/\.]+:\*$Required: No
- Name
-
The updated name for the hypervisor
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[a-zA-Z0-9-]*$Required: No
- Password
-
The updated password for the hypervisor.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[ -~]+$Required: No
- Username
-
The updated username for the hypervisor.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$Required: No
Response Syntax
{
"HypervisorArn": "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.
- HypervisorArn
-
The Amazon Resource Name (ARN) of the hypervisor you updated.
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]+$
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The operation cannot proceed because you have insufficient permissions.
HTTP Status Code: 400
- 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:
