Class: AWS.StorageGateway

/* 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"
   }
   */
 });

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 Amazon Web Services Region.

  • DiskIds — (Array<String>)

    An array of strings that identify disks that are to be configured as working storage. Each string has 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 Amazon Web Services Region.

Returns:

• (AWS.Request) —

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

/* 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"
   }
   */
 });

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

/* 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"
   }
   */
 });

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 Amazon Web Services Region.

  • DiskIds — (Array<String>)

    An array of strings that identify disks that are to be configured as working storage. Each string has 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 Amazon Web Services Region.

Returns:

• (AWS.Request) —

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

/* 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"
   }
   */
 });

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 Amazon Web Services Region.

  • DiskIds — (Array<String>)

    An array of strings that identify disks that are to be configured as working storage. Each string has 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 Amazon Web Services Region.

Returns:

• (AWS.Request) —

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

var params = {
  PoolId: 'STRING_VALUE', /* required */
  TapeARN: 'STRING_VALUE', /* required */
  BypassGovernanceRetention: true || false
};
storagegateway.assignTapePool(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 unique Amazon Resource Name (ARN) of the virtual tape that you want to add to the tape pool.

  • 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 (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

  • BypassGovernanceRetention — (Boolean)

    Set permissions to bypass governance retention. If the lock type of the archived tape is Governance, the tape's archived age is not older than RetentionLockInDays, and the user does not already have BypassGovernanceRetention, setting this to TRUE enables the user to bypass the retention lock. This parameter is set to true by default for calls from the console.

    Valid values: TRUE | FALSE

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 unique Amazon Resource Names (ARN) of the virtual tape that was added to the tape pool.

Returns:

• (AWS.Request) —

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

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  GatewayARN: 'STRING_VALUE', /* required */
  LocationARN: 'STRING_VALUE', /* required */
  Password: 'STRING_VALUE', /* required */
  UserName: 'STRING_VALUE', /* required */
  AuditDestinationARN: 'STRING_VALUE',
  CacheAttributes: {
    CacheStaleTimeoutInSeconds: 'NUMBER_VALUE'
  },
  EndpointNetworkConfiguration: {
    IpAddresses: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
storagegateway.associateFileSystem(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: {}) —
  • UserName — (String)

    The user name of the user credential that has permission to access the root share D$ of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.

  • Password — (String)

    The password of the user credential.

  • ClientToken — (String)

    A unique string value that you supply that is used by the FSx File Gateway to ensure idempotent file system association creation.

  • GatewayARN — (String)

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

  • LocationARN — (String)

    The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.

  • Tags — (Array<map>)

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

    • Key — required — (String)

      Tag key. The key can't start with aws:.

    • Value — required — (String)

      Value of the tag key.

  • AuditDestinationARN — (String)

    The Amazon Resource Name (ARN) of the storage used for the audit logs.

  • CacheAttributes — (map)

    The refresh cache information for the file share or FSx file systems.

    • CacheStaleTimeoutInSeconds — (Integer)

      Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket or Amazon FSx file system. The TTL duration is in seconds.

      Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)

  • EndpointNetworkConfiguration — (map)

    Specifies the network configuration information for the gateway associated with the Amazon FSx file system.

    Note: If multiple file systems are associated with this gateway, this parameter's IpAddresses field is required.
    • IpAddresses — (Array<String>)

      A list of gateway IP addresses on which the associated Amazon FSx file system is available.

      Note: If multiple file systems are associated with this gateway, this field is required.

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:

    • FileSystemAssociationARN — (String)

      The ARN of the newly created file system association.

Returns:

• (AWS.Request) —

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

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.

/* 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"
   }
   */
 });

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 Amazon Web Services 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.

/* 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"
   }
   */
 });

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 Amazon Web Services 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.

/* 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"
   }
   */
 });

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 Amazon Web Services 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)

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

    Valid Values: true | false

  • KMSKey — (String)

    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

  • Tags — (Array<map>)

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

    Note: Valid characters for key and value are letters, spaces, and numbers that you can represent 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 characters.
    • Key — required — (String)

      Tag key. 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.

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  GatewayARN: 'STRING_VALUE', /* required */
  LocationARN: 'STRING_VALUE', /* required */
  Role: 'STRING_VALUE', /* required */
  AuditDestinationARN: 'STRING_VALUE',
  BucketRegion: 'STRING_VALUE',
  CacheAttributes: {
    CacheStaleTimeoutInSeconds: 'NUMBER_VALUE'
  },
  ClientList: [
    'STRING_VALUE',
    /* more items */
  ],
  DefaultStorageClass: 'STRING_VALUE',
  FileShareName: 'STRING_VALUE',
  GuessMIMETypeEnabled: true || false,
  KMSEncrypted: true || false,
  KMSKey: 'STRING_VALUE',
  NFSFileShareDefaults: {
    DirectoryMode: 'STRING_VALUE',
    FileMode: 'STRING_VALUE',
    GroupId: 'NUMBER_VALUE',
    OwnerId: 'NUMBER_VALUE'
  },
  NotificationPolicy: '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,
  Squash: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  VPCEndpointDNSName: 'STRING_VALUE'
};
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 S3 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 S3 File Gateway on which you want to create a file share.

  • KMSEncrypted — (Boolean)

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

    Valid Values: true | false

  • KMSKey — (String)

    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

  • Role — (String)

    The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.

  • LocationARN — (String)

    A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).

    Note: You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples. Bucket ARN: arn:aws:s3:::my-bucket/prefix/ Access point ARN: arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/ If you specify an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide. Access point alias: test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias
  • DefaultStorageClass — (String)

    The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD. Optional.

    Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

  • ObjectACL — (String)

    A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 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 S3 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 values 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. Set this value to true to set the write status to read-only, otherwise set to false.

    Valid Values: true | 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, otherwise set to false. The default value is true.

    Valid Values: true | false

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

    Valid Values: true | false

  • 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. The key can't start with aws:.

    • Value — required — (String)

      Value of the tag key.

  • FileShareName — (String)

    The name of the file share. Optional.

    Note: FileShareName must be set if an S3 prefix name is set in LocationARN, or if an access point or access point alias is used.
  • CacheAttributes — (map)

    Specifies refresh cache information for the file share.

    • CacheStaleTimeoutInSeconds — (Integer)

      Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket or Amazon FSx file system. The TTL duration is in seconds.

      Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)

  • NotificationPolicy — (String)

    The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.

    Note: SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.

    The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.

    {\"Upload\": {\"SettlingTimeInSeconds\": 60}}

    The following example sets NotificationPolicy off.

    {}

  • VPCEndpointDNSName — (String)

    Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.

    Note: This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
  • BucketRegion — (String)

    Specifies the Region of the S3 bucket where the NFS file share stores files.

    Note: This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
  • AuditDestinationARN — (String)

    The Amazon Resource Name (ARN) of the storage used for audit logs.

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.

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  GatewayARN: 'STRING_VALUE', /* required */
  LocationARN: 'STRING_VALUE', /* required */
  Role: 'STRING_VALUE', /* required */
  AccessBasedEnumeration: true || false,
  AdminUserList: [
    'STRING_VALUE',
    /* more items */
  ],
  AuditDestinationARN: 'STRING_VALUE',
  Authentication: 'STRING_VALUE',
  BucketRegion: 'STRING_VALUE',
  CacheAttributes: {
    CacheStaleTimeoutInSeconds: 'NUMBER_VALUE'
  },
  CaseSensitivity: ClientSpecified | CaseSensitive,
  DefaultStorageClass: 'STRING_VALUE',
  FileShareName: 'STRING_VALUE',
  GuessMIMETypeEnabled: true || false,
  InvalidUserList: [
    'STRING_VALUE',
    /* more items */
  ],
  KMSEncrypted: true || false,
  KMSKey: 'STRING_VALUE',
  NotificationPolicy: 'STRING_VALUE',
  ObjectACL: private | public-read | public-read-write | authenticated-read | bucket-owner-read | bucket-owner-full-control | aws-exec-read,
  OplocksEnabled: true || false,
  ReadOnly: true || false,
  RequesterPays: true || false,
  SMBACLEnabled: true || false,
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  VPCEndpointDNSName: 'STRING_VALUE',
  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 S3 File Gateway to ensure idempotent file share creation.

  • GatewayARN — (String)

    The ARN of the S3 File Gateway on which you want to create a file share.

  • KMSEncrypted — (Boolean)

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

    Valid Values: true | false

  • KMSKey — (String)

    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

  • Role — (String)

    The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.

  • LocationARN — (String)

    A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).

    Note: You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples. Bucket ARN: arn:aws:s3:::my-bucket/prefix/ Access point ARN: arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/ If you specify an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide. Access point alias: test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias
  • DefaultStorageClass — (String)

    The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD. Optional.

    Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

  • ObjectACL — (String)

    A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 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. Set this value to true to set the write status to read-only, otherwise set to false.

    Valid Values: true | 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, otherwise set to false. The default value is true.

    Valid Values: true | false

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

    Valid Values: true | false

  • SMBACLEnabled — (Boolean)

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

    For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.

    Valid Values: true | false

  • AccessBasedEnumeration — (Boolean)

    The files and folders on this share will only be visible to users with read access.

  • AdminUserList — (Array<String>)

    A list of users or groups in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1.

    Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file 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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.

  • AuditDestinationARN — (String)

    The Amazon Resource Name (ARN) of the storage used for audit logs.

  • Authentication — (String)

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

    Valid Values: ActiveDirectory | GuestAccess

  • CaseSensitivity — (String)

    The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.

    Possible values include:
    • "ClientSpecified"
    • "CaseSensitive"
  • 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. The key can't start with aws:.

    • Value — required — (String)

      Value of the tag key.

  • FileShareName — (String)

    The name of the file share. Optional.

    Note: FileShareName must be set if an S3 prefix name is set in LocationARN, or if an access point or access point alias is used.
  • CacheAttributes — (map)

    Specifies refresh cache information for the file share.

    • CacheStaleTimeoutInSeconds — (Integer)

      Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket or Amazon FSx file system. The TTL duration is in seconds.

      Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)

  • NotificationPolicy — (String)

    The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.

    Note: SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.

    The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.

    {\"Upload\": {\"SettlingTimeInSeconds\": 60}}

    The following example sets NotificationPolicy off.

    {}

  • VPCEndpointDNSName — (String)

    Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.

    Note: This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
  • BucketRegion — (String)

    Specifies the Region of the S3 bucket where the SMB file share stores files.

    Note: This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
  • OplocksEnabled — (Boolean)

    Specifies whether opportunistic locking is enabled for the SMB file share.

    Note: Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.

    Valid Values: true | false

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

/* 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"
   }
   */
 });

var params = {
  SnapshotDescription: 'STRING_VALUE', /* required */
  VolumeARN: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
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 Storage Gateway snapshot Details pane, Description field.

  • Tags — (Array<map>)

    A list of up to 50 tags that can be assigned to a snapshot. 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. 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 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.

/* 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"
   }
   */
 });

var params = {
  SnapshotDescription: 'STRING_VALUE', /* required */
  VolumeARN: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
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 Storage Gateway snapshot Details pane, Description field.

  • Tags — (Array<map>)

    A list of up to 50 tags that can be assigned to a snapshot. 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. 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:

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

/* 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
   }
   */
 });

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 Amazon Web Services 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)

    Set to true if you want to preserve the data on the local disk. Otherwise, set to false to create 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)

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

    Valid Values: true | false

  • KMSKey — (String)

    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. 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. 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.

var params = {
  PoolName: 'STRING_VALUE', /* required */
  StorageClass: DEEP_ARCHIVE | GLACIER, /* required */
  RetentionLockTimeInDays: 'NUMBER_VALUE',
  RetentionLockType: COMPLIANCE | GOVERNANCE | NONE,
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
storagegateway.createTapePool(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: {}) —
  • PoolName — (String)

    The name of the new custom tape pool.

  • StorageClass — (String)

    The storage class that is associated with the new custom pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

    Possible values include:
    • "DEEP_ARCHIVE"
    • "GLACIER"
  • RetentionLockType — (String)

    Tape retention lock can be configured in two modes. When configured in governance mode, Amazon Web Services accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root Amazon Web Services account.

    Possible values include:
    • "COMPLIANCE"
    • "GOVERNANCE"
    • "NONE"
  • RetentionLockTimeInDays — (Integer)

    Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days).

  • Tags — (Array<map>)

    A list of up to 50 tags that can be assigned to tape pool. 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. 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:

    • PoolARN — (String)

      The unique Amazon Resource Name (ARN) that represents the custom tape pool. Use the ListTapePools operation to return a list of tape pools for your account and Amazon Web Services Region.

Returns:

• (AWS.Request) —

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

/* 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"
    ]
   }
   */
 });

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 */
  ],
  Worm: true || false
};
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 Amazon Web Services 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 bytes).
  • 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-4 characters in length and must be one of the uppercase letters from A to Z.
  • KMSEncrypted — (Boolean)

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

    Valid Values: true | false

  • KMSKey — (String)

    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. 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 (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

  • Worm — (Boolean)

    Set to TRUE if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.

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

/* 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"
   }
   */
 });

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 */
  ],
  Worm: true || false
};
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 Amazon Web Services 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 bytes).
  • 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)

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

    Valid Values: true | false

  • KMSKey — (String)

    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. 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 (S3 Glacier or S3 Deep Archive) that corresponds to the pool.

  • Worm — (Boolean)

    Set to TRUE if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.

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

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

Parameters:

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • GatewayARN — (String)

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

Returns:

• (AWS.Request) —

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

/* 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"
   }
   */
 });

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 Amazon Web Services 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 Amazon Web Services Region.

Returns:

• (AWS.Request) —

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

/* 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"
   }
   */
 });

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.

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 Amazon Web Services. Otherwise, the file share is not deleted until all data is uploaded to Amazon Web Services. This process aborts the data upload process, and the file share enters the FORCE_DELETING status.

    Valid Values: true | false

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.

/* 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"
   }
   */
 });

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 Amazon Web Services Region.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • GatewayARN — (String)

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

Returns:

• (AWS.Request) —

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

/* 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"
   }
   */
 });

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.

/* 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"
   }
   */
 });

var params = {
  GatewayARN: 'STRING_VALUE', /* required */
  TapeARN: 'STRING_VALUE', /* required */
  BypassGovernanceRetention: true || false
};
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 Amazon Web Services Region.

  • TapeARN — (String)

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

  • BypassGovernanceRetention — (Boolean)

    Set to TRUE to delete an archived tape that belongs to a custom pool with tape retention lock. Only archived tapes with tape retention lock set to governance can be deleted. Archived tapes with tape retention lock set to compliance can't be deleted.

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.

/* 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"
   }
   */
 });

var params = {
  TapeARN: 'STRING_VALUE', /* required */
  BypassGovernanceRetention: true || false
};
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).

  • BypassGovernanceRetention — (Boolean)

    Set to TRUE to delete an archived tape that belongs to a custom pool with tape retention lock. Only archived tapes with tape retention lock set to governance can be deleted. Archived tapes with tape retention lock set to compliance can't be deleted.

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.

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

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

    • PoolARN — (String)

      The Amazon Resource Name (ARN) of the custom tape pool being deleted.

Returns:

• (AWS.Request) —

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

/* 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"
   }
   */
 });

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.

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

Parameters:

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • GatewayARN — (String)

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

    • Status — (String)

      The status of the high availability monitoring test. If a test hasn't been performed, the value of this field is null.

      Possible values include:
      • "COMPLETE"
      • "FAILED"
      • "PENDING"
    • StartTime — (Date)

      The time the high availability monitoring test was started. If a test hasn't been performed, the value of this field is null.

Returns:

• (AWS.Request) —

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

/* 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"
   }
   */
 });

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 Amazon Web Services Region.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • GatewayARN — (String)

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

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

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

Parameters:

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • GatewayARN — (String)

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

    • BandwidthRateLimitIntervals — (Array<map>)

      An array that contains the bandwidth rate limit intervals for a tape or volume gateway.

      • StartHourOfDay — required — (Integer)

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

      • StartMinuteOfHour — required — (Integer)

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

      • EndHourOfDay — required — (Integer)

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

      • EndMinuteOfHour — required — (Integer)

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

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

      • DaysOfWeek — required — (Array<Integer>)

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

      • AverageUploadRateLimitInBitsPerSec — (Integer)

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

        Note: For Tape Gateway and Volume Gateway, the minimum value is 51200. For S3 File Gateway and FSx File Gateway, the minimum value is 104857600.
      • AverageDownloadRateLimitInBitsPerSec — (Integer)

        The average download rate limit component of the bandwidth rate limit interval, 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.

/* 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"
   }
   */
 });

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 Amazon Web Services Region.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • GatewayARN — (String)

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

    • DiskIds — (Array<String>)

      An array of strings that identify disks that are to be configured as working storage. Each string has 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 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 Amazon Web Services. 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.

/* 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"
      }
     }
    ]
   }
   */
 });

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 be 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 timestamp.

      • 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. If you use a delete tool that overwrites the data on your volume with random data, your usage will not be reduced. This is because the random data is not compressible. If you want to reduce the amount of billed storage on your volume, we recommend overwriting your files with zeros to compress the data to a negligible amount of actual storage.
      • KMSKey — (String)

        The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. 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.

/* 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"
     }
    ]
   }
   */
 });

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.

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

    An array containing the Amazon Resource Name (ARN) of each file system association 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:

    • FileSystemAssociationInfoList — (Array<map>)

      An array containing the FileSystemAssociationInfo data type of each file system association to be described.

      • FileSystemAssociationARN — (String)

        The Amazon Resource Name (ARN) of the file system association.

      • LocationARN — (String)

        The ARN of the backend Amazon FSx file system used for storing file data. For information, see FileSystem in the Amazon FSx API Reference.

      • FileSystemAssociationStatus — (String)

        The status of the file system association. Valid Values: AVAILABLE | CREATING | DELETING | FORCE_DELETING | UPDATING | ERROR

      • AuditDestinationARN — (String)

        The Amazon Resource Name (ARN) of the storage used for the audit logs.

      • GatewayARN — (String)

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

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

        • Key — required — (String)

          Tag key. The key can't start with aws:.

        • Value — required — (String)

          Value of the tag key.

      • CacheAttributes — (map)

        The refresh cache information for the file share or FSx file systems.

        • CacheStaleTimeoutInSeconds — (Integer)

          Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket or Amazon FSx file system. The TTL duration is in seconds.

          Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)

      • EndpointNetworkConfiguration — (map)

        Specifies network configuration information for the gateway associated with the Amazon FSx file system.

        Note: If multiple file systems are associated with this gateway, this parameter's IpAddresses field is required.
        • IpAddresses — (Array<String>)

          A list of gateway IP addresses on which the associated Amazon FSx file system is available.

          Note: If multiple file systems are associated with this gateway, this field is required.
      • FileSystemAssociationStatusDetails — (Array<map>)

        An array containing the FileSystemAssociationStatusDetail data type, which provides detailed information on file system association status.

        • ErrorCode — (String)

          The error code for a given file system association status.

Returns:

• (AWS.Request) —

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

/* 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"
   }
   */
 });

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 Amazon Web Services Region.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • GatewayARN — (String)

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

    • 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. This only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM

    • Ec2InstanceId — (String)

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

    • Ec2InstanceRegion — (String)

      The Amazon Web Services 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. The key can't start with aws:.

      • Value — required — (String)

        Value of the tag key.

    • VPCEndpoint — (String)

      The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.

    • CloudWatchLogGroupARN — (String)

      The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway. This field only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM

    • HostEnvironment — (String)

      The type of hardware or software platform on which the gateway is running.

      Note: Tape Gateway is no longer available on Snow Family devices.
      Possible values include:
      • "VMWARE"
      • "HYPER-V"
      • "EC2"
      • "KVM"
      • "OTHER"
      • "SNOWBALL"
    • EndpointType — (String)

      The type of endpoint for your gateway.

      Valid Values: STANDARD | FIPS

    • SoftwareUpdatesEndDate — (String)

      Date after which this gateway will not receive software updates for new features.

    • DeprecationDate — (String)

      Date after which this gateway will not receive software updates for new features and bug fixes.

    • GatewayCapacity — (String)

      Specifies the size of the gateway's metadata cache.

      Possible values include:
      • "Small"
      • "Medium"
      • "Large"
    • SupportedGatewayCapacities — (Array<String>)

      A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.

    • HostEnvironmentId — (String)

      A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.

    • SoftwareVersion — (String)

      The version number of the software running on the gateway appliance.

Returns:

• (AWS.Request) —

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

/* 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"
   }
   */
 });

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 Amazon Web Services Region.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • GatewayARN — (String)

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

    • 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. It is not possible to set the maintenance schedule to start on days 29 through 31.

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

    • SoftwareUpdatePreferences — (map)

      A set of variables indicating the software update preferences for the gateway.

      Includes AutomaticUpdatePolicy field with the following inputs:

      ALL_VERSIONS - Enables regular gateway maintenance updates.

      EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates.

      • AutomaticUpdatePolicy — (String)

        Indicates the automatic update policy for a gateway.

        ALL_VERSIONS - Enables regular gateway maintenance updates.

        EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance updates.

        Possible values include:
        • "ALL_VERSIONS"
        • "EMERGENCY_VERSIONS_ONLY"

Returns:

• (AWS.Request) —

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

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

        Valid Values: CREATING | UPDATING | AVAILABLE | 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 Amazon Web Services Region.

      • KMSEncrypted — (Boolean)

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

        Valid Values: true | false

      • KMSKey — (String)

        The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. 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 an S3 File Gateway assumes when it accesses the underlying storage.

      • LocationARN — (String)

        A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).

        Note: You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples. Bucket ARN: arn:aws:s3:::my-bucket/prefix/ Access point ARN: arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/ If you specify an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide. Access point alias: test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias
      • DefaultStorageClass — (String)

        The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD. Optional.

        Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

      • ObjectACL — (String)

        A value that sets the access control list (ACL) permission for objects in the S3 bucket that an S3 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 S3 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. Set this value to true to set the write status to read-only, otherwise set to false.

        Valid Values: true | 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, otherwise set to false. The default value is true.

        Valid Values: true | false

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

        Valid Values: true | false

      • 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. The key can't start with aws:.

        • Value — required — (String)

          Value of the tag key.

      • FileShareName — (String)

        The name of the file share. Optional.

        Note: FileShareName must be set if an S3 prefix name is set in LocationARN, or if an access point or access point alias is used.
      • CacheAttributes — (map)

        Refresh cache information for the file share.

        • CacheStaleTimeoutInSeconds — (Integer)

          Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket or Amazon FSx file system. The TTL duration is in seconds.

          Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)

      • NotificationPolicy — (String)

        The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.

        Note: SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.

        The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.

        {\"Upload\": {\"SettlingTimeInSeconds\": 60}}

        The following example sets NotificationPolicy off.

        {}

      • VPCEndpointDNSName — (String)

        Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.

        Note: This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
      • BucketRegion — (String)

        Specifies the Region of the S3 bucket where the NFS file share stores files.

        Note: This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
      • AuditDestinationARN — (String)

        The Amazon Resource Name (ARN) of the storage used for audit logs.

Returns:

• (AWS.Request) —

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

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.

        Valid Values: CREATING | UPDATING | AVAILABLE | 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 Amazon Web Services Region.

      • KMSEncrypted — (Boolean)

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

        Valid Values: true | false

      • KMSKey — (String)

        The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. 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 an S3 File Gateway assumes when it accesses the underlying storage.

      • LocationARN — (String)

        A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).

        Note: You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples. Bucket ARN: arn:aws:s3:::my-bucket/prefix/ Access point ARN: arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/ If you specify an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide. Access point alias: test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias
      • DefaultStorageClass — (String)

        The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD. Optional.

        Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

      • ObjectACL — (String)

        A value that sets the access control list (ACL) permission for objects in the S3 bucket that an S3 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. Set this value to true to set the write status to read-only, otherwise set to false.

        Valid Values: true | 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, otherwise set to false. The default value is true.

        Valid Values: true | false

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

        Valid Values: true | false

      • SMBACLEnabled — (Boolean)

        If this value is set to true, it indicates that access control list (ACL) 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.

        For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.

      • AccessBasedEnumeration — (Boolean)

        Indicates whether AccessBasedEnumeration is enabled.

      • AdminUserList — (Array<String>)

        A list of users or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.

      • 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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.

      • AuditDestinationARN — (String)

        The Amazon Resource Name (ARN) of the storage used for audit logs.

      • Authentication — (String)

        The authentication method of the file share. The default is ActiveDirectory.

        Valid Values: ActiveDirectory | GuestAccess

      • CaseSensitivity — (String)

        The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.

        Possible values include:
        • "ClientSpecified"
        • "CaseSensitive"
      • 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. The key can't start with aws:.

        • Value — required — (String)

          Value of the tag key.

      • FileShareName — (String)

        The name of the file share. Optional.

        Note: FileShareName must be set if an S3 prefix name is set in LocationARN, or if an access point or access point alias is used.
      • CacheAttributes — (map)

        Refresh cache information for the file share.

        • CacheStaleTimeoutInSeconds — (Integer)

          Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket or Amazon FSx file system. The TTL duration is in seconds.

          Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)

      • NotificationPolicy — (String)

        The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.

        Note: SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.

        The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.

        {\"Upload\": {\"SettlingTimeInSeconds\": 60}}

        The following example sets NotificationPolicy off.

        {}

      • VPCEndpointDNSName — (String)

        Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.

        Note: This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
      • BucketRegion — (String)

        Specifies the Region of the S3 bucket where the SMB file share stores files.

        Note: This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
      • OplocksEnabled — (Boolean)

        Specifies whether opportunistic locking is enabled for the SMB file share.

        Note: Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.

        Valid Values: true | false

Returns:

• (AWS.Request) —

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

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 Amazon Web Services Region.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • GatewayARN — (String)

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

    • DomainName — (String)

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

    • ActiveDirectoryStatus — (String)

      Indicates the status of a gateway that is a member of the Active Directory domain.

      • ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.

      • DETACHED: Indicates that gateway is not joined to a domain.

      • JOINED: Indicates that the gateway has successfully joined a domain.

      • JOINING: Indicates that a JoinDomain operation is in progress.

      • NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.

      • TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.

      • UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.

      Possible values include:
      • "ACCESS_DENIED"
      • "DETACHED"
      • "JOINED"
      • "JOINING"
      • "NETWORK_ERROR"
      • "TIMEOUT"
      • "UNKNOWN_ERROR"
    • SMBGuestPasswordSet — (Boolean)

      This value is true if a password for the guest user smbguest is set, otherwise false. Only supported for S3 File Gateways.

      Valid Values: true | false

    • SMBSecurityStrategy — (String)

      The type of security strategy that was specified for file gateway.

      • ClientSpecified: If you choose this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Supported only for S3 File Gateway.

      • MandatorySigning: If you choose this option, File Gateway only allows connections from SMBv2 or SMBv3 clients that have signing turned on. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008, or later.

      • MandatoryEncryption: If you choose this option, File Gateway only allows connections from SMBv3 clients that have encryption turned on. Both 256-bit and 128-bit algorithms are allowed. This option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server 2012, or later.

      • MandatoryEncryptionNoAes128: If you choose this option, File Gateway only allows connections from SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit algorithms are not allowed. This option is recommended for environments that handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server 2012, or later.

      Possible values include:
      • "ClientSpecified"
      • "MandatorySigning"
      • "MandatoryEncryption"
      • "MandatoryEncryptionNoAes128"
    • FileSharesVisible — (Boolean)

      The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.

    • SMBLocalGroups — (map)

      A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.

      • GatewayAdmins — (Array<String>)

        A list of Active Directory users and groups that have local Gateway Admin permissions. Acceptable formats include: DOMAIN\User1, user1, DOMAIN\group1, and group1.

        Gateway Admins can use the Shared Folders Microsoft Management Console snap-in to force-close files that are open and locked.

Returns:

• (AWS.Request) —

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

/* 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"
   }
   */
 });

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.

    • Tags — (Array<map>)

      A list of up to 50 tags assigned to the snapshot schedule, 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. 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.

/* 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"
      }
     }
    ]
   }
   */
 });

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 be 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 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, only 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 timestamp.

      • 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 a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. 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.