Class: AWS.StorageGateway

Inherits:
AWS.Service show all
Identifier:
storagegateway
API Version:
2013-06-30
Defined in:
(unknown)

Overview

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

Service Description

AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and the AWS storage infrastructure. The service enables you to securely upload data to the AWS cloud for cost effective backup and rapid disaster recovery.

Use the following links to get started using the AWS Storage Gateway Service API Reference:

Note: AWS Storage Gateway resource IDs are in uppercase. When you use these resource IDs with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use this ID with the EC2 API, you must change it to vol-aa22bb012345daf670. Otherwise, the EC2 API might not behave as expected.

IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes are changing to a longer format. Starting in December 2016, all new volumes and snapshots will be created with a 17-character string. Starting in April 2016, you will be able to use these longer IDs so you can test your systems with the new format. For more information, see Longer EC2 and EBS Resource IDs.

For example, a volume Amazon Resource Name (ARN) with the longer volume ID format looks like the following:

arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.

A snapshot ID with the longer ID format looks like the following: snap-78e226633445566ee.

For more information, see Announcement: Heads-up – Longer AWS Storage Gateway volume and snapshot IDs coming in 2016.

Sending a Request Using StorageGateway

var storagegateway = new AWS.StorageGateway();
storagegateway.activateGateway(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 StorageGateway object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var storagegateway = new AWS.StorageGateway({apiVersion: '2013-06-30'});

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

AWS.config.apiVersions = {
  storagegateway: '2013-06-30',
  // other service API versions
};

var storagegateway = new AWS.StorageGateway();

Version:

  • 2013-06-30

Constructor Summary

Property Summary

Properties inherited from AWS.Service

apiVersions

Method Summary

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a StorageGateway object

var storagegateway = new AWS.StorageGateway({apiVersion: '2013-06-30'});

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) —

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

  • 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.StorageGateway.region for more information.

  • maxRetries (Integer) —

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

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.StorageGateway.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.

  • 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 returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • 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) —

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

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

Property Details

endpoint ⇒ AWS.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

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

Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the region you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account; for more information, see UpdateGatewayInformation.

Note: You must turn on the gateway VM before you can activate your gateway.

Service Reference:

Examples:

To activate the gateway


/* Activates the gateway you previously deployed on your host. */

 var params = {
  ActivationKey: "29AV1-3OFV9-VVIUB-NKT0I-LRO6V", 
  GatewayName: "My_Gateway", 
  GatewayRegion: "us-east-1", 
  GatewayTimezone: "GMT-12:00", 
  GatewayType: "STORED", 
  MediumChangerType: "AWS-Gateway-VTL", 
  TapeDriveType: "IBM-ULT3580-TD5"
 };
 storagegateway.activateGateway(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B"
   }
   */
 });

Calling the activateGateway operation

var params = {
  ActivationKey: 'STRING_VALUE', /* required */
  GatewayName: 'STRING_VALUE', /* required */
  GatewayRegion: 'STRING_VALUE', /* required */
  GatewayTimezone: 'STRING_VALUE', /* required */
  GatewayType: 'STRING_VALUE',
  MediumChangerType: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  TapeDriveType: 'STRING_VALUE'
};
storagegateway.activateGateway(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)

      Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.

      For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html in the Storage Gateway User Guide.

    • GatewayName — (String)

      The name you configured for your gateway.

    • GatewayTimezone — (String)

      A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.

    • GatewayRegion — (String)

      A value that indicates the region where you want to store your data. The gateway region specified must be the same region as the region in your Host header in the request. For more information about available regions and endpoints for AWS Storage Gateway, see Regions and Endpoints in the Amazon Web Services Glossary.

      Valid Values: See AWS Storage Gateway Regions and Endpoints in the AWS General Reference.

    • GatewayType — (String)

      A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED.

      Valid Values: "STORED", "CACHED", "VTL", "FILE_S3"

    • TapeDriveType — (String)

      The value that indicates the type of tape drive to use for tape gateway. This field is optional.

      Valid Values: "IBM-ULT3580-TD5"

    • MediumChangerType — (String)

      The value that indicates the type of medium changer to use for tape gateway. This field is optional.

      Valid Values: "STK-L700", "AWS-Gateway-VTL"

    • Tags — (Array<map>)

      A list of up to 50 tags that can be assigned to the gateway. Each tag is a key-value pair.

      Note: Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
      • Key — required — (String)

        Tag key (String). The key can't start with aws:.

      • Value — required — (String)

        Value of the tag key.

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

Returns:

  • (AWS.Request) —

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

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

Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape and file gateway type (see Storage Gateway Concepts).

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.

Service Reference:

Examples:

To add a cache


/* The following example shows a request that activates a gateway-stored volume. */

 var params = {
  DiskIds: [
     "pci-0000:03:00.0-scsi-0:0:0:0", 
     "pci-0000:03:00.0-scsi-0:0:1:0"
  ], 
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
 };
 storagegateway.addCache(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
   }
   */
 });

Calling the addCache operation

var params = {
  DiskIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  GatewayARN: 'STRING_VALUE' /* required */
};
storagegateway.addCache(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 region.

    • DiskIds — (Array<String>)

      An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

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

Returns:

  • (AWS.Request) —

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

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

Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following AWS Storage Gateway resources:

  • Storage gateways of all types

  • Storage volumes

  • Virtual tapes

  • NFS and SMB file shares

You can create a maximum of 50 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags.

Service Reference:

Examples:

To add tags to resource


/* Adds one or more tags to the specified resource. */

 var params = {
  ResourceARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B", 
  Tags: [
     {
    Key: "Dev Gatgeway Region", 
    Value: "East Coast"
   }
  ]
 };
 storagegateway.addTagsToResource(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ResourceARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B"
   }
   */
 });

Calling the addTagsToResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
storagegateway.addTagsToResource(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 you want to add tags to.

    • Tags — (Array<map>)

      The key-value pair that represents the tag you want to add to the resource. The value can be an empty string.

      Note: Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
      • Key — required — (String)

        Tag key (String). The key can't start with aws:.

      • Value — required — (String)

        Value of the tag key.

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 want to add tags to.

Returns:

  • (AWS.Request) —

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

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

Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume and tape gateway types.

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer.

Service Reference:

Examples:

To add upload buffer on local disk


/* Configures one or more gateway local disks as upload buffer for a specified gateway. */

 var params = {
  DiskIds: [
     "pci-0000:03:00.0-scsi-0:0:0:0", 
     "pci-0000:03:00.0-scsi-0:0:1:0"
  ], 
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
 };
 storagegateway.addUploadBuffer(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
   }
   */
 });

Calling the addUploadBuffer operation

var params = {
  DiskIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  GatewayARN: 'STRING_VALUE' /* required */
};
storagegateway.addUploadBuffer(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 region.

    • DiskIds — (Array<String>)

      An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

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

Returns:

  • (AWS.Request) —

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

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

Configures one or more gateway local disks as working storage for a gateway. This operation is only supported in the stored volume gateway type. This operation is deprecated in cached volume API version 20120630. Use AddUploadBuffer instead.

Note: Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to add upload buffer to a stored volume gateway.

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage.

Service Reference:

Examples:

To add storage on local disk


/* Configures one or more gateway local disks as working storage for a gateway. (Working storage is also referred to as upload buffer.) */

 var params = {
  DiskIds: [
     "pci-0000:03:00.0-scsi-0:0:0:0", 
     "pci-0000:03:00.0-scsi-0:0:1:0"
  ], 
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
 };
 storagegateway.addWorkingStorage(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
   }
   */
 });

Calling the addWorkingStorage operation

var params = {
  DiskIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  GatewayARN: 'STRING_VALUE' /* required */
};
storagegateway.addWorkingStorage(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 region.

    • DiskIds — (Array<String>)

      An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

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

Returns:

  • (AWS.Request) —

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

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

Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance.

Service Reference:

Examples:

Calling the attachVolume operation

var params = {
  GatewayARN: 'STRING_VALUE', /* required */
  NetworkInterfaceId: 'STRING_VALUE', /* required */
  VolumeARN: 'STRING_VALUE', /* required */
  DiskId: 'STRING_VALUE',
  TargetName: 'STRING_VALUE'
};
storagegateway.attachVolume(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 that you want to attach the volume to.

    • TargetName — (String)

      The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

      If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

    • VolumeARN — (String)

      The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.

    • NetworkInterfaceId — (String)

      The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

      Valid Values: A valid IP address.

    • DiskId — (String)

      The unique device ID or other distinguishing data that identifies the local disk used to create the volume. This value is only required when you are attaching a stored volume.

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:

      • VolumeARN — (String)

        The Amazon Resource Name (ARN) of the volume that was attached to the gateway.

      • TargetARN — (String)

        The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name for the initiator that was used to connect to the target.

Returns:

  • (AWS.Request) —

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

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

Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. This operation is only supported in the tape gateway type.

Service Reference:

Examples:

To cancel virtual tape archiving


/* Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 
  TapeARN: "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4"
 };
 storagegateway.cancelArchival(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    TapeARN: "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4"
   }
   */
 });

Calling the cancelArchival operation

var params = {
  GatewayARN: 'STRING_VALUE', /* required */
  TapeARN: 'STRING_VALUE' /* required */
};
storagegateway.cancelArchival(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 region.

    • TapeARN — (String)

      The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving for.

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:

      • TapeARN — (String)

        The Amazon Resource Name (ARN) of the virtual tape for which archiving was canceled.

Returns:

  • (AWS.Request) —

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

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

Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS. This operation is only supported in the tape gateway type.

Service Reference:

Examples:

To cancel virtual tape retrieval


/* Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 
  TapeARN: "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4"
 };
 storagegateway.cancelRetrieval(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    TapeARN: "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4"
   }
   */
 });

Calling the cancelRetrieval operation

var params = {
  GatewayARN: 'STRING_VALUE', /* required */
  TapeARN: 'STRING_VALUE' /* required */
};
storagegateway.cancelRetrieval(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 region.

    • TapeARN — (String)

      The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.

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:

      • TapeARN — (String)

        The Amazon Resource Name (ARN) of the virtual tape for which retrieval was canceled.

Returns:

  • (AWS.Request) —

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

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

Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type.

Note: Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway.

In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes.

Service Reference:

Examples:

To create a cached iSCSI volume


/* Creates a cached volume on a specified cached gateway. */

 var params = {
  ClientToken: "cachedvol112233", 
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 
  NetworkInterfaceId: "10.1.1.1", 
  SnapshotId: "snap-f47b7b94", 
  TargetName: "my-volume", 
  VolumeSizeInBytes: 536870912000
 };
 storagegateway.createCachediSCSIVolume(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    TargetARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume", 
    VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
   }
   */
 });

Calling the createCachediSCSIVolume operation

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  GatewayARN: 'STRING_VALUE', /* required */
  NetworkInterfaceId: 'STRING_VALUE', /* required */
  TargetName: 'STRING_VALUE', /* required */
  VolumeSizeInBytes: 'NUMBER_VALUE', /* required */
  KMSEncrypted: true || false,
  KMSKey: 'STRING_VALUE',
  SnapshotId: 'STRING_VALUE',
  SourceVolumeARN: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
storagegateway.createCachediSCSIVolume(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 region.

    • VolumeSizeInBytes — (Integer)

      The size of the volume in bytes.

    • SnapshotId — (String)

      The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

    • TargetName — (String)

      The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

      If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

    • SourceVolumeARN — (String)

      The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

    • NetworkInterfaceId — (String)

      The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

      Valid Values: A valid IP address.

    • ClientToken — (String)

      A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.

    • KMSEncrypted — (Boolean)

      True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

    • KMSKey — (String)

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

    • Tags — (Array<map>)

      A list of up to 50 tags that can be assigned to a cached volume. Each tag is a key-value pair.

      Note: Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
      • Key — required — (String)

        Tag key (String). The key can't start with aws:.

      • Value — required — (String)

        Value of the tag key.

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:

      • VolumeARN — (String)

        The Amazon Resource Name (ARN) of the configured volume.

      • TargetARN — (String)

        The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target.

Returns:

  • (AWS.Request) —

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

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

Creates a Network File System (NFS) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using a NFS interface. This operation is only supported for file gateways.

File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you create a file share. Make sure AWS STS is activated in the region you are creating your file gateway in. If AWS STS is not activated in the region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

File gateway does not support creating hard or symbolic links on a file share.

Service Reference:

Examples:

Calling the createNFSFileShare operation

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  GatewayARN: 'STRING_VALUE', /* required */
  LocationARN: 'STRING_VALUE', /* required */
  Role: 'STRING_VALUE', /* required */
  ClientList: [
    'STRING_VALUE',
    /* more items */
  ],
  DefaultStorageClass: 'STRING_VALUE',
  GuessMIMETypeEnabled: true || false,
  KMSEncrypted: true || false,
  KMSKey: 'STRING_VALUE',
  NFSFileShareDefaults: {
    DirectoryMode: 'STRING_VALUE',
    FileMode: 'STRING_VALUE',
    GroupId: 'NUMBER_VALUE',
    OwnerId: 'NUMBER_VALUE'
  },
  ObjectACL: private | public-read | public-read-write | authenticated-read | bucket-owner-read | bucket-owner-full-control | aws-exec-read,
  ReadOnly: true || false,
  RequesterPays: true || false,
  Squash: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
storagegateway.createNFSFileShare(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: {}) —
    • ClientToken — (String)

      A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

    • NFSFileShareDefaults — (map)

      File share default values. Optional.

      • FileMode — (String)

        The Unix file mode in the form "nnnn". For example, "0666" represents the default file mode inside the file share. The default value is 0666.

      • DirectoryMode — (String)

        The Unix directory mode in the form "nnnn". For example, "0666" represents the default access mode for all directories inside the file share. The default value is 0777.

      • GroupId — (Integer)

        The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody.

      • OwnerId — (Integer)

        The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody.

    • GatewayARN — (String)

      The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

    • KMSEncrypted — (Boolean)

      True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

    • KMSKey — (String)

      The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

    • Role — (String)

      The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

    • LocationARN — (String)

      The ARN of the backed storage used for storing file data.

    • DefaultStorageClass — (String)

      The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

    • ObjectACL — (String)

      A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

      Possible values include:
      • "private"
      • "public-read"
      • "public-read-write"
      • "authenticated-read"
      • "bucket-owner-read"
      • "bucket-owner-full-control"
      • "aws-exec-read"
    • ClientList — (Array<String>)

      The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

    • Squash — (String)

      A value that maps a user to anonymous user. Valid options are the following:

      • RootSquash - Only root is mapped to anonymous user.

      • NoSquash - No one is mapped to anonymous user

      • AllSquash - Everyone is mapped to anonymous user.

    • ReadOnly — (Boolean)

      A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

    • GuessMIMETypeEnabled — (Boolean)

      A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

    • RequesterPays — (Boolean)

      A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

      Note: RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
    • Tags — (Array<map>)

      A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.

      Note: Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
      • Key — required — (String)

        Tag key (String). The key can't start with aws:.

      • Value — required — (String)

        Value of the tag key.

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:

      • FileShareARN — (String)

        The Amazon Resource Name (ARN) of the newly created file share.

Returns:

  • (AWS.Request) —

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

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

Creates a Server Message Block (SMB) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway expose file shares using a SMB interface. This operation is only supported for file gateways.

File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

File gateways don't support creating hard or symbolic links on a file share.

Service Reference:

Examples:

Calling the createSMBFileShare operation

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  GatewayARN: 'STRING_VALUE', /* required */
  LocationARN: 'STRING_VALUE', /* required */
  Role: 'STRING_VALUE', /* required */
  Authentication: 'STRING_VALUE',
  DefaultStorageClass: 'STRING_VALUE',
  GuessMIMETypeEnabled: true || false,
  InvalidUserList: [
    'STRING_VALUE',
    /* more items */
  ],
  KMSEncrypted: true || false,
  KMSKey: 'STRING_VALUE',
  ObjectACL: private | public-read | public-read-write | authenticated-read | bucket-owner-read | bucket-owner-full-control | aws-exec-read,
  ReadOnly: true || false,
  RequesterPays: true || false,
  SMBACLEnabled: true || false,
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  ValidUserList: [
    'STRING_VALUE',
    /* more items */
  ]
};
storagegateway.createSMBFileShare(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: {}) —
    • ClientToken — (String)

      A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

    • GatewayARN — (String)

      The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

    • KMSEncrypted — (Boolean)

      True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

    • KMSKey — (String)

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

    • Role — (String)

      The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

    • LocationARN — (String)

      The ARN of the backed storage used for storing file data.

    • DefaultStorageClass — (String)

      The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

    • ObjectACL — (String)

      A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

      Possible values include:
      • "private"
      • "public-read"
      • "public-read-write"
      • "authenticated-read"
      • "bucket-owner-read"
      • "bucket-owner-full-control"
      • "aws-exec-read"
    • ReadOnly — (Boolean)

      A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

    • GuessMIMETypeEnabled — (Boolean)

      A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

    • RequesterPays — (Boolean)

      A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

      Note: RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
    • SMBACLEnabled — (Boolean)

      Set this value to "true to enable ACL (access control list) on the SMB file share. Set it to "false" to map file and directory permissions to the POSIX permissions.

    • ValidUserList — (Array<String>)

      A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

    • InvalidUserList — (Array<String>)

      A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

    • Authentication — (String)

      The authentication method that users use to access the file share.

      Valid values are ActiveDirectory or GuestAccess. The default is ActiveDirectory.

    • Tags — (Array<map>)

      A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.

      Note: Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
      • Key — required — (String)

        Tag key (String). The key can't start with aws:.

      • Value — required — (String)

        Value of the tag key.

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:

      • FileShareARN — (String)

        The Amazon Resource Name (ARN) of the newly created file share.

Returns:

  • (AWS.Request) —

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

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

Initiates a snapshot of a volume.

AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API enables you to take ad-hoc snapshot. For more information, see Editing a Snapshot Schedule.

In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type.

Note: To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the EC2 API reference.

Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page.

Service Reference:

Examples:

To create a snapshot of a gateway volume


/* Initiates an ad-hoc snapshot of a gateway volume. */

 var params = {
  SnapshotDescription: "My root volume snapshot as of 10/03/2017", 
  VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
 };
 storagegateway.createSnapshot(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    SnapshotId: "snap-78e22663", 
    VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
   }
   */
 });

Calling the createSnapshot operation

var params = {
  SnapshotDescription: 'STRING_VALUE', /* required */
  VolumeARN: 'STRING_VALUE' /* required */
};
storagegateway.createSnapshot(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: {}) —
    • VolumeARN — (String)

      The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

    • SnapshotDescription — (String)

      Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field

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:

      • VolumeARN — (String)

        The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.

      • SnapshotId — (String)

        The snapshot ID that is used to refer to the snapshot in future operations such as describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots) or creating a volume from a snapshot (CreateStorediSCSIVolume).

Returns:

  • (AWS.Request) —

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

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

Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type.

A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for cached volume gateway, use ListVolumeRecoveryPoints.

In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.

Note: To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference.

Service Reference:

Examples:

To create a snapshot of a gateway volume


/* Initiates a snapshot of a gateway from a volume recovery point. */

 var params = {
  SnapshotDescription: "My root volume snapshot as of 2017-06-30T10:10:10.000Z", 
  VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
 };
 storagegateway.createSnapshotFromVolumeRecoveryPoint(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    SnapshotId: "snap-78e22663", 
    VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", 
    VolumeRecoveryPointTime: "2017-06-30T10:10:10.000Z"
   }
   */
 });

Calling the createSnapshotFromVolumeRecoveryPoint operation

var params = {
  SnapshotDescription: 'STRING_VALUE', /* required */
  VolumeARN: 'STRING_VALUE' /* required */
};
storagegateway.createSnapshotFromVolumeRecoveryPoint(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: {}) —
    • VolumeARN — (String)

      The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

    • SnapshotDescription — (String)

      Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field

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:

      • SnapshotId — (String)

        The ID of the snapshot.

      • VolumeARN — (String)

        The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

      • VolumeRecoveryPointTime — (String)

        The time the volume was created from the recovery point.

Returns:

  • (AWS.Request) —

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

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

Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type.

The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased.

In the request you must specify the gateway and the disk information on which you are creating the volume. In response, the gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

Service Reference:

Examples:

To create a stored iSCSI volume


/* Creates a stored volume on a specified stored gateway. */

 var params = {
  DiskId: "pci-0000:03:00.0-scsi-0:0:0:0", 
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 
  NetworkInterfaceId: "10.1.1.1", 
  PreserveExistingData: true, 
  SnapshotId: "snap-f47b7b94", 
  TargetName: "my-volume"
 };
 storagegateway.createStorediSCSIVolume(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    TargetARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume", 
    VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", 
    VolumeSizeInBytes: 1099511627776
   }
   */
 });

Calling the createStorediSCSIVolume operation

var params = {
  DiskId: 'STRING_VALUE', /* required */
  GatewayARN: 'STRING_VALUE', /* required */
  NetworkInterfaceId: 'STRING_VALUE', /* required */
  PreserveExistingData: true || false, /* required */
  TargetName: 'STRING_VALUE', /* required */
  KMSEncrypted: true || false,
  KMSKey: 'STRING_VALUE',
  SnapshotId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
storagegateway.createStorediSCSIVolume(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 region.

    • DiskId — (String)

      The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.

    • SnapshotId — (String)

      The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

    • PreserveExistingData — (Boolean)

      Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field as false creates an empty volume.

      Valid Values: true, false

    • TargetName — (String)

      The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

      If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

    • NetworkInterfaceId — (String)

      The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

      Valid Values: A valid IP address.

    • KMSEncrypted — (Boolean)

      True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

    • KMSKey — (String)

      The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

    • Tags — (Array<map>)

      A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value pair.

      Note: Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
      • Key — required — (String)

        Tag key (String). The key can't start with aws:.

      • Value — required — (String)

        Value of the tag key.

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:

      • VolumeARN — (String)

        The Amazon Resource Name (ARN) of the configured volume.

      • VolumeSizeInBytes — (Integer)

        The size of the volume in bytes.

      • TargetARN — (String)

        The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target.

Returns:

  • (AWS.Request) —

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

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

Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type.

Note: Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway.

Service Reference:

Examples:

To create a virtual tape


/* Creates one or more virtual tapes. */

 var params = {
  ClientToken: "77777", 
  GatewayARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", 
  NumTapesToCreate: 3, 
  TapeBarcodePrefix: "TEST", 
  TapeSizeInBytes: 107374182400
 };
 storagegateway.createTapes(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    TapeARNs: [
       "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST38A29D", 
       "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST3AA29F", 
       "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST3BA29E"
    ]
   }
   */
 });

Calling the createTapes operation

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  GatewayARN: 'STRING_VALUE', /* required */
  NumTapesToCreate: 'NUMBER_VALUE', /* required */
  TapeBarcodePrefix: 'STRING_VALUE', /* required */
  TapeSizeInBytes: 'NUMBER_VALUE', /* required */
  KMSEncrypted: true || false,
  KMSKey: 'STRING_VALUE',
  PoolId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
storagegateway.createTapes(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 unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the ListGateways operation to return a list of gateways for your account and region.

    • TapeSizeInBytes — (Integer)

      The size, in bytes, of the virtual tapes that you want to create.

      Note: The size must be aligned by gigabyte (102410241024 byte).
    • ClientToken — (String)

      A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.

      Note: Using the same ClientToken prevents creating the tape multiple times.
    • NumTapesToCreate — (Integer)

      The number of virtual tapes that you want to create.

    • TapeBarcodePrefix — (String)

      A prefix that you append to the barcode of the virtual tape you are creating. This prefix makes the barcode unique.

      Note: The prefix must be 1 to 4 characters in length and must be one of the uppercase letters from A to Z.
    • KMSEncrypted — (Boolean)

      True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

    • KMSKey — (String)

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

    • PoolId — (String)

      The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

    • Tags — (Array<map>)

      A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value pair.

      Note: Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
      • Key — required — (String)

        Tag key (String). The key can't start with aws:.

      • Value — required — (String)

        Value of the tag key.

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:

      • TapeARNs — (Array<String>)

        A list of unique Amazon Resource Names (ARNs) that represents the virtual tapes that were created.

Returns:

  • (AWS.Request) —

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

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

Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and can not be reused if it has already been used on a tape . This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type.

Note: Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.

Service Reference:

Examples:

To create a virtual tape using a barcode


/* Creates a virtual tape by using your own barcode. */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", 
  TapeBarcode: "TEST12345", 
  TapeSizeInBytes: 107374182400
 };
 storagegateway.createTapeWithBarcode(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    TapeARN: "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST12345"
   }
   */
 });

Calling the createTapeWithBarcode operation

var params = {
  GatewayARN: 'STRING_VALUE', /* required */
  TapeBarcode: 'STRING_VALUE', /* required */
  TapeSizeInBytes: 'NUMBER_VALUE', /* required */
  KMSEncrypted: true || false,
  KMSKey: 'STRING_VALUE',
  PoolId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
storagegateway.createTapeWithBarcode(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 unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the ListGateways operation to return a list of gateways for your account and region.

    • TapeSizeInBytes — (Integer)

      The size, in bytes, of the virtual tape that you want to create.

      Note: The size must be aligned by gigabyte (102410241024 byte).
    • TapeBarcode — (String)

      The barcode that you want to assign to the tape.

      Note: Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.
    • KMSEncrypted — (Boolean)

      True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

    • KMSKey — (String)

      The Amazon Resource Name (ARN) of the AWS KMS Key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

    • PoolId — (String)

      The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.

      Valid values: "GLACIER", "DEEP_ARCHIVE"

    • Tags — (Array<map>)

      A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each tag is a key-value pair.

      Note: Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
      • Key — required — (String)

        Tag key (String). The key can't start with aws:.

      • Value — required — (String)

        Value of the tag key.

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:

      • TapeARN — (String)

        A unique Amazon Resource Name (ARN) that represents the virtual tape that was created.

Returns:

  • (AWS.Request) —

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

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

Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request.

Service Reference:

Examples:

To delete bandwidth rate limits of gateway


/* Deletes the bandwidth rate limits of a gateway; either the upload or download limit, or both. */

 var params = {
  BandwidthType: "All", 
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
 };
 storagegateway.deleteBandwidthRateLimit(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
   }
   */
 });

Calling the deleteBandwidthRateLimit operation

var params = {
  BandwidthType: 'STRING_VALUE', /* required */
  GatewayARN: 'STRING_VALUE' /* required */
};
storagegateway.deleteBandwidthRateLimit(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 region.

    • BandwidthType — (String)

      One of the BandwidthType values that indicates the gateway bandwidth rate limit to delete.

      Valid Values: Upload, Download, All.

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

Returns:

  • (AWS.Request) —

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

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

Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.

Service Reference:

Examples:

To delete CHAP credentials


/* Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair. */

 var params = {
  InitiatorName: "iqn.1991-05.com.microsoft:computername.domain.example.com", 
  TargetARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
 };
 storagegateway.deleteChapCredentials(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    InitiatorName: "iqn.1991-05.com.microsoft:computername.domain.example.com", 
    TargetARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
   }
   */
 });

Calling the deleteChapCredentials operation

var params = {
  InitiatorName: 'STRING_VALUE', /* required */
  TargetARN: 'STRING_VALUE' /* required */
};
storagegateway.deleteChapCredentials(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: {}) —
    • TargetARN — (String)

      The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

    • InitiatorName — (String)

      The iSCSI initiator that connects to the target.

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:

      • TargetARN — (String)

        The Amazon Resource Name (ARN) of the target.

      • InitiatorName — (String)

        The iSCSI initiator that connects to the target.

Returns:

  • (AWS.Request) —

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

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

Deletes a file share from a file gateway. This operation is only supported for file gateways.

Service Reference:

Examples:

Calling the deleteFileShare operation

var params = {
  FileShareARN: 'STRING_VALUE', /* required */
  ForceDelete: true || false
};
storagegateway.deleteFileShare(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: {}) —
    • FileShareARN — (String)

      The Amazon Resource Name (ARN) of the file share to be deleted.

    • ForceDelete — (Boolean)

      If this value is set to true, the operation deletes a file share immediately and aborts all data uploads to AWS. Otherwise, the file share is not deleted until all data is uploaded to AWS. This process aborts the data upload process, and the file share enters the FORCE_DELETING status.

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:

      • FileShareARN — (String)

        The Amazon Resource Name (ARN) of the deleted file share.

Returns:

  • (AWS.Request) —

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

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

Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer.

After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment.

You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription.  If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the AWS Storage Gateway Detail Page.

Service Reference:

Examples:

To delete a gatgeway


/* This operation deletes the gateway, but not the gateway's VM from the host computer. */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
 };
 storagegateway.deleteGateway(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
   }
   */
 });

Calling the deleteGateway operation

var params = {
  GatewayARN: 'STRING_VALUE' /* required */
};
storagegateway.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. Use the ListGateways operation to return a list of gateways for your account and 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 region.

Returns:

  • (AWS.Request) —

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

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

Deletes a snapshot of a volume.

You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Working with Snapshots. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported in stored and cached volume gateway types.

Note: To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference.

Service Reference:

Examples:

To delete a snapshot of a volume


/* This action enables you to delete a snapshot schedule for a volume. */

 var params = {
  VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
 };
 storagegateway.deleteSnapshotSchedule(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
   }
   */
 });

Calling the deleteSnapshotSchedule operation

var params = {
  VolumeARN: 'STRING_VALUE' /* required */
};
storagegateway.deleteSnapshotSchedule(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: {}) —
    • VolumeARN — (String)

      The volume which snapshot schedule 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:

      • VolumeARN — (String)

        The volume which snapshot schedule was deleted.

Returns:

  • (AWS.Request) —

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

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

Deletes the specified virtual tape. This operation is only supported in the tape gateway type.

Service Reference:

Examples:

To delete a virtual tape


/* This example deletes the specified virtual tape. */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:204469490176:gateway/sgw-12A3456B", 
  TapeARN: "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0"
 };
 storagegateway.deleteTape(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    TapeARN: "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0"
   }
   */
 });

Calling the deleteTape operation

var params = {
  GatewayARN: 'STRING_VALUE', /* required */
  TapeARN: 'STRING_VALUE' /* required */
};
storagegateway.deleteTape(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 unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the ListGateways operation to return a list of gateways for your account and region.

    • TapeARN — (String)

      The Amazon Resource Name (ARN) of the virtual tape 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:

      • TapeARN — (String)

        The Amazon Resource Name (ARN) of the deleted virtual tape.

Returns:

  • (AWS.Request) —

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

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

Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

Service Reference:

Examples:

To delete a virtual tape from the shelf (VTS)


/* Deletes the specified virtual tape from the virtual tape shelf (VTS). */

 var params = {
  TapeARN: "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0"
 };
 storagegateway.deleteTapeArchive(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    TapeARN: "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0"
   }
   */
 });

Calling the deleteTapeArchive operation

var params = {
  TapeARN: 'STRING_VALUE' /* required */
};
storagegateway.deleteTapeArchive(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: {}) —
    • TapeARN — (String)

      The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS).

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:

      • TapeARN — (String)

        The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual tape shelf (VTS).

Returns:

  • (AWS.Request) —

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

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

Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This operation is only supported in the cached volume and stored volume types. For stored volume gateways, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume.

Before you delete a volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.

Service Reference:

Examples:

To delete a gateway volume


/* Deletes the specified gateway volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. */

 var params = {
  VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
 };
 storagegateway.deleteVolume(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
   }
   */
 });

Calling the deleteVolume operation

var params = {
  VolumeARN: 'STRING_VALUE' /* required */
};
storagegateway.deleteVolume(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: {}) —
    • VolumeARN — (String)

      The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

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:

      • VolumeARN — (String)

        The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the request.

Returns:

  • (AWS.Request) —

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

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

Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect.

This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

Service Reference:

Examples:

To describe the bandwidth rate limits of a gateway


/* Returns a value for a bandwidth rate limit if set. If not set, then only the gateway ARN is returned. */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
 };
 storagegateway.describeBandwidthRateLimit(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AverageDownloadRateLimitInBitsPerSec: 204800, 
    AverageUploadRateLimitInBitsPerSec: 102400, 
    GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
   }
   */
 });

Calling the describeBandwidthRateLimit operation

var params = {
  GatewayARN: 'STRING_VALUE' /* required */
};
storagegateway.describeBandwidthRateLimit(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 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 region.

      • AverageUploadRateLimitInBitsPerSec — (Integer)

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

      • AverageDownloadRateLimitInBitsPerSec — (Integer)

        The average download bandwidth rate limit in bits per second. This field does not appear in the response if the download rate limit is not set.

Returns:

  • (AWS.Request) —

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

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

Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape and file gateway types.

The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.

Service Reference:

Examples:

To describe cache information


/* Returns information about the cache of a gateway. */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
 };
 storagegateway.describeCache(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CacheAllocatedInBytes: 2199023255552, 
    CacheDirtyPercentage: 0.07, 
    CacheHitPercentage: 99.68, 
    CacheMissPercentage: 0.32, 
    CacheUsedPercentage: 0.07, 
    DiskIds: [
       "pci-0000:03:00.0-scsi-0:0:0:0", 
       "pci-0000:04:00.0-scsi-0:1:0:0"
    ], 
    GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
   }
   */
 });

Calling the describeCache operation

var params = {
  GatewayARN: 'STRING_VALUE' /* required */
};
storagegateway.describeCache(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 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 region.

      • DiskIds — (Array<String>)

        An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

      • CacheAllocatedInBytes — (Integer)

        The amount of cache in bytes allocated to the a gateway.

      • CacheUsedPercentage — (Float)

        Percent use of the gateway's cache storage. This metric applies only to the gateway-cached volume setup. The sample is taken at the end of the reporting period.

      • CacheDirtyPercentage — (Float)

        The file share's contribution to the overall percentage of the gateway's cache that has not been persisted to AWS. The sample is taken at the end of the reporting period.

      • CacheHitPercentage — (Float)

        Percent of application read operations from the file shares that are served from cache. The sample is taken at the end of the reporting period.

      • CacheMissPercentage — (Float)

        Percent of application read operations from the file shares that are not served from cache. The sample is taken at the end of the reporting period.

Returns:

  • (AWS.Request) —

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

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

Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types.

The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).

Service Reference:

Examples:

To describe gateway cached iSCSI volumes


/* Returns a description of the gateway cached iSCSI volumes specified in the request. */

 var params = {
  VolumeARNs: [
     "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
  ]
 };
 storagegateway.describeCachediSCSIVolumes(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CachediSCSIVolumes: [
       {
      VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", 
      VolumeId: "vol-1122AABB", 
      VolumeSizeInBytes: 1099511627776, 
      VolumeStatus: "AVAILABLE", 
      VolumeType: "CACHED iSCSI", 
      VolumeiSCSIAttributes: {
       ChapEnabled: true, 
       LunNumber: 1, 
       NetworkInterfaceId: "10.243.43.207", 
       NetworkInterfacePort: 3260, 
       TargetARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
      }
     }
    ]
   }
   */
 });

Calling the describeCachediSCSIVolumes operation

var params = {
  VolumeARNs: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
storagegateway.describeCachediSCSIVolumes(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: {}) —
    • VolumeARNs — (Array<String>)

      An array of strings where each string represents the Amazon Resource Name (ARN) of a cached volume. All of the specified cached volumes must from the same gateway. Use ListVolumes to get volume ARNs for 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:

      • CachediSCSIVolumes — (Array<map>)

        An array of objects where each object contains metadata about one cached volume.

        • VolumeARN — (String)

          The Amazon Resource Name (ARN) of the storage volume.

        • VolumeId — (String)

          The unique identifier of the volume, e.g. vol-AE4B946D.

        • VolumeType — (String)

          One of the VolumeType enumeration values that describes the type of the volume.

        • VolumeStatus — (String)

          One of the VolumeStatus values that indicates the state of the storage volume.

        • VolumeAttachmentStatus — (String)

          A value that indicates whether a storage volume is attached to or detached from a gateway. For more information, see Moving Your Volumes to a Different Gateway.

        • VolumeSizeInBytes — (Integer)

          The size, in bytes, of the volume capacity.

        • VolumeProgress — (Float)

          Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the cached volume is not restoring or bootstrapping.

        • SourceSnapshotId — (String)

          If the cached volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.

        • VolumeiSCSIAttributes — (map)

          An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

          • TargetARN — (String)

            The Amazon Resource Name (ARN) of the volume target.

          • NetworkInterfaceId — (String)

            The network interface identifier.

          • NetworkInterfacePort — (Integer)

            The port used to communicate with iSCSI targets.

          • LunNumber — (Integer)

            The logical disk number.

          • ChapEnabled — (Boolean)

            Indicates whether mutual CHAP is enabled for the iSCSI target.

        • CreatedDate — (Date)

          The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp.

        • VolumeUsedInBytes — (Integer)

          The size of the data stored on the volume in bytes. This value is calculated based on the number of blocks that are touched, instead of the actual amount of data written. This value can be useful for sequential write patterns but less accurate for random write patterns. VolumeUsedInBytes is different from the compressed size of the volume, which is the value that is used to calculate your bill.

          Note: This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.
        • KMSKey — (String)

          The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

        • TargetName — (String)

          The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

          If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Returns:

  • (AWS.Request) —

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

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

Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.

Service Reference:

Examples:

To describe CHAP credetnitals for an iSCSI


/* Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair. */

 var params = {
  TargetARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
 };
 storagegateway.describeChapCredentials(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChapCredentials: [
       {
      InitiatorName: "iqn.1991-05.com.microsoft:computername.domain.example.com", 
      SecretToAuthenticateInitiator: "111111111111", 
      SecretToAuthenticateTarget: "222222222222", 
      TargetARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
     }
    ]
   }
   */
 });

Calling the describeChapCredentials operation

var params = {
  TargetARN: 'STRING_VALUE' /* required */
};
storagegateway.describeChapCredentials(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: {}) —
    • TargetARN — (String)

      The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

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:

      • ChapCredentials — (Array<map>)

        An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:

        • InitiatorName: The iSCSI initiator that connects to the target.

        • SecretToAuthenticateInitiator: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.

        • SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).

        • TargetARN: The Amazon Resource Name (ARN) of the storage volume.

        • TargetARN — (String)

          The Amazon Resource Name (ARN) of the volume.

          Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

        • SecretToAuthenticateInitiator — (String)

          The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.

        • InitiatorName — (String)

          The iSCSI initiator that connects to the target.

        • SecretToAuthenticateTarget — (String)

          The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).

Returns:

  • (AWS.Request) —

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

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

Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

Service Reference:

Examples:

To describe metadata about the gateway


/* Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
 };
 storagegateway.describeGatewayInformation(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 
    GatewayId: "sgw-AABB1122", 
    GatewayName: "My_Gateway", 
    GatewayNetworkInterfaces: [
       {
      Ipv4Address: "10.35.69.216"
     }
    ], 
    GatewayState: "STATE_RUNNING", 
    GatewayTimezone: "GMT-8:00", 
    GatewayType: "STORED", 
    LastSoftwareUpdate: "2016-01-02T16:00:00", 
    NextUpdateAvailabilityDate: "2017-01-02T16:00:00"
   }
   */
 });

Calling the describeGatewayInformation operation

var params = {
  GatewayARN: 'STRING_VALUE' /* required */
};
storagegateway.describeGatewayInformation(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 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 region.

      • GatewayId — (String)

        The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

      • GatewayName — (String)

        The name you configured for your gateway.

      • GatewayTimezone — (String)

        A value that indicates the time zone configured for the gateway.

      • GatewayState — (String)

        A value that indicates the operating state of the gateway.

      • GatewayNetworkInterfaces — (Array<map>)

        A NetworkInterface array that contains descriptions of the gateway network interfaces.

        • Ipv4Address — (String)

          The Internet Protocol version 4 (IPv4) address of the interface.

        • MacAddress — (String)

          The Media Access Control (MAC) address of the interface.

          Note: This is currently unsupported and will not be returned in output.
        • Ipv6Address — (String)

          The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported.

      • GatewayType — (String)

        The type of the gateway.

      • NextUpdateAvailabilityDate — (String)

        The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.

      • LastSoftwareUpdate — (String)

        The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response.

      • Ec2InstanceId — (String)

        The ID of the Amazon EC2 instance that was used to launch the gateway.

      • Ec2InstanceRegion — (String)

        The AWS Region where the Amazon EC2 instance is located.

      • Tags — (Array<map>)

        A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

        • Key — required — (String)

          Tag key (String). The key can't start with aws:.

        • Value — required — (String)

          Value of the tag key.

Returns:

  • (AWS.Request) —

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

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

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.

Service Reference:

Examples:

To describe gateway's maintenance start time


/* Returns your gateway's weekly maintenance start time including the day and time of the week. */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
 };
 storagegateway.describeMaintenanceStartTime(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    DayOfWeek: 2, 
    GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 
    HourOfDay: 15, 
    MinuteOfHour: 35, 
    Timezone: "GMT+7:00"
   }
   */
 });

Calling the describeMaintenanceStartTime operation

var params = {
  GatewayARN: 'STRING_VALUE' /* required */
};
storagegateway.describeMaintenanceStartTime(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 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 region.

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

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

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

        Note: This value is only available for tape and volume gateways.
      • Timezone — (String)

        A value that indicates the time zone that is set for the gateway. The start time and day of week specified should be in the time zone of the gateway.

Returns:

  • (AWS.Request) —

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

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

Gets a description for one or more Network File System (NFS) file shares from a file gateway. This operation is only supported for file gateways.

Service Reference:

Examples:

Calling the describeNFSFileShares operation

var params = {
  FileShareARNList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
storagegateway.describeNFSFileShares(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: {}) —
    • FileShareARNList — (Array<String>)

      An array containing the Amazon Resource Name (ARN) of each file share to be described.

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:

      • NFSFileShareInfoList — (Array<map>)

        An array containing a description for each requested file share.

        • NFSFileShareDefaults — (map)

          Describes Network File System (NFS) file share default values. Files and folders stored as Amazon S3 objects in S3 buckets don't, by default, have Unix file permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, the S3 objects that represent files and folders are assigned these default Unix permissions. This operation is only supported for file gateways.

          • FileMode — (String)

            The Unix file mode in the form "nnnn". For example, "0666" represents the default file mode inside the file share. The default value is 0666.

          • DirectoryMode — (String)

            The Unix directory mode in the form "nnnn". For example, "0666" represents the default access mode for all directories inside the file share. The default value is 0777.

          • GroupId — (Integer)

            The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody.

          • OwnerId — (Integer)

            The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody.

        • FileShareARN — (String)

          The Amazon Resource Name (ARN) of the file share.

        • FileShareId — (String)

          The ID of the file share.

        • FileShareStatus — (String)

          The status of the file share. Possible values are CREATING, UPDATING, AVAILABLE and DELETING.

        • GatewayARN — (String)

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

        • KMSEncrypted — (Boolean)

          True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

        • KMSKey — (String)

          The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

        • Path — (String)

          The file share path used by the NFS client to identify the mount point.

        • Role — (String)

          The ARN of the IAM role that file gateway assumes when it accesses the underlying storage.

        • LocationARN — (String)

          The ARN of the backend storage used for storing file data.

        • DefaultStorageClass — (String)

          The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

        • ObjectACL — (String)

          A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

          Possible values include:
          • "private"
          • "public-read"
          • "public-read-write"
          • "authenticated-read"
          • "bucket-owner-read"
          • "bucket-owner-full-control"
          • "aws-exec-read"
        • ClientList — (Array<String>)

          The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

        • Squash — (String)

          The user mapped to anonymous user. Valid options are the following:

          • RootSquash - Only root is mapped to anonymous user.

          • NoSquash - No one is mapped to anonymous user

          • AllSquash - Everyone is mapped to anonymous user.

        • ReadOnly — (Boolean)

          A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

        • GuessMIMETypeEnabled — (Boolean)

          A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

        • RequesterPays — (Boolean)

          A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

          Note: RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
        • Tags — (Array<map>)

          A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

          • Key — required — (String)

            Tag key (String). The key can't start with aws:.

          • Value — required — (String)

            Value of the tag key.

Returns:

  • (AWS.Request) —

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

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

Gets a description for one or more Server Message Block (SMB) file shares from a file gateway. This operation is only supported for file gateways.

Service Reference:

Examples:

Calling the describeSMBFileShares operation

var params = {
  FileShareARNList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
storagegateway.describeSMBFileShares(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: {}) —
    • FileShareARNList — (Array<String>)

      An array containing the Amazon Resource Name (ARN) of each file share to be described.

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:

      • SMBFileShareInfoList — (Array<map>)

        An array containing a description for each requested file share.

        • FileShareARN — (String)

          The Amazon Resource Name (ARN) of the file share.

        • FileShareId — (String)

          The ID of the file share.

        • FileShareStatus — (String)

          The status of the file share. Possible values are CREATING, UPDATING, AVAILABLE and DELETING.

        • GatewayARN — (String)

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

        • KMSEncrypted — (Boolean)

          True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

        • KMSKey — (String)

          The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

        • Path — (String)

          The file share path used by the SMB client to identify the mount point.

        • Role — (String)

          The ARN of the IAM role that file gateway assumes when it accesses the underlying storage.

        • LocationARN — (String)

          The ARN of the backend storage used for storing file data.

        • DefaultStorageClass — (String)

          The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

        • ObjectACL — (String)

          A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

          Possible values include:
          • "private"
          • "public-read"
          • "public-read-write"
          • "authenticated-read"
          • "bucket-owner-read"
          • "bucket-owner-full-control"
          • "aws-exec-read"
        • ReadOnly — (Boolean)

          A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

        • GuessMIMETypeEnabled — (Boolean)

          A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

        • RequesterPays — (Boolean)

          A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

          Note: RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
        • SMBACLEnabled — (Boolean)

          If this value is set to "true", indicates that ACL (access control list) is enabled on the SMB file share. If it is set to "false", it indicates that file and directory permissions are mapped to the POSIX permission.

        • ValidUserList — (Array<String>)

          A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

        • InvalidUserList — (Array<String>)

          A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

        • Authentication — (String)

          The authentication method of the file share.

          Valid values are ActiveDirectory or GuestAccess. The default is ActiveDirectory.

        • Tags — (Array<map>)

          A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

          • Key — required — (String)

            Tag key (String). The key can't start with aws:.

          • Value — required — (String)

            Value of the tag key.

Returns:

  • (AWS.Request) —

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

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

Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.

Service Reference:

Examples:

Calling the describeSMBSettings operation

var params = {
  GatewayARN: 'STRING_VALUE' /* required */
};
storagegateway.describeSMBSettings(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 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 region.

      • DomainName — (String)

        The name of the domain that the gateway is joined to.

      • SMBGuestPasswordSet — (Boolean)

        This value is true if a password for the guest user “smbguest” is set, and otherwise false.

Returns:

  • (AWS.Request) —

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

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

Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the cached volume and stored volume types.

Service Reference:

Examples:

To describe snapshot schedule for gateway volume


/* Describes the snapshot schedule for the specified gateway volume including intervals at which snapshots are automatically initiated. */

 var params = {
  VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
 };
 storagegateway.describeSnapshotSchedule(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Description: "sgw-AABB1122:vol-AABB1122:Schedule", 
    RecurrenceInHours: 24, 
    StartAt: 6, 
    Timezone: "GMT+7:00", 
    VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
   }
   */
 });

Calling the describeSnapshotSchedule operation

var params = {
  VolumeARN: 'STRING_VALUE' /* required */
};
storagegateway.describeSnapshotSchedule(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: {}) —
    • VolumeARN — (String)

      The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

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:

      • VolumeARN — (String)

        The Amazon Resource Name (ARN) of the volume that was specified in the request.

      • StartAt — (Integer)

        The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

      • RecurrenceInHours — (Integer)

        The number of hours between snapshots.

      • Description — (String)

        The snapshot description.

      • Timezone — (String)

        A value that indicates the time zone of the gateway.

Returns:

  • (AWS.Request) —

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

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

Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.

Service Reference:

Examples:

To describe the volumes of a gateway


/* Returns the description of the gateway volumes specified in the request belonging to the same gateway. */

 var params = {
  VolumeARNs: [
     "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
  ]
 };
 storagegateway.describeStorediSCSIVolumes(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    StorediSCSIVolumes: [
       {
      PreservedExistingData: false, 
      VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", 
      VolumeDiskId: "pci-0000:03:00.0-scsi-0:0:0:0", 
      VolumeId: "vol-1122AABB", 
      VolumeProgress: 23.7, 
      VolumeSizeInBytes: 1099511627776, 
      VolumeStatus: "BOOTSTRAPPING", 
      VolumeiSCSIAttributes: {
       ChapEnabled: true, 
       NetworkInterfaceId: "10.243.43.207", 
       NetworkInterfacePort: 3260, 
       TargetARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
      }
     }
    ]
   }
   */
 });

Calling the describeStorediSCSIVolumes operation

var params = {
  VolumeARNs: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
storagegateway.describeStorediSCSIVolumes(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: {}) —
    • VolumeARNs — (Array<String>)

      An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must from the same gateway. Use ListVolumes to get volume ARNs for 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:

      • StorediSCSIVolumes — (Array<map>)

        Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are returned:

        • ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target.

        • LunNumber: The logical disk number.

        • NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map the stored volume as an iSCSI target.

        • NetworkInterfacePort: The port used to communicate with iSCSI targets.

        • PreservedExistingData: Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.

        • SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-1122aabb. Otherwise, this field is not included.

        • StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata about one stored volume.

        • TargetARN: The Amazon Resource Name (ARN) of the volume target.

        • VolumeARN: The Amazon Resource Name (ARN) of the stored volume.

        • VolumeDiskId: The disk ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

        • VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB.

        • VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

        • VolumeProgress: Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.

        • VolumeSizeInBytes: The size of the volume in bytes.

        • VolumeStatus: One of the VolumeStatus values that indicates the state of the volume.

        • VolumeType: One of the enumeration values describing the type of the volume. Currently, on STORED volumes are supported.

        • VolumeARN — (String)

          The Amazon Resource Name (ARN) of the storage volume.

        • VolumeId — (String)

          The unique identifier of the volume, e.g. vol-AE4B946D.

        • VolumeType — (String)

          One of the VolumeType enumeration values describing the type of the volume.

        • VolumeStatus — (String)

          One of the VolumeStatus values that indicates the state of the storage volume.

        • VolumeAttachmentStatus — (String)

          A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway. For more information, see Moving Your Volumes to a Different Gateway.

        • VolumeSizeInBytes — (Integer)

          The size of the volume in bytes.

        • VolumeProgress — (Float)

          Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.

        • VolumeDiskId — (String)

          The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

        • SourceSnapshotId — (String)

          If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.

        • PreservedExistingData — (Boolean)

          Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.

          Valid Values: true, false

        • VolumeiSCSIAttributes — (map)

          An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

          • TargetARN — (String)

            The Amazon Resource Name (ARN) of the volume target.

          • NetworkInterfaceId — (String)

            The network interface identifier.

          • NetworkInterfacePort — (Integer)

            The port used to communicate with iSCSI targets.

          • LunNumber — (Integer)

            The logical disk number.

          • ChapEnabled — (Boolean)

            Indicates whether mutual CHAP is enabled for the iSCSI target.

        • CreatedDate — (Date)

          The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp.

        • VolumeUsedInBytes — (Integer)

          The size of the data stored on the volume in bytes. This value is calculated based on the number of blocks that are touched, instead of the actual amount of data written. This value can be useful for sequential write patterns but less accurate for random write patterns. VolumeUsedInBytes is different from the compressed size of the volume, which is the value that is used to calculate your bill.

          Note: This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.
        • KMSKey — (String)

          The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

        • TargetName — (String)

          The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

          If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Returns:

  • (AWS.Request) —

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

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

Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.

Service Reference:

Examples:

To describe virtual tapes in the VTS


/* Returns a description of specified virtual tapes in the virtual tape shelf (VTS). */

 var params = {
  Limit: 123, 
  Marker: "1", 
  TapeARNs: [
     "arn:aws:storagegateway:us-east-1:999999999999:tape/AM08A1AD", 
     "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4"
  ]
 };
 storagegateway.describeTapeArchives(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Marker: "1", 
    TapeArchives: [
       {
      CompletionTime: <Date Representation>, 
      TapeARN: "arn:aws:storagegateway:us-east-1:999999999:tape/AM08A1AD", 
      TapeBarcode: "AM08A1AD", 
      TapeSizeInBytes: 107374182400, 
      TapeStatus: "ARCHIVED"
     }, 
       {
      CompletionTime: <Date Representation>, 
      TapeARN: "arn:aws:storagegateway:us-east-1:999999999:tape/AMZN01A2A4", 
      TapeBarcode: "AMZN01A2A4", 
      TapeSizeInBytes: 429496729600, 
      TapeStatus: "ARCHIVED"
     }
    ]
   }
   */
 });

Calling the describeTapeArchives operation

var params = {
  Limit: 'NUMBER_VALUE',
  Marker: 'STRING_VALUE',
  TapeARNs: [
    'STRING_VALUE',
    /* more items */
  ]
};
storagegateway.describeTapeArchives(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: {}) —
    • TapeARNs — (Array<String>)

      Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.

    • Marker — (String)

      An opaque string that indicates the position at which to begin describing virtual tapes.

    • Limit — (Integer)

      Specifies that the number of virtual tapes descried be limited to the specified number.

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:

      • TapeArchives — (Array<map>)

        An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name (ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description and tape barcode.

        • TapeARN — (String)

          The Amazon Resource Name (ARN) of an archived virtual tape.

        • TapeBarcode — (String)

          The barcode that identifies the archived virtual tape.

        • TapeCreatedDate — (Date)

          The date the virtual tape was created.

        • TapeSizeInBytes — (Integer)

          The size, in bytes, of the archived virtual tape.

        • CompletionTime — (Date)

          The time that the archiving of the virtual tape was completed.

          The default time stamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.

        • RetrievedTo — (String)

          The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being retrieved to.

          The virtual tape is retrieved from the virtual tape shelf (VTS).

        • TapeStatus — (String)

          The current state of the archived virtual tape.

        • TapeUsedInBytes — (Integer)

          The size, in bytes, of data stored on the virtual tape.

          Note: This value is not available for tapes created prior to May 13, 2015.
        • KMSKey — (String)

          The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

        • PoolId — (String)

          The ID of the pool that was used to archive the tape. The tapes in this pool are archived in the S3 storage class that is associated with the pool.

          Valid values: "GLACIER", "DEEP_ARCHIVE"

      • Marker — (String)

        An opaque string that indicates the position at which the virtual tapes that were fetched for description ended. Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this field does not appear in the response.

Returns:

  • (AWS.Request) —

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

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

Returns a list of virtual tape recovery points that are available for the specified tape gateway.

A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. This operation is only supported in the tape gateway type.

Service Reference:

Examples:

To describe virtual tape recovery points


/* Returns a list of virtual tape recovery points that are available for the specified gateway-VTL. */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 
  Limit: 1, 
  Marker: "1"
 };
 storagegateway.describeTapeRecoveryPoints(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 
    Marker: "1", 
    TapeRecoveryPointInfos: [
       {
      TapeARN: "arn:aws:storagegateway:us-east-1:999999999:tape/AMZN01A2A4", 
      TapeRecoveryPointTime: <Date Representation>, 
      TapeSizeInBytes: 1471550497, 
      TapeStatus: "AVAILABLE"
     }
    ]
   }
   */
 });

Calling the describeTapeRecoveryPoints operation

var params = {
  GatewayARN: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  Marker: 'STRING_VALUE'
};
storagegateway.describeTapeRecoveryPoints(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 region.

    • Marker — (String)

      An opaque string that indicates the position at which to begin describing the virtual tape recovery points.

    • Limit — (Integer)

      Specifies that the number of virtual tape recovery points that are described be limited to the specified number.

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

      • TapeRecoveryPointInfos — (Array<map>)

        An array of TapeRecoveryPointInfos that are available for the specified gateway.

        • TapeARN — (String)

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

        • TapeRecoveryPointTime — (Date)

          The time when the point-in-time view of the virtual tape was replicated for later recovery.

          The default time stamp format of the tape recovery point time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.

        • TapeSizeInBytes — (Integer)

          The size, in bytes, of the virtual tapes to recover.

        • TapeStatus — (String)

          The status of the virtual tapes.

      • Marker — (String)

        An opaque string that indicates the position at which the virtual tape recovery points that were listed for description ended.

        Use this marker in your next request to list the next set of virtual tape recovery points in the list. If there are no more recovery points to describe, this field does not appear in the response.

Returns:

  • (AWS.Request) —

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

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

Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes associated with the specified gateway. This operation is only supported in the tape gateway type.

Service Reference:

Examples:

To describe virtual tape(s) associated with gateway


/* Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes. */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", 
  Limit: 2, 
  Marker: "1", 
  TapeARNs: [
     "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1", 
     "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0"
  ]
 };
 storagegateway.describeTapes(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Marker: "1", 
    Tapes: [
       {
      TapeARN: "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1", 
      TapeBarcode: "TEST04A2A1", 
      TapeSizeInBytes: 107374182400, 
      TapeStatus: "AVAILABLE"
     }, 
       {
      TapeARN: "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0", 
      TapeBarcode: "TEST05A2A0", 
      TapeSizeInBytes: 107374182400, 
      TapeStatus: "AVAILABLE"
     }
    ]
   }
   */
 });

Calling the describeTapes operation

var params = {
  GatewayARN: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  Marker: 'STRING_VALUE',
  TapeARNs: [
    'STRING_VALUE',
    /* more items */
  ]
};
storagegateway.describeTapes(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 region.

    • TapeARNs — (Array<String>)

      Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.

    • Marker — (String)

      A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.

      If not specified, the first page of results is retrieved.

    • Limit — (Integer)

      Specifies that the number of virtual tapes described be limited to the specified number.

      Note: Amazon Web Services may impose its own limit, if this field is not set.

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:

      • Tapes — (Array<map>)

        An array of virtual tape descriptions.

        • TapeARN — (String)

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

        • TapeBarcode — (String)

          The barcode that identifies a specific virtual tape.

        • TapeCreatedDate — (Date)

          The date the virtual tape was created.

        • TapeSizeInBytes — (Integer)

          The size, in bytes, of the virtual tape capacity.

        • TapeStatus — (String)

          The current state of the virtual tape.

        • VTLDevice — (String)

          The virtual tape library (VTL) device that the virtual tape is associated with.

        • Progress — (Float)

          For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.

          Range: 0 (not started) to 100 (complete).

        • TapeUsedInBytes — (Integer)

          The size, in bytes, of data stored on the virtual tape.

          Note: This value is not available for tapes created prior to May 13, 2015.
        • KMSKey — (String)

          The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

        • PoolId — (String)

          The ID of the pool that contains tapes that will be archived. The tapes in this pool are archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.

          Valid values: "GLACIER", "DEEP_ARCHIVE"

      • Marker — (String)

        An opaque string which can be used as part of a subsequent DescribeTapes call to retrieve the next page of results.

        If a response does not contain a marker, then there are no more results to be retrieved.

Returns:

  • (AWS.Request) —

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

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

Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume and tape gateway types.

The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.

Service Reference:

Examples:

To describe upload buffer of gateway


/* Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated/used. */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
 };
 storagegateway.describeUploadBuffer(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    DiskIds: [
       "pci-0000:03:00.0-scsi-0:0:0:0", 
       "pci-0000:04:00.0-scsi-0:1:0:0"
    ], 
    GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 
    UploadBufferAllocatedInBytes: 0, 
    UploadBufferUsedInBytes: 161061273600
   }
   */
 });

To describe upload buffer of a gateway


/* Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated and used. */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
 };
 storagegateway.describeUploadBuffer(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    DiskIds: [
       "pci-0000:03:00.0-scsi-0:0:0:0", 
       "pci-0000:04:00.0-scsi-0:1:0:0"
    ], 
    GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 
    UploadBufferAllocatedInBytes: 161061273600, 
    UploadBufferUsedInBytes: 0
   }
   */
 });

Calling the describeUploadBuffer operation

var params = {
  GatewayARN: 'STRING_VALUE' /* required */
};
storagegateway.describeUploadBuffer(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 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 region.

      • DiskIds — (Array<String>)

        An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.

      • UploadBufferUsedInBytes — (Integer)

        The total number of bytes being used in the gateway's upload buffer.

      • UploadBufferAllocatedInBytes — (Integer)

        The total number of bytes allocated in the gateway's as upload buffer.

Returns:

  • (AWS.Request) —

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

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

Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, AWS Storage Gateway returns VTL device information.

This operation is only supported in the tape gateway type.

Service Reference:

Examples:

To describe virtual tape library (VTL) devices of a single gateway


/* Returns a description of virtual tape library (VTL) devices for the specified gateway. */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", 
  Limit: 123, 
  Marker: "1", 
  VTLDeviceARNs: [
  ]
 };
 storagegateway.describeVTLDevices(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    GatewayARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", 
    Marker: "1", 
    VTLDevices: [
       {
      DeviceiSCSIAttributes: {
       ChapEnabled: false, 
       NetworkInterfaceId: "10.243.43.207", 
       NetworkInterfacePort: 3260, 
       TargetARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-mediachanger"
      }, 
      VTLDeviceARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001", 
      VTLDeviceProductIdentifier: "L700", 
      VTLDeviceType: "Medium Changer", 
      VTLDeviceVendor: "STK"
     }, 
       {
      DeviceiSCSIAttributes: {
       ChapEnabled: false, 
       NetworkInterfaceId: "10.243.43.209", 
       NetworkInterfacePort: 3260, 
       TargetARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-01"
      }, 
      VTLDeviceARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00001", 
      VTLDeviceProductIdentifier: "ULT3580-TD5", 
      VTLDeviceType: "Tape Drive", 
      VTLDeviceVendor: "IBM"
     }, 
       {
      DeviceiSCSIAttributes: {
       ChapEnabled: false, 
       NetworkInterfaceId: "10.243.43.209", 
       NetworkInterfacePort: 3260, 
       TargetARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-02"
      }, 
      VTLDeviceARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00002", 
      VTLDeviceProductIdentifier: "ULT3580-TD5", 
      VTLDeviceType: "Tape Drive", 
      VTLDeviceVendor: "IBM"
     }
    ]
   }
   */
 });

Calling the describeVTLDevices operation

var params = {
  GatewayARN: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  Marker: 'STRING_VALUE',
  VTLDeviceARNs: [
    'STRING_VALUE',
    /* more items */
  ]
};
storagegateway.describeVTLDevices(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 region.

    • VTLDeviceARNs — (Array<String>)

      An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.

      Note: All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.
    • Marker — (String)

      An opaque string that indicates the position at which to begin describing the VTL devices.

    • Limit — (Integer)

      Specifies that the number of VTL devices described be limited to the specified number.

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

      • VTLDevices — (Array<map>)

        An array of VTL device objects composed of the Amazon Resource Name(ARN) of the VTL devices.

        • VTLDeviceARN — (String)

          Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer).

        • VTLDeviceType — (String)

          Specifies the type of device that the VTL device emulates.

        • VTLDeviceVendor — (String)

          Specifies the vendor of the device that the VTL device object emulates.

        • VTLDeviceProductIdentifier — (String)

          Specifies the model number of device that the VTL device emulates.

        • DeviceiSCSIAttributes — (map)

          A list of iSCSI information about a VTL device.

          • TargetARN — (String)

            Specifies the unique Amazon Resource Name (ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target.

          • NetworkInterfaceId — (String)

            The network interface identifier of the VTL device.

          • NetworkInterfacePort — (Integer)

            The port used to communicate with iSCSI VTL device targets.

          • ChapEnabled — (Boolean)

            Indicates whether mutual CHAP is enabled for the iSCSI target.

      • Marker — (String)

        An opaque string that indicates the position at which the VTL devices that were fetched for description ended. Use the marker in your next request to fetch the next set of VTL devices in the list. If there are no more VTL devices to describe, this field does not appear in the response.

Returns:

  • (AWS.Request) —

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

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

Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway type. This operation is deprecated in cached volumes API version (20120630). Use DescribeUploadBuffer instead.

Note: Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored volume gateway.

The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.

Service Reference:

Examples:

To describe the working storage of a gateway [Depreciated]


/* This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead. */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
 };
 storagegateway.describeWorkingStorage(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    DiskIds: [
       "pci-0000:03:00.0-scsi-0:0:0:0", 
       "pci-0000:03:00.0-scsi-0:0:1:0"
    ], 
    GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 
    WorkingStorageAllocatedInBytes: 2199023255552, 
    WorkingStorageUsedInBytes: 789207040
   }
   */
 });

Calling the describeWorkingStorage operation

var params = {
  GatewayARN: 'STRING_VALUE' /* required */
};
storagegateway.describeWorkingStorage(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 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 region.

      • DiskIds — (Array<String>)

        An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.

      • WorkingStorageUsedInBytes — (Integer)

        The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0.

      • WorkingStorageAllocatedInBytes — (Integer)

        The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0.

Returns:

  • (AWS.Request) —

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

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

Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance.

Service Reference:

Examples:

Calling the detachVolume operation

var params = {
  VolumeARN: 'STRING_VALUE', /* required */
  ForceDetach: true || false
};
storagegateway.detachVolume(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: {}) —
    • VolumeARN — (String)

      The Amazon Resource Name (ARN) of the volume to detach from the gateway.

    • ForceDetach — (Boolean)

      Set to true to forcibly remove the iSCSI connection of the target volume and detach the volume. The default is false. If this value is set to false, you must manually disconnect the iSCSI connection from the target volume.

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:

      • VolumeARN — (String)

        The Amazon Resource Name (ARN) of the volume that was detached.

Returns:

  • (AWS.Request) —

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

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

Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.

Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway type.

Once a gateway is disabled it cannot be enabled.

Service Reference:

Examples:

To disable a gateway when it is no longer functioning


/* Disables a gateway when the gateway is no longer functioning. Use this operation for a gateway-VTL that is not reachable or not functioning. */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
 };
 storagegateway.disableGateway(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
   }
   */
 });

Calling the disableGateway operation

var params = {
  GatewayARN: 'STRING_VALUE' /* required */
};
storagegateway.disableGateway(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 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 unique Amazon Resource Name (ARN) of the disabled gateway.

Returns:

  • (AWS.Request) —

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

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

Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.

Service Reference:

Examples:

Calling the joinDomain operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  GatewayARN: 'STRING_VALUE', /* required */
  Password: 'STRING_VALUE', /* required */
  UserName: 'STRING_VALUE', /* required */
  DomainControllers: [
    'STRING_VALUE',
    /* more items */
  ],
  OrganizationalUnit: 'STRING_VALUE'
};
storagegateway.joinDomain(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 region.

    • DomainName — (String)

      The name of the domain that you want the gateway to join.

    • OrganizationalUnit — (String)

      The organizational unit (OU) is a container with an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.

    • DomainControllers — (Array<String>)

      List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, mydc.mydomain.com:389.

    • UserName — (String)

      Sets the user name of user who has permission to add the gateway to the Active Directory domain.

    • Password — (String)

      Sets the password of the user who has permission to add the gateway to the Active Directory domain.

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 unique Amazon Resource Name (ARN) of the gateway that joined the domain.

Returns:

  • (AWS.Request) —

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

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

Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling user account. This operation is only supported for file gateways.

Service Reference:

Examples:

Calling the listFileShares operation

var params = {
  GatewayARN: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  Marker: 'STRING_VALUE'
};
storagegateway.listFileShares(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 whose file shares you want to list. If this field is not present, all file shares under your account are listed.

    • Limit — (Integer)

      The maximum number of file shares to return in the response. The value must be an integer with a value greater than zero. Optional.

    • Marker — (String)

      Opaque pagination token returned from a previous ListFileShares operation. If present, Marker specifies where to continue the list from after a previous call to ListFileShares. Optional.

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:

      • Marker — (String)

        If the request includes Marker, the response returns that value in this field.

      • NextMarker — (String)

        If a value is present, there are more file shares to return. In a subsequent request, use NextMarker as the value for Marker to retrieve the next set of file shares.

      • FileShareInfoList — (Array<map>)

        An array of information about the file gateway's file shares.

        • FileShareType — (String)

          The type of the file share.

          Possible values include:
          • "NFS"
          • "SMB"
        • FileShareARN — (String)

          The Amazon Resource Name (ARN) of the file share.

        • FileShareId — (String)

          The ID of the file share.

        • FileShareStatus — (String)

          The status of the file share. Possible values are CREATING, UPDATING, AVAILABLE and DELETING.

        • GatewayARN — (String)

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

Returns:

  • (AWS.Request) —

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

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

Lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).

By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.

If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.

Service Reference:

Examples:

To lists region specific gateways per AWS account


/* Lists gateways owned by an AWS account in a specified region as requested. Results are sorted by gateway ARN up to a maximum of 100 gateways. */

 var params = {
  Limit: 2, 
  Marker: "1"
 };
 storagegateway.listGateways(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Gateways: [
       {
      GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
     }, 
       {
      GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-23A4567C"
     }
    ], 
    Marker: "1"
   }
   */
 });

Calling the listGateways operation

var params = {
  Limit: 'NUMBER_VALUE',
  Marker: 'STRING_VALUE'
};
storagegateway.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: {}) —
    • Marker — (String)

      An opaque string that indicates the position at which to begin the returned list of gateways.

    • Limit — (Integer)

      Specifies that the list of gateways returned be limited to the specified number of items.

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>)

        An array of GatewayInfo objects.

        • GatewayId — (String)

          The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

        • GatewayARN — (String)

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

        • GatewayType — (String)

          The type of the gateway.

        • GatewayOperationalState — (String)

          The state of the gateway.

          Valid Values: DISABLED or ACTIVE

        • GatewayName — (String)

          The name of the gateway.

        • Ec2InstanceId — (String)

          The ID of the Amazon EC2 instance that was used to launch the gateway.

        • Ec2InstanceRegion — (String)

          The AWS Region where the Amazon EC2 instance is located.

      • Marker — (String)

        Use the marker in your next request to fetch the next set of gateways in the list. If there are no more gateways to list, this field does not appear in the response.

Returns:

  • (AWS.Request) —

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

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

Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request.

The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a DiskStatus field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted).

Service Reference:

Examples:

To list the gateway's local disks


/* The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
 };
 storagegateway.listLocalDisks(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Disks: [
       {
      DiskAllocationType: "CACHE_STORAGE", 
      DiskId: "pci-0000:03:00.0-scsi-0:0:0:0", 
      DiskNode: "SCSI(0:0)", 
      DiskPath: "/dev/sda", 
      DiskSizeInBytes: 1099511627776, 
      DiskStatus: "missing"
     }, 
       {
      DiskAllocationResource: "", 
      DiskAllocationType: "UPLOAD_BUFFER", 
      DiskId: "pci-0000:03:00.0-scsi-0:0:1:0", 
      DiskNode: "SCSI(0:1)", 
      DiskPath: "/dev/sdb", 
      DiskSizeInBytes: 1099511627776, 
      DiskStatus: "present"
     }
    ], 
    GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
   }
   */
 });

Calling the listLocalDisks operation

var params = {
  GatewayARN: 'STRING_VALUE' /* required */
};
storagegateway.listLocalDisks(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 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 region.

      • Disks — (Array<map>)

        A JSON object containing the following fields:

        • DiskId — (String)

          The unique device ID or other distinguishing data that identifies a local disk.

        • DiskPath — (String)

          The path of a local disk in the gateway virtual machine (VM).

        • DiskNode — (String)

          The device node of a local disk as assigned by the virtualization environment.

        • DiskStatus — (String)

          A value that represents the status of a local disk.

        • DiskSizeInBytes — (Integer)

          The local disk size in bytes.

        • DiskAllocationType — (String)

          One of the DiskAllocationType enumeration values that identifies how a local disk is used. Valid values: UPLOAD_BUFFER, CACHE_STORAGE

        • DiskAllocationResource — (String)

          The iSCSI qualified name (IQN) that is defined for a disk. This field is not included in the response if the local disk is not defined as an iSCSI target. The format of this field is targetIqn::LUNNumber::region-volumeId.

        • DiskAttributeList — (Array<String>)

          A list of values that represents attributes of a local disk.

Returns:

  • (AWS.Request) —

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

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

Lists the tags that have been added to the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway type.

Service Reference:

Examples:

To list tags that have been added to a resource


/* Lists the tags that have been added to the specified resource. */

 var params = {
  Limit: 1, 
  Marker: "1", 
  ResourceARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B"
 };
 storagegateway.listTagsForResource(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Marker: "1", 
    ResourceARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B", 
    Tags: [
       {
      Key: "Dev Gatgeway Region", 
      Value: "East Coast"
     }
    ]
   }
   */
 });

Calling the listTagsForResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  Marker: 'STRING_VALUE'
};
storagegateway.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 for which you want to list tags.

    • Marker — (String)

      An opaque string that indicates the position at which to begin returning the list of tags.

    • Limit — (Integer)

      Specifies that the list of tags returned be limited to the specified number of items.

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)

        he Amazon Resource Name (ARN) of the resource for which you want to list tags.

      • Marker — (String)

        An opaque string that indicates the position at which to stop returning the list of tags.

      • Tags — (Array<map>)

        An array that contains the tags for the specified resource.

        • Key — required — (String)

          Tag key (String). The key can't start with aws:.

        • Value — required — (String)

          Value of the tag key.

Returns:

  • (AWS.Request) —

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

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

Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS.

This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit parameter in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported in the tape gateway type.

Service Reference:

Examples:

Calling the listTapes operation

var params = {
  Limit: 'NUMBER_VALUE',
  Marker: 'STRING_VALUE',
  TapeARNs: [
    'STRING_VALUE',
    /* more items */
  ]
};
storagegateway.listTapes(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: {}) —
    • TapeARNs — (Array<String>)

      The Amazon Resource Name (ARN) of each of the tapes you want to list. If you don't specify a tape ARN, the response lists all tapes in both your VTL and VTS.

    • Marker — (String)

      A string that indicates the position at which to begin the returned list of tapes.

    • Limit — (Integer)

      An optional number limit for the tapes in the list returned by this call.

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:

      • TapeInfos — (Array<map>)

        An array of TapeInfo objects, where each object describes an a single tape. If there not tapes in the tape library or VTS, then the TapeInfos is an empty array.

        • TapeARN — (String)

          The Amazon Resource Name (ARN) of a virtual tape.

        • TapeBarcode — (String)

          The barcode that identifies a specific virtual tape.

        • TapeSizeInBytes — (Integer)

          The size, in bytes, of a virtual tape.

        • TapeStatus — (String)

          The status of the tape.

        • GatewayARN — (String)

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

        • PoolId — (String)

          The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.

          Valid values: "GLACIER", "DEEP_ARCHIVE"

      • Marker — (String)

        A string that indicates the position at which to begin returning the next list of tapes. Use the marker in your next request to continue pagination of tapes. If there are no more tapes to list, this element does not appear in the response body.

Returns:

  • (AWS.Request) —

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

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

Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. This operation is only supported in the cached volume and stored volume gateway types.

Service Reference:

Examples:

Calling the listVolumeInitiators operation

var params = {
  VolumeARN: 'STRING_VALUE' /* required */
};
storagegateway.listVolumeInitiators(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: {}) —
    • VolumeARN — (String)

      The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes for 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:

      • Initiators — (Array<String>)

        The host names and port numbers of all iSCSI initiators that are connected to the gateway.

Returns:

  • (AWS.Request) —

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

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

Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type.

Each cache volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.

Service Reference:

Examples:

To list recovery points for a gateway


/* Lists the recovery points for a specified gateway in which all data of the volume is consistent and can be used to create a snapshot. */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
 };
 storagegateway.listVolumeRecoveryPoints(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 
    VolumeRecoveryPointInfos: [
       {
      VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", 
      VolumeRecoveryPointTime: "2012-09-04T21:08:44.627Z", 
      VolumeSizeInBytes: 536870912000
     }
    ]
   }
   */
 });

Calling the listVolumeRecoveryPoints operation

var params = {
  GatewayARN: 'STRING_VALUE' /* required */
};
storagegateway.listVolumeRecoveryPoints(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 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 region.

      • VolumeRecoveryPointInfos — (Array<map>)

        An array of VolumeRecoveryPointInfo objects.

        • VolumeARN — (String)

          The Amazon Resource Name (ARN) of the volume target.

        • VolumeSizeInBytes — (Integer)

          The size of the volume in bytes.

        • VolumeUsageInBytes — (Integer)

          The size of the data stored on the volume in bytes.

          Note: This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.
        • VolumeRecoveryPointTime — (String)

          The time the recovery point was taken.

Returns:

  • (AWS.Request) —

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

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

Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API.

The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only supported in the cached volume and stored volume gateway types.

Service Reference:

Examples:

To list the iSCSI stored volumes of a gateway


/* Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN up to a maximum of 100 volumes. */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 
  Limit: 2, 
  Marker: "1"
 };
 storagegateway.listVolumes(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 
    Marker: "1", 
    VolumeInfos: [
       {
      GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 
      GatewayId: "sgw-12A3456B", 
      VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", 
      VolumeId: "vol-1122AABB", 
      VolumeSizeInBytes: 107374182400, 
      VolumeType: "STORED"
     }, 
       {
      GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C", 
      GatewayId: "sgw-gw-13B4567C", 
      VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C/volume/vol-3344CCDD", 
      VolumeId: "vol-1122AABB", 
      VolumeSizeInBytes: 107374182400, 
      VolumeType: "STORED"
     }
    ]
   }
   */
 });

Calling the listVolumes operation

var params = {
  GatewayARN: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  Marker: 'STRING_VALUE'
};
storagegateway.listVolumes(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 region.

    • Marker — (String)

      A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.

    • Limit — (Integer)

      Specifies that the list of volumes returned be limited to the specified number of items.

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

      • Marker — (String)

        Use the marker in your next request to continue pagination of iSCSI volumes. If there are no more volumes to list, this field does not appear in the response body.

      • VolumeInfos — (Array<map>)

        An array of VolumeInfo objects, where each object describes an iSCSI volume. If no volumes are defined for the gateway, then VolumeInfos is an empty array "[]".

        • VolumeARN — (String)

          The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:

          arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB

          Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

        • VolumeId — (String)

          The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.

          Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

        • GatewayARN — (String)

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

        • GatewayId — (String)

          The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

          Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

        • VolumeType — (String)

          One of the VolumeType enumeration values describing the type of the volume.

        • VolumeSizeInBytes — (Integer)

          The size of the volume in bytes.

          Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

        • VolumeAttachmentStatus — (String)

          One of the VolumeStatus values that indicates the state of the storage volume.

Returns:

  • (AWS.Request) —

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

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

Sends you notification through CloudWatch Events when all files written to your NFS file share have been uploaded to Amazon S3.

AWS Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the NFS file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or AWS Lambda function. This operation is only supported for file gateways.

For more information, see Getting File Upload Notification in the Storage Gateway User Guide (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification).

Service Reference:

Examples:

Calling the notifyWhenUploaded operation

var params = {
  FileShareARN: 'STRING_VALUE' /* required */
};
storagegateway.notifyWhenUploaded(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: {}) —
    • FileShareARN — (String)

      The Amazon Resource Name (ARN) of the file share.

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:

      • FileShareARN — (String)

        The Amazon Resource Name (ARN) of the file share.

      • NotificationId — (String)

        The randomly generated ID of the notification that was sent. This ID is in UUID format.

Returns:

  • (AWS.Request) —

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

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

Refreshes the cache for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed or replaced since the gateway last listed the bucket's contents and cached the results. This operation is only supported in the file gateway type. You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see Getting Notified About File Operations.

When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through an CloudWatch event when your RefreshCache operation completes.

Service Reference:

Examples:

Calling the refreshCache operation

var params = {
  FileShareARN: 'STRING_VALUE', /* required */
  FolderList: [
    'STRING_VALUE',
    /* more items */
  ],
  Recursive: true || false
};
storagegateway.refreshCache(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: {}) —
    • FileShareARN — (String)

      The Amazon Resource Name (ARN) of the file share you want to refresh.

    • FolderList — (Array<String>)

      A comma-separated list of the paths of folders to refresh in the cache. The default is ["/"]. The default refreshes objects and folders at the root of the Amazon S3 bucket. If Recursive is set to "true", the entire S3 bucket that the file share has access to is refreshed.

    • Recursive — (Boolean)

      A value that specifies whether to recursively refresh folders in the cache. The refresh includes folders that were in the cache the last time the gateway listed the folder's contents. If this value set to "true", each folder that is listed in FolderList is recursively updated. Otherwise, subfolders listed in FolderList are not refreshed. Only objects that are in folders listed directly under FolderList are found and used for the update. The default is "true".

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:

      • FileShareARN — (String)

        The Amazon Resource Name (ARN) of the file share.

      • NotificationId — (String)

        The randomly generated ID of the notification that was sent. This ID is in UUID format.

Returns:

  • (AWS.Request) —

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

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

Removes one or more tags from the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway types.

Service Reference:

Examples:

To remove tags from a resource


/* Lists the iSCSI stored volumes of a gateway. Removes one or more tags from the specified resource. */

 var params = {
  ResourceARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B", 
  TagKeys: [
     "Dev Gatgeway Region", 
     "East Coast"
  ]
 };
 storagegateway.removeTagsFromResource(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ResourceARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B"
   }
   */
 });

Calling the removeTagsFromResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
storagegateway.removeTagsFromResource(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 you want to remove the tags from.

    • TagKeys — (Array<String>)

      The keys of the tags you want to remove from the specified resource. A tag is composed of a 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 that the tags were removed from.

Returns:

  • (AWS.Request) —

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

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

Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types.

If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.

Service Reference:

Examples:

To reset cache disks in error status


/* Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C"
 };
 storagegateway.resetCache(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C"
   }
   */
 });

Calling the resetCache operation

var params = {
  GatewayARN: 'STRING_VALUE' /* required */
};
storagegateway.resetCache(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 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 region.

Returns:

  • (AWS.Request) —

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

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

Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS, that is, archive. This operation is only supported in the tape gateway type.

Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. This operation is only supported in the tape gateway type.

Service Reference:

Examples:

To retrieve an archived tape from the VTS


/* Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL. Virtual tapes archived in the VTS are not associated with any gateway. */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", 
  TapeARN: "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF"
 };
 storagegateway.retrieveTapeArchive(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    TapeARN: "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF"
   }
   */
 });

Calling the retrieveTapeArchive operation

var params = {
  GatewayARN: 'STRING_VALUE', /* required */
  TapeARN: 'STRING_VALUE' /* required */
};
storagegateway.retrieveTapeArchive(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: {}) —
    • TapeARN — (String)

      The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS).

    • GatewayARN — (String)

      The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the ListGateways operation to return a list of gateways for your account and region.

      You retrieve archived virtual tapes to only one gateway and the gateway must be a tape 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:

      • TapeARN — (String)

        The Amazon Resource Name (ARN) of the retrieved virtual tape.

Returns:

  • (AWS.Request) —

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

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

Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway type.

A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.

Note: The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a tape gateway. There is no charge for retrieving recovery points.

Service Reference:

Examples:

To retrieve the recovery point of a virtual tape


/* Retrieves the recovery point for the specified virtual tape. */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", 
  TapeARN: "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF"
 };
 storagegateway.retrieveTapeRecoveryPoint(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    TapeARN: "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF"
   }
   */
 });

Calling the retrieveTapeRecoveryPoint operation

var params = {
  GatewayARN: 'STRING_VALUE', /* required */
  TapeARN: 'STRING_VALUE' /* required */
};
storagegateway.retrieveTapeRecoveryPoint(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: {}) —
    • TapeARN — (String)

      The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the recovery point.

    • GatewayARN — (String)

      The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and 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:

      • TapeARN — (String)

        The Amazon Resource Name (ARN) of the virtual tape for which the recovery point was retrieved.

Returns:

  • (AWS.Request) —

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

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

Sets the password for your VM local console. When you log in to the local console for the first time, you log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know the default password to set a new password.

Service Reference:

Examples:

To set a password for your VM


/* Sets the password for your VM local console. */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", 
  LocalConsolePassword: "PassWordMustBeAtLeast6Chars."
 };
 storagegateway.setLocalConsolePassword(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    GatewayARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"
   }
   */
 });

Calling the setLocalConsolePassword operation

var params = {
  GatewayARN: 'STRING_VALUE', /* required */
  LocalConsolePassword: 'STRING_VALUE' /* required */
};
storagegateway.setLocalConsolePassword(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 region.

    • LocalConsolePassword — (String)

      The password you want to set for your VM local console.

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

Returns:

  • (AWS.Request) —

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

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

Sets the password for the guest user smbguest. The smbguest user is the user when the authentication method for the file share is set to GuestAccess.

Service Reference:

Examples:

Calling the setSMBGuestPassword operation

var params = {
  GatewayARN: 'STRING_VALUE', /* required */
  Password: 'STRING_VALUE' /* required */
};
storagegateway.setSMBGuestPassword(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 file gateway the SMB file share is associated with.

    • Password — (String)

      The password that you want to set for your SMB Server.

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

Returns:

  • (AWS.Request) —

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

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

Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.

The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM.

Note: If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.

After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.

Note: When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway.

If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.

Service Reference:

Examples:

To shut down a gateway service


/* This operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the VM. */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"
 };
 storagegateway.shutdownGateway(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    GatewayARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"
   }
   */
 });

Calling the shutdownGateway operation

var params = {
  GatewayARN: 'STRING_VALUE' /* required */
};
storagegateway.shutdownGateway(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 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 region.

Returns:

  • (AWS.Request) —

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

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

Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups.

Note: When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway.

To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.

Service Reference:

Examples:

To start a gateway service


/* Starts a gateway service that was previously shut down. */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"
 };
 storagegateway.startGateway(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    GatewayARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"
   }
   */
 });

Calling the startGateway operation

var params = {
  GatewayARN: 'STRING_VALUE' /* required */
};
storagegateway.startGateway(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 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 region.

Returns:

  • (AWS.Request) —

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

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

Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains.

By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.

To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

Service Reference:

Examples:

To update the bandwidth rate limits of a gateway


/* Updates the bandwidth rate limits of a gateway. Both the upload and download bandwidth rate limit can be set, or either one of the two. If a new limit is not set, the existing rate limit remains. */

 var params = {
  AverageDownloadRateLimitInBitsPerSec: 102400, 
  AverageUploadRateLimitInBitsPerSec: 51200, 
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
 };
 storagegateway.updateBandwidthRateLimit(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
   }
   */
 });

Calling the updateBandwidthRateLimit operation

var params = {
  GatewayARN: 'STRING_VALUE', /* required */
  AverageDownloadRateLimitInBitsPerSec: 'NUMBER_VALUE',
  AverageUploadRateLimitInBitsPerSec: 'NUMBER_VALUE'
};
storagegateway.updateBandwidthRateLimit(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 region.

    • AverageUploadRateLimitInBitsPerSec — (Integer)

      The average upload bandwidth rate limit in bits per second.

    • AverageDownloadRateLimitInBitsPerSec — (Integer)

      The average download bandwidth rate limit in bits per second.

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

Returns:

  • (AWS.Request) —

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

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

Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it.

When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.

Service Reference:

Examples:

To update CHAP credentials for an iSCSI target


/* Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. */

 var params = {
  InitiatorName: "iqn.1991-05.com.microsoft:computername.domain.example.com", 
  SecretToAuthenticateInitiator: "111111111111", 
  SecretToAuthenticateTarget: "222222222222", 
  TargetARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
 };
 storagegateway.updateChapCredentials(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    InitiatorName: "iqn.1991-05.com.microsoft:computername.domain.example.com", 
    TargetARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
   }
   */
 });

Calling the updateChapCredentials operation

var params = {
  InitiatorName: 'STRING_VALUE', /* required */
  SecretToAuthenticateInitiator: 'STRING_VALUE', /* required */
  TargetARN: 'STRING_VALUE', /* required */
  SecretToAuthenticateTarget: 'STRING_VALUE'
};
storagegateway.updateChapCredentials(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: {}) —
    • TargetARN — (String)

      The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified VolumeARN.

    • SecretToAuthenticateInitiator — (String)

      The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.

      Note: The secret key must be between 12 and 16 bytes when encoded in UTF-8.
    • InitiatorName — (String)

      The iSCSI initiator that connects to the target.

    • SecretToAuthenticateTarget — (String)

      The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).

      Byte constraints: Minimum bytes of 12. Maximum bytes of 16.

      Note: The secret key must be between 12 and 16 bytes when encoded in UTF-8.

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:

      • TargetARN — (String)

        The Amazon Resource Name (ARN) of the target. This is the same target specified in the request.

      • InitiatorName — (String)

        The iSCSI initiator that connects to the target. This is the same initiator name specified in the request.

Returns:

  • (AWS.Request) —

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

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

Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

Note: For Gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN.

Service Reference:

Examples:

To update a gateway's metadata


/* Updates a gateway's metadata, which includes the gateway's name and time zone. */

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 
  GatewayName: "MyGateway2", 
  GatewayTimezone: "GMT-12:00"
 };
 storagegateway.updateGatewayInformation(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 
    GatewayName: ""
   }
   */
 });

Calling the updateGatewayInformation operation

var params = {
  GatewayARN: 'STRING_VALUE', /* required */
  GatewayName: 'STRING_VALUE',
  GatewayTimezone: 'STRING_VALUE'
};
storagegateway.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. Use the ListGateways operation to return a list of gateways for your account and region.

    • GatewayName — (String)

      The name you configured for your gateway.

    • GatewayTimezone — (String)

      A value that indicates the time zone 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. Use the ListGateways operation to return a list of gateways for your account and region.

      • GatewayName — (String)

        The name you configured for your gateway.

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. You can call DescribeGatewayInformation to verify the gateway is in the STATE_RUNNING state.

A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see Customizing Your Windows iSCSI Settings and Customizing Your Linux iSCSI Settings, respectively.

Service Reference:

Examples:

To update a gateway's VM software


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

 var params = {
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
 };
 storagegateway.updateGatewaySoftwareNow(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
   }
   */
 });

Calling the updateGatewaySoftwareNow operation

var params = {
  GatewayARN: 'STRING_VALUE' /* required */
};
storagegateway.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. Use the ListGateways operation to return a list of gateways for your account and 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 region.

Returns:

  • (AWS.Request) —

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

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

Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone.

Service Reference:

Examples:

To update a gateway's maintenance start time


/* Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is in your gateway's time zone. */

 var params = {
  DayOfWeek: 2, 
  GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", 
  HourOfDay: 0, 
  MinuteOfHour: 30
 };
 storagegateway.updateMaintenanceStartTime(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
   }
   */
 });

Calling the updateMaintenanceStartTime operation

var params = {
  GatewayARN: 'STRING_VALUE', /* required */
  HourOfDay: 'NUMBER_VALUE', /* required */
  MinuteOfHour: 'NUMBER_VALUE', /* required */
  DayOfMonth: 'NUMBER_VALUE',
  DayOfWeek: 'NUMBER_VALUE'
};
storagegateway.updateMaintenanceStartTime(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 region.

    • HourOfDay — (Integer)

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

    • MinuteOfHour — (Integer)

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

    • DayOfWeek — (Integer)

      The day of the week component of the maintenance start time week represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday.

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

      Note: This value is only available for tape and volume gateways.

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

Returns:

  • (AWS.Request) —

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

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

Updates a Network File System (NFS) file share. This operation is only supported in the file gateway type.

Note: To leave a file share field unchanged, set the corresponding input field to null.

Updates the following file share setting:

  • Default storage class for your S3 bucket

  • Metadata defaults for your S3 bucket

  • Allowed NFS clients for your file share

  • Squash settings

  • Write status of your file share

Note: To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported in file gateways.

Service Reference:

Examples:

Calling the updateNFSFileShare operation

var params = {
  FileShareARN: 'STRING_VALUE', /* required */
  ClientList: [
    'STRING_VALUE',
    /* more items */
  ],
  DefaultStorageClass: 'STRING_VALUE',
  GuessMIMETypeEnabled: true || false,
  KMSEncrypted: true || false,
  KMSKey: 'STRING_VALUE',
  NFSFileShareDefaults: {
    DirectoryMode: 'STRING_VALUE',
    FileMode: 'STRING_VALUE',
    GroupId: 'NUMBER_VALUE',
    OwnerId: 'NUMBER_VALUE'
  },
  ObjectACL: private | public-read | public-read-write | authenticated-read | bucket-owner-read | bucket-owner-full-control | aws-exec-read,
  ReadOnly: true || false,
  RequesterPays: true || false,
  Squash: 'STRING_VALUE'
};
storagegateway.updateNFSFileShare(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: {}) —
    • FileShareARN — (String)

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

    • KMSEncrypted — (Boolean)

      True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

    • KMSKey — (String)

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

    • NFSFileShareDefaults — (map)

      The default values for the file share. Optional.

      • FileMode — (String)

        The Unix file mode in the form "nnnn". For example, "0666" represents the default file mode inside the file share. The default value is 0666.

      • DirectoryMode — (String)

        The Unix directory mode in the form "nnnn". For example, "0666" represents the default access mode for all directories inside the file share. The default value is 0777.

      • GroupId — (Integer)

        The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody.

      • OwnerId — (Integer)

        The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody.

    • DefaultStorageClass — (String)

      The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

    • ObjectACL — (String)

      A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

      Possible values include:
      • "private"
      • "public-read"
      • "public-read-write"
      • "authenticated-read"
      • "bucket-owner-read"
      • "bucket-owner-full-control"
      • "aws-exec-read"
    • ClientList — (Array<String>)

      The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

    • Squash — (String)

      The user mapped to anonymous user. Valid options are the following:

      • RootSquash - Only root is mapped to anonymous user.

      • NoSquash - No one is mapped to anonymous user

      • AllSquash - Everyone is mapped to anonymous user.

    • ReadOnly — (Boolean)

      A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

    • GuessMIMETypeEnabled — (Boolean)

      A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

    • RequesterPays — (Boolean)

      A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

      Note: RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

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:

      • FileShareARN — (String)

        The Amazon Resource Name (ARN) of the updated file share.

Returns:

  • (AWS.Request) —

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

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

Updates a Server Message Block (SMB) file share.

Note: To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported for file gateways.

File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

File gateways don't support creating hard or symbolic links on a file share.

Service Reference:

Examples:

Calling the updateSMBFileShare operation

var params = {
  FileShareARN: 'STRING_VALUE', /* required */
  DefaultStorageClass: 'STRING_VALUE',
  GuessMIMETypeEnabled: true || false,
  InvalidUserList: [
    'STRING_VALUE',
    /* more items */
  ],
  KMSEncrypted: true || false,
  KMSKey: 'STRING_VALUE',
  ObjectACL: private | public-read | public-read-write | authenticated-read | bucket-owner-read | bucket-owner-full-control | aws-exec-read,
  ReadOnly: true || false,
  RequesterPays: true || false,
  SMBACLEnabled: true || false,
  ValidUserList: [
    'STRING_VALUE',
    /* more items */
  ]
};
storagegateway.updateSMBFileShare(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: {}) —
    • FileShareARN — (String)

      The Amazon Resource Name (ARN) of the SMB file share that you want to update.

    • KMSEncrypted — (Boolean)

      True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

    • KMSKey — (String)

      The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

    • DefaultStorageClass — (String)

      The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

    • ObjectACL — (String)

      A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

      Possible values include:
      • "private"
      • "public-read"
      • "public-read-write"
      • "authenticated-read"
      • "bucket-owner-read"
      • "bucket-owner-full-control"
      • "aws-exec-read"
    • ReadOnly — (Boolean)

      A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

    • GuessMIMETypeEnabled — (Boolean)

      A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

    • RequesterPays — (Boolean)

      A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

      Note: RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
    • SMBACLEnabled — (Boolean)

      Set this value to "true to enable ACL (access control list) on the SMB file share. Set it to "false" to map file and directory permissions to the POSIX permissions.

    • ValidUserList — (Array<String>)

      A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

    • InvalidUserList — (Array<String>)

      A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

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:

      • FileShareARN — (String)

        The Amazon Resource Name (ARN) of the updated SMB file share.

Returns:

  • (AWS.Request) —

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

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

Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway types.

The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume.

In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.

Service Reference:

Examples:

To update a volume snapshot schedule


/* Updates a snapshot schedule configured for a gateway volume. */

 var params = {
  Description: "Hourly snapshot", 
  RecurrenceInHours: 1, 
  StartAt: 0, 
  VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
 };
 storagegateway.updateSnapshotSchedule(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
   }
   */
 });

Calling the updateSnapshotSchedule operation

var params = {
  RecurrenceInHours: 'NUMBER_VALUE', /* required */
  StartAt: 'NUMBER_VALUE', /* required */
  VolumeARN: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE'
};
storagegateway.updateSnapshotSchedule(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: {}) —
    • VolumeARN — (String)

      The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

    • StartAt — (Integer)

      The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

    • RecurrenceInHours — (Integer)

      Frequency of snapshots. Specify the number of hours between snapshots.

    • Description — (String)

      Optional description of the snapshot that overwrites the existing description.

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:

      • VolumeARN — (String)

        The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Returns:

  • (AWS.Request) —

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

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

Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a medium changer type for the tape gateway. This operation enables you to select a different type of medium changer after a tape gateway is activated. This operation is only supported in the tape gateway type.

Service Reference:

Examples:

To update a VTL device type


/* Updates the type of medium changer in a gateway-VTL after a gateway-VTL is activated. */

 var params = {
  DeviceType: "Medium Changer", 
  VTLDeviceARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001"
 };
 storagegateway.updateVTLDeviceType(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    VTLDeviceARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001"
   }
   */
 });

Calling the updateVTLDeviceType operation

var params = {
  DeviceType: 'STRING_VALUE', /* required */
  VTLDeviceARN: 'STRING_VALUE' /* required */
};
storagegateway.updateVTLDeviceType(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: {}) —
    • VTLDeviceARN — (String)

      The Amazon Resource Name (ARN) of the medium changer you want to select.

    • DeviceType — (String)

      The type of medium changer you want to select.

      Valid Values: "STK-L700", "AWS-Gateway-VTL"

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:

      • VTLDeviceARN — (String)

        The Amazon Resource Name (ARN) of the medium changer you have selected.

Returns:

  • (AWS.Request) —

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