AWS Backup Gateway

Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.

See also: AWS API Documentation

Request Syntax

client.update_gateway_software_now(
    GatewayArn='string'
)

type GatewayArn:

string

param GatewayArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the gateway to be updated.

rtype:

dict

returns:

Response Syntax

{
    'GatewayArn': 'string'
}

Response Structure

• (dict) --

  • GatewayArn (string) --

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

By providing the ARN (Amazon Resource Name), this API returns the gateway.

See also: AWS API Documentation

Request Syntax

client.get_gateway(
    GatewayArn='string'
)

type GatewayArn:

string

param GatewayArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the gateway.

rtype:

dict

returns:

Response Syntax

{
    'Gateway': {
        'GatewayArn': 'string',
        'GatewayDisplayName': 'string',
        'GatewayType': 'BACKUP_VM',
        'HypervisorId': 'string',
        'LastSeenTime': datetime(2015, 1, 1),
        'NextUpdateAvailabilityTime': datetime(2015, 1, 1),
        'VpcEndpoint': 'string'
    }
}

Response Structure

• (dict) --

  • Gateway (dict) --

    By providing the ARN (Amazon Resource Name), this API returns the gateway.

    • GatewayArn (string) --

      The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    • GatewayDisplayName (string) --

      The display name of the gateway.

    • GatewayType (string) --

      The type of the gateway type.

    • HypervisorId (string) --

      The hypervisor ID of the gateway.

    • LastSeenTime (datetime) --

      Details showing the last time Backup gateway communicated with the cloud, in Unix format and UTC time.

    • NextUpdateAvailabilityTime (datetime) --

      Details showing the next update availability time of the gateway.

    • VpcEndpoint (string) --

      The DNS name for the virtual private cloud (VPC) endpoint the gateway uses to connect to the cloud for backup gateway.

{'Name': 'string'}

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

client.update_hypervisor(
    Host='string',
    HypervisorArn='string',
    Name='string',
    Password='string',
    Username='string'
)

type Host:

string

param Host:

The updated host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).

type HypervisorArn:

string

param HypervisorArn:

[REQUIRED]

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

type Name:

string

param Name:

The updated name for the hypervisor

type Password:

string

param Password:

The updated password for the hypervisor.

type Username:

string

param Username:

The updated username for the hypervisor.

rtype:

dict

returns:

Response Syntax

{
    'HypervisorArn': 'string'
}

Response Structure

• (dict) --

  • HypervisorArn (string) --

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