@aws-sdk/client-storage-gateway 3.287.0 → 3.289.0

package/dist-types/commands/ActivateGatewayCommand.d.ts

@@ -36,6 +36,28 @@ export interface ActivateGatewayCommandOutput extends ActivateGatewayOutput, __M
  * @see {@link ActivateGatewayCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To activate the gateway
+ * ```javascript
+ * // Activates the gateway you previously deployed on your host.
+ * const input = {
+ *   "ActivationKey": "29AV1-3OFV9-VVIUB-NKT0I-LRO6V",
+ *   "GatewayName": "My_Gateway",
+ *   "GatewayRegion": "us-east-1",
+ *   "GatewayTimezone": "GMT-12:00",
+ *   "GatewayType": "STORED",
+ *   "MediumChangerType": "AWS-Gateway-VTL",
+ *   "TapeDriveType": "IBM-ULT3580-TD5"
+ * };
+ * const command = new ActivateGatewayCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B"
+ * }
+ * *\/
+ * // example id: to-activate-the-gateway-1471281611207
+ * ```
+ *
  */
 export declare class ActivateGatewayCommand extends $Command<ActivateGatewayCommandInput, ActivateGatewayCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: ActivateGatewayCommandInput;

package/dist-types/commands/AddCacheCommand.d.ts

@@ -33,6 +33,26 @@ export interface AddCacheCommandOutput extends AddCacheOutput, __MetadataBearer
  * @see {@link AddCacheCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To add a cache
+ * ```javascript
+ * // The following example shows a request that activates a gateway-stored volume.
+ * const input = {
+ *   "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"
+ * };
+ * const command = new AddCacheCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
+ * }
+ * *\/
+ * // example id: to-add-a-cache-1471043606854
+ * ```
+ *
  */
 export declare class AddCacheCommand extends $Command<AddCacheCommandInput, AddCacheCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: AddCacheCommandInput;

package/dist-types/commands/AddTagsToResourceCommand.d.ts

@@ -53,6 +53,28 @@ export interface AddTagsToResourceCommandOutput extends AddTagsToResourceOutput,
  * @see {@link AddTagsToResourceCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To add tags to resource
+ * ```javascript
+ * // Adds one or more tags to the specified resource.
+ * const input = {
+ *   "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B",
+ *   "Tags": [
+ *     {
+ *       "Key": "Dev Gatgeway Region",
+ *       "Value": "East Coast"
+ *     }
+ *   ]
+ * };
+ * const command = new AddTagsToResourceCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B"
+ * }
+ * *\/
+ * // example id: to-add-tags-to-resource-1471283689460
+ * ```
+ *
  */
 export declare class AddTagsToResourceCommand extends $Command<AddTagsToResourceCommandInput, AddTagsToResourceCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: AddTagsToResourceCommandInput;

package/dist-types/commands/AddUploadBufferCommand.d.ts

@@ -35,6 +35,26 @@ export interface AddUploadBufferCommandOutput extends AddUploadBufferOutput, __M
  * @see {@link AddUploadBufferCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To add upload buffer on local disk
+ * ```javascript
+ * // Configures one or more gateway local disks as upload buffer for a specified gateway.
+ * const input = {
+ *   "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"
+ * };
+ * const command = new AddUploadBufferCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
+ * }
+ * *\/
+ * // example id: to-add-upload-buffer-on-local-disk-1471293902847
+ * ```
+ *
  */
 export declare class AddUploadBufferCommand extends $Command<AddUploadBufferCommandInput, AddUploadBufferCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: AddUploadBufferCommandInput;

package/dist-types/commands/AddWorkingStorageCommand.d.ts

@@ -41,6 +41,26 @@ export interface AddWorkingStorageCommandOutput extends AddWorkingStorageOutput,
  * @see {@link AddWorkingStorageCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To add storage on local disk
+ * ```javascript
+ * // Configures one or more gateway local disks as working storage for a gateway. (Working storage is also referred to as upload buffer.)
+ * const input = {
+ *   "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"
+ * };
+ * const command = new AddWorkingStorageCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
+ * }
+ * *\/
+ * // example id: to-add-storage-on-local-disk-1471294305401
+ * ```
+ *
  */
 export declare class AddWorkingStorageCommand extends $Command<AddWorkingStorageCommandInput, AddWorkingStorageCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: AddWorkingStorageCommandInput;

package/dist-types/commands/CancelArchivalCommand.d.ts

@@ -30,6 +30,23 @@ export interface CancelArchivalCommandOutput extends CancelArchivalOutput, __Met
  * @see {@link CancelArchivalCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To cancel virtual tape archiving
+ * ```javascript
+ * // Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.
+ * const input = {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
+ *   "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4"
+ * };
+ * const command = new CancelArchivalCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4"
+ * }
+ * *\/
+ * // example id: to-cancel-virtual-tape-archiving-1471294865203
+ * ```
+ *
  */
 export declare class CancelArchivalCommand extends $Command<CancelArchivalCommandInput, CancelArchivalCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: CancelArchivalCommandInput;

package/dist-types/commands/CancelRetrievalCommand.d.ts

@@ -31,6 +31,23 @@ export interface CancelRetrievalCommandOutput extends CancelRetrievalOutput, __M
  * @see {@link CancelRetrievalCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To cancel virtual tape retrieval
+ * ```javascript
+ * // Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated.
+ * const input = {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
+ *   "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4"
+ * };
+ * const command = new CancelRetrievalCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4"
+ * }
+ * *\/
+ * // example id: to-cancel-virtual-tape-retrieval-1471295704491
+ * ```
+ *
  */
 export declare class CancelRetrievalCommand extends $Command<CancelRetrievalCommandInput, CancelRetrievalCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: CancelRetrievalCommandInput;

package/dist-types/commands/CreateCachediSCSIVolumeCommand.d.ts

@@ -46,6 +46,28 @@ export interface CreateCachediSCSIVolumeCommandOutput extends CreateCachediSCSIV
  * @see {@link CreateCachediSCSIVolumeCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To create a cached iSCSI volume
+ * ```javascript
+ * // Creates a cached volume on a specified cached gateway.
+ * const input = {
+ *   "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
+ * };
+ * const command = new CreateCachediSCSIVolumeCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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"
+ * }
+ * *\/
+ * // example id: to-create-a-cached-iscsi-volume-1471296661787
+ * ```
+ *
  */
 export declare class CreateCachediSCSIVolumeCommand extends $Command<CreateCachediSCSIVolumeCommandInput, CreateCachediSCSIVolumeCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: CreateCachediSCSIVolumeCommandInput;

package/dist-types/commands/CreateSnapshotCommand.d.ts

@@ -56,6 +56,24 @@ export interface CreateSnapshotCommandOutput extends CreateSnapshotOutput, __Met
  * @see {@link CreateSnapshotCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To create a snapshot of a gateway volume
+ * ```javascript
+ * // Initiates an ad-hoc snapshot of a gateway volume.
+ * const input = {
+ *   "SnapshotDescription": "My root volume snapshot as of 10/03/2017",
+ *   "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
+ * };
+ * const command = new CreateSnapshotCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "SnapshotId": "snap-78e22663",
+ *   "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
+ * }
+ * *\/
+ * // example id: to-create-a-snapshot-of-a-gateway-volume-1471301469561
+ * ```
+ *
  */
 export declare class CreateSnapshotCommand extends $Command<CreateSnapshotCommandInput, CreateSnapshotCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: CreateSnapshotCommandInput;

package/dist-types/commands/CreateSnapshotFromVolumeRecoveryPointCommand.d.ts

@@ -49,6 +49,25 @@ export interface CreateSnapshotFromVolumeRecoveryPointCommandOutput extends Crea
  * @see {@link CreateSnapshotFromVolumeRecoveryPointCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To create a snapshot of a gateway volume
+ * ```javascript
+ * // Initiates a snapshot of a gateway from a volume recovery point.
+ * const input = {
+ *   "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"
+ * };
+ * const command = new CreateSnapshotFromVolumeRecoveryPointCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "SnapshotId": "snap-78e22663",
+ *   "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
+ *   "VolumeRecoveryPointTime": "2017-06-30T10:10:10.000Z"
+ * }
+ * *\/
+ * // example id: to-create-a-snapshot-of-a-gateway-volume-1471301469561
+ * ```
+ *
  */
 export declare class CreateSnapshotFromVolumeRecoveryPointCommand extends $Command<CreateSnapshotFromVolumeRecoveryPointCommandInput, CreateSnapshotFromVolumeRecoveryPointCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: CreateSnapshotFromVolumeRecoveryPointCommandInput;

package/dist-types/commands/CreateStorediSCSIVolumeCommand.d.ts

@@ -40,6 +40,29 @@ export interface CreateStorediSCSIVolumeCommandOutput extends CreateStorediSCSIV
  * @see {@link CreateStorediSCSIVolumeCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To create a stored iSCSI volume
+ * ```javascript
+ * // Creates a stored volume on a specified stored gateway.
+ * const input = {
+ *   "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"
+ * };
+ * const command = new CreateStorediSCSIVolumeCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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
+ * }
+ * *\/
+ * // example id: to-create-a-stored-iscsi-volume-1471367662813
+ * ```
+ *
  */
 export declare class CreateStorediSCSIVolumeCommand extends $Command<CreateStorediSCSIVolumeCommandInput, CreateStorediSCSIVolumeCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: CreateStorediSCSIVolumeCommandInput;

package/dist-types/commands/CreateTapeWithBarcodeCommand.d.ts

@@ -37,6 +37,24 @@ export interface CreateTapeWithBarcodeCommandOutput extends CreateTapeWithBarcod
  * @see {@link CreateTapeWithBarcodeCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To create a virtual tape using a barcode
+ * ```javascript
+ * // Creates a virtual tape by using your own barcode.
+ * const input = {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
+ *   "TapeBarcode": "TEST12345",
+ *   "TapeSizeInBytes": 107374182400
+ * };
+ * const command = new CreateTapeWithBarcodeCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST12345"
+ * }
+ * *\/
+ * // example id: to-create-a-virtual-tape-using-a-barcode-1471371842452
+ * ```
+ *
  */
 export declare class CreateTapeWithBarcodeCommand extends $Command<CreateTapeWithBarcodeCommandInput, CreateTapeWithBarcodeCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: CreateTapeWithBarcodeCommandInput;

package/dist-types/commands/CreateTapesCommand.d.ts

@@ -35,6 +35,30 @@ export interface CreateTapesCommandOutput extends CreateTapesOutput, __MetadataB
  * @see {@link CreateTapesCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To create a virtual tape
+ * ```javascript
+ * // Creates one or more virtual tapes.
+ * const input = {
+ *   "ClientToken": "77777",
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
+ *   "NumTapesToCreate": 3,
+ *   "TapeBarcodePrefix": "TEST",
+ *   "TapeSizeInBytes": 107374182400
+ * };
+ * const command = new CreateTapesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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"
+ *   ]
+ * }
+ * *\/
+ * // example id: to-create-a-virtual-tape-1471372061659
+ * ```
+ *
  */
 export declare class CreateTapesCommand extends $Command<CreateTapesCommandInput, CreateTapesCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: CreateTapesCommandInput;

package/dist-types/commands/DeleteBandwidthRateLimitCommand.d.ts

@@ -33,6 +33,23 @@ export interface DeleteBandwidthRateLimitCommandOutput extends DeleteBandwidthRa
  * @see {@link DeleteBandwidthRateLimitCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To delete bandwidth rate limits of gateway
+ * ```javascript
+ * // Deletes the bandwidth rate limits of a gateway; either the upload or download limit, or both.
+ * const input = {
+ *   "BandwidthType": "All",
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
+ * };
+ * const command = new DeleteBandwidthRateLimitCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
+ * }
+ * *\/
+ * // example id: to-delete-bandwidth-rate-limits-of-gateway-1471373225520
+ * ```
+ *
  */
 export declare class DeleteBandwidthRateLimitCommand extends $Command<DeleteBandwidthRateLimitCommandInput, DeleteBandwidthRateLimitCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: DeleteBandwidthRateLimitCommandInput;

package/dist-types/commands/DeleteChapCredentialsCommand.d.ts

@@ -31,6 +31,24 @@ export interface DeleteChapCredentialsCommandOutput extends DeleteChapCredential
  * @see {@link DeleteChapCredentialsCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To delete CHAP credentials
+ * ```javascript
+ * // Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
+ * const input = {
+ *   "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"
+ * };
+ * const command = new DeleteChapCredentialsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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"
+ * }
+ * *\/
+ * // example id: to-delete-chap-credentials-1471375025612
+ * ```
+ *
  */
 export declare class DeleteChapCredentialsCommand extends $Command<DeleteChapCredentialsCommandInput, DeleteChapCredentialsCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: DeleteChapCredentialsCommandInput;

package/dist-types/commands/DeleteGatewayCommand.d.ts

@@ -46,6 +46,22 @@ export interface DeleteGatewayCommandOutput extends DeleteGatewayOutput, __Metad
  * @see {@link DeleteGatewayCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To delete a gatgeway
+ * ```javascript
+ * // This operation deletes the gateway, but not the gateway's VM from the host computer.
+ * const input = {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
+ * };
+ * const command = new DeleteGatewayCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
+ * }
+ * *\/
+ * // example id: to-delete-a-gatgeway-1471381697333
+ * ```
+ *
  */
 export declare class DeleteGatewayCommand extends $Command<DeleteGatewayCommandInput, DeleteGatewayCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: DeleteGatewayCommandInput;

package/dist-types/commands/DeleteSnapshotScheduleCommand.d.ts

@@ -43,6 +43,22 @@ export interface DeleteSnapshotScheduleCommandOutput extends DeleteSnapshotSched
  * @see {@link DeleteSnapshotScheduleCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To delete a snapshot of a volume
+ * ```javascript
+ * // This action enables you to delete a snapshot schedule for a volume.
+ * const input = {
+ *   "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
+ * };
+ * const command = new DeleteSnapshotScheduleCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
+ * }
+ * *\/
+ * // example id: to-delete-a-snapshot-of-a-volume-1471382234377
+ * ```
+ *
  */
 export declare class DeleteSnapshotScheduleCommand extends $Command<DeleteSnapshotScheduleCommandInput, DeleteSnapshotScheduleCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: DeleteSnapshotScheduleCommandInput;

package/dist-types/commands/DeleteTapeArchiveCommand.d.ts

@@ -30,6 +30,22 @@ export interface DeleteTapeArchiveCommandOutput extends DeleteTapeArchiveOutput,
  * @see {@link DeleteTapeArchiveCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To delete a virtual tape from the shelf (VTS)
+ * ```javascript
+ * // Deletes the specified virtual tape from the virtual tape shelf (VTS).
+ * const input = {
+ *   "TapeARN": "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0"
+ * };
+ * const command = new DeleteTapeArchiveCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "TapeARN": "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0"
+ * }
+ * *\/
+ * // example id: to-delete-a-virtual-tape-from-the-shelf-vts-1471383964329
+ * ```
+ *
  */
 export declare class DeleteTapeArchiveCommand extends $Command<DeleteTapeArchiveCommandInput, DeleteTapeArchiveCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: DeleteTapeArchiveCommandInput;

package/dist-types/commands/DeleteTapeCommand.d.ts

@@ -30,6 +30,23 @@ export interface DeleteTapeCommandOutput extends DeleteTapeOutput, __MetadataBea
  * @see {@link DeleteTapeCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To delete a virtual tape
+ * ```javascript
+ * // This example deletes the specified virtual tape.
+ * const input = {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:204469490176:gateway/sgw-12A3456B",
+ *   "TapeARN": "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0"
+ * };
+ * const command = new DeleteTapeCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "TapeARN": "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0"
+ * }
+ * *\/
+ * // example id: to-delete-a-virtual-tape-1471382444157
+ * ```
+ *
  */
 export declare class DeleteTapeCommand extends $Command<DeleteTapeCommandInput, DeleteTapeCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: DeleteTapeCommandInput;

package/dist-types/commands/DeleteVolumeCommand.d.ts

@@ -41,6 +41,22 @@ export interface DeleteVolumeCommandOutput extends DeleteVolumeOutput, __Metadat
  * @see {@link DeleteVolumeCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To delete a gateway volume
+ * ```javascript
+ * // Deletes the specified gateway volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API.
+ * const input = {
+ *   "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
+ * };
+ * const command = new DeleteVolumeCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
+ * }
+ * *\/
+ * // example id: to-delete-a-gateway-volume-1471384418416
+ * ```
+ *
  */
 export declare class DeleteVolumeCommand extends $Command<DeleteVolumeCommandInput, DeleteVolumeCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: DeleteVolumeCommandInput;

package/dist-types/commands/DescribeBandwidthRateLimitCommand.d.ts

@@ -37,6 +37,24 @@ export interface DescribeBandwidthRateLimitCommandOutput extends DescribeBandwid
  * @see {@link DescribeBandwidthRateLimitCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To describe the bandwidth rate limits of a gateway
+ * ```javascript
+ * // Returns a value for a bandwidth rate limit if set. If not set, then only the gateway ARN is returned.
+ * const input = {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
+ * };
+ * const command = new DescribeBandwidthRateLimitCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "AverageDownloadRateLimitInBitsPerSec": 204800,
+ *   "AverageUploadRateLimitInBitsPerSec": 102400,
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
+ * }
+ * *\/
+ * // example id: to-describe-the-bandwidth-rate-limits-of-a-gateway-1471384826404
+ * ```
+ *
  */
 export declare class DescribeBandwidthRateLimitCommand extends $Command<DescribeBandwidthRateLimitCommandInput, DescribeBandwidthRateLimitCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: DescribeBandwidthRateLimitCommandInput;

package/dist-types/commands/DescribeCacheCommand.d.ts

@@ -33,6 +33,31 @@ export interface DescribeCacheCommandOutput extends DescribeCacheOutput, __Metad
  * @see {@link DescribeCacheCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To describe cache information
+ * ```javascript
+ * // Returns information about the cache of a gateway.
+ * const input = {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
+ * };
+ * const command = new DescribeCacheCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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"
+ * }
+ * *\/
+ * // example id: to-describe-cache-information-1471385756036
+ * ```
+ *
  */
 export declare class DescribeCacheCommand extends $Command<DescribeCacheCommandInput, DescribeCacheCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: DescribeCacheCommandInput;

package/dist-types/commands/DescribeCachediSCSIVolumesCommand.d.ts

@@ -34,6 +34,39 @@ export interface DescribeCachediSCSIVolumesCommandOutput extends DescribeCachedi
  * @see {@link DescribeCachediSCSIVolumesCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To describe gateway cached iSCSI volumes
+ * ```javascript
+ * // Returns a description of the gateway cached iSCSI volumes specified in the request.
+ * const input = {
+ *   "VolumeARNs": [
+ *     "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
+ *   ]
+ * };
+ * const command = new DescribeCachediSCSIVolumesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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"
+ *       }
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-gateway-cached-iscsi-volumes-1471458094649
+ * ```
+ *
  */
 export declare class DescribeCachediSCSIVolumesCommand extends $Command<DescribeCachediSCSIVolumesCommandInput, DescribeCachediSCSIVolumesCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: DescribeCachediSCSIVolumesCommandInput;