@aws-sdk/client-storage-gateway 3.321.1 → 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 +16 -16
@@ -50,6 +50,10 @@ export interface ActivateGatewayCommandOutput extends ActivateGatewayOutput, __M
50
50
  * };
51
51
  * const command = new ActivateGatewayCommand(input);
52
52
  * const response = await client.send(command);
53
+ * // { // ActivateGatewayOutput
54
+ * // GatewayARN: "STRING_VALUE",
55
+ * // };
56
+ *
53
57
  * ```
54
58
  *
55
59
  * @param ActivateGatewayCommandInput - {@link ActivateGatewayCommandInput}
@@ -66,6 +70,8 @@ export interface ActivateGatewayCommandOutput extends ActivateGatewayOutput, __M
66
70
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
67
71
  * more information, see the error and message fields.</p>
68
72
  *
73
+ * @throws {@link StorageGatewayServiceException}
74
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
69
75
  *
70
76
  * @example To activate the gateway
71
77
  * ```javascript
@@ -38,6 +38,10 @@ export interface AddCacheCommandOutput extends AddCacheOutput, __MetadataBearer
38
38
  * };
39
39
  * const command = new AddCacheCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // AddCacheOutput
42
+ * // GatewayARN: "STRING_VALUE",
43
+ * // };
44
+ *
41
45
  * ```
42
46
  *
43
47
  * @param AddCacheCommandInput - {@link AddCacheCommandInput}
@@ -54,6 +58,8 @@ export interface AddCacheCommandOutput extends AddCacheOutput, __MetadataBearer
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
  * @example To add a cache
59
65
  * ```javascript
@@ -61,6 +61,10 @@ export interface AddTagsToResourceCommandOutput extends AddTagsToResourceOutput,
61
61
  * };
62
62
  * const command = new AddTagsToResourceCommand(input);
63
63
  * const response = await client.send(command);
64
+ * // { // AddTagsToResourceOutput
65
+ * // ResourceARN: "STRING_VALUE",
66
+ * // };
67
+ *
64
68
  * ```
65
69
  *
66
70
  * @param AddTagsToResourceCommandInput - {@link AddTagsToResourceCommandInput}
@@ -77,6 +81,8 @@ export interface AddTagsToResourceCommandOutput extends AddTagsToResourceOutput,
77
81
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
78
82
  * more information, see the error and message fields.</p>
79
83
  *
84
+ * @throws {@link StorageGatewayServiceException}
85
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
80
86
  *
81
87
  * @example To add tags to resource
82
88
  * ```javascript
@@ -40,6 +40,10 @@ export interface AddUploadBufferCommandOutput extends AddUploadBufferOutput, __M
40
40
  * };
41
41
  * const command = new AddUploadBufferCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // AddUploadBufferOutput
44
+ * // GatewayARN: "STRING_VALUE",
45
+ * // };
46
+ *
43
47
  * ```
44
48
  *
45
49
  * @param AddUploadBufferCommandInput - {@link AddUploadBufferCommandInput}
@@ -56,6 +60,8 @@ export interface AddUploadBufferCommandOutput extends AddUploadBufferOutput, __M
56
60
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
57
61
  * more information, see the error and message fields.</p>
58
62
  *
63
+ * @throws {@link StorageGatewayServiceException}
64
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
59
65
  *
60
66
  * @example To add upload buffer on local disk
61
67
  * ```javascript
@@ -46,6 +46,10 @@ export interface AddWorkingStorageCommandOutput extends AddWorkingStorageOutput,
46
46
  * };
47
47
  * const command = new AddWorkingStorageCommand(input);
48
48
  * const response = await client.send(command);
49
+ * // { // AddWorkingStorageOutput
50
+ * // GatewayARN: "STRING_VALUE",
51
+ * // };
52
+ *
49
53
  * ```
50
54
  *
51
55
  * @param AddWorkingStorageCommandInput - {@link AddWorkingStorageCommandInput}
@@ -62,6 +66,8 @@ export interface AddWorkingStorageCommandOutput extends AddWorkingStorageOutput,
62
66
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
63
67
  * more information, see the error and message fields.</p>
64
68
  *
69
+ * @throws {@link StorageGatewayServiceException}
70
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
65
71
  *
66
72
  * @example To add storage on local disk
67
73
  * ```javascript
@@ -36,6 +36,10 @@ export interface AssignTapePoolCommandOutput extends AssignTapePoolOutput, __Met
36
36
  * };
37
37
  * const command = new AssignTapePoolCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // AssignTapePoolOutput
40
+ * // TapeARN: "STRING_VALUE",
41
+ * // };
42
+ *
39
43
  * ```
40
44
  *
41
45
  * @param AssignTapePoolCommandInput - {@link AssignTapePoolCommandInput}
@@ -52,6 +56,8 @@ export interface AssignTapePoolCommandOutput extends AssignTapePoolOutput, __Met
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 AssignTapePoolCommand extends $Command<AssignTapePoolCommandInput, AssignTapePoolCommandOutput, StorageGatewayClientResolvedConfig> {
@@ -53,6 +53,10 @@ export interface AssociateFileSystemCommandOutput extends AssociateFileSystemOut
53
53
  * };
54
54
  * const command = new AssociateFileSystemCommand(input);
55
55
  * const response = await client.send(command);
56
+ * // { // AssociateFileSystemOutput
57
+ * // FileSystemAssociationARN: "STRING_VALUE",
58
+ * // };
59
+ *
56
60
  * ```
57
61
  *
58
62
  * @param AssociateFileSystemCommandInput - {@link AssociateFileSystemCommandInput}
@@ -69,6 +73,8 @@ export interface AssociateFileSystemCommandOutput extends AssociateFileSystemOut
69
73
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
70
74
  * more information, see the error and message fields.</p>
71
75
  *
76
+ * @throws {@link StorageGatewayServiceException}
77
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
72
78
  *
73
79
  */
74
80
  export declare class AssociateFileSystemCommand extends $Command<AssociateFileSystemCommandInput, AssociateFileSystemCommandOutput, StorageGatewayClientResolvedConfig> {
@@ -38,6 +38,11 @@ export interface AttachVolumeCommandOutput extends AttachVolumeOutput, __Metadat
38
38
  * };
39
39
  * const command = new AttachVolumeCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // AttachVolumeOutput
42
+ * // VolumeARN: "STRING_VALUE",
43
+ * // TargetARN: "STRING_VALUE",
44
+ * // };
45
+ *
41
46
  * ```
42
47
  *
43
48
  * @param AttachVolumeCommandInput - {@link AttachVolumeCommandInput}
@@ -54,6 +59,8 @@ export interface AttachVolumeCommandOutput extends AttachVolumeOutput, __Metadat
54
59
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
55
60
  * more information, see the error and message fields.</p>
56
61
  *
62
+ * @throws {@link StorageGatewayServiceException}
63
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
57
64
  *
58
65
  */
59
66
  export declare class AttachVolumeCommand extends $Command<AttachVolumeCommandInput, AttachVolumeCommandOutput, StorageGatewayClientResolvedConfig> {
@@ -33,6 +33,10 @@ export interface CancelArchivalCommandOutput extends CancelArchivalOutput, __Met
33
33
  * };
34
34
  * const command = new CancelArchivalCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // CancelArchivalOutput
37
+ * // TapeARN: "STRING_VALUE",
38
+ * // };
39
+ *
36
40
  * ```
37
41
  *
38
42
  * @param CancelArchivalCommandInput - {@link CancelArchivalCommandInput}
@@ -49,6 +53,8 @@ export interface CancelArchivalCommandOutput extends CancelArchivalOutput, __Met
49
53
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
50
54
  * more information, see the error and message fields.</p>
51
55
  *
56
+ * @throws {@link StorageGatewayServiceException}
57
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
52
58
  *
53
59
  * @example To cancel virtual tape archiving
54
60
  * ```javascript
@@ -34,6 +34,10 @@ export interface CancelRetrievalCommandOutput extends CancelRetrievalOutput, __M
34
34
  * };
35
35
  * const command = new CancelRetrievalCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // CancelRetrievalOutput
38
+ * // TapeARN: "STRING_VALUE",
39
+ * // };
40
+ *
37
41
  * ```
38
42
  *
39
43
  * @param CancelRetrievalCommandInput - {@link CancelRetrievalCommandInput}
@@ -50,6 +54,8 @@ export interface CancelRetrievalCommandOutput extends CancelRetrievalOutput, __M
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
  * @example To cancel virtual tape retrieval
55
61
  * ```javascript
@@ -62,6 +62,11 @@ export interface CreateCachediSCSIVolumeCommandOutput extends CreateCachediSCSIV
62
62
  * };
63
63
  * const command = new CreateCachediSCSIVolumeCommand(input);
64
64
  * const response = await client.send(command);
65
+ * // { // CreateCachediSCSIVolumeOutput
66
+ * // VolumeARN: "STRING_VALUE",
67
+ * // TargetARN: "STRING_VALUE",
68
+ * // };
69
+ *
65
70
  * ```
66
71
  *
67
72
  * @param CreateCachediSCSIVolumeCommandInput - {@link CreateCachediSCSIVolumeCommandInput}
@@ -78,6 +83,8 @@ export interface CreateCachediSCSIVolumeCommandOutput extends CreateCachediSCSIV
78
83
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
79
84
  * more information, see the error and message fields.</p>
80
85
  *
86
+ * @throws {@link StorageGatewayServiceException}
87
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
81
88
  *
82
89
  * @example To create a cached iSCSI volume
83
90
  * ```javascript
@@ -81,6 +81,10 @@ export interface CreateNFSFileShareCommandOutput extends CreateNFSFileShareOutpu
81
81
  * };
82
82
  * const command = new CreateNFSFileShareCommand(input);
83
83
  * const response = await client.send(command);
84
+ * // { // CreateNFSFileShareOutput
85
+ * // FileShareARN: "STRING_VALUE",
86
+ * // };
87
+ *
84
88
  * ```
85
89
  *
86
90
  * @param CreateNFSFileShareCommandInput - {@link CreateNFSFileShareCommandInput}
@@ -97,6 +101,8 @@ export interface CreateNFSFileShareCommandOutput extends CreateNFSFileShareOutpu
97
101
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
98
102
  * more information, see the error and message fields.</p>
99
103
  *
104
+ * @throws {@link StorageGatewayServiceException}
105
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
100
106
  *
101
107
  */
102
108
  export declare class CreateNFSFileShareCommand extends $Command<CreateNFSFileShareCommandInput, CreateNFSFileShareCommandOutput, StorageGatewayClientResolvedConfig> {
@@ -85,6 +85,10 @@ export interface CreateSMBFileShareCommandOutput extends CreateSMBFileShareOutpu
85
85
  * };
86
86
  * const command = new CreateSMBFileShareCommand(input);
87
87
  * const response = await client.send(command);
88
+ * // { // CreateSMBFileShareOutput
89
+ * // FileShareARN: "STRING_VALUE",
90
+ * // };
91
+ *
88
92
  * ```
89
93
  *
90
94
  * @param CreateSMBFileShareCommandInput - {@link CreateSMBFileShareCommandInput}
@@ -101,6 +105,8 @@ export interface CreateSMBFileShareCommandOutput extends CreateSMBFileShareOutpu
101
105
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
102
106
  * more information, see the error and message fields.</p>
103
107
  *
108
+ * @throws {@link StorageGatewayServiceException}
109
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
104
110
  *
105
111
  */
106
112
  export declare class CreateSMBFileShareCommand extends $Command<CreateSMBFileShareCommandInput, CreateSMBFileShareCommandOutput, StorageGatewayClientResolvedConfig> {
@@ -65,6 +65,11 @@ export interface CreateSnapshotCommandOutput extends CreateSnapshotOutput, __Met
65
65
  * };
66
66
  * const command = new CreateSnapshotCommand(input);
67
67
  * const response = await client.send(command);
68
+ * // { // CreateSnapshotOutput
69
+ * // VolumeARN: "STRING_VALUE",
70
+ * // SnapshotId: "STRING_VALUE",
71
+ * // };
72
+ *
68
73
  * ```
69
74
  *
70
75
  * @param CreateSnapshotCommandInput - {@link CreateSnapshotCommandInput}
@@ -85,6 +90,8 @@ export interface CreateSnapshotCommandOutput extends CreateSnapshotOutput, __Met
85
90
  * <p>An internal server error has occurred because the service is unavailable. For more
86
91
  * information, see the error and message fields.</p>
87
92
  *
93
+ * @throws {@link StorageGatewayServiceException}
94
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
88
95
  *
89
96
  * @example To create a snapshot of a gateway volume
90
97
  * ```javascript
@@ -58,6 +58,12 @@ export interface CreateSnapshotFromVolumeRecoveryPointCommandOutput extends Crea
58
58
  * };
59
59
  * const command = new CreateSnapshotFromVolumeRecoveryPointCommand(input);
60
60
  * const response = await client.send(command);
61
+ * // { // CreateSnapshotFromVolumeRecoveryPointOutput
62
+ * // SnapshotId: "STRING_VALUE",
63
+ * // VolumeARN: "STRING_VALUE",
64
+ * // VolumeRecoveryPointTime: "STRING_VALUE",
65
+ * // };
66
+ *
61
67
  * ```
62
68
  *
63
69
  * @param CreateSnapshotFromVolumeRecoveryPointCommandInput - {@link CreateSnapshotFromVolumeRecoveryPointCommandInput}
@@ -78,6 +84,8 @@ export interface CreateSnapshotFromVolumeRecoveryPointCommandOutput extends Crea
78
84
  * <p>An internal server error has occurred because the service is unavailable. For more
79
85
  * information, see the error and message fields.</p>
80
86
  *
87
+ * @throws {@link StorageGatewayServiceException}
88
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
81
89
  *
82
90
  * @example To create a snapshot of a gateway volume
83
91
  * ```javascript
@@ -55,6 +55,12 @@ export interface CreateStorediSCSIVolumeCommandOutput extends CreateStorediSCSIV
55
55
  * };
56
56
  * const command = new CreateStorediSCSIVolumeCommand(input);
57
57
  * const response = await client.send(command);
58
+ * // { // CreateStorediSCSIVolumeOutput
59
+ * // VolumeARN: "STRING_VALUE",
60
+ * // VolumeSizeInBytes: Number("long"),
61
+ * // TargetARN: "STRING_VALUE",
62
+ * // };
63
+ *
58
64
  * ```
59
65
  *
60
66
  * @param CreateStorediSCSIVolumeCommandInput - {@link CreateStorediSCSIVolumeCommandInput}
@@ -71,6 +77,8 @@ export interface CreateStorediSCSIVolumeCommandOutput extends CreateStorediSCSIV
71
77
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
72
78
  * more information, see the error and message fields.</p>
73
79
  *
80
+ * @throws {@link StorageGatewayServiceException}
81
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
74
82
  *
75
83
  * @example To create a stored iSCSI volume
76
84
  * ```javascript
@@ -41,6 +41,10 @@ export interface CreateTapePoolCommandOutput extends CreateTapePoolOutput, __Met
41
41
  * };
42
42
  * const command = new CreateTapePoolCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // { // CreateTapePoolOutput
45
+ * // PoolARN: "STRING_VALUE",
46
+ * // };
47
+ *
44
48
  * ```
45
49
  *
46
50
  * @param CreateTapePoolCommandInput - {@link CreateTapePoolCommandInput}
@@ -57,6 +61,8 @@ export interface CreateTapePoolCommandOutput extends CreateTapePoolOutput, __Met
57
61
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
58
62
  * more information, see the error and message fields.</p>
59
63
  *
64
+ * @throws {@link StorageGatewayServiceException}
65
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
60
66
  *
61
67
  */
62
68
  export declare class CreateTapePoolCommand extends $Command<CreateTapePoolCommandInput, CreateTapePoolCommandOutput, StorageGatewayClientResolvedConfig> {
@@ -51,6 +51,10 @@ export interface CreateTapeWithBarcodeCommandOutput extends CreateTapeWithBarcod
51
51
  * };
52
52
  * const command = new CreateTapeWithBarcodeCommand(input);
53
53
  * const response = await client.send(command);
54
+ * // { // CreateTapeWithBarcodeOutput
55
+ * // TapeARN: "STRING_VALUE",
56
+ * // };
57
+ *
54
58
  * ```
55
59
  *
56
60
  * @param CreateTapeWithBarcodeCommandInput - {@link CreateTapeWithBarcodeCommandInput}
@@ -67,6 +71,8 @@ export interface CreateTapeWithBarcodeCommandOutput extends CreateTapeWithBarcod
67
71
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
68
72
  * more information, see the error and message fields.</p>
69
73
  *
74
+ * @throws {@link StorageGatewayServiceException}
75
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
70
76
  *
71
77
  * @example To create a virtual tape using a barcode
72
78
  * ```javascript
@@ -51,6 +51,12 @@ export interface CreateTapesCommandOutput extends CreateTapesOutput, __MetadataB
51
51
  * };
52
52
  * const command = new CreateTapesCommand(input);
53
53
  * const response = await client.send(command);
54
+ * // { // CreateTapesOutput
55
+ * // TapeARNs: [ // TapeARNs
56
+ * // "STRING_VALUE",
57
+ * // ],
58
+ * // };
59
+ *
54
60
  * ```
55
61
  *
56
62
  * @param CreateTapesCommandInput - {@link CreateTapesCommandInput}
@@ -67,6 +73,8 @@ export interface CreateTapesCommandOutput extends CreateTapesOutput, __MetadataB
67
73
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
68
74
  * more information, see the error and message fields.</p>
69
75
  *
76
+ * @throws {@link StorageGatewayServiceException}
77
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
70
78
  *
71
79
  * @example To create a virtual tape
72
80
  * ```javascript
@@ -33,6 +33,10 @@ export interface DeleteAutomaticTapeCreationPolicyCommandOutput extends DeleteAu
33
33
  * };
34
34
  * const command = new DeleteAutomaticTapeCreationPolicyCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DeleteAutomaticTapeCreationPolicyOutput
37
+ * // GatewayARN: "STRING_VALUE",
38
+ * // };
39
+ *
36
40
  * ```
37
41
  *
38
42
  * @param DeleteAutomaticTapeCreationPolicyCommandInput - {@link DeleteAutomaticTapeCreationPolicyCommandInput}
@@ -49,6 +53,8 @@ export interface DeleteAutomaticTapeCreationPolicyCommandOutput extends DeleteAu
49
53
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
50
54
  * more information, see the error and message fields.</p>
51
55
  *
56
+ * @throws {@link StorageGatewayServiceException}
57
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
52
58
  *
53
59
  */
54
60
  export declare class DeleteAutomaticTapeCreationPolicyCommand extends $Command<DeleteAutomaticTapeCreationPolicyCommandInput, DeleteAutomaticTapeCreationPolicyCommandOutput, StorageGatewayClientResolvedConfig> {
@@ -36,6 +36,10 @@ export interface DeleteBandwidthRateLimitCommandOutput extends DeleteBandwidthRa
36
36
  * };
37
37
  * const command = new DeleteBandwidthRateLimitCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // DeleteBandwidthRateLimitOutput
40
+ * // GatewayARN: "STRING_VALUE",
41
+ * // };
42
+ *
39
43
  * ```
40
44
  *
41
45
  * @param DeleteBandwidthRateLimitCommandInput - {@link DeleteBandwidthRateLimitCommandInput}
@@ -52,6 +56,8 @@ export interface DeleteBandwidthRateLimitCommandOutput extends DeleteBandwidthRa
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
  * @example To delete bandwidth rate limits of gateway
57
63
  * ```javascript
@@ -34,6 +34,11 @@ export interface DeleteChapCredentialsCommandOutput extends DeleteChapCredential
34
34
  * };
35
35
  * const command = new DeleteChapCredentialsCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // DeleteChapCredentialsOutput
38
+ * // TargetARN: "STRING_VALUE",
39
+ * // InitiatorName: "STRING_VALUE",
40
+ * // };
41
+ *
37
42
  * ```
38
43
  *
39
44
  * @param DeleteChapCredentialsCommandInput - {@link DeleteChapCredentialsCommandInput}
@@ -50,6 +55,8 @@ export interface DeleteChapCredentialsCommandOutput extends DeleteChapCredential
50
55
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
51
56
  * more information, see the error and message fields.</p>
52
57
  *
58
+ * @throws {@link StorageGatewayServiceException}
59
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
53
60
  *
54
61
  * @example To delete CHAP credentials
55
62
  * ```javascript
@@ -33,6 +33,10 @@ export interface DeleteFileShareCommandOutput extends DeleteFileShareOutput, __M
33
33
  * };
34
34
  * const command = new DeleteFileShareCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DeleteFileShareOutput
37
+ * // FileShareARN: "STRING_VALUE",
38
+ * // };
39
+ *
36
40
  * ```
37
41
  *
38
42
  * @param DeleteFileShareCommandInput - {@link DeleteFileShareCommandInput}
@@ -49,6 +53,8 @@ export interface DeleteFileShareCommandOutput extends DeleteFileShareOutput, __M
49
53
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
50
54
  * more information, see the error and message fields.</p>
51
55
  *
56
+ * @throws {@link StorageGatewayServiceException}
57
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
52
58
  *
53
59
  */
54
60
  export declare class DeleteFileShareCommand extends $Command<DeleteFileShareCommandInput, DeleteFileShareCommandOutput, StorageGatewayClientResolvedConfig> {
@@ -48,6 +48,10 @@ export interface DeleteGatewayCommandOutput extends DeleteGatewayOutput, __Metad
48
48
  * };
49
49
  * const command = new DeleteGatewayCommand(input);
50
50
  * const response = await client.send(command);
51
+ * // { // DeleteGatewayOutput
52
+ * // GatewayARN: "STRING_VALUE",
53
+ * // };
54
+ *
51
55
  * ```
52
56
  *
53
57
  * @param DeleteGatewayCommandInput - {@link DeleteGatewayCommandInput}
@@ -64,6 +68,8 @@ export interface DeleteGatewayCommandOutput extends DeleteGatewayOutput, __Metad
64
68
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
65
69
  * more information, see the error and message fields.</p>
66
70
  *
71
+ * @throws {@link StorageGatewayServiceException}
72
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
67
73
  *
68
74
  * @example To delete a gatgeway
69
75
  * ```javascript
@@ -45,6 +45,10 @@ export interface DeleteSnapshotScheduleCommandOutput extends DeleteSnapshotSched
45
45
  * };
46
46
  * const command = new DeleteSnapshotScheduleCommand(input);
47
47
  * const response = await client.send(command);
48
+ * // { // DeleteSnapshotScheduleOutput
49
+ * // VolumeARN: "STRING_VALUE",
50
+ * // };
51
+ *
48
52
  * ```
49
53
  *
50
54
  * @param DeleteSnapshotScheduleCommandInput - {@link DeleteSnapshotScheduleCommandInput}
@@ -61,6 +65,8 @@ export interface DeleteSnapshotScheduleCommandOutput extends DeleteSnapshotSched
61
65
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
62
66
  * more information, see the error and message fields.</p>
63
67
  *
68
+ * @throws {@link StorageGatewayServiceException}
69
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
64
70
  *
65
71
  * @example To delete a snapshot of a volume
66
72
  * ```javascript
@@ -33,6 +33,10 @@ export interface DeleteTapeArchiveCommandOutput extends DeleteTapeArchiveOutput,
33
33
  * };
34
34
  * const command = new DeleteTapeArchiveCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DeleteTapeArchiveOutput
37
+ * // TapeARN: "STRING_VALUE",
38
+ * // };
39
+ *
36
40
  * ```
37
41
  *
38
42
  * @param DeleteTapeArchiveCommandInput - {@link DeleteTapeArchiveCommandInput}
@@ -49,6 +53,8 @@ export interface DeleteTapeArchiveCommandOutput extends DeleteTapeArchiveOutput,
49
53
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
50
54
  * more information, see the error and message fields.</p>
51
55
  *
56
+ * @throws {@link StorageGatewayServiceException}
57
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
52
58
  *
53
59
  * @example To delete a virtual tape from the shelf (VTS)
54
60
  * ```javascript
@@ -34,6 +34,10 @@ export interface DeleteTapeCommandOutput extends DeleteTapeOutput, __MetadataBea
34
34
  * };
35
35
  * const command = new DeleteTapeCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // DeleteTapeOutput
38
+ * // TapeARN: "STRING_VALUE",
39
+ * // };
40
+ *
37
41
  * ```
38
42
  *
39
43
  * @param DeleteTapeCommandInput - {@link DeleteTapeCommandInput}
@@ -50,6 +54,8 @@ export interface DeleteTapeCommandOutput extends DeleteTapeOutput, __MetadataBea
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
  * @example To delete a virtual tape
55
61
  * ```javascript
@@ -33,6 +33,10 @@ export interface DeleteTapePoolCommandOutput extends DeleteTapePoolOutput, __Met
33
33
  * };
34
34
  * const command = new DeleteTapePoolCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DeleteTapePoolOutput
37
+ * // PoolARN: "STRING_VALUE",
38
+ * // };
39
+ *
36
40
  * ```
37
41
  *
38
42
  * @param DeleteTapePoolCommandInput - {@link DeleteTapePoolCommandInput}
@@ -49,6 +53,8 @@ export interface DeleteTapePoolCommandOutput extends DeleteTapePoolOutput, __Met
49
53
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
50
54
  * more information, see the error and message fields.</p>
51
55
  *
56
+ * @throws {@link StorageGatewayServiceException}
57
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
52
58
  *
53
59
  */
54
60
  export declare class DeleteTapePoolCommand extends $Command<DeleteTapePoolCommandInput, DeleteTapePoolCommandOutput, StorageGatewayClientResolvedConfig> {
@@ -43,6 +43,10 @@ export interface DeleteVolumeCommandOutput extends DeleteVolumeOutput, __Metadat
43
43
  * };
44
44
  * const command = new DeleteVolumeCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // DeleteVolumeOutput
47
+ * // VolumeARN: "STRING_VALUE",
48
+ * // };
49
+ *
46
50
  * ```
47
51
  *
48
52
  * @param DeleteVolumeCommandInput - {@link DeleteVolumeCommandInput}
@@ -59,6 +63,8 @@ export interface DeleteVolumeCommandOutput extends DeleteVolumeOutput, __Metadat
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 delete a gateway volume
64
70
  * ```javascript
@@ -33,6 +33,12 @@ export interface DescribeAvailabilityMonitorTestCommandOutput extends DescribeAv
33
33
  * };
34
34
  * const command = new DescribeAvailabilityMonitorTestCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DescribeAvailabilityMonitorTestOutput
37
+ * // GatewayARN: "STRING_VALUE",
38
+ * // Status: "STRING_VALUE",
39
+ * // StartTime: new Date("TIMESTAMP"),
40
+ * // };
41
+ *
36
42
  * ```
37
43
  *
38
44
  * @param DescribeAvailabilityMonitorTestCommandInput - {@link DescribeAvailabilityMonitorTestCommandInput}
@@ -49,6 +55,8 @@ export interface DescribeAvailabilityMonitorTestCommandOutput extends DescribeAv
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 DescribeAvailabilityMonitorTestCommand extends $Command<DescribeAvailabilityMonitorTestCommandInput, DescribeAvailabilityMonitorTestCommandOutput, StorageGatewayClientResolvedConfig> {
@@ -39,6 +39,12 @@ export interface DescribeBandwidthRateLimitCommandOutput extends DescribeBandwid
39
39
  * };
40
40
  * const command = new DescribeBandwidthRateLimitCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // DescribeBandwidthRateLimitOutput
43
+ * // GatewayARN: "STRING_VALUE",
44
+ * // AverageUploadRateLimitInBitsPerSec: Number("long"),
45
+ * // AverageDownloadRateLimitInBitsPerSec: Number("long"),
46
+ * // };
47
+ *
42
48
  * ```
43
49
  *
44
50
  * @param DescribeBandwidthRateLimitCommandInput - {@link DescribeBandwidthRateLimitCommandInput}
@@ -55,6 +61,8 @@ export interface DescribeBandwidthRateLimitCommandOutput extends DescribeBandwid
55
61
  * <p>An exception occurred because an invalid gateway request was issued to the service. For
56
62
  * more information, see the error and message fields.</p>
57
63
  *
64
+ * @throws {@link StorageGatewayServiceException}
65
+ * <p>Base exception class for all service exceptions from StorageGateway service.</p>
58
66
  *
59
67
  * @example To describe the bandwidth rate limits of a gateway
60
68
  * ```javascript