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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (91) hide show
  1. package/dist-types/commands/ActivateGatewayCommand.d.ts +6 -0
  2. package/dist-types/commands/AddCacheCommand.d.ts +6 -0
  3. package/dist-types/commands/AddTagsToResourceCommand.d.ts +6 -0
  4. package/dist-types/commands/AddUploadBufferCommand.d.ts +6 -0
  5. package/dist-types/commands/AddWorkingStorageCommand.d.ts +6 -0
  6. package/dist-types/commands/AssignTapePoolCommand.d.ts +6 -0
  7. package/dist-types/commands/AssociateFileSystemCommand.d.ts +6 -0
  8. package/dist-types/commands/AttachVolumeCommand.d.ts +7 -0
  9. package/dist-types/commands/CancelArchivalCommand.d.ts +6 -0
  10. package/dist-types/commands/CancelRetrievalCommand.d.ts +6 -0
  11. package/dist-types/commands/CreateCachediSCSIVolumeCommand.d.ts +7 -0
  12. package/dist-types/commands/CreateNFSFileShareCommand.d.ts +6 -0
  13. package/dist-types/commands/CreateSMBFileShareCommand.d.ts +6 -0
  14. package/dist-types/commands/CreateSnapshotCommand.d.ts +7 -0
  15. package/dist-types/commands/CreateSnapshotFromVolumeRecoveryPointCommand.d.ts +8 -0
  16. package/dist-types/commands/CreateStorediSCSIVolumeCommand.d.ts +8 -0
  17. package/dist-types/commands/CreateTapePoolCommand.d.ts +6 -0
  18. package/dist-types/commands/CreateTapeWithBarcodeCommand.d.ts +6 -0
  19. package/dist-types/commands/CreateTapesCommand.d.ts +8 -0
  20. package/dist-types/commands/DeleteAutomaticTapeCreationPolicyCommand.d.ts +6 -0
  21. package/dist-types/commands/DeleteBandwidthRateLimitCommand.d.ts +6 -0
  22. package/dist-types/commands/DeleteChapCredentialsCommand.d.ts +7 -0
  23. package/dist-types/commands/DeleteFileShareCommand.d.ts +6 -0
  24. package/dist-types/commands/DeleteGatewayCommand.d.ts +6 -0
  25. package/dist-types/commands/DeleteSnapshotScheduleCommand.d.ts +6 -0
  26. package/dist-types/commands/DeleteTapeArchiveCommand.d.ts +6 -0
  27. package/dist-types/commands/DeleteTapeCommand.d.ts +6 -0
  28. package/dist-types/commands/DeleteTapePoolCommand.d.ts +6 -0
  29. package/dist-types/commands/DeleteVolumeCommand.d.ts +6 -0
  30. package/dist-types/commands/DescribeAvailabilityMonitorTestCommand.d.ts +8 -0
  31. package/dist-types/commands/DescribeBandwidthRateLimitCommand.d.ts +8 -0
  32. package/dist-types/commands/DescribeBandwidthRateLimitScheduleCommand.d.ts +19 -0
  33. package/dist-types/commands/DescribeCacheCommand.d.ts +14 -0
  34. package/dist-types/commands/DescribeCachediSCSIVolumesCommand.d.ts +28 -0
  35. package/dist-types/commands/DescribeChapCredentialsCommand.d.ts +13 -0
  36. package/dist-types/commands/DescribeFileSystemAssociationsCommand.d.ts +33 -0
  37. package/dist-types/commands/DescribeGatewayInformationCommand.d.ts +39 -0
  38. package/dist-types/commands/DescribeMaintenanceStartTimeCommand.d.ts +11 -0
  39. package/dist-types/commands/DescribeNFSFileSharesCommand.d.ts +47 -0
  40. package/dist-types/commands/DescribeSMBFileSharesCommand.d.ts +51 -0
  41. package/dist-types/commands/DescribeSMBSettingsCommand.d.ts +16 -0
  42. package/dist-types/commands/DescribeSnapshotScheduleCommand.d.ts +16 -0
  43. package/dist-types/commands/DescribeStorediSCSIVolumesCommand.d.ts +30 -0
  44. package/dist-types/commands/DescribeTapeArchivesCommand.d.ts +23 -0
  45. package/dist-types/commands/DescribeTapeRecoveryPointsCommand.d.ts +15 -0
  46. package/dist-types/commands/DescribeTapesCommand.d.ts +23 -0
  47. package/dist-types/commands/DescribeUploadBufferCommand.d.ts +11 -0
  48. package/dist-types/commands/DescribeVTLDevicesCommand.d.ts +21 -0
  49. package/dist-types/commands/DescribeWorkingStorageCommand.d.ts +11 -0
  50. package/dist-types/commands/DetachVolumeCommand.d.ts +6 -0
  51. package/dist-types/commands/DisableGatewayCommand.d.ts +6 -0
  52. package/dist-types/commands/DisassociateFileSystemCommand.d.ts +6 -0
  53. package/dist-types/commands/JoinDomainCommand.d.ts +7 -0
  54. package/dist-types/commands/ListAutomaticTapeCreationPoliciesCommand.d.ts +19 -0
  55. package/dist-types/commands/ListFileSharesCommand.d.ts +16 -0
  56. package/dist-types/commands/ListFileSystemAssociationsCommand.d.ts +15 -0
  57. package/dist-types/commands/ListGatewaysCommand.d.ts +19 -0
  58. package/dist-types/commands/ListLocalDisksCommand.d.ts +20 -0
  59. package/dist-types/commands/ListTagsForResourceCommand.d.ts +13 -0
  60. package/dist-types/commands/ListTapePoolsCommand.d.ts +16 -0
  61. package/dist-types/commands/ListTapesCommand.d.ts +18 -0
  62. package/dist-types/commands/ListVolumeInitiatorsCommand.d.ts +8 -0
  63. package/dist-types/commands/ListVolumeRecoveryPointsCommand.d.ts +14 -0
  64. package/dist-types/commands/ListVolumesCommand.d.ts +18 -0
  65. package/dist-types/commands/NotifyWhenUploadedCommand.d.ts +7 -0
  66. package/dist-types/commands/RefreshCacheCommand.d.ts +7 -0
  67. package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +6 -0
  68. package/dist-types/commands/ResetCacheCommand.d.ts +6 -0
  69. package/dist-types/commands/RetrieveTapeArchiveCommand.d.ts +6 -0
  70. package/dist-types/commands/RetrieveTapeRecoveryPointCommand.d.ts +6 -0
  71. package/dist-types/commands/SetLocalConsolePasswordCommand.d.ts +6 -0
  72. package/dist-types/commands/SetSMBGuestPasswordCommand.d.ts +6 -0
  73. package/dist-types/commands/ShutdownGatewayCommand.d.ts +6 -0
  74. package/dist-types/commands/StartAvailabilityMonitorTestCommand.d.ts +6 -0
  75. package/dist-types/commands/StartGatewayCommand.d.ts +6 -0
  76. package/dist-types/commands/UpdateAutomaticTapeCreationPolicyCommand.d.ts +6 -0
  77. package/dist-types/commands/UpdateBandwidthRateLimitCommand.d.ts +6 -0
  78. package/dist-types/commands/UpdateBandwidthRateLimitScheduleCommand.d.ts +6 -0
  79. package/dist-types/commands/UpdateChapCredentialsCommand.d.ts +7 -0
  80. package/dist-types/commands/UpdateFileSystemAssociationCommand.d.ts +6 -0
  81. package/dist-types/commands/UpdateGatewayInformationCommand.d.ts +7 -0
  82. package/dist-types/commands/UpdateGatewaySoftwareNowCommand.d.ts +6 -0
  83. package/dist-types/commands/UpdateMaintenanceStartTimeCommand.d.ts +6 -0
  84. package/dist-types/commands/UpdateNFSFileShareCommand.d.ts +6 -0
  85. package/dist-types/commands/UpdateSMBFileShareCommand.d.ts +6 -0
  86. package/dist-types/commands/UpdateSMBFileShareVisibilityCommand.d.ts +6 -0
  87. package/dist-types/commands/UpdateSMBLocalGroupsCommand.d.ts +6 -0
  88. package/dist-types/commands/UpdateSMBSecurityStrategyCommand.d.ts +6 -0
  89. package/dist-types/commands/UpdateSnapshotScheduleCommand.d.ts +6 -0
  90. package/dist-types/commands/UpdateVTLDeviceTypeCommand.d.ts +6 -0
  91. package/package.json +3 -3
@@ -41,6 +41,15 @@ export interface DescribeWorkingStorageCommandOutput extends DescribeWorkingStor
41
41
  * };
42
42
  * const command = new DescribeWorkingStorageCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // { // DescribeWorkingStorageOutput
45
+ * // GatewayARN: "STRING_VALUE",
46
+ * // DiskIds: [ // DiskIds
47
+ * // "STRING_VALUE",
48
+ * // ],
49
+ * // WorkingStorageUsedInBytes: Number("long"),
50
+ * // WorkingStorageAllocatedInBytes: Number("long"),
51
+ * // };
52
+ *
44
53
  * ```
45
54
  *
46
55
  * @param DescribeWorkingStorageCommandInput - {@link DescribeWorkingStorageCommandInput}
@@ -57,6 +66,8 @@ export interface DescribeWorkingStorageCommandOutput extends DescribeWorkingStor
57
66
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
58
67
  * more information, see the error and message fields.</p>
59
68
  *
69
+ * @throws {@link StorageGatewayServiceException}
70
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
60
71
  *
61
72
  * @example To describe the working storage of a gateway [Depreciated]
62
73
  * ```javascript
@@ -36,6 +36,10 @@ export interface DetachVolumeCommandOutput extends DetachVolumeOutput, __Metadat
36
36
  * };
37
37
  * const command = new DetachVolumeCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // DetachVolumeOutput
40
+ * // VolumeARN: "STRING_VALUE",
41
+ * // };
42
+ *
39
43
  * ```
40
44
  *
41
45
  * @param DetachVolumeCommandInput - {@link DetachVolumeCommandInput}
@@ -52,6 +56,8 @@ export interface DetachVolumeCommandOutput extends DetachVolumeOutput, __Metadat
52
56
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
53
57
  * more information, see the error and message fields.</p>
54
58
  *
59
+ * @throws {@link StorageGatewayServiceException}
60
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
55
61
  *
56
62
  */
57
63
  export declare class DetachVolumeCommand extends $Command<DetachVolumeCommandInput, DetachVolumeCommandOutput, StorageGatewayClientResolvedConfig> {
@@ -39,6 +39,10 @@ export interface DisableGatewayCommandOutput extends DisableGatewayOutput, __Met
39
39
  * };
40
40
  * const command = new DisableGatewayCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // DisableGatewayOutput
43
+ * // GatewayARN: "STRING_VALUE",
44
+ * // };
45
+ *
42
46
  * ```
43
47
  *
44
48
  * @param DisableGatewayCommandInput - {@link DisableGatewayCommandInput}
@@ -55,6 +59,8 @@ export interface DisableGatewayCommandOutput extends DisableGatewayOutput, __Met
55
59
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
56
60
  * more information, see the error and message fields.</p>
57
61
  *
62
+ * @throws {@link StorageGatewayServiceException}
63
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
58
64
  *
59
65
  * @example To disable a gateway when it is no longer functioning
60
66
  * ```javascript
@@ -34,6 +34,10 @@ export interface DisassociateFileSystemCommandOutput extends DisassociateFileSys
34
34
  * };
35
35
  * const command = new DisassociateFileSystemCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // DisassociateFileSystemOutput
38
+ * // FileSystemAssociationARN: "STRING_VALUE",
39
+ * // };
40
+ *
37
41
  * ```
38
42
  *
39
43
  * @param DisassociateFileSystemCommandInput - {@link DisassociateFileSystemCommandInput}
@@ -50,6 +54,8 @@ export interface DisassociateFileSystemCommandOutput extends DisassociateFileSys
50
54
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
51
55
  * more information, see the error and message fields.</p>
52
56
  *
57
+ * @throws {@link StorageGatewayServiceException}
58
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
53
59
  *
54
60
  */
55
61
  export declare class DisassociateFileSystemCommand extends $Command<DisassociateFileSystemCommandInput, DisassociateFileSystemCommandOutput, StorageGatewayClientResolvedConfig> {
@@ -40,6 +40,11 @@ export interface JoinDomainCommandOutput extends JoinDomainOutput, __MetadataBea
40
40
  * };
41
41
  * const command = new JoinDomainCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // JoinDomainOutput
44
+ * // GatewayARN: "STRING_VALUE",
45
+ * // ActiveDirectoryStatus: "STRING_VALUE",
46
+ * // };
47
+ *
43
48
  * ```
44
49
  *
45
50
  * @param JoinDomainCommandInput - {@link JoinDomainCommandInput}
@@ -56,6 +61,8 @@ export interface JoinDomainCommandOutput extends JoinDomainOutput, __MetadataBea
56
61
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
57
62
  * more information, see the error and message fields.</p>
58
63
  *
64
+ * @throws {@link StorageGatewayServiceException}
65
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
59
66
  *
60
67
  */
61
68
  export declare class JoinDomainCommand extends $Command<JoinDomainCommandInput, JoinDomainCommandOutput, StorageGatewayClientResolvedConfig> {
@@ -34,6 +34,23 @@ export interface ListAutomaticTapeCreationPoliciesCommandOutput extends ListAuto
34
34
  * };
35
35
  * const command = new ListAutomaticTapeCreationPoliciesCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListAutomaticTapeCreationPoliciesOutput
38
+ * // AutomaticTapeCreationPolicyInfos: [ // AutomaticTapeCreationPolicyInfos
39
+ * // { // AutomaticTapeCreationPolicyInfo
40
+ * // AutomaticTapeCreationRules: [ // AutomaticTapeCreationRules
41
+ * // { // AutomaticTapeCreationRule
42
+ * // TapeBarcodePrefix: "STRING_VALUE", // required
43
+ * // PoolId: "STRING_VALUE", // required
44
+ * // TapeSizeInBytes: Number("long"), // required
45
+ * // MinimumNumTapes: Number("int"), // required
46
+ * // Worm: true || false,
47
+ * // },
48
+ * // ],
49
+ * // GatewayARN: "STRING_VALUE",
50
+ * // },
51
+ * // ],
52
+ * // };
53
+ *
37
54
  * ```
38
55
  *
39
56
  * @param ListAutomaticTapeCreationPoliciesCommandInput - {@link ListAutomaticTapeCreationPoliciesCommandInput}
@@ -50,6 +67,8 @@ export interface ListAutomaticTapeCreationPoliciesCommandOutput extends ListAuto
50
67
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
51
68
  * more information, see the error and message fields.</p>
52
69
  *
70
+ * @throws {@link StorageGatewayServiceException}
71
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
53
72
  *
54
73
  */
55
74
  export declare class ListAutomaticTapeCreationPoliciesCommand extends $Command<ListAutomaticTapeCreationPoliciesCommandInput, ListAutomaticTapeCreationPoliciesCommandOutput, StorageGatewayClientResolvedConfig> {
@@ -35,6 +35,20 @@ export interface ListFileSharesCommandOutput extends ListFileSharesOutput, __Met
35
35
  * };
36
36
  * const command = new ListFileSharesCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // ListFileSharesOutput
39
+ * // Marker: "STRING_VALUE",
40
+ * // NextMarker: "STRING_VALUE",
41
+ * // FileShareInfoList: [ // FileShareInfoList
42
+ * // { // FileShareInfo
43
+ * // FileShareType: "STRING_VALUE",
44
+ * // FileShareARN: "STRING_VALUE",
45
+ * // FileShareId: "STRING_VALUE",
46
+ * // FileShareStatus: "STRING_VALUE",
47
+ * // GatewayARN: "STRING_VALUE",
48
+ * // },
49
+ * // ],
50
+ * // };
51
+ *
38
52
  * ```
39
53
  *
40
54
  * @param ListFileSharesCommandInput - {@link ListFileSharesCommandInput}
@@ -51,6 +65,8 @@ export interface ListFileSharesCommandOutput extends ListFileSharesOutput, __Met
51
65
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
52
66
  * more information, see the error and message fields.</p>
53
67
  *
68
+ * @throws {@link StorageGatewayServiceException}
69
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
54
70
  *
55
71
  */
56
72
  export declare class ListFileSharesCommand extends $Command<ListFileSharesCommandInput, ListFileSharesCommandOutput, StorageGatewayClientResolvedConfig> {
@@ -35,6 +35,19 @@ export interface ListFileSystemAssociationsCommandOutput extends ListFileSystemA
35
35
  * };
36
36
  * const command = new ListFileSystemAssociationsCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // ListFileSystemAssociationsOutput
39
+ * // Marker: "STRING_VALUE",
40
+ * // NextMarker: "STRING_VALUE",
41
+ * // FileSystemAssociationSummaryList: [ // FileSystemAssociationSummaryList
42
+ * // { // FileSystemAssociationSummary
43
+ * // FileSystemAssociationId: "STRING_VALUE",
44
+ * // FileSystemAssociationARN: "STRING_VALUE",
45
+ * // FileSystemAssociationStatus: "STRING_VALUE",
46
+ * // GatewayARN: "STRING_VALUE",
47
+ * // },
48
+ * // ],
49
+ * // };
50
+ *
38
51
  * ```
39
52
  *
40
53
  * @param ListFileSystemAssociationsCommandInput - {@link ListFileSystemAssociationsCommandInput}
@@ -51,6 +64,8 @@ export interface ListFileSystemAssociationsCommandOutput extends ListFileSystemA
51
64
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
52
65
  * more information, see the error and message fields.</p>
53
66
  *
67
+ * @throws {@link StorageGatewayServiceException}
68
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
54
69
  *
55
70
  */
56
71
  export declare class ListFileSystemAssociationsCommand extends $Command<ListFileSystemAssociationsCommandInput, ListFileSystemAssociationsCommandOutput, StorageGatewayClientResolvedConfig> {
@@ -42,6 +42,23 @@ export interface ListGatewaysCommandOutput extends ListGatewaysOutput, __Metadat
42
42
  * };
43
43
  * const command = new ListGatewaysCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // ListGatewaysOutput
46
+ * // Gateways: [ // Gateways
47
+ * // { // GatewayInfo
48
+ * // GatewayId: "STRING_VALUE",
49
+ * // GatewayARN: "STRING_VALUE",
50
+ * // GatewayType: "STRING_VALUE",
51
+ * // GatewayOperationalState: "STRING_VALUE",
52
+ * // GatewayName: "STRING_VALUE",
53
+ * // Ec2InstanceId: "STRING_VALUE",
54
+ * // Ec2InstanceRegion: "STRING_VALUE",
55
+ * // HostEnvironment: "STRING_VALUE",
56
+ * // HostEnvironmentId: "STRING_VALUE",
57
+ * // },
58
+ * // ],
59
+ * // Marker: "STRING_VALUE",
60
+ * // };
61
+ *
45
62
  * ```
46
63
  *
47
64
  * @param ListGatewaysCommandInput - {@link ListGatewaysCommandInput}
@@ -58,6 +75,8 @@ export interface ListGatewaysCommandOutput extends ListGatewaysOutput, __Metadat
58
75
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
59
76
  * more information, see the error and message fields.</p>
60
77
  *
78
+ * @throws {@link StorageGatewayServiceException}
79
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
61
80
  *
62
81
  * @example To lists region specific gateways per AWS account
63
82
  * ```javascript
@@ -39,6 +39,24 @@ export interface ListLocalDisksCommandOutput extends ListLocalDisksOutput, __Met
39
39
  * };
40
40
  * const command = new ListLocalDisksCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // ListLocalDisksOutput
43
+ * // GatewayARN: "STRING_VALUE",
44
+ * // Disks: [ // Disks
45
+ * // { // Disk
46
+ * // DiskId: "STRING_VALUE",
47
+ * // DiskPath: "STRING_VALUE",
48
+ * // DiskNode: "STRING_VALUE",
49
+ * // DiskStatus: "STRING_VALUE",
50
+ * // DiskSizeInBytes: Number("long"),
51
+ * // DiskAllocationType: "STRING_VALUE",
52
+ * // DiskAllocationResource: "STRING_VALUE",
53
+ * // DiskAttributeList: [ // DiskAttributeList
54
+ * // "STRING_VALUE",
55
+ * // ],
56
+ * // },
57
+ * // ],
58
+ * // };
59
+ *
42
60
  * ```
43
61
  *
44
62
  * @param ListLocalDisksCommandInput - {@link ListLocalDisksCommandInput}
@@ -55,6 +73,8 @@ export interface ListLocalDisksCommandOutput extends ListLocalDisksOutput, __Met
55
73
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
56
74
  * more information, see the error and message fields.</p>
57
75
  *
76
+ * @throws {@link StorageGatewayServiceException}
77
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
58
78
  *
59
79
  * @example To list the gateway's local disks
60
80
  * ```javascript
@@ -34,6 +34,17 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
34
34
  * };
35
35
  * const command = new ListTagsForResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListTagsForResourceOutput
38
+ * // ResourceARN: "STRING_VALUE",
39
+ * // Marker: "STRING_VALUE",
40
+ * // Tags: [ // Tags
41
+ * // { // Tag
42
+ * // Key: "STRING_VALUE", // required
43
+ * // Value: "STRING_VALUE", // required
44
+ * // },
45
+ * // ],
46
+ * // };
47
+ *
37
48
  * ```
38
49
  *
39
50
  * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
@@ -50,6 +61,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
50
61
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
51
62
  * more information, see the error and message fields.</p>
52
63
  *
64
+ * @throws {@link StorageGatewayServiceException}
65
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
53
66
  *
54
67
  * @example To list tags that have been added to a resource
55
68
  * ```javascript
@@ -43,6 +43,20 @@ export interface ListTapePoolsCommandOutput extends ListTapePoolsOutput, __Metad
43
43
  * };
44
44
  * const command = new ListTapePoolsCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // ListTapePoolsOutput
47
+ * // PoolInfos: [ // PoolInfos
48
+ * // { // PoolInfo
49
+ * // PoolARN: "STRING_VALUE",
50
+ * // PoolName: "STRING_VALUE",
51
+ * // StorageClass: "STRING_VALUE",
52
+ * // RetentionLockType: "STRING_VALUE",
53
+ * // RetentionLockTimeInDays: Number("int"),
54
+ * // PoolStatus: "STRING_VALUE",
55
+ * // },
56
+ * // ],
57
+ * // Marker: "STRING_VALUE",
58
+ * // };
59
+ *
46
60
  * ```
47
61
  *
48
62
  * @param ListTapePoolsCommandInput - {@link ListTapePoolsCommandInput}
@@ -59,6 +73,8 @@ export interface ListTapePoolsCommandOutput extends ListTapePoolsOutput, __Metad
59
73
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
60
74
  * more information, see the error and message fields.</p>
61
75
  *
76
+ * @throws {@link StorageGatewayServiceException}
77
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
62
78
  *
63
79
  */
64
80
  export declare class ListTapePoolsCommand extends $Command<ListTapePoolsCommandInput, ListTapePoolsCommandOutput, StorageGatewayClientResolvedConfig> {
@@ -45,6 +45,22 @@ export interface ListTapesCommandOutput extends ListTapesOutput, __MetadataBeare
45
45
  * };
46
46
  * const command = new ListTapesCommand(input);
47
47
  * const response = await client.send(command);
48
+ * // { // ListTapesOutput
49
+ * // TapeInfos: [ // TapeInfos
50
+ * // { // TapeInfo
51
+ * // TapeARN: "STRING_VALUE",
52
+ * // TapeBarcode: "STRING_VALUE",
53
+ * // TapeSizeInBytes: Number("long"),
54
+ * // TapeStatus: "STRING_VALUE",
55
+ * // GatewayARN: "STRING_VALUE",
56
+ * // PoolId: "STRING_VALUE",
57
+ * // RetentionStartDate: new Date("TIMESTAMP"),
58
+ * // PoolEntryDate: new Date("TIMESTAMP"),
59
+ * // },
60
+ * // ],
61
+ * // Marker: "STRING_VALUE",
62
+ * // };
63
+ *
48
64
  * ```
49
65
  *
50
66
  * @param ListTapesCommandInput - {@link ListTapesCommandInput}
@@ -61,6 +77,8 @@ export interface ListTapesCommandOutput extends ListTapesOutput, __MetadataBeare
61
77
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
62
78
  * more information, see the error and message fields.</p>
63
79
  *
80
+ * @throws {@link StorageGatewayServiceException}
81
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
64
82
  *
65
83
  */
66
84
  export declare class ListTapesCommand extends $Command<ListTapesCommandInput, ListTapesCommandOutput, StorageGatewayClientResolvedConfig> {
@@ -33,6 +33,12 @@ export interface ListVolumeInitiatorsCommandOutput extends ListVolumeInitiatorsO
33
33
  * };
34
34
  * const command = new ListVolumeInitiatorsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListVolumeInitiatorsOutput
37
+ * // Initiators: [ // Initiators
38
+ * // "STRING_VALUE",
39
+ * // ],
40
+ * // };
41
+ *
36
42
  * ```
37
43
  *
38
44
  * @param ListVolumeInitiatorsCommandInput - {@link ListVolumeInitiatorsCommandInput}
@@ -49,6 +55,8 @@ export interface ListVolumeInitiatorsCommandOutput extends ListVolumeInitiatorsO
49
55
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
50
56
  * more information, see the error and message fields.</p>
51
57
  *
58
+ * @throws {@link StorageGatewayServiceException}
59
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
52
60
  *
53
61
  */
54
62
  export declare class ListVolumeInitiatorsCommand extends $Command<ListVolumeInitiatorsCommandInput, ListVolumeInitiatorsCommandOutput, StorageGatewayClientResolvedConfig> {
@@ -37,6 +37,18 @@ export interface ListVolumeRecoveryPointsCommandOutput extends ListVolumeRecover
37
37
  * };
38
38
  * const command = new ListVolumeRecoveryPointsCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // ListVolumeRecoveryPointsOutput
41
+ * // GatewayARN: "STRING_VALUE",
42
+ * // VolumeRecoveryPointInfos: [ // VolumeRecoveryPointInfos
43
+ * // { // VolumeRecoveryPointInfo
44
+ * // VolumeARN: "STRING_VALUE",
45
+ * // VolumeSizeInBytes: Number("long"),
46
+ * // VolumeUsageInBytes: Number("long"),
47
+ * // VolumeRecoveryPointTime: "STRING_VALUE",
48
+ * // },
49
+ * // ],
50
+ * // };
51
+ *
40
52
  * ```
41
53
  *
42
54
  * @param ListVolumeRecoveryPointsCommandInput - {@link ListVolumeRecoveryPointsCommandInput}
@@ -53,6 +65,8 @@ export interface ListVolumeRecoveryPointsCommandOutput extends ListVolumeRecover
53
65
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
54
66
  * more information, see the error and message fields.</p>
55
67
  *
68
+ * @throws {@link StorageGatewayServiceException}
69
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
56
70
  *
57
71
  * @example To list recovery points for a gateway
58
72
  * ```javascript
@@ -42,6 +42,22 @@ export interface ListVolumesCommandOutput extends ListVolumesOutput, __MetadataB
42
42
  * };
43
43
  * const command = new ListVolumesCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // ListVolumesOutput
46
+ * // GatewayARN: "STRING_VALUE",
47
+ * // Marker: "STRING_VALUE",
48
+ * // VolumeInfos: [ // VolumeInfos
49
+ * // { // VolumeInfo
50
+ * // VolumeARN: "STRING_VALUE",
51
+ * // VolumeId: "STRING_VALUE",
52
+ * // GatewayARN: "STRING_VALUE",
53
+ * // GatewayId: "STRING_VALUE",
54
+ * // VolumeType: "STRING_VALUE",
55
+ * // VolumeSizeInBytes: Number("long"),
56
+ * // VolumeAttachmentStatus: "STRING_VALUE",
57
+ * // },
58
+ * // ],
59
+ * // };
60
+ *
45
61
  * ```
46
62
  *
47
63
  * @param ListVolumesCommandInput - {@link ListVolumesCommandInput}
@@ -58,6 +74,8 @@ export interface ListVolumesCommandOutput extends ListVolumesOutput, __MetadataB
58
74
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
59
75
  * more information, see the error and message fields.</p>
60
76
  *
77
+ * @throws {@link StorageGatewayServiceException}
78
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
61
79
  *
62
80
  * @example To list the iSCSI stored volumes of a gateway
63
81
  * ```javascript
@@ -43,6 +43,11 @@ export interface NotifyWhenUploadedCommandOutput extends NotifyWhenUploadedOutpu
43
43
  * };
44
44
  * const command = new NotifyWhenUploadedCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // NotifyWhenUploadedOutput
47
+ * // FileShareARN: "STRING_VALUE",
48
+ * // NotificationId: "STRING_VALUE",
49
+ * // };
50
+ *
46
51
  * ```
47
52
  *
48
53
  * @param NotifyWhenUploadedCommandInput - {@link NotifyWhenUploadedCommandInput}
@@ -59,6 +64,8 @@ export interface NotifyWhenUploadedCommandOutput extends NotifyWhenUploadedOutpu
59
64
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
60
65
  * more information, see the error and message fields.</p>
61
66
  *
67
+ * @throws {@link StorageGatewayServiceException}
68
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
62
69
  *
63
70
  */
64
71
  export declare class NotifyWhenUploadedCommand extends $Command<NotifyWhenUploadedCommandInput, NotifyWhenUploadedCommandOutput, StorageGatewayClientResolvedConfig> {
@@ -84,6 +84,11 @@ export interface RefreshCacheCommandOutput extends RefreshCacheOutput, __Metadat
84
84
  * };
85
85
  * const command = new RefreshCacheCommand(input);
86
86
  * const response = await client.send(command);
87
+ * // { // RefreshCacheOutput
88
+ * // FileShareARN: "STRING_VALUE",
89
+ * // NotificationId: "STRING_VALUE",
90
+ * // };
91
+ *
87
92
  * ```
88
93
  *
89
94
  * @param RefreshCacheCommandInput - {@link RefreshCacheCommandInput}
@@ -100,6 +105,8 @@ export interface RefreshCacheCommandOutput extends RefreshCacheOutput, __Metadat
100
105
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
101
106
  * more information, see the error and message fields.</p>
102
107
  *
108
+ * @throws {@link StorageGatewayServiceException}
109
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
103
110
  *
104
111
  */
105
112
  export declare class RefreshCacheCommand extends $Command<RefreshCacheCommandInput, RefreshCacheCommandOutput, StorageGatewayClientResolvedConfig> {
@@ -35,6 +35,10 @@ export interface RemoveTagsFromResourceCommandOutput extends RemoveTagsFromResou
35
35
  * };
36
36
  * const command = new RemoveTagsFromResourceCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // RemoveTagsFromResourceOutput
39
+ * // ResourceARN: "STRING_VALUE",
40
+ * // };
41
+ *
38
42
  * ```
39
43
  *
40
44
  * @param RemoveTagsFromResourceCommandInput - {@link RemoveTagsFromResourceCommandInput}
@@ -51,6 +55,8 @@ export interface RemoveTagsFromResourceCommandOutput extends RemoveTagsFromResou
51
55
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
52
56
  * more information, see the error and message fields.</p>
53
57
  *
58
+ * @throws {@link StorageGatewayServiceException}
59
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
54
60
  *
55
61
  * @example To remove tags from a resource
56
62
  * ```javascript
@@ -43,6 +43,10 @@ export interface ResetCacheCommandOutput extends ResetCacheOutput, __MetadataBea
43
43
  * };
44
44
  * const command = new ResetCacheCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // ResetCacheOutput
47
+ * // GatewayARN: "STRING_VALUE",
48
+ * // };
49
+ *
46
50
  * ```
47
51
  *
48
52
  * @param ResetCacheCommandInput - {@link ResetCacheCommandInput}
@@ -59,6 +63,8 @@ export interface ResetCacheCommandOutput extends ResetCacheOutput, __MetadataBea
59
63
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
60
64
  * more information, see the error and message fields.</p>
61
65
  *
66
+ * @throws {@link StorageGatewayServiceException}
67
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
62
68
  *
63
69
  * @example To reset cache disks in error status
64
70
  * ```javascript
@@ -39,6 +39,10 @@ export interface RetrieveTapeArchiveCommandOutput extends RetrieveTapeArchiveOut
39
39
  * };
40
40
  * const command = new RetrieveTapeArchiveCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // RetrieveTapeArchiveOutput
43
+ * // TapeARN: "STRING_VALUE",
44
+ * // };
45
+ *
42
46
  * ```
43
47
  *
44
48
  * @param RetrieveTapeArchiveCommandInput - {@link RetrieveTapeArchiveCommandInput}
@@ -55,6 +59,8 @@ export interface RetrieveTapeArchiveCommandOutput extends RetrieveTapeArchiveOut
55
59
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
56
60
  * more information, see the error and message fields.</p>
57
61
  *
62
+ * @throws {@link StorageGatewayServiceException}
63
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
58
64
  *
59
65
  * @example To retrieve an archived tape from the VTS
60
66
  * ```javascript
@@ -43,6 +43,10 @@ export interface RetrieveTapeRecoveryPointCommandOutput extends RetrieveTapeReco
43
43
  * };
44
44
  * const command = new RetrieveTapeRecoveryPointCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // RetrieveTapeRecoveryPointOutput
47
+ * // TapeARN: "STRING_VALUE",
48
+ * // };
49
+ *
46
50
  * ```
47
51
  *
48
52
  * @param RetrieveTapeRecoveryPointCommandInput - {@link RetrieveTapeRecoveryPointCommandInput}
@@ -59,6 +63,8 @@ export interface RetrieveTapeRecoveryPointCommandOutput extends RetrieveTapeReco
59
63
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
60
64
  * more information, see the error and message fields.</p>
61
65
  *
66
+ * @throws {@link StorageGatewayServiceException}
67
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
62
68
  *
63
69
  * @example To retrieve the recovery point of a virtual tape
64
70
  * ```javascript
@@ -35,6 +35,10 @@ export interface SetLocalConsolePasswordCommandOutput extends SetLocalConsolePas
35
35
  * };
36
36
  * const command = new SetLocalConsolePasswordCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // SetLocalConsolePasswordOutput
39
+ * // GatewayARN: "STRING_VALUE",
40
+ * // };
41
+ *
38
42
  * ```
39
43
  *
40
44
  * @param SetLocalConsolePasswordCommandInput - {@link SetLocalConsolePasswordCommandInput}
@@ -51,6 +55,8 @@ export interface SetLocalConsolePasswordCommandOutput extends SetLocalConsolePas
51
55
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
52
56
  * more information, see the error and message fields.</p>
53
57
  *
58
+ * @throws {@link StorageGatewayServiceException}
59
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
54
60
  *
55
61
  * @example To set a password for your VM
56
62
  * ```javascript
@@ -34,6 +34,10 @@ export interface SetSMBGuestPasswordCommandOutput extends SetSMBGuestPasswordOut
34
34
  * };
35
35
  * const command = new SetSMBGuestPasswordCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // SetSMBGuestPasswordOutput
38
+ * // GatewayARN: "STRING_VALUE",
39
+ * // };
40
+ *
37
41
  * ```
38
42
  *
39
43
  * @param SetSMBGuestPasswordCommandInput - {@link SetSMBGuestPasswordCommandInput}
@@ -50,6 +54,8 @@ export interface SetSMBGuestPasswordCommandOutput extends SetSMBGuestPasswordOut
50
54
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
51
55
  * more information, see the error and message fields.</p>
52
56
  *
57
+ * @throws {@link StorageGatewayServiceException}
58
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
53
59
  *
54
60
  */
55
61
  export declare class SetSMBGuestPasswordCommand extends $Command<SetSMBGuestPasswordCommandInput, SetSMBGuestPasswordCommandOutput, StorageGatewayClientResolvedConfig> {
@@ -54,6 +54,10 @@ export interface ShutdownGatewayCommandOutput extends ShutdownGatewayOutput, __M
54
54
  * };
55
55
  * const command = new ShutdownGatewayCommand(input);
56
56
  * const response = await client.send(command);
57
+ * // { // ShutdownGatewayOutput
58
+ * // GatewayARN: "STRING_VALUE",
59
+ * // };
60
+ *
57
61
  * ```
58
62
  *
59
63
  * @param ShutdownGatewayCommandInput - {@link ShutdownGatewayCommandInput}
@@ -70,6 +74,8 @@ export interface ShutdownGatewayCommandOutput extends ShutdownGatewayOutput, __M
70
74
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
71
75
  * more information, see the error and message fields.</p>
72
76
  *
77
+ * @throws {@link StorageGatewayServiceException}
78
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
73
79
  *
74
80
  * @example To shut down a gateway service
75
81
  * ```javascript
@@ -38,6 +38,10 @@ export interface StartAvailabilityMonitorTestCommandOutput extends StartAvailabi
38
38
  * };
39
39
  * const command = new StartAvailabilityMonitorTestCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // StartAvailabilityMonitorTestOutput
42
+ * // GatewayARN: "STRING_VALUE",
43
+ * // };
44
+ *
41
45
  * ```
42
46
  *
43
47
  * @param StartAvailabilityMonitorTestCommandInput - {@link StartAvailabilityMonitorTestCommandInput}
@@ -54,6 +58,8 @@ export interface StartAvailabilityMonitorTestCommandOutput extends StartAvailabi
54
58
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
55
59
  * more information, see the error and message fields.</p>
56
60
  *
61
+ * @throws {@link StorageGatewayServiceException}
62
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
57
63
  *
58
64
  */
59
65
  export declare class StartAvailabilityMonitorTestCommand extends $Command<StartAvailabilityMonitorTestCommandInput, StartAvailabilityMonitorTestCommandOutput, StorageGatewayClientResolvedConfig> {