@aws-sdk/client-storage-gateway 3.321.1 → 3.326.0

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

@@ -47,6 +47,23 @@ export interface DescribeBandwidthRateLimitScheduleCommandOutput extends Describ
  * };
  * const command = new DescribeBandwidthRateLimitScheduleCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeBandwidthRateLimitScheduleOutput
+ * //   GatewayARN: "STRING_VALUE",
+ * //   BandwidthRateLimitIntervals: [ // BandwidthRateLimitIntervals
+ * //     { // BandwidthRateLimitInterval
+ * //       StartHourOfDay: Number("int"), // required
+ * //       StartMinuteOfHour: Number("int"), // required
+ * //       EndHourOfDay: Number("int"), // required
+ * //       EndMinuteOfHour: Number("int"), // required
+ * //       DaysOfWeek: [ // DaysOfWeek // required
+ * //         Number("int"),
+ * //       ],
+ * //       AverageUploadRateLimitInBitsPerSec: Number("long"),
+ * //       AverageDownloadRateLimitInBitsPerSec: Number("long"),
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param DescribeBandwidthRateLimitScheduleCommandInput - {@link DescribeBandwidthRateLimitScheduleCommandInput}
@@ -63,6 +80,8 @@ export interface DescribeBandwidthRateLimitScheduleCommandOutput extends Describ
  *  <p>An exception occurred because an invalid gateway request was issued to the service. For
  *          more information, see the error and message fields.</p>
  *
+ * @throws {@link StorageGatewayServiceException}
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
  *
  */
 export declare class DescribeBandwidthRateLimitScheduleCommand extends $Command<DescribeBandwidthRateLimitScheduleCommandInput, DescribeBandwidthRateLimitScheduleCommandOutput, StorageGatewayClientResolvedConfig> {

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

@@ -35,6 +35,18 @@ export interface DescribeCacheCommandOutput extends DescribeCacheOutput, __Metad
  * };
  * const command = new DescribeCacheCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeCacheOutput
+ * //   GatewayARN: "STRING_VALUE",
+ * //   DiskIds: [ // DiskIds
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   CacheAllocatedInBytes: Number("long"),
+ * //   CacheUsedPercentage: Number("double"),
+ * //   CacheDirtyPercentage: Number("double"),
+ * //   CacheHitPercentage: Number("double"),
+ * //   CacheMissPercentage: Number("double"),
+ * // };
+ *
  * ```
  *
  * @param DescribeCacheCommandInput - {@link DescribeCacheCommandInput}
@@ -51,6 +63,8 @@ export interface DescribeCacheCommandOutput extends DescribeCacheOutput, __Metad
  *  <p>An exception occurred because an invalid gateway request was issued to the service. For
  *          more information, see the error and message fields.</p>
  *
+ * @throws {@link StorageGatewayServiceException}
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
  *
  * @example To describe cache information
  * ```javascript

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

@@ -38,6 +38,32 @@ export interface DescribeCachediSCSIVolumesCommandOutput extends DescribeCachedi
  * };
  * const command = new DescribeCachediSCSIVolumesCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeCachediSCSIVolumesOutput
+ * //   CachediSCSIVolumes: [ // CachediSCSIVolumes
+ * //     { // CachediSCSIVolume
+ * //       VolumeARN: "STRING_VALUE",
+ * //       VolumeId: "STRING_VALUE",
+ * //       VolumeType: "STRING_VALUE",
+ * //       VolumeStatus: "STRING_VALUE",
+ * //       VolumeAttachmentStatus: "STRING_VALUE",
+ * //       VolumeSizeInBytes: Number("long"),
+ * //       VolumeProgress: Number("double"),
+ * //       SourceSnapshotId: "STRING_VALUE",
+ * //       VolumeiSCSIAttributes: { // VolumeiSCSIAttributes
+ * //         TargetARN: "STRING_VALUE",
+ * //         NetworkInterfaceId: "STRING_VALUE",
+ * //         NetworkInterfacePort: Number("int"),
+ * //         LunNumber: Number("int"),
+ * //         ChapEnabled: true || false,
+ * //       },
+ * //       CreatedDate: new Date("TIMESTAMP"),
+ * //       VolumeUsedInBytes: Number("long"),
+ * //       KMSKey: "STRING_VALUE",
+ * //       TargetName: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param DescribeCachediSCSIVolumesCommandInput - {@link DescribeCachediSCSIVolumesCommandInput}
@@ -54,6 +80,8 @@ export interface DescribeCachediSCSIVolumesCommandOutput extends DescribeCachedi
  *  <p>An exception occurred because an invalid gateway request was issued to the service. For
  *          more information, see the error and message fields.</p>
  *
+ * @throws {@link StorageGatewayServiceException}
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
  *
  * @example To describe gateway cached iSCSI volumes
  * ```javascript

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

@@ -33,6 +33,17 @@ export interface DescribeChapCredentialsCommandOutput extends DescribeChapCreden
  * };
  * const command = new DescribeChapCredentialsCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeChapCredentialsOutput
+ * //   ChapCredentials: [ // ChapCredentials
+ * //     { // ChapInfo
+ * //       TargetARN: "STRING_VALUE",
+ * //       SecretToAuthenticateInitiator: "STRING_VALUE",
+ * //       InitiatorName: "STRING_VALUE",
+ * //       SecretToAuthenticateTarget: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param DescribeChapCredentialsCommandInput - {@link DescribeChapCredentialsCommandInput}
@@ -49,6 +60,8 @@ export interface DescribeChapCredentialsCommandOutput extends DescribeChapCreden
  *  <p>An exception occurred because an invalid gateway request was issued to the service. For
  *          more information, see the error and message fields.</p>
  *
+ * @throws {@link StorageGatewayServiceException}
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
  *
  * @example To describe CHAP credetnitals for an iSCSI
  * ```javascript

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

@@ -34,6 +34,37 @@ export interface DescribeFileSystemAssociationsCommandOutput extends DescribeFil
  * };
  * const command = new DescribeFileSystemAssociationsCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeFileSystemAssociationsOutput
+ * //   FileSystemAssociationInfoList: [ // FileSystemAssociationInfoList
+ * //     { // FileSystemAssociationInfo
+ * //       FileSystemAssociationARN: "STRING_VALUE",
+ * //       LocationARN: "STRING_VALUE",
+ * //       FileSystemAssociationStatus: "STRING_VALUE",
+ * //       AuditDestinationARN: "STRING_VALUE",
+ * //       GatewayARN: "STRING_VALUE",
+ * //       Tags: [ // Tags
+ * //         { // Tag
+ * //           Key: "STRING_VALUE", // required
+ * //           Value: "STRING_VALUE", // required
+ * //         },
+ * //       ],
+ * //       CacheAttributes: { // CacheAttributes
+ * //         CacheStaleTimeoutInSeconds: Number("int"),
+ * //       },
+ * //       EndpointNetworkConfiguration: { // EndpointNetworkConfiguration
+ * //         IpAddresses: [ // IpAddressList
+ * //           "STRING_VALUE",
+ * //         ],
+ * //       },
+ * //       FileSystemAssociationStatusDetails: [ // FileSystemAssociationStatusDetails
+ * //         { // FileSystemAssociationStatusDetail
+ * //           ErrorCode: "STRING_VALUE",
+ * //         },
+ * //       ],
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param DescribeFileSystemAssociationsCommandInput - {@link DescribeFileSystemAssociationsCommandInput}
@@ -50,6 +81,8 @@ export interface DescribeFileSystemAssociationsCommandOutput extends DescribeFil
  *  <p>An exception occurred because an invalid gateway request was issued to the service. For
  *          more information, see the error and message fields.</p>
  *
+ * @throws {@link StorageGatewayServiceException}
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
  *
  */
 export declare class DescribeFileSystemAssociationsCommand extends $Command<DescribeFileSystemAssociationsCommandInput, DescribeFileSystemAssociationsCommandOutput, StorageGatewayClientResolvedConfig> {

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

@@ -33,6 +33,43 @@ export interface DescribeGatewayInformationCommandOutput extends DescribeGateway
  * };
  * const command = new DescribeGatewayInformationCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeGatewayInformationOutput
+ * //   GatewayARN: "STRING_VALUE",
+ * //   GatewayId: "STRING_VALUE",
+ * //   GatewayName: "STRING_VALUE",
+ * //   GatewayTimezone: "STRING_VALUE",
+ * //   GatewayState: "STRING_VALUE",
+ * //   GatewayNetworkInterfaces: [ // GatewayNetworkInterfaces
+ * //     { // NetworkInterface
+ * //       Ipv4Address: "STRING_VALUE",
+ * //       MacAddress: "STRING_VALUE",
+ * //       Ipv6Address: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   GatewayType: "STRING_VALUE",
+ * //   NextUpdateAvailabilityDate: "STRING_VALUE",
+ * //   LastSoftwareUpdate: "STRING_VALUE",
+ * //   Ec2InstanceId: "STRING_VALUE",
+ * //   Ec2InstanceRegion: "STRING_VALUE",
+ * //   Tags: [ // Tags
+ * //     { // Tag
+ * //       Key: "STRING_VALUE", // required
+ * //       Value: "STRING_VALUE", // required
+ * //     },
+ * //   ],
+ * //   VPCEndpoint: "STRING_VALUE",
+ * //   CloudWatchLogGroupARN: "STRING_VALUE",
+ * //   HostEnvironment: "STRING_VALUE",
+ * //   EndpointType: "STRING_VALUE",
+ * //   SoftwareUpdatesEndDate: "STRING_VALUE",
+ * //   DeprecationDate: "STRING_VALUE",
+ * //   GatewayCapacity: "STRING_VALUE",
+ * //   SupportedGatewayCapacities: [ // SupportedGatewayCapacities
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   HostEnvironmentId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DescribeGatewayInformationCommandInput - {@link DescribeGatewayInformationCommandInput}
@@ -49,6 +86,8 @@ export interface DescribeGatewayInformationCommandOutput extends DescribeGateway
  *  <p>An exception occurred because an invalid gateway request was issued to the service. For
  *          more information, see the error and message fields.</p>
  *
+ * @throws {@link StorageGatewayServiceException}
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
  *
  * @example To describe metadata about the gateway
  * ```javascript

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

@@ -32,6 +32,15 @@ export interface DescribeMaintenanceStartTimeCommandOutput extends DescribeMaint
  * };
  * const command = new DescribeMaintenanceStartTimeCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeMaintenanceStartTimeOutput
+ * //   GatewayARN: "STRING_VALUE",
+ * //   HourOfDay: Number("int"),
+ * //   MinuteOfHour: Number("int"),
+ * //   DayOfWeek: Number("int"),
+ * //   DayOfMonth: Number("int"),
+ * //   Timezone: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DescribeMaintenanceStartTimeCommandInput - {@link DescribeMaintenanceStartTimeCommandInput}
@@ -48,6 +57,8 @@ export interface DescribeMaintenanceStartTimeCommandOutput extends DescribeMaint
  *  <p>An exception occurred because an invalid gateway request was issued to the service. For
  *          more information, see the error and message fields.</p>
  *
+ * @throws {@link StorageGatewayServiceException}
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
  *
  * @example To describe gateway's maintenance start time
  * ```javascript

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

@@ -34,6 +34,51 @@ export interface DescribeNFSFileSharesCommandOutput extends DescribeNFSFileShare
  * };
  * const command = new DescribeNFSFileSharesCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeNFSFileSharesOutput
+ * //   NFSFileShareInfoList: [ // NFSFileShareInfoList
+ * //     { // NFSFileShareInfo
+ * //       NFSFileShareDefaults: { // NFSFileShareDefaults
+ * //         FileMode: "STRING_VALUE",
+ * //         DirectoryMode: "STRING_VALUE",
+ * //         GroupId: Number("long"),
+ * //         OwnerId: Number("long"),
+ * //       },
+ * //       FileShareARN: "STRING_VALUE",
+ * //       FileShareId: "STRING_VALUE",
+ * //       FileShareStatus: "STRING_VALUE",
+ * //       GatewayARN: "STRING_VALUE",
+ * //       KMSEncrypted: true || false,
+ * //       KMSKey: "STRING_VALUE",
+ * //       Path: "STRING_VALUE",
+ * //       Role: "STRING_VALUE",
+ * //       LocationARN: "STRING_VALUE",
+ * //       DefaultStorageClass: "STRING_VALUE",
+ * //       ObjectACL: "STRING_VALUE",
+ * //       ClientList: [ // FileShareClientList
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       Squash: "STRING_VALUE",
+ * //       ReadOnly: true || false,
+ * //       GuessMIMETypeEnabled: true || false,
+ * //       RequesterPays: true || false,
+ * //       Tags: [ // Tags
+ * //         { // Tag
+ * //           Key: "STRING_VALUE", // required
+ * //           Value: "STRING_VALUE", // required
+ * //         },
+ * //       ],
+ * //       FileShareName: "STRING_VALUE",
+ * //       CacheAttributes: { // CacheAttributes
+ * //         CacheStaleTimeoutInSeconds: Number("int"),
+ * //       },
+ * //       NotificationPolicy: "STRING_VALUE",
+ * //       VPCEndpointDNSName: "STRING_VALUE",
+ * //       BucketRegion: "STRING_VALUE",
+ * //       AuditDestinationARN: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param DescribeNFSFileSharesCommandInput - {@link DescribeNFSFileSharesCommandInput}
@@ -50,6 +95,8 @@ export interface DescribeNFSFileSharesCommandOutput extends DescribeNFSFileShare
  *  <p>An exception occurred because an invalid gateway request was issued to the service. For
  *          more information, see the error and message fields.</p>
  *
+ * @throws {@link StorageGatewayServiceException}
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
  *
  */
 export declare class DescribeNFSFileSharesCommand extends $Command<DescribeNFSFileSharesCommandInput, DescribeNFSFileSharesCommandOutput, StorageGatewayClientResolvedConfig> {

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

@@ -34,6 +34,55 @@ export interface DescribeSMBFileSharesCommandOutput extends DescribeSMBFileShare
  * };
  * const command = new DescribeSMBFileSharesCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeSMBFileSharesOutput
+ * //   SMBFileShareInfoList: [ // SMBFileShareInfoList
+ * //     { // SMBFileShareInfo
+ * //       FileShareARN: "STRING_VALUE",
+ * //       FileShareId: "STRING_VALUE",
+ * //       FileShareStatus: "STRING_VALUE",
+ * //       GatewayARN: "STRING_VALUE",
+ * //       KMSEncrypted: true || false,
+ * //       KMSKey: "STRING_VALUE",
+ * //       Path: "STRING_VALUE",
+ * //       Role: "STRING_VALUE",
+ * //       LocationARN: "STRING_VALUE",
+ * //       DefaultStorageClass: "STRING_VALUE",
+ * //       ObjectACL: "STRING_VALUE",
+ * //       ReadOnly: true || false,
+ * //       GuessMIMETypeEnabled: true || false,
+ * //       RequesterPays: true || false,
+ * //       SMBACLEnabled: true || false,
+ * //       AccessBasedEnumeration: true || false,
+ * //       AdminUserList: [ // UserList
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       ValidUserList: [
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       InvalidUserList: [
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       AuditDestinationARN: "STRING_VALUE",
+ * //       Authentication: "STRING_VALUE",
+ * //       CaseSensitivity: "STRING_VALUE",
+ * //       Tags: [ // Tags
+ * //         { // Tag
+ * //           Key: "STRING_VALUE", // required
+ * //           Value: "STRING_VALUE", // required
+ * //         },
+ * //       ],
+ * //       FileShareName: "STRING_VALUE",
+ * //       CacheAttributes: { // CacheAttributes
+ * //         CacheStaleTimeoutInSeconds: Number("int"),
+ * //       },
+ * //       NotificationPolicy: "STRING_VALUE",
+ * //       VPCEndpointDNSName: "STRING_VALUE",
+ * //       BucketRegion: "STRING_VALUE",
+ * //       OplocksEnabled: true || false,
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param DescribeSMBFileSharesCommandInput - {@link DescribeSMBFileSharesCommandInput}
@@ -50,6 +99,8 @@ export interface DescribeSMBFileSharesCommandOutput extends DescribeSMBFileShare
  *  <p>An exception occurred because an invalid gateway request was issued to the service. For
  *          more information, see the error and message fields.</p>
  *
+ * @throws {@link StorageGatewayServiceException}
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
  *
  */
 export declare class DescribeSMBFileSharesCommand extends $Command<DescribeSMBFileSharesCommandInput, DescribeSMBFileSharesCommandOutput, StorageGatewayClientResolvedConfig> {

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

@@ -32,6 +32,20 @@ export interface DescribeSMBSettingsCommandOutput extends DescribeSMBSettingsOut
  * };
  * const command = new DescribeSMBSettingsCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeSMBSettingsOutput
+ * //   GatewayARN: "STRING_VALUE",
+ * //   DomainName: "STRING_VALUE",
+ * //   ActiveDirectoryStatus: "STRING_VALUE",
+ * //   SMBGuestPasswordSet: true || false,
+ * //   SMBSecurityStrategy: "STRING_VALUE",
+ * //   FileSharesVisible: true || false,
+ * //   SMBLocalGroups: { // SMBLocalGroups
+ * //     GatewayAdmins: [ // UserList
+ * //       "STRING_VALUE",
+ * //     ],
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeSMBSettingsCommandInput - {@link DescribeSMBSettingsCommandInput}
@@ -48,6 +62,8 @@ export interface DescribeSMBSettingsCommandOutput extends DescribeSMBSettingsOut
  *  <p>An exception occurred because an invalid gateway request was issued to the service. For
  *          more information, see the error and message fields.</p>
  *
+ * @throws {@link StorageGatewayServiceException}
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
  *
  */
 export declare class DescribeSMBSettingsCommand extends $Command<DescribeSMBSettingsCommandInput, DescribeSMBSettingsCommandOutput, StorageGatewayClientResolvedConfig> {

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

@@ -34,6 +34,20 @@ export interface DescribeSnapshotScheduleCommandOutput extends DescribeSnapshotS
  * };
  * const command = new DescribeSnapshotScheduleCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeSnapshotScheduleOutput
+ * //   VolumeARN: "STRING_VALUE",
+ * //   StartAt: Number("int"),
+ * //   RecurrenceInHours: Number("int"),
+ * //   Description: "STRING_VALUE",
+ * //   Timezone: "STRING_VALUE",
+ * //   Tags: [ // Tags
+ * //     { // Tag
+ * //       Key: "STRING_VALUE", // required
+ * //       Value: "STRING_VALUE", // required
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param DescribeSnapshotScheduleCommandInput - {@link DescribeSnapshotScheduleCommandInput}
@@ -50,6 +64,8 @@ export interface DescribeSnapshotScheduleCommandOutput extends DescribeSnapshotS
  *  <p>An exception occurred because an invalid gateway request was issued to the service. For
  *          more information, see the error and message fields.</p>
  *
+ * @throws {@link StorageGatewayServiceException}
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
  *
  * @example To describe snapshot schedule for gateway volume
  * ```javascript

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

@@ -35,6 +35,34 @@ export interface DescribeStorediSCSIVolumesCommandOutput extends DescribeStoredi
  * };
  * const command = new DescribeStorediSCSIVolumesCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeStorediSCSIVolumesOutput
+ * //   StorediSCSIVolumes: [ // StorediSCSIVolumes
+ * //     { // StorediSCSIVolume
+ * //       VolumeARN: "STRING_VALUE",
+ * //       VolumeId: "STRING_VALUE",
+ * //       VolumeType: "STRING_VALUE",
+ * //       VolumeStatus: "STRING_VALUE",
+ * //       VolumeAttachmentStatus: "STRING_VALUE",
+ * //       VolumeSizeInBytes: Number("long"),
+ * //       VolumeProgress: Number("double"),
+ * //       VolumeDiskId: "STRING_VALUE",
+ * //       SourceSnapshotId: "STRING_VALUE",
+ * //       PreservedExistingData: true || false,
+ * //       VolumeiSCSIAttributes: { // VolumeiSCSIAttributes
+ * //         TargetARN: "STRING_VALUE",
+ * //         NetworkInterfaceId: "STRING_VALUE",
+ * //         NetworkInterfacePort: Number("int"),
+ * //         LunNumber: Number("int"),
+ * //         ChapEnabled: true || false,
+ * //       },
+ * //       CreatedDate: new Date("TIMESTAMP"),
+ * //       VolumeUsedInBytes: Number("long"),
+ * //       KMSKey: "STRING_VALUE",
+ * //       TargetName: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param DescribeStorediSCSIVolumesCommandInput - {@link DescribeStorediSCSIVolumesCommandInput}
@@ -51,6 +79,8 @@ export interface DescribeStorediSCSIVolumesCommandOutput extends DescribeStoredi
  *  <p>An exception occurred because an invalid gateway request was issued to the service. For
  *          more information, see the error and message fields.</p>
  *
+ * @throws {@link StorageGatewayServiceException}
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
  *
  * @example To describe the volumes of a gateway
  * ```javascript

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

@@ -39,6 +39,27 @@ export interface DescribeTapeArchivesCommandOutput extends DescribeTapeArchivesO
  * };
  * const command = new DescribeTapeArchivesCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeTapeArchivesOutput
+ * //   TapeArchives: [ // TapeArchives
+ * //     { // TapeArchive
+ * //       TapeARN: "STRING_VALUE",
+ * //       TapeBarcode: "STRING_VALUE",
+ * //       TapeCreatedDate: new Date("TIMESTAMP"),
+ * //       TapeSizeInBytes: Number("long"),
+ * //       CompletionTime: new Date("TIMESTAMP"),
+ * //       RetrievedTo: "STRING_VALUE",
+ * //       TapeStatus: "STRING_VALUE",
+ * //       TapeUsedInBytes: Number("long"),
+ * //       KMSKey: "STRING_VALUE",
+ * //       PoolId: "STRING_VALUE",
+ * //       Worm: true || false,
+ * //       RetentionStartDate: new Date("TIMESTAMP"),
+ * //       PoolEntryDate: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   Marker: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DescribeTapeArchivesCommandInput - {@link DescribeTapeArchivesCommandInput}
@@ -55,6 +76,8 @@ export interface DescribeTapeArchivesCommandOutput extends DescribeTapeArchivesO
  *  <p>An exception occurred because an invalid gateway request was issued to the service. For
  *          more information, see the error and message fields.</p>
  *
+ * @throws {@link StorageGatewayServiceException}
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
  *
  * @example To describe virtual tapes in the VTS
  * ```javascript

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

@@ -39,6 +39,19 @@ export interface DescribeTapeRecoveryPointsCommandOutput extends DescribeTapeRec
  * };
  * const command = new DescribeTapeRecoveryPointsCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeTapeRecoveryPointsOutput
+ * //   GatewayARN: "STRING_VALUE",
+ * //   TapeRecoveryPointInfos: [ // TapeRecoveryPointInfos
+ * //     { // TapeRecoveryPointInfo
+ * //       TapeARN: "STRING_VALUE",
+ * //       TapeRecoveryPointTime: new Date("TIMESTAMP"),
+ * //       TapeSizeInBytes: Number("long"),
+ * //       TapeStatus: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   Marker: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DescribeTapeRecoveryPointsCommandInput - {@link DescribeTapeRecoveryPointsCommandInput}
@@ -55,6 +68,8 @@ export interface DescribeTapeRecoveryPointsCommandOutput extends DescribeTapeRec
  *  <p>An exception occurred because an invalid gateway request was issued to the service. For
  *          more information, see the error and message fields.</p>
  *
+ * @throws {@link StorageGatewayServiceException}
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
  *
  * @example To describe virtual tape recovery points
  * ```javascript

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

@@ -39,6 +39,27 @@ export interface DescribeTapesCommandOutput extends DescribeTapesOutput, __Metad
  * };
  * const command = new DescribeTapesCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeTapesOutput
+ * //   Tapes: [ // Tapes
+ * //     { // Tape
+ * //       TapeARN: "STRING_VALUE",
+ * //       TapeBarcode: "STRING_VALUE",
+ * //       TapeCreatedDate: new Date("TIMESTAMP"),
+ * //       TapeSizeInBytes: Number("long"),
+ * //       TapeStatus: "STRING_VALUE",
+ * //       VTLDevice: "STRING_VALUE",
+ * //       Progress: Number("double"),
+ * //       TapeUsedInBytes: Number("long"),
+ * //       KMSKey: "STRING_VALUE",
+ * //       PoolId: "STRING_VALUE",
+ * //       Worm: true || false,
+ * //       RetentionStartDate: new Date("TIMESTAMP"),
+ * //       PoolEntryDate: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   Marker: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DescribeTapesCommandInput - {@link DescribeTapesCommandInput}
@@ -55,6 +76,8 @@ export interface DescribeTapesCommandOutput extends DescribeTapesOutput, __Metad
  *  <p>An exception occurred because an invalid gateway request was issued to the service. For
  *          more information, see the error and message fields.</p>
  *
+ * @throws {@link StorageGatewayServiceException}
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
  *
  * @example To describe virtual tape(s) associated with gateway
  * ```javascript

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

@@ -35,6 +35,15 @@ export interface DescribeUploadBufferCommandOutput extends DescribeUploadBufferO
  * };
  * const command = new DescribeUploadBufferCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeUploadBufferOutput
+ * //   GatewayARN: "STRING_VALUE",
+ * //   DiskIds: [ // DiskIds
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   UploadBufferUsedInBytes: Number("long"),
+ * //   UploadBufferAllocatedInBytes: Number("long"),
+ * // };
+ *
  * ```
  *
  * @param DescribeUploadBufferCommandInput - {@link DescribeUploadBufferCommandInput}
@@ -51,6 +60,8 @@ export interface DescribeUploadBufferCommandOutput extends DescribeUploadBufferO
  *  <p>An exception occurred because an invalid gateway request was issued to the service. For
  *          more information, see the error and message fields.</p>
  *
+ * @throws {@link StorageGatewayServiceException}
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
  *
  * @example To describe upload buffer of gateway
  * ```javascript

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

@@ -39,6 +39,25 @@ export interface DescribeVTLDevicesCommandOutput extends DescribeVTLDevicesOutpu
  * };
  * const command = new DescribeVTLDevicesCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeVTLDevicesOutput
+ * //   GatewayARN: "STRING_VALUE",
+ * //   VTLDevices: [ // VTLDevices
+ * //     { // VTLDevice
+ * //       VTLDeviceARN: "STRING_VALUE",
+ * //       VTLDeviceType: "STRING_VALUE",
+ * //       VTLDeviceVendor: "STRING_VALUE",
+ * //       VTLDeviceProductIdentifier: "STRING_VALUE",
+ * //       DeviceiSCSIAttributes: { // DeviceiSCSIAttributes
+ * //         TargetARN: "STRING_VALUE",
+ * //         NetworkInterfaceId: "STRING_VALUE",
+ * //         NetworkInterfacePort: Number("int"),
+ * //         ChapEnabled: true || false,
+ * //       },
+ * //     },
+ * //   ],
+ * //   Marker: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DescribeVTLDevicesCommandInput - {@link DescribeVTLDevicesCommandInput}
@@ -55,6 +74,8 @@ export interface DescribeVTLDevicesCommandOutput extends DescribeVTLDevicesOutpu
  *  <p>An exception occurred because an invalid gateway request was issued to the service. For
  *          more information, see the error and message fields.</p>
  *
+ * @throws {@link StorageGatewayServiceException}
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
  *
  * @example To describe virtual tape library (VTL) devices of a single gateway
  * ```javascript