You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.BackupGateway

Inherits:
AWS.Service show all
Identifier:
backupgateway
API Version:
2021-01-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Backup gateway connects Backup to your hypervisor, so you can create, store, and restore backups of your virtual machines (VMs) anywhere, whether on-premises or in the VMware Cloud (VMC) on Amazon Web Services.

Add on-premises resources by connecting to a hypervisor through a gateway. Backup will automatically discover the resources in your hypervisor.

Use Backup to assign virtual or on-premises resources to a backup plan, or run on-demand backups. Once you have backed up your resources, you can view them and restore them like any resource supported by Backup.

To download the Amazon Web Services software to get started, navigate to the Backup console, choose Gateways, then choose Create gateway.

Sending a Request Using BackupGateway

var backupgateway = new AWS.BackupGateway();
backupgateway.associateGatewayToServer(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the BackupGateway object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var backupgateway = new AWS.BackupGateway({apiVersion: '2021-01-01'});

You can also set the API version globally in AWS.config.apiVersions using the backupgateway service identifier:

AWS.config.apiVersions = {
  backupgateway: '2021-01-01',
  // other service API versions
};

var backupgateway = new AWS.BackupGateway();

Version:

  • 2021-01-01

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.BackupGateway(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a BackupGateway object

var backupgateway = new AWS.BackupGateway({apiVersion: '2021-01-01'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.BackupGateway.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.BackupGateway.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.BackupGateway.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

associateGatewayToServer(params = {}, callback) ⇒ AWS.Request

Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.

Service Reference:

Examples:

Calling the associateGatewayToServer operation

var params = {
  GatewayArn: 'STRING_VALUE', /* required */
  ServerArn: 'STRING_VALUE' /* required */
};
backupgateway.associateGatewayToServer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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.

    • ServerArn — (String)

      The Amazon Resource Name (ARN) of the server that hosts your virtual machines.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GatewayArn — (String)

        The Amazon Resource Name (ARN) of a gateway.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createGateway(params = {}, callback) ⇒ AWS.Request

Creates a backup gateway. After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation.

Service Reference:

Examples:

Calling the createGateway operation

var params = {
  ActivationKey: 'STRING_VALUE', /* required */
  GatewayDisplayName: 'STRING_VALUE', /* required */
  GatewayType: BACKUP_VM, /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
backupgateway.createGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ActivationKey — (String)

      The activation key of the created gateway.

    • GatewayDisplayName — (String)

      The display name of the created gateway.

    • GatewayType — (String)

      The type of created gateway.

      Possible values include:
      • "BACKUP_VM"
    • Tags — (Array<map>)

      A list of up to 50 tags to assign to the gateway. Each tag is a key-value pair.

      • Keyrequired — (String)

        The key part of a tag's key-value pair. The key can't start with aws:.

      • Valuerequired — (String)

        The value part of a tag's key-value pair.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GatewayArn — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteGateway(params = {}, callback) ⇒ AWS.Request

Deletes a backup gateway.

Service Reference:

Examples:

Calling the deleteGateway operation

var params = {
  GatewayArn: 'STRING_VALUE' /* required */
};
backupgateway.deleteGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GatewayArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GatewayArn — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteHypervisor(params = {}, callback) ⇒ AWS.Request

Deletes a hypervisor.

Service Reference:

Examples:

Calling the deleteHypervisor operation

var params = {
  HypervisorArn: 'STRING_VALUE' /* required */
};
backupgateway.deleteHypervisor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • HypervisorArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HypervisorArn — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disassociateGatewayFromServer(params = {}, callback) ⇒ AWS.Request

Disassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway can no longer access the virtual machines on the server.

Service Reference:

Examples:

Calling the disassociateGatewayFromServer operation

var params = {
  GatewayArn: 'STRING_VALUE' /* required */
};
backupgateway.disassociateGatewayFromServer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GatewayArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GatewayArn — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getGateway(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getGateway operation

var params = {
  GatewayArn: 'STRING_VALUE' /* required */
};
backupgateway.getGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GatewayArn — (String)

      The Amazon Resource Name (ARN) of the gateway.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Gateway — (map)

        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.

          Possible values include:
          • "BACKUP_VM"
        • HypervisorId — (String)

          The hypervisor ID of the gateway.

        • LastSeenTime — (Date)

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

        • MaintenanceStartTime — (map)

          Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. Can be weekly or monthly.

          • DayOfMonth — (Integer)

            The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.

          • DayOfWeek — (Integer)

            An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and 6 represents Saturday. The day of week is in the time zone of the gateway.

          • HourOfDayrequired — (Integer)

            The hour component of the maintenance start time represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

          • MinuteOfHourrequired — (Integer)

            The minute component of the maintenance start time represented as mm, where mm is the minute (0 to 59). The minute of the hour is in the time zone of the gateway.

        • NextUpdateAvailabilityTime — (Date)

          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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getVirtualMachine(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getVirtualMachine operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
backupgateway.getVirtualMachine(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the virtual machine.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VirtualMachine — (map)

        This object contains the basic attributes of VirtualMachine contained by the output of GetVirtualMachine

        • HostName — (String)

          The host name of the virtual machine.

        • HypervisorId — (String)

          The ID of the virtual machine's hypervisor.

        • LastBackupDate — (Date)

          The most recent date a virtual machine was backed up, in Unix format and UTC time.

        • Name — (String)

          The name of the virtual machine.

        • Path — (String)

          The path of the virtual machine.

        • ResourceArn — (String)

          The Amazon Resource Name (ARN) of the virtual machine. For example, arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

importHypervisorConfiguration(params = {}, callback) ⇒ AWS.Request

Connect to a hypervisor by importing its configuration.

Service Reference:

Examples:

Calling the importHypervisorConfiguration operation

var params = {
  Host: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  KmsKeyArn: 'STRING_VALUE',
  Password: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  Username: 'STRING_VALUE'
};
backupgateway.importHypervisorConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Host — (String)

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

    • KmsKeyArn — (String)

      The Key Management Service for the hypervisor.

    • Name — (String)

      The name of the hypervisor.

    • Password — (String)

      The password for the hypervisor.

    • Tags — (Array<map>)

      The tags of the hypervisor configuration to import.

      • Keyrequired — (String)

        The key part of a tag's key-value pair. The key can't start with aws:.

      • Valuerequired — (String)

        The value part of a tag's key-value pair.

    • Username — (String)

      The username for the hypervisor.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HypervisorArn — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listGateways(params = {}, callback) ⇒ AWS.Request

Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN).

Service Reference:

Examples:

Calling the listGateways operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backupgateway.listGateways(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (Integer)

      The maximum number of gateways to list.

    • NextToken — (String)

      The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Gateways — (Array<map>)

        A list of your gateways.

        • 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.

          Possible values include:
          • "BACKUP_VM"
        • HypervisorId — (String)

          The hypervisor ID of the gateway.

        • LastSeenTime — (Date)

          The last time Backup gateway communicated with the gateway, in Unix format and UTC time.

      • NextToken — (String)

        The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listHypervisors(params = {}, callback) ⇒ AWS.Request

Lists your hypervisors.

Service Reference:

Examples:

Calling the listHypervisors operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backupgateway.listHypervisors(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (Integer)

      The maximum number of hypervisors to list.

    • NextToken — (String)

      The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Hypervisors — (Array<map>)

        A list of your Hypervisor objects, ordered by their Amazon Resource Names (ARNs).

        • Host — (String)

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

        • HypervisorArn — (String)

          The Amazon Resource Name (ARN) of the hypervisor.

        • KmsKeyArn — (String)

          The Amazon Resource Name (ARN) of the Key Management Service used to encrypt the hypervisor.

        • Name — (String)

          The name of the hypervisor.

        • State — (String)

          The state of the hypervisor.

          Possible values include:
          • "PENDING"
          • "ONLINE"
          • "OFFLINE"
          • "ERROR"
      • NextToken — (String)

        The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
backupgateway.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource's tags to list.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourceArn — (String)

        The Amazon Resource Name (ARN) of the resource's tags that you listed.

      • Tags — (Array<map>)

        A list of the resource's tags.

        • Keyrequired — (String)

          The key part of a tag's key-value pair. The key can't start with aws:.

        • Valuerequired — (String)

          The value part of a tag's key-value pair.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listVirtualMachines(params = {}, callback) ⇒ AWS.Request

Lists your virtual machines.

Service Reference:

Examples:

Calling the listVirtualMachines operation

var params = {
  HypervisorArn: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backupgateway.listVirtualMachines(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • HypervisorArn — (String)

      The Amazon Resource Name (ARN) of the hypervisor connected to your virtual machine.

    • MaxResults — (Integer)

      The maximum number of virtual machines to list.

    • NextToken — (String)

      The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

      • VirtualMachines — (Array<map>)

        A list of your VirtualMachine objects, ordered by their Amazon Resource Names (ARNs).

        • HostName — (String)

          The host name of the virtual machine.

        • HypervisorId — (String)

          The ID of the virtual machine's hypervisor.

        • LastBackupDate — (Date)

          The most recent date a virtual machine was backed up, in Unix format and UTC time.

        • Name — (String)

          The name of the virtual machine.

        • Path — (String)

          The path of the virtual machine.

        • ResourceArn — (String)

          The Amazon Resource Name (ARN) of the virtual machine. For example, arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putMaintenanceStartTime(params = {}, callback) ⇒ AWS.Request

Set the maintenance start time for a gateway.

Service Reference:

Examples:

Calling the putMaintenanceStartTime operation

var params = {
  GatewayArn: 'STRING_VALUE', /* required */
  HourOfDay: 'NUMBER_VALUE', /* required */
  MinuteOfHour: 'NUMBER_VALUE', /* required */
  DayOfMonth: 'NUMBER_VALUE',
  DayOfWeek: 'NUMBER_VALUE'
};
backupgateway.putMaintenanceStartTime(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DayOfMonth — (Integer)

      The day of the month start maintenance on a gateway.

      Valid values range from Sunday to Saturday.

    • DayOfWeek — (Integer)

      The day of the week to start maintenance on a gateway.

    • GatewayArn — (String)

      The Amazon Resource Name (ARN) for the gateway, used to specify its maintenance start time.

    • HourOfDay — (Integer)

      The hour of the day to start maintenance on a gateway.

    • MinuteOfHour — (Integer)

      The minute of the hour to start maintenance on a gateway.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GatewayArn — (String)

        The Amazon Resource Name (ARN) of a gateway for which you set the maintenance start time.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Tag the resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
backupgateway.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceARN — (String)

      The Amazon Resource Name (ARN) of the resource to tag.

    • Tags — (Array<map>)

      A list of tags to assign to the resource.

      • Keyrequired — (String)

        The key part of a tag's key-value pair. The key can't start with aws:.

      • Valuerequired — (String)

        The value part of a tag's key-value pair.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourceARN — (String)

        The Amazon Resource Name (ARN) of the resource you tagged.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

testHypervisorConfiguration(params = {}, callback) ⇒ AWS.Request

Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.

Service Reference:

Examples:

Calling the testHypervisorConfiguration operation

var params = {
  GatewayArn: 'STRING_VALUE', /* required */
  Host: 'STRING_VALUE', /* required */
  Password: 'STRING_VALUE',
  Username: 'STRING_VALUE'
};
backupgateway.testHypervisorConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GatewayArn — (String)

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

    • Host — (String)

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

    • Password — (String)

      The password for the hypervisor.

    • Username — (String)

      The username for the hypervisor.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from the resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
backupgateway.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceARN — (String)

      The Amazon Resource Name (ARN) of the resource from which to remove tags.

    • TagKeys — (Array<String>)

      The list of tag keys specifying which tags to remove.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourceARN — (String)

        The Amazon Resource Name (ARN) of the resource from which you removed tags.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateGatewayInformation(params = {}, callback) ⇒ AWS.Request

Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.

Service Reference:

Examples:

Calling the updateGatewayInformation operation

var params = {
  GatewayArn: 'STRING_VALUE', /* required */
  GatewayDisplayName: 'STRING_VALUE'
};
backupgateway.updateGatewayInformation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GatewayArn — (String)

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

    • GatewayDisplayName — (String)

      The updated display name of the gateway.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GatewayArn — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateGatewaySoftwareNow(params = {}, callback) ⇒ AWS.Request

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

Note: When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete.

Service Reference:

Examples:

Calling the updateGatewaySoftwareNow operation

var params = {
  GatewayArn: 'STRING_VALUE' /* required */
};
backupgateway.updateGatewaySoftwareNow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GatewayArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GatewayArn — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateHypervisor(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the updateHypervisor operation

var params = {
  HypervisorArn: 'STRING_VALUE', /* required */
  Host: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  Password: 'STRING_VALUE',
  Username: 'STRING_VALUE'
};
backupgateway.updateHypervisor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Host — (String)

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

    • HypervisorArn — (String)

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

    • Name — (String)

      The updated name for the hypervisor

    • Password — (String)

      The updated password for the hypervisor.

    • Username — (String)

      The updated username for the hypervisor.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HypervisorArn — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.