update_hypervisor

update_hypervisor(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.update_hypervisor(
    Host='string',
    HypervisorArn='string',
    LogGroupArn='string',
    Name='string',
    Password='string',
    Username='string'
)
Parameters
  • Host (string) -- The updated host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
  • HypervisorArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the hypervisor to update.

  • LogGroupArn (string) -- The Amazon Resource Name (ARN) of the group of gateways within the requested log.
  • Name (string) -- The updated name for the hypervisor
  • Password (string) -- The updated password for the hypervisor.
  • Username (string) -- The updated username for the hypervisor.
Return type

dict

Returns

Response Syntax

{
    'HypervisorArn': 'string'
}

Response Structure

  • (dict) --

    • HypervisorArn (string) --

      The Amazon Resource Name (ARN) of the hypervisor you updated.

Exceptions

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