Class: AWS.BackupGateway

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.

    • Key — required — (String)

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

    • Value — required — (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.

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.

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.

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.

var params = {
  GatewayArn: 'STRING_VALUE' /* required */
};
backupgateway.getBandwidthRateLimitSchedule(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.

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:

    • BandwidthRateLimitIntervals — (Array<map>)

      An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.

      • AverageUploadRateLimitInBitsPerSec — (Integer)

        The average upload rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the upload rate limit is not set.

        Note: For Backup Gateway, the minimum value is (Value).
      • DaysOfWeek — required — (Array<Integer>)

        The days of the week component of the bandwidth rate limit interval, represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents Saturday.

      • EndHourOfDay — required — (Integer)

        The hour of the day to end the bandwidth rate limit interval.

      • EndMinuteOfHour — required — (Integer)

        The minute of the hour to end the bandwidth rate limit interval.

        The bandwidth rate limit interval ends at the end of the minute. To end an interval at the end of an hour, use the value 59.

      • StartHourOfDay — required — (Integer)

        The hour of the day to start the bandwidth rate limit interval.

      • StartMinuteOfHour — required — (Integer)

        The minute of the hour to start the bandwidth rate limit interval. The interval begins at the start of that minute. To begin an interval exactly at the start of the hour, use the value 0.

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

Returns:

• (AWS.Request) —

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

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.

        • HourOfDay — required — (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.

        • MinuteOfHour — required — (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.

var params = {
  HypervisorArn: 'STRING_VALUE' /* required */
};
backupgateway.getHypervisor(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.

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:

    • Hypervisor — (map)

      Details about the requested hypervisor.

      • 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 KMS used to encrypt the hypervisor.

      • LastSuccessfulMetadataSyncTime — (Date)

        This is the time when the most recent successful sync of metadata occurred.

      • LatestMetadataSyncStatus — (String)

        This is the most recent status for the indicated metadata sync.

        Possible values include:
        • "CREATED"
        • "RUNNING"
        • "FAILED"
        • "PARTIALLY_FAILED"
        • "SUCCEEDED"
      • LatestMetadataSyncStatusMessage — (String)

        This is the most recent status for the indicated metadata sync.

      • LogGroupArn — (String)

        The Amazon Resource Name (ARN) of the group of gateways within the requested log.

      • Name — (String)

        This is the name of the specified hypervisor.

      • State — (String)

        This is the current state of the specified hypervisor.

        The possible states are PENDING, ONLINE, OFFLINE, or ERROR.

        Possible values include:
        • "PENDING"
        • "ONLINE"
        • "OFFLINE"
        • "ERROR"

Returns:

• (AWS.Request) —

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

var params = {
  HypervisorArn: 'STRING_VALUE' /* required */
};
backupgateway.getHypervisorPropertyMappings(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.

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.

    • IamRoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role.

    • VmwareToAwsTagMappings — (Array<map>)

      This is a display of the mappings of on-premises VMware tags to the Amazon Web Services tags.

      • AwsTagKey — required — (String)

        The key part of the Amazon Web Services tag's key-value pair.

      • AwsTagValue — required — (String)

        The value part of the Amazon Web Services tag's key-value pair.

      • VmwareCategory — required — (String)

        The is the category of VMware.

      • VmwareTagName — required — (String)

        This is the user-defined name of a VMware tag.

Returns:

• (AWS.Request) —

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

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.

      • VmwareTags — (Array<map>)

        These are the details of the VMware tags associated with the specified virtual machine.

        • VmwareCategory — (String)

          The is the category of VMware.

        • VmwareTagDescription — (String)

          This is a user-defined description of a VMware tag.

        • VmwareTagName — (String)

          This is the user-defined name of a VMware tag.

Returns:

• (AWS.Request) —

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

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.

    • Key — required — (String)

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

    • Value — required — (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.

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.

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.

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.

      • Key — required — (String)

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

      • Value — required — (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.

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.

var params = {
  BandwidthRateLimitIntervals: [ /* required */
    {
      DaysOfWeek: [ /* required */
        'NUMBER_VALUE',
        /* more items */
      ],
      EndHourOfDay: 'NUMBER_VALUE', /* required */
      EndMinuteOfHour: 'NUMBER_VALUE', /* required */
      StartHourOfDay: 'NUMBER_VALUE', /* required */
      StartMinuteOfHour: 'NUMBER_VALUE', /* required */
      AverageUploadRateLimitInBitsPerSec: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  GatewayArn: 'STRING_VALUE' /* required */
};
backupgateway.putBandwidthRateLimitSchedule(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: {}) —
  • BandwidthRateLimitIntervals — (Array<map>)

    An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.

    • AverageUploadRateLimitInBitsPerSec — (Integer)

      The average upload rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the upload rate limit is not set.

      Note: For Backup Gateway, the minimum value is (Value).
    • DaysOfWeek — required — (Array<Integer>)

      The days of the week component of the bandwidth rate limit interval, represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents Saturday.

    • EndHourOfDay — required — (Integer)

      The hour of the day to end the bandwidth rate limit interval.

    • EndMinuteOfHour — required — (Integer)

      The minute of the hour to end the bandwidth rate limit interval.

      The bandwidth rate limit interval ends at the end of the minute. To end an interval at the end of an hour, use the value 59.

    • StartHourOfDay — required — (Integer)

      The hour of the day to start the bandwidth rate limit interval.

    • StartMinuteOfHour — required — (Integer)

      The minute of the hour to start the bandwidth rate limit interval. The interval begins at the start of that minute. To begin an interval exactly at the start of the hour, use the value 0.

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

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. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

Returns:

• (AWS.Request) —

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

var params = {
  HypervisorArn: 'STRING_VALUE', /* required */
  IamRoleArn: 'STRING_VALUE', /* required */
  VmwareToAwsTagMappings: [ /* required */
    {
      AwsTagKey: 'STRING_VALUE', /* required */
      AwsTagValue: 'STRING_VALUE', /* required */
      VmwareCategory: 'STRING_VALUE', /* required */
      VmwareTagName: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
backupgateway.putHypervisorPropertyMappings(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.

  • IamRoleArn — (String)

    The Amazon Resource Name (ARN) of the IAM role.

  • VmwareToAwsTagMappings — (Array<map>)

    This action requests the mappings of on-premises VMware tags to the Amazon Web Services tags.

    • AwsTagKey — required — (String)

      The key part of the Amazon Web Services tag's key-value pair.

    • AwsTagValue — required — (String)

      The value part of the Amazon Web Services tag's key-value pair.

    • VmwareCategory — required — (String)

      The is the category of VMware.

    • VmwareTagName — required — (String)

      This is the user-defined name of a VMware tag.

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.

Returns:

• (AWS.Request) —

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

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.

var params = {
  HypervisorArn: 'STRING_VALUE' /* required */
};
backupgateway.startVirtualMachinesMetadataSync(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.

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.

Returns:

• (AWS.Request) —

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

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.

    • Key — required — (String)

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

    • Value — required — (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.

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.

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.

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.

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.

var params = {
  HypervisorArn: 'STRING_VALUE', /* required */
  Host: 'STRING_VALUE',
  LogGroupArn: '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.

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

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.