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

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

@@ -31,6 +31,29 @@ export interface DescribeChapCredentialsCommandOutput extends DescribeChapCreden
  * @see {@link DescribeChapCredentialsCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To describe CHAP credetnitals for an iSCSI
+ * ```javascript
+ * // Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
+ * const input = {
+ *   "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
+ * };
+ * const command = new DescribeChapCredentialsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-chap-credetnitals-for-an-iscsi-1471467462967
+ * ```
+ *
  */
 export declare class DescribeChapCredentialsCommand extends $Command<DescribeChapCredentialsCommandInput, DescribeChapCredentialsCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: DescribeChapCredentialsCommandInput;

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

@@ -31,6 +31,34 @@ export interface DescribeGatewayInformationCommandOutput extends DescribeGateway
  * @see {@link DescribeGatewayInformationCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To describe metadata about the gateway
+ * ```javascript
+ * // Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not).
+ * const input = {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
+ * };
+ * const command = new DescribeGatewayInformationCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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"
+ * }
+ * *\/
+ * // example id: to-describe-metadata-about-the-gateway-1471467849079
+ * ```
+ *
  */
 export declare class DescribeGatewayInformationCommand extends $Command<DescribeGatewayInformationCommandInput, DescribeGatewayInformationCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: DescribeGatewayInformationCommandInput;

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

@@ -30,6 +30,26 @@ export interface DescribeMaintenanceStartTimeCommandOutput extends DescribeMaint
  * @see {@link DescribeMaintenanceStartTimeCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To describe gateway's maintenance start time
+ * ```javascript
+ * // Returns your gateway's weekly maintenance start time including the day and time of the week.
+ * const input = {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
+ * };
+ * const command = new DescribeMaintenanceStartTimeCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DayOfWeek": 2,
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
+ *   "HourOfDay": 15,
+ *   "MinuteOfHour": 35,
+ *   "Timezone": "GMT+7:00"
+ * }
+ * *\/
+ * // example id: to-describe-gateways-maintenance-start-time-1471470727387
+ * ```
+ *
  */
 export declare class DescribeMaintenanceStartTimeCommand extends $Command<DescribeMaintenanceStartTimeCommandInput, DescribeMaintenanceStartTimeCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: DescribeMaintenanceStartTimeCommandInput;

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

@@ -32,6 +32,26 @@ export interface DescribeSnapshotScheduleCommandOutput extends DescribeSnapshotS
  * @see {@link DescribeSnapshotScheduleCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To describe snapshot schedule for gateway volume
+ * ```javascript
+ * // Describes the snapshot schedule for the specified gateway volume including intervals at which snapshots are automatically initiated.
+ * const input = {
+ *   "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
+ * };
+ * const command = new DescribeSnapshotScheduleCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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"
+ * }
+ * *\/
+ * // example id: to-describe-snapshot-schedule-for-gateway-volume-1471471139538
+ * ```
+ *
  */
 export declare class DescribeSnapshotScheduleCommand extends $Command<DescribeSnapshotScheduleCommandInput, DescribeSnapshotScheduleCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: DescribeSnapshotScheduleCommandInput;

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

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

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

@@ -33,6 +33,43 @@ export interface DescribeTapeArchivesCommandOutput extends DescribeTapeArchivesO
  * @see {@link DescribeTapeArchivesCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To describe virtual tapes in the VTS
+ * ```javascript
+ * // Returns a description of specified virtual tapes in the virtual tape shelf (VTS).
+ * const input = {
+ *   "Limit": 123,
+ *   "Marker": "1",
+ *   "TapeARNs": [
+ *     "arn:aws:storagegateway:us-east-1:999999999999:tape/AM08A1AD",
+ *     "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4"
+ *   ]
+ * };
+ * const command = new DescribeTapeArchivesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Marker": "1",
+ *   "TapeArchives": [
+ *     {
+ *       "CompletionTime": "2016-12-16T13:50Z",
+ *       "TapeARN": "arn:aws:storagegateway:us-east-1:999999999:tape/AM08A1AD",
+ *       "TapeBarcode": "AM08A1AD",
+ *       "TapeSizeInBytes": 107374182400,
+ *       "TapeStatus": "ARCHIVED"
+ *     },
+ *     {
+ *       "CompletionTime": "2016-12-16T13:59Z",
+ *       "TapeARN": "arn:aws:storagegateway:us-east-1:999999999:tape/AMZN01A2A4",
+ *       "TapeBarcode": "AMZN01A2A4",
+ *       "TapeSizeInBytes": 429496729600,
+ *       "TapeStatus": "ARCHIVED"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-virtual-tapes-in-the-vts-1471473188198
+ * ```
+ *
  */
 export declare class DescribeTapeArchivesCommand extends $Command<DescribeTapeArchivesCommandInput, DescribeTapeArchivesCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: DescribeTapeArchivesCommandInput;

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

@@ -35,6 +35,33 @@ export interface DescribeTapeRecoveryPointsCommandOutput extends DescribeTapeRec
  * @see {@link DescribeTapeRecoveryPointsCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To describe virtual tape recovery points
+ * ```javascript
+ * // Returns a list of virtual tape recovery points that are available for the specified gateway-VTL.
+ * const input = {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
+ *   "Limit": 1,
+ *   "Marker": "1"
+ * };
+ * const command = new DescribeTapeRecoveryPointsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
+ *   "Marker": "1",
+ *   "TapeRecoveryPointInfos": [
+ *     {
+ *       "TapeARN": "arn:aws:storagegateway:us-east-1:999999999:tape/AMZN01A2A4",
+ *       "TapeRecoveryPointTime": "2016-12-16T13:50Z",
+ *       "TapeSizeInBytes": 1471550497,
+ *       "TapeStatus": "AVAILABLE"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-virtual-tape-recovery-points-1471542042026
+ * ```
+ *
  */
 export declare class DescribeTapeRecoveryPointsCommand extends $Command<DescribeTapeRecoveryPointsCommandInput, DescribeTapeRecoveryPointsCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: DescribeTapeRecoveryPointsCommandInput;

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

@@ -32,6 +32,42 @@ export interface DescribeTapesCommandOutput extends DescribeTapesOutput, __Metad
  * @see {@link DescribeTapesCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To describe virtual tape(s) associated with gateway
+ * ```javascript
+ * // Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes.
+ * const input = {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
+ *   "Limit": 2,
+ *   "Marker": "1",
+ *   "TapeARNs": [
+ *     "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1",
+ *     "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0"
+ *   ]
+ * };
+ * const command = new DescribeTapesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Marker": "1",
+ *   "Tapes": [
+ *     {
+ *       "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1",
+ *       "TapeBarcode": "TEST04A2A1",
+ *       "TapeSizeInBytes": 107374182400,
+ *       "TapeStatus": "AVAILABLE"
+ *     },
+ *     {
+ *       "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0",
+ *       "TapeBarcode": "TEST05A2A0",
+ *       "TapeSizeInBytes": 107374182400,
+ *       "TapeStatus": "AVAILABLE"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-virtual-tapes-associated-with-gateway-1471629287727
+ * ```
+ *
  */
 export declare class DescribeTapesCommand extends $Command<DescribeTapesCommandInput, DescribeTapesCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: DescribeTapesCommandInput;

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

@@ -33,6 +33,50 @@ export interface DescribeUploadBufferCommandOutput extends DescribeUploadBufferO
  * @see {@link DescribeUploadBufferCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To describe upload buffer of gateway
+ * ```javascript
+ * // Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated/used.
+ * const input = {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
+ * };
+ * const command = new DescribeUploadBufferCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DiskIds": [
+ *     "pci-0000:03:00.0-scsi-0:0:0:0",
+ *     "pci-0000:04:00.0-scsi-0:1:0:0"
+ *   ],
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
+ *   "UploadBufferAllocatedInBytes": 0,
+ *   "UploadBufferUsedInBytes": 161061273600
+ * }
+ * *\/
+ * // example id: to-describe-upload-buffer-of-gateway-1471631099003
+ * ```
+ *
+ * @example To describe upload buffer of a gateway
+ * ```javascript
+ * // Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated and used.
+ * const input = {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
+ * };
+ * const command = new DescribeUploadBufferCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DiskIds": [
+ *     "pci-0000:03:00.0-scsi-0:0:0:0",
+ *     "pci-0000:04:00.0-scsi-0:1:0:0"
+ *   ],
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
+ *   "UploadBufferAllocatedInBytes": 161061273600,
+ *   "UploadBufferUsedInBytes": 0
+ * }
+ * *\/
+ * // example id: to-describe-upload-buffer-of-a-gateway--1471904566370
+ * ```
+ *
  */
 export declare class DescribeUploadBufferCommand extends $Command<DescribeUploadBufferCommandInput, DescribeUploadBufferCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: DescribeUploadBufferCommandInput;

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

@@ -32,6 +32,64 @@ export interface DescribeVTLDevicesCommandOutput extends DescribeVTLDevicesOutpu
  * @see {@link DescribeVTLDevicesCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To describe virtual tape library (VTL) devices of a single gateway
+ * ```javascript
+ * // Returns a description of virtual tape library (VTL) devices for the specified gateway.
+ * const input = {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
+ *   "Limit": 123,
+ *   "Marker": "1",
+ *   "VTLDeviceARNs": []
+ * };
+ * const command = new DescribeVTLDevicesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
+ *   "Marker": "1",
+ *   "VTLDevices": [
+ *     {
+ *       "DeviceiSCSIAttributes": {
+ *         "ChapEnabled": false,
+ *         "NetworkInterfaceId": "10.243.43.207",
+ *         "NetworkInterfacePort": 3260,
+ *         "TargetARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-mediachanger"
+ *       },
+ *       "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001",
+ *       "VTLDeviceProductIdentifier": "L700",
+ *       "VTLDeviceType": "Medium Changer",
+ *       "VTLDeviceVendor": "STK"
+ *     },
+ *     {
+ *       "DeviceiSCSIAttributes": {
+ *         "ChapEnabled": false,
+ *         "NetworkInterfaceId": "10.243.43.209",
+ *         "NetworkInterfacePort": 3260,
+ *         "TargetARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-01"
+ *       },
+ *       "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00001",
+ *       "VTLDeviceProductIdentifier": "ULT3580-TD5",
+ *       "VTLDeviceType": "Tape Drive",
+ *       "VTLDeviceVendor": "IBM"
+ *     },
+ *     {
+ *       "DeviceiSCSIAttributes": {
+ *         "ChapEnabled": false,
+ *         "NetworkInterfaceId": "10.243.43.209",
+ *         "NetworkInterfacePort": 3260,
+ *         "TargetARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-02"
+ *       },
+ *       "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00002",
+ *       "VTLDeviceProductIdentifier": "ULT3580-TD5",
+ *       "VTLDeviceType": "Tape Drive",
+ *       "VTLDeviceVendor": "IBM"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-virtual-tape-library-vtl-devices-of-a-single-gateway-1471906071410
+ * ```
+ *
  */
 export declare class DescribeVTLDevicesCommand extends $Command<DescribeVTLDevicesCommandInput, DescribeVTLDevicesCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: DescribeVTLDevicesCommandInput;

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

@@ -39,6 +39,28 @@ export interface DescribeWorkingStorageCommandOutput extends DescribeWorkingStor
  * @see {@link DescribeWorkingStorageCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To describe the working storage of a gateway [Depreciated]
+ * ```javascript
+ * // This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead.
+ * const input = {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
+ * };
+ * const command = new DescribeWorkingStorageCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DiskIds": [
+ *     "pci-0000:03:00.0-scsi-0:0:0:0",
+ *     "pci-0000:03:00.0-scsi-0:0:1:0"
+ *   ],
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
+ *   "WorkingStorageAllocatedInBytes": 2199023255552,
+ *   "WorkingStorageUsedInBytes": 789207040
+ * }
+ * *\/
+ * // example id: to-describe-the-working-storage-of-a-gateway-depreciated-1472070842332
+ * ```
+ *
  */
 export declare class DescribeWorkingStorageCommand extends $Command<DescribeWorkingStorageCommandInput, DescribeWorkingStorageCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: DescribeWorkingStorageCommandInput;

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

@@ -37,6 +37,22 @@ export interface DisableGatewayCommandOutput extends DisableGatewayOutput, __Met
  * @see {@link DisableGatewayCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To disable a gateway when it is no longer functioning
+ * ```javascript
+ * // Disables a gateway when the gateway is no longer functioning. Use this operation for a gateway-VTL that is not reachable or not functioning.
+ * const input = {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
+ * };
+ * const command = new DisableGatewayCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
+ * }
+ * *\/
+ * // example id: to-disable-a-gateway-when-it-is-no-longer-functioning-1472076046936
+ * ```
+ *
  */
 export declare class DisableGatewayCommand extends $Command<DisableGatewayCommandInput, DisableGatewayCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: DisableGatewayCommandInput;

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

@@ -39,6 +39,31 @@ export interface ListGatewaysCommandOutput extends ListGatewaysOutput, __Metadat
  * @see {@link ListGatewaysCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To lists region specific gateways per AWS account
+ * ```javascript
+ * // Lists gateways owned by an AWS account in a specified region as requested. Results are sorted by gateway ARN up to a maximum of 100 gateways.
+ * const input = {
+ *   "Limit": 2,
+ *   "Marker": "1"
+ * };
+ * const command = new ListGatewaysCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Gateways": [
+ *     {
+ *       "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
+ *     },
+ *     {
+ *       "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-23A4567C"
+ *     }
+ *   ],
+ *   "Marker": "1"
+ * }
+ * *\/
+ * // example id: to-lists-region-specific-gateways-per-aws-account-1472077860657
+ * ```
+ *
  */
 export declare class ListGatewaysCommand extends $Command<ListGatewaysCommandInput, ListGatewaysCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: ListGatewaysCommandInput;

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

@@ -37,6 +37,41 @@ export interface ListLocalDisksCommandOutput extends ListLocalDisksOutput, __Met
  * @see {@link ListLocalDisksCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To list the gateway's local disks
+ * ```javascript
+ * // The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all.
+ * const input = {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
+ * };
+ * const command = new ListLocalDisksCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Disks": [
+ *     {
+ *       "DiskAllocationType": "CACHE_STORAGE",
+ *       "DiskId": "pci-0000:03:00.0-scsi-0:0:0:0",
+ *       "DiskNode": "SCSI(0:0)",
+ *       "DiskPath": "/dev/sda",
+ *       "DiskSizeInBytes": 1099511627776,
+ *       "DiskStatus": "missing"
+ *     },
+ *     {
+ *       "DiskAllocationResource": "",
+ *       "DiskAllocationType": "UPLOAD_BUFFER",
+ *       "DiskId": "pci-0000:03:00.0-scsi-0:0:1:0",
+ *       "DiskNode": "SCSI(0:1)",
+ *       "DiskPath": "/dev/sdb",
+ *       "DiskSizeInBytes": 1099511627776,
+ *       "DiskStatus": "present"
+ *     }
+ *   ],
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
+ * }
+ * *\/
+ * // example id: to-list-the-gateways-local-disks-1472079564618
+ * ```
+ *
  */
 export declare class ListLocalDisksCommand extends $Command<ListLocalDisksCommandInput, ListLocalDisksCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: ListLocalDisksCommandInput;

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

@@ -30,6 +30,31 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To list tags that have been added to a resource
+ * ```javascript
+ * // Lists the tags that have been added to the specified resource.
+ * const input = {
+ *   "Limit": 1,
+ *   "Marker": "1",
+ *   "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B"
+ * };
+ * const command = new ListTagsForResourceCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Marker": "1",
+ *   "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B",
+ *   "Tags": [
+ *     {
+ *       "Key": "Dev Gatgeway Region",
+ *       "Value": "East Coast"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-tags-that-have-been-added-to-a-resource-1472080268972
+ * ```
+ *
  */
 export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: ListTagsForResourceCommandInput;

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

@@ -35,6 +35,29 @@ export interface ListVolumeRecoveryPointsCommandOutput extends ListVolumeRecover
  * @see {@link ListVolumeRecoveryPointsCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To list recovery points for a gateway
+ * ```javascript
+ * // Lists the recovery points for a specified gateway in which all data of the volume is consistent and can be used to create a snapshot.
+ * const input = {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
+ * };
+ * const command = new ListVolumeRecoveryPointsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
+ *   "VolumeRecoveryPointInfos": [
+ *     {
+ *       "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
+ *       "VolumeRecoveryPointTime": "2012-09-04T21:08:44.627Z",
+ *       "VolumeSizeInBytes": 536870912000
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-recovery-points-for-a-gateway-1472143015088
+ * ```
+ *
  */
 export declare class ListVolumeRecoveryPointsCommand extends $Command<ListVolumeRecoveryPointsCommandInput, ListVolumeRecoveryPointsCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: ListVolumeRecoveryPointsCommandInput;

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

@@ -38,6 +38,43 @@ export interface ListVolumesCommandOutput extends ListVolumesOutput, __MetadataB
  * @see {@link ListVolumesCommandOutput} for command's `response` shape.
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
  *
+ * @example To list the iSCSI stored volumes of a gateway
+ * ```javascript
+ * // Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN up to a maximum of 100 volumes.
+ * const input = {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
+ *   "Limit": 2,
+ *   "Marker": "1"
+ * };
+ * const command = new ListVolumesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
+ *   "Marker": "1",
+ *   "VolumeInfos": [
+ *     {
+ *       "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
+ *       "GatewayId": "sgw-12A3456B",
+ *       "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
+ *       "VolumeId": "vol-1122AABB",
+ *       "VolumeSizeInBytes": 107374182400,
+ *       "VolumeType": "STORED"
+ *     },
+ *     {
+ *       "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C",
+ *       "GatewayId": "sgw-gw-13B4567C",
+ *       "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C/volume/vol-3344CCDD",
+ *       "VolumeId": "vol-1122AABB",
+ *       "VolumeSizeInBytes": 107374182400,
+ *       "VolumeType": "STORED"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-the-iscsi-stored-volumes-of-a-gateway-1472145723653
+ * ```
+ *
  */
 export declare class ListVolumesCommand extends $Command<ListVolumesCommandInput, ListVolumesCommandOutput, StorageGatewayClientResolvedConfig> {
     readonly input: ListVolumesCommandInput;