@aws-sdk/client-storage-gateway 3.288.0 → 3.290.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 +31 -0
  2. package/dist-types/commands/AddCacheCommand.d.ts +29 -0
  3. package/dist-types/commands/AddTagsToResourceCommand.d.ts +31 -0
  4. package/dist-types/commands/AddUploadBufferCommand.d.ts +29 -0
  5. package/dist-types/commands/AddWorkingStorageCommand.d.ts +29 -0
  6. package/dist-types/commands/AssignTapePoolCommand.d.ts +9 -0
  7. package/dist-types/commands/AssociateFileSystemCommand.d.ts +9 -0
  8. package/dist-types/commands/AttachVolumeCommand.d.ts +9 -0
  9. package/dist-types/commands/CancelArchivalCommand.d.ts +26 -0
  10. package/dist-types/commands/CancelRetrievalCommand.d.ts +26 -0
  11. package/dist-types/commands/CreateCachediSCSIVolumeCommand.d.ts +31 -0
  12. package/dist-types/commands/CreateNFSFileShareCommand.d.ts +9 -0
  13. package/dist-types/commands/CreateSMBFileShareCommand.d.ts +9 -0
  14. package/dist-types/commands/CreateSnapshotCommand.d.ts +31 -0
  15. package/dist-types/commands/CreateSnapshotFromVolumeRecoveryPointCommand.d.ts +32 -0
  16. package/dist-types/commands/CreateStorediSCSIVolumeCommand.d.ts +32 -0
  17. package/dist-types/commands/CreateTapePoolCommand.d.ts +9 -0
  18. package/dist-types/commands/CreateTapeWithBarcodeCommand.d.ts +27 -0
  19. package/dist-types/commands/CreateTapesCommand.d.ts +33 -0
  20. package/dist-types/commands/DeleteAutomaticTapeCreationPolicyCommand.d.ts +9 -0
  21. package/dist-types/commands/DeleteBandwidthRateLimitCommand.d.ts +26 -0
  22. package/dist-types/commands/DeleteChapCredentialsCommand.d.ts +27 -0
  23. package/dist-types/commands/DeleteFileShareCommand.d.ts +9 -0
  24. package/dist-types/commands/DeleteGatewayCommand.d.ts +25 -0
  25. package/dist-types/commands/DeleteSnapshotScheduleCommand.d.ts +25 -0
  26. package/dist-types/commands/DeleteTapeArchiveCommand.d.ts +25 -0
  27. package/dist-types/commands/DeleteTapeCommand.d.ts +26 -0
  28. package/dist-types/commands/DeleteTapePoolCommand.d.ts +9 -0
  29. package/dist-types/commands/DeleteVolumeCommand.d.ts +25 -0
  30. package/dist-types/commands/DescribeAvailabilityMonitorTestCommand.d.ts +9 -0
  31. package/dist-types/commands/DescribeBandwidthRateLimitCommand.d.ts +27 -0
  32. package/dist-types/commands/DescribeBandwidthRateLimitScheduleCommand.d.ts +9 -0
  33. package/dist-types/commands/DescribeCacheCommand.d.ts +34 -0
  34. package/dist-types/commands/DescribeCachediSCSIVolumesCommand.d.ts +42 -0
  35. package/dist-types/commands/DescribeChapCredentialsCommand.d.ts +32 -0
  36. package/dist-types/commands/DescribeFileSystemAssociationsCommand.d.ts +9 -0
  37. package/dist-types/commands/DescribeGatewayInformationCommand.d.ts +37 -0
  38. package/dist-types/commands/DescribeMaintenanceStartTimeCommand.d.ts +29 -0
  39. package/dist-types/commands/DescribeNFSFileSharesCommand.d.ts +9 -0
  40. package/dist-types/commands/DescribeSMBFileSharesCommand.d.ts +9 -0
  41. package/dist-types/commands/DescribeSMBSettingsCommand.d.ts +9 -0
  42. package/dist-types/commands/DescribeSnapshotScheduleCommand.d.ts +29 -0
  43. package/dist-types/commands/DescribeStorediSCSIVolumesCommand.d.ts +43 -0
  44. package/dist-types/commands/DescribeTapeArchivesCommand.d.ts +46 -0
  45. package/dist-types/commands/DescribeTapeRecoveryPointsCommand.d.ts +36 -0
  46. package/dist-types/commands/DescribeTapesCommand.d.ts +45 -0
  47. package/dist-types/commands/DescribeUploadBufferCommand.d.ts +53 -0
  48. package/dist-types/commands/DescribeVTLDevicesCommand.d.ts +67 -0
  49. package/dist-types/commands/DescribeWorkingStorageCommand.d.ts +31 -0
  50. package/dist-types/commands/DetachVolumeCommand.d.ts +9 -0
  51. package/dist-types/commands/DisableGatewayCommand.d.ts +25 -0
  52. package/dist-types/commands/DisassociateFileSystemCommand.d.ts +9 -0
  53. package/dist-types/commands/JoinDomainCommand.d.ts +9 -0
  54. package/dist-types/commands/ListAutomaticTapeCreationPoliciesCommand.d.ts +9 -0
  55. package/dist-types/commands/ListFileSharesCommand.d.ts +9 -0
  56. package/dist-types/commands/ListFileSystemAssociationsCommand.d.ts +9 -0
  57. package/dist-types/commands/ListGatewaysCommand.d.ts +34 -0
  58. package/dist-types/commands/ListLocalDisksCommand.d.ts +44 -0
  59. package/dist-types/commands/ListTagsForResourceCommand.d.ts +34 -0
  60. package/dist-types/commands/ListTapePoolsCommand.d.ts +9 -0
  61. package/dist-types/commands/ListTapesCommand.d.ts +9 -0
  62. package/dist-types/commands/ListVolumeInitiatorsCommand.d.ts +9 -0
  63. package/dist-types/commands/ListVolumeRecoveryPointsCommand.d.ts +32 -0
  64. package/dist-types/commands/ListVolumesCommand.d.ts +46 -0
  65. package/dist-types/commands/NotifyWhenUploadedCommand.d.ts +9 -0
  66. package/dist-types/commands/RefreshCacheCommand.d.ts +9 -0
  67. package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +29 -0
  68. package/dist-types/commands/ResetCacheCommand.d.ts +25 -0
  69. package/dist-types/commands/RetrieveTapeArchiveCommand.d.ts +26 -0
  70. package/dist-types/commands/RetrieveTapeRecoveryPointCommand.d.ts +26 -0
  71. package/dist-types/commands/SetLocalConsolePasswordCommand.d.ts +26 -0
  72. package/dist-types/commands/SetSMBGuestPasswordCommand.d.ts +9 -0
  73. package/dist-types/commands/ShutdownGatewayCommand.d.ts +25 -0
  74. package/dist-types/commands/StartAvailabilityMonitorTestCommand.d.ts +9 -0
  75. package/dist-types/commands/StartGatewayCommand.d.ts +25 -0
  76. package/dist-types/commands/UpdateAutomaticTapeCreationPolicyCommand.d.ts +9 -0
  77. package/dist-types/commands/UpdateBandwidthRateLimitCommand.d.ts +27 -0
  78. package/dist-types/commands/UpdateBandwidthRateLimitScheduleCommand.d.ts +9 -0
  79. package/dist-types/commands/UpdateChapCredentialsCommand.d.ts +29 -0
  80. package/dist-types/commands/UpdateFileSystemAssociationCommand.d.ts +9 -0
  81. package/dist-types/commands/UpdateGatewayInformationCommand.d.ts +28 -0
  82. package/dist-types/commands/UpdateGatewaySoftwareNowCommand.d.ts +25 -0
  83. package/dist-types/commands/UpdateMaintenanceStartTimeCommand.d.ts +28 -0
  84. package/dist-types/commands/UpdateNFSFileShareCommand.d.ts +9 -0
  85. package/dist-types/commands/UpdateSMBFileShareCommand.d.ts +9 -0
  86. package/dist-types/commands/UpdateSMBFileShareVisibilityCommand.d.ts +9 -0
  87. package/dist-types/commands/UpdateSMBLocalGroupsCommand.d.ts +9 -0
  88. package/dist-types/commands/UpdateSMBSecurityStrategyCommand.d.ts +9 -0
  89. package/dist-types/commands/UpdateSnapshotScheduleCommand.d.ts +28 -0
  90. package/dist-types/commands/UpdateVTLDeviceTypeCommand.d.ts +26 -0
  91. package/package.json +29 -29
@@ -36,6 +36,37 @@ export interface ActivateGatewayCommandOutput extends ActivateGatewayOutput, __M
36
36
  * @see {@link ActivateGatewayCommandOutput} for command's `response` shape.
37
37
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
38
38
  *
39
+ * @throws {@link InternalServerError} (server fault)
40
+ * <p>An internal server error has occurred during the request. For more information, see the
41
+ * error and message fields.</p>
42
+ *
43
+ * @throws {@link InvalidGatewayRequestException} (client fault)
44
+ * <p>An exception occurred because an invalid gateway request was issued to the service. For
45
+ * more information, see the error and message fields.</p>
46
+ *
47
+ *
48
+ * @example To activate the gateway
49
+ * ```javascript
50
+ * // Activates the gateway you previously deployed on your host.
51
+ * const input = {
52
+ * "ActivationKey": "29AV1-3OFV9-VVIUB-NKT0I-LRO6V",
53
+ * "GatewayName": "My_Gateway",
54
+ * "GatewayRegion": "us-east-1",
55
+ * "GatewayTimezone": "GMT-12:00",
56
+ * "GatewayType": "STORED",
57
+ * "MediumChangerType": "AWS-Gateway-VTL",
58
+ * "TapeDriveType": "IBM-ULT3580-TD5"
59
+ * };
60
+ * const command = new ActivateGatewayCommand(input);
61
+ * const response = await client.send(command);
62
+ * /* response ==
63
+ * {
64
+ * "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B"
65
+ * }
66
+ * *\/
67
+ * // example id: to-activate-the-gateway-1471281611207
68
+ * ```
69
+ *
39
70
  */
40
71
  export declare class ActivateGatewayCommand extends $Command<ActivateGatewayCommandInput, ActivateGatewayCommandOutput, StorageGatewayClientResolvedConfig> {
41
72
  readonly input: ActivateGatewayCommandInput;
@@ -33,6 +33,35 @@ export interface AddCacheCommandOutput extends AddCacheOutput, __MetadataBearer
33
33
  * @see {@link AddCacheCommandOutput} for command's `response` shape.
34
34
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
35
35
  *
36
+ * @throws {@link InternalServerError} (server fault)
37
+ * <p>An internal server error has occurred during the request. For more information, see the
38
+ * error and message fields.</p>
39
+ *
40
+ * @throws {@link InvalidGatewayRequestException} (client fault)
41
+ * <p>An exception occurred because an invalid gateway request was issued to the service. For
42
+ * more information, see the error and message fields.</p>
43
+ *
44
+ *
45
+ * @example To add a cache
46
+ * ```javascript
47
+ * // The following example shows a request that activates a gateway-stored volume.
48
+ * const input = {
49
+ * "DiskIds": [
50
+ * "pci-0000:03:00.0-scsi-0:0:0:0",
51
+ * "pci-0000:03:00.0-scsi-0:0:1:0"
52
+ * ],
53
+ * "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
54
+ * };
55
+ * const command = new AddCacheCommand(input);
56
+ * const response = await client.send(command);
57
+ * /* response ==
58
+ * {
59
+ * "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
60
+ * }
61
+ * *\/
62
+ * // example id: to-add-a-cache-1471043606854
63
+ * ```
64
+ *
36
65
  */
37
66
  export declare class AddCacheCommand extends $Command<AddCacheCommandInput, AddCacheCommandOutput, StorageGatewayClientResolvedConfig> {
38
67
  readonly input: AddCacheCommandInput;
@@ -53,6 +53,37 @@ export interface AddTagsToResourceCommandOutput extends AddTagsToResourceOutput,
53
53
  * @see {@link AddTagsToResourceCommandOutput} for command's `response` shape.
54
54
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
55
55
  *
56
+ * @throws {@link InternalServerError} (server fault)
57
+ * <p>An internal server error has occurred during the request. For more information, see the
58
+ * error and message fields.</p>
59
+ *
60
+ * @throws {@link InvalidGatewayRequestException} (client fault)
61
+ * <p>An exception occurred because an invalid gateway request was issued to the service. For
62
+ * more information, see the error and message fields.</p>
63
+ *
64
+ *
65
+ * @example To add tags to resource
66
+ * ```javascript
67
+ * // Adds one or more tags to the specified resource.
68
+ * const input = {
69
+ * "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B",
70
+ * "Tags": [
71
+ * {
72
+ * "Key": "Dev Gatgeway Region",
73
+ * "Value": "East Coast"
74
+ * }
75
+ * ]
76
+ * };
77
+ * const command = new AddTagsToResourceCommand(input);
78
+ * const response = await client.send(command);
79
+ * /* response ==
80
+ * {
81
+ * "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B"
82
+ * }
83
+ * *\/
84
+ * // example id: to-add-tags-to-resource-1471283689460
85
+ * ```
86
+ *
56
87
  */
57
88
  export declare class AddTagsToResourceCommand extends $Command<AddTagsToResourceCommandInput, AddTagsToResourceCommandOutput, StorageGatewayClientResolvedConfig> {
58
89
  readonly input: AddTagsToResourceCommandInput;
@@ -35,6 +35,35 @@ export interface AddUploadBufferCommandOutput extends AddUploadBufferOutput, __M
35
35
  * @see {@link AddUploadBufferCommandOutput} for command's `response` shape.
36
36
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
37
37
  *
38
+ * @throws {@link InternalServerError} (server fault)
39
+ * <p>An internal server error has occurred during the request. For more information, see the
40
+ * error and message fields.</p>
41
+ *
42
+ * @throws {@link InvalidGatewayRequestException} (client fault)
43
+ * <p>An exception occurred because an invalid gateway request was issued to the service. For
44
+ * more information, see the error and message fields.</p>
45
+ *
46
+ *
47
+ * @example To add upload buffer on local disk
48
+ * ```javascript
49
+ * // Configures one or more gateway local disks as upload buffer for a specified gateway.
50
+ * const input = {
51
+ * "DiskIds": [
52
+ * "pci-0000:03:00.0-scsi-0:0:0:0",
53
+ * "pci-0000:03:00.0-scsi-0:0:1:0"
54
+ * ],
55
+ * "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
56
+ * };
57
+ * const command = new AddUploadBufferCommand(input);
58
+ * const response = await client.send(command);
59
+ * /* response ==
60
+ * {
61
+ * "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
62
+ * }
63
+ * *\/
64
+ * // example id: to-add-upload-buffer-on-local-disk-1471293902847
65
+ * ```
66
+ *
38
67
  */
39
68
  export declare class AddUploadBufferCommand extends $Command<AddUploadBufferCommandInput, AddUploadBufferCommandOutput, StorageGatewayClientResolvedConfig> {
40
69
  readonly input: AddUploadBufferCommandInput;
@@ -41,6 +41,35 @@ export interface AddWorkingStorageCommandOutput extends AddWorkingStorageOutput,
41
41
  * @see {@link AddWorkingStorageCommandOutput} for command's `response` shape.
42
42
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
43
43
  *
44
+ * @throws {@link InternalServerError} (server fault)
45
+ * <p>An internal server error has occurred during the request. For more information, see the
46
+ * error and message fields.</p>
47
+ *
48
+ * @throws {@link InvalidGatewayRequestException} (client fault)
49
+ * <p>An exception occurred because an invalid gateway request was issued to the service. For
50
+ * more information, see the error and message fields.</p>
51
+ *
52
+ *
53
+ * @example To add storage on local disk
54
+ * ```javascript
55
+ * // Configures one or more gateway local disks as working storage for a gateway. (Working storage is also referred to as upload buffer.)
56
+ * const input = {
57
+ * "DiskIds": [
58
+ * "pci-0000:03:00.0-scsi-0:0:0:0",
59
+ * "pci-0000:03:00.0-scsi-0:0:1:0"
60
+ * ],
61
+ * "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
62
+ * };
63
+ * const command = new AddWorkingStorageCommand(input);
64
+ * const response = await client.send(command);
65
+ * /* response ==
66
+ * {
67
+ * "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
68
+ * }
69
+ * *\/
70
+ * // example id: to-add-storage-on-local-disk-1471294305401
71
+ * ```
72
+ *
44
73
  */
45
74
  export declare class AddWorkingStorageCommand extends $Command<AddWorkingStorageCommandInput, AddWorkingStorageCommandOutput, StorageGatewayClientResolvedConfig> {
46
75
  readonly input: AddWorkingStorageCommandInput;
@@ -32,6 +32,15 @@ export interface AssignTapePoolCommandOutput extends AssignTapePoolOutput, __Met
32
32
  * @see {@link AssignTapePoolCommandOutput} for command's `response` shape.
33
33
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
34
34
  *
35
+ * @throws {@link InternalServerError} (server fault)
36
+ * <p>An internal server error has occurred during the request. For more information, see the
37
+ * error and message fields.</p>
38
+ *
39
+ * @throws {@link InvalidGatewayRequestException} (client fault)
40
+ * <p>An exception occurred because an invalid gateway request was issued to the service. For
41
+ * more information, see the error and message fields.</p>
42
+ *
43
+ *
35
44
  */
36
45
  export declare class AssignTapePoolCommand extends $Command<AssignTapePoolCommandInput, AssignTapePoolCommandOutput, StorageGatewayClientResolvedConfig> {
37
46
  readonly input: AssignTapePoolCommandInput;
@@ -32,6 +32,15 @@ export interface AssociateFileSystemCommandOutput extends AssociateFileSystemOut
32
32
  * @see {@link AssociateFileSystemCommandOutput} for command's `response` shape.
33
33
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
34
34
  *
35
+ * @throws {@link InternalServerError} (server fault)
36
+ * <p>An internal server error has occurred during the request. For more information, see the
37
+ * error and message fields.</p>
38
+ *
39
+ * @throws {@link InvalidGatewayRequestException} (client fault)
40
+ * <p>An exception occurred because an invalid gateway request was issued to the service. For
41
+ * more information, see the error and message fields.</p>
42
+ *
43
+ *
35
44
  */
36
45
  export declare class AssociateFileSystemCommand extends $Command<AssociateFileSystemCommandInput, AssociateFileSystemCommandOutput, StorageGatewayClientResolvedConfig> {
37
46
  readonly input: AssociateFileSystemCommandInput;
@@ -32,6 +32,15 @@ export interface AttachVolumeCommandOutput extends AttachVolumeOutput, __Metadat
32
32
  * @see {@link AttachVolumeCommandOutput} for command's `response` shape.
33
33
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
34
34
  *
35
+ * @throws {@link InternalServerError} (server fault)
36
+ * <p>An internal server error has occurred during the request. For more information, see the
37
+ * error and message fields.</p>
38
+ *
39
+ * @throws {@link InvalidGatewayRequestException} (client fault)
40
+ * <p>An exception occurred because an invalid gateway request was issued to the service. For
41
+ * more information, see the error and message fields.</p>
42
+ *
43
+ *
35
44
  */
36
45
  export declare class AttachVolumeCommand extends $Command<AttachVolumeCommandInput, AttachVolumeCommandOutput, StorageGatewayClientResolvedConfig> {
37
46
  readonly input: AttachVolumeCommandInput;
@@ -30,6 +30,32 @@ export interface CancelArchivalCommandOutput extends CancelArchivalOutput, __Met
30
30
  * @see {@link CancelArchivalCommandOutput} for command's `response` shape.
31
31
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
32
32
  *
33
+ * @throws {@link InternalServerError} (server fault)
34
+ * <p>An internal server error has occurred during the request. For more information, see the
35
+ * error and message fields.</p>
36
+ *
37
+ * @throws {@link InvalidGatewayRequestException} (client fault)
38
+ * <p>An exception occurred because an invalid gateway request was issued to the service. For
39
+ * more information, see the error and message fields.</p>
40
+ *
41
+ *
42
+ * @example To cancel virtual tape archiving
43
+ * ```javascript
44
+ * // Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.
45
+ * const input = {
46
+ * "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
47
+ * "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4"
48
+ * };
49
+ * const command = new CancelArchivalCommand(input);
50
+ * const response = await client.send(command);
51
+ * /* response ==
52
+ * {
53
+ * "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4"
54
+ * }
55
+ * *\/
56
+ * // example id: to-cancel-virtual-tape-archiving-1471294865203
57
+ * ```
58
+ *
33
59
  */
34
60
  export declare class CancelArchivalCommand extends $Command<CancelArchivalCommandInput, CancelArchivalCommandOutput, StorageGatewayClientResolvedConfig> {
35
61
  readonly input: CancelArchivalCommandInput;
@@ -31,6 +31,32 @@ export interface CancelRetrievalCommandOutput extends CancelRetrievalOutput, __M
31
31
  * @see {@link CancelRetrievalCommandOutput} for command's `response` shape.
32
32
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
33
33
  *
34
+ * @throws {@link InternalServerError} (server fault)
35
+ * <p>An internal server error has occurred during the request. For more information, see the
36
+ * error and message fields.</p>
37
+ *
38
+ * @throws {@link InvalidGatewayRequestException} (client fault)
39
+ * <p>An exception occurred because an invalid gateway request was issued to the service. For
40
+ * more information, see the error and message fields.</p>
41
+ *
42
+ *
43
+ * @example To cancel virtual tape retrieval
44
+ * ```javascript
45
+ * // Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated.
46
+ * const input = {
47
+ * "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
48
+ * "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4"
49
+ * };
50
+ * const command = new CancelRetrievalCommand(input);
51
+ * const response = await client.send(command);
52
+ * /* response ==
53
+ * {
54
+ * "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4"
55
+ * }
56
+ * *\/
57
+ * // example id: to-cancel-virtual-tape-retrieval-1471295704491
58
+ * ```
59
+ *
34
60
  */
35
61
  export declare class CancelRetrievalCommand extends $Command<CancelRetrievalCommandInput, CancelRetrievalCommandOutput, StorageGatewayClientResolvedConfig> {
36
62
  readonly input: CancelRetrievalCommandInput;
@@ -46,6 +46,37 @@ export interface CreateCachediSCSIVolumeCommandOutput extends CreateCachediSCSIV
46
46
  * @see {@link CreateCachediSCSIVolumeCommandOutput} for command's `response` shape.
47
47
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
48
48
  *
49
+ * @throws {@link InternalServerError} (server fault)
50
+ * <p>An internal server error has occurred during the request. For more information, see the
51
+ * error and message fields.</p>
52
+ *
53
+ * @throws {@link InvalidGatewayRequestException} (client fault)
54
+ * <p>An exception occurred because an invalid gateway request was issued to the service. For
55
+ * more information, see the error and message fields.</p>
56
+ *
57
+ *
58
+ * @example To create a cached iSCSI volume
59
+ * ```javascript
60
+ * // Creates a cached volume on a specified cached gateway.
61
+ * const input = {
62
+ * "ClientToken": "cachedvol112233",
63
+ * "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
64
+ * "NetworkInterfaceId": "10.1.1.1",
65
+ * "SnapshotId": "snap-f47b7b94",
66
+ * "TargetName": "my-volume",
67
+ * "VolumeSizeInBytes": 536870912000
68
+ * };
69
+ * const command = new CreateCachediSCSIVolumeCommand(input);
70
+ * const response = await client.send(command);
71
+ * /* response ==
72
+ * {
73
+ * "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume",
74
+ * "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
75
+ * }
76
+ * *\/
77
+ * // example id: to-create-a-cached-iscsi-volume-1471296661787
78
+ * ```
79
+ *
49
80
  */
50
81
  export declare class CreateCachediSCSIVolumeCommand extends $Command<CreateCachediSCSIVolumeCommandInput, CreateCachediSCSIVolumeCommandOutput, StorageGatewayClientResolvedConfig> {
51
82
  readonly input: CreateCachediSCSIVolumeCommandInput;
@@ -45,6 +45,15 @@ export interface CreateNFSFileShareCommandOutput extends CreateNFSFileShareOutpu
45
45
  * @see {@link CreateNFSFileShareCommandOutput} for command's `response` shape.
46
46
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
47
47
  *
48
+ * @throws {@link InternalServerError} (server fault)
49
+ * <p>An internal server error has occurred during the request. For more information, see the
50
+ * error and message fields.</p>
51
+ *
52
+ * @throws {@link InvalidGatewayRequestException} (client fault)
53
+ * <p>An exception occurred because an invalid gateway request was issued to the service. For
54
+ * more information, see the error and message fields.</p>
55
+ *
56
+ *
48
57
  */
49
58
  export declare class CreateNFSFileShareCommand extends $Command<CreateNFSFileShareCommandInput, CreateNFSFileShareCommandOutput, StorageGatewayClientResolvedConfig> {
50
59
  readonly input: CreateNFSFileShareCommandInput;
@@ -45,6 +45,15 @@ export interface CreateSMBFileShareCommandOutput extends CreateSMBFileShareOutpu
45
45
  * @see {@link CreateSMBFileShareCommandOutput} for command's `response` shape.
46
46
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
47
47
  *
48
+ * @throws {@link InternalServerError} (server fault)
49
+ * <p>An internal server error has occurred during the request. For more information, see the
50
+ * error and message fields.</p>
51
+ *
52
+ * @throws {@link InvalidGatewayRequestException} (client fault)
53
+ * <p>An exception occurred because an invalid gateway request was issued to the service. For
54
+ * more information, see the error and message fields.</p>
55
+ *
56
+ *
48
57
  */
49
58
  export declare class CreateSMBFileShareCommand extends $Command<CreateSMBFileShareCommandInput, CreateSMBFileShareCommandOutput, StorageGatewayClientResolvedConfig> {
50
59
  readonly input: CreateSMBFileShareCommandInput;
@@ -56,6 +56,37 @@ export interface CreateSnapshotCommandOutput extends CreateSnapshotOutput, __Met
56
56
  * @see {@link CreateSnapshotCommandOutput} for command's `response` shape.
57
57
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
58
58
  *
59
+ * @throws {@link InternalServerError} (server fault)
60
+ * <p>An internal server error has occurred during the request. For more information, see the
61
+ * error and message fields.</p>
62
+ *
63
+ * @throws {@link InvalidGatewayRequestException} (client fault)
64
+ * <p>An exception occurred because an invalid gateway request was issued to the service. For
65
+ * more information, see the error and message fields.</p>
66
+ *
67
+ * @throws {@link ServiceUnavailableError} (server fault)
68
+ * <p>An internal server error has occurred because the service is unavailable. For more
69
+ * information, see the error and message fields.</p>
70
+ *
71
+ *
72
+ * @example To create a snapshot of a gateway volume
73
+ * ```javascript
74
+ * // Initiates an ad-hoc snapshot of a gateway volume.
75
+ * const input = {
76
+ * "SnapshotDescription": "My root volume snapshot as of 10/03/2017",
77
+ * "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
78
+ * };
79
+ * const command = new CreateSnapshotCommand(input);
80
+ * const response = await client.send(command);
81
+ * /* response ==
82
+ * {
83
+ * "SnapshotId": "snap-78e22663",
84
+ * "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
85
+ * }
86
+ * *\/
87
+ * // example id: to-create-a-snapshot-of-a-gateway-volume-1471301469561
88
+ * ```
89
+ *
59
90
  */
60
91
  export declare class CreateSnapshotCommand extends $Command<CreateSnapshotCommandInput, CreateSnapshotCommandOutput, StorageGatewayClientResolvedConfig> {
61
92
  readonly input: CreateSnapshotCommandInput;
@@ -49,6 +49,38 @@ export interface CreateSnapshotFromVolumeRecoveryPointCommandOutput extends Crea
49
49
  * @see {@link CreateSnapshotFromVolumeRecoveryPointCommandOutput} for command's `response` shape.
50
50
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
51
51
  *
52
+ * @throws {@link InternalServerError} (server fault)
53
+ * <p>An internal server error has occurred during the request. For more information, see the
54
+ * error and message fields.</p>
55
+ *
56
+ * @throws {@link InvalidGatewayRequestException} (client fault)
57
+ * <p>An exception occurred because an invalid gateway request was issued to the service. For
58
+ * more information, see the error and message fields.</p>
59
+ *
60
+ * @throws {@link ServiceUnavailableError} (server fault)
61
+ * <p>An internal server error has occurred because the service is unavailable. For more
62
+ * information, see the error and message fields.</p>
63
+ *
64
+ *
65
+ * @example To create a snapshot of a gateway volume
66
+ * ```javascript
67
+ * // Initiates a snapshot of a gateway from a volume recovery point.
68
+ * const input = {
69
+ * "SnapshotDescription": "My root volume snapshot as of 2017-06-30T10:10:10.000Z",
70
+ * "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
71
+ * };
72
+ * const command = new CreateSnapshotFromVolumeRecoveryPointCommand(input);
73
+ * const response = await client.send(command);
74
+ * /* response ==
75
+ * {
76
+ * "SnapshotId": "snap-78e22663",
77
+ * "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
78
+ * "VolumeRecoveryPointTime": "2017-06-30T10:10:10.000Z"
79
+ * }
80
+ * *\/
81
+ * // example id: to-create-a-snapshot-of-a-gateway-volume-1471301469561
82
+ * ```
83
+ *
52
84
  */
53
85
  export declare class CreateSnapshotFromVolumeRecoveryPointCommand extends $Command<CreateSnapshotFromVolumeRecoveryPointCommandInput, CreateSnapshotFromVolumeRecoveryPointCommandOutput, StorageGatewayClientResolvedConfig> {
54
86
  readonly input: CreateSnapshotFromVolumeRecoveryPointCommandInput;
@@ -40,6 +40,38 @@ export interface CreateStorediSCSIVolumeCommandOutput extends CreateStorediSCSIV
40
40
  * @see {@link CreateStorediSCSIVolumeCommandOutput} for command's `response` shape.
41
41
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
42
42
  *
43
+ * @throws {@link InternalServerError} (server fault)
44
+ * <p>An internal server error has occurred during the request. For more information, see the
45
+ * error and message fields.</p>
46
+ *
47
+ * @throws {@link InvalidGatewayRequestException} (client fault)
48
+ * <p>An exception occurred because an invalid gateway request was issued to the service. For
49
+ * more information, see the error and message fields.</p>
50
+ *
51
+ *
52
+ * @example To create a stored iSCSI volume
53
+ * ```javascript
54
+ * // Creates a stored volume on a specified stored gateway.
55
+ * const input = {
56
+ * "DiskId": "pci-0000:03:00.0-scsi-0:0:0:0",
57
+ * "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
58
+ * "NetworkInterfaceId": "10.1.1.1",
59
+ * "PreserveExistingData": true,
60
+ * "SnapshotId": "snap-f47b7b94",
61
+ * "TargetName": "my-volume"
62
+ * };
63
+ * const command = new CreateStorediSCSIVolumeCommand(input);
64
+ * const response = await client.send(command);
65
+ * /* response ==
66
+ * {
67
+ * "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume",
68
+ * "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
69
+ * "VolumeSizeInBytes": 1099511627776
70
+ * }
71
+ * *\/
72
+ * // example id: to-create-a-stored-iscsi-volume-1471367662813
73
+ * ```
74
+ *
43
75
  */
44
76
  export declare class CreateStorediSCSIVolumeCommand extends $Command<CreateStorediSCSIVolumeCommandInput, CreateStorediSCSIVolumeCommandOutput, StorageGatewayClientResolvedConfig> {
45
77
  readonly input: CreateStorediSCSIVolumeCommandInput;
@@ -30,6 +30,15 @@ export interface CreateTapePoolCommandOutput extends CreateTapePoolOutput, __Met
30
30
  * @see {@link CreateTapePoolCommandOutput} for command's `response` shape.
31
31
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
32
32
  *
33
+ * @throws {@link InternalServerError} (server fault)
34
+ * <p>An internal server error has occurred during the request. For more information, see the
35
+ * error and message fields.</p>
36
+ *
37
+ * @throws {@link InvalidGatewayRequestException} (client fault)
38
+ * <p>An exception occurred because an invalid gateway request was issued to the service. For
39
+ * more information, see the error and message fields.</p>
40
+ *
41
+ *
33
42
  */
34
43
  export declare class CreateTapePoolCommand extends $Command<CreateTapePoolCommandInput, CreateTapePoolCommandOutput, StorageGatewayClientResolvedConfig> {
35
44
  readonly input: CreateTapePoolCommandInput;
@@ -37,6 +37,33 @@ export interface CreateTapeWithBarcodeCommandOutput extends CreateTapeWithBarcod
37
37
  * @see {@link CreateTapeWithBarcodeCommandOutput} for command's `response` shape.
38
38
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
39
39
  *
40
+ * @throws {@link InternalServerError} (server fault)
41
+ * <p>An internal server error has occurred during the request. For more information, see the
42
+ * error and message fields.</p>
43
+ *
44
+ * @throws {@link InvalidGatewayRequestException} (client fault)
45
+ * <p>An exception occurred because an invalid gateway request was issued to the service. For
46
+ * more information, see the error and message fields.</p>
47
+ *
48
+ *
49
+ * @example To create a virtual tape using a barcode
50
+ * ```javascript
51
+ * // Creates a virtual tape by using your own barcode.
52
+ * const input = {
53
+ * "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
54
+ * "TapeBarcode": "TEST12345",
55
+ * "TapeSizeInBytes": 107374182400
56
+ * };
57
+ * const command = new CreateTapeWithBarcodeCommand(input);
58
+ * const response = await client.send(command);
59
+ * /* response ==
60
+ * {
61
+ * "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST12345"
62
+ * }
63
+ * *\/
64
+ * // example id: to-create-a-virtual-tape-using-a-barcode-1471371842452
65
+ * ```
66
+ *
40
67
  */
41
68
  export declare class CreateTapeWithBarcodeCommand extends $Command<CreateTapeWithBarcodeCommandInput, CreateTapeWithBarcodeCommandOutput, StorageGatewayClientResolvedConfig> {
42
69
  readonly input: CreateTapeWithBarcodeCommandInput;
@@ -35,6 +35,39 @@ export interface CreateTapesCommandOutput extends CreateTapesOutput, __MetadataB
35
35
  * @see {@link CreateTapesCommandOutput} for command's `response` shape.
36
36
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
37
37
  *
38
+ * @throws {@link InternalServerError} (server fault)
39
+ * <p>An internal server error has occurred during the request. For more information, see the
40
+ * error and message fields.</p>
41
+ *
42
+ * @throws {@link InvalidGatewayRequestException} (client fault)
43
+ * <p>An exception occurred because an invalid gateway request was issued to the service. For
44
+ * more information, see the error and message fields.</p>
45
+ *
46
+ *
47
+ * @example To create a virtual tape
48
+ * ```javascript
49
+ * // Creates one or more virtual tapes.
50
+ * const input = {
51
+ * "ClientToken": "77777",
52
+ * "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
53
+ * "NumTapesToCreate": 3,
54
+ * "TapeBarcodePrefix": "TEST",
55
+ * "TapeSizeInBytes": 107374182400
56
+ * };
57
+ * const command = new CreateTapesCommand(input);
58
+ * const response = await client.send(command);
59
+ * /* response ==
60
+ * {
61
+ * "TapeARNs": [
62
+ * "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST38A29D",
63
+ * "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST3AA29F",
64
+ * "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST3BA29E"
65
+ * ]
66
+ * }
67
+ * *\/
68
+ * // example id: to-create-a-virtual-tape-1471372061659
69
+ * ```
70
+ *
38
71
  */
39
72
  export declare class CreateTapesCommand extends $Command<CreateTapesCommandInput, CreateTapesCommandOutput, StorageGatewayClientResolvedConfig> {
40
73
  readonly input: CreateTapesCommandInput;
@@ -31,6 +31,15 @@ export interface DeleteAutomaticTapeCreationPolicyCommandOutput extends DeleteAu
31
31
  * @see {@link DeleteAutomaticTapeCreationPolicyCommandOutput} for command's `response` shape.
32
32
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
33
33
  *
34
+ * @throws {@link InternalServerError} (server fault)
35
+ * <p>An internal server error has occurred during the request. For more information, see the
36
+ * error and message fields.</p>
37
+ *
38
+ * @throws {@link InvalidGatewayRequestException} (client fault)
39
+ * <p>An exception occurred because an invalid gateway request was issued to the service. For
40
+ * more information, see the error and message fields.</p>
41
+ *
42
+ *
34
43
  */
35
44
  export declare class DeleteAutomaticTapeCreationPolicyCommand extends $Command<DeleteAutomaticTapeCreationPolicyCommandInput, DeleteAutomaticTapeCreationPolicyCommandOutput, StorageGatewayClientResolvedConfig> {
36
45
  readonly input: DeleteAutomaticTapeCreationPolicyCommandInput;
@@ -33,6 +33,32 @@ export interface DeleteBandwidthRateLimitCommandOutput extends DeleteBandwidthRa
33
33
  * @see {@link DeleteBandwidthRateLimitCommandOutput} for command's `response` shape.
34
34
  * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
35
35
  *
36
+ * @throws {@link InternalServerError} (server fault)
37
+ * <p>An internal server error has occurred during the request. For more information, see the
38
+ * error and message fields.</p>
39
+ *
40
+ * @throws {@link InvalidGatewayRequestException} (client fault)
41
+ * <p>An exception occurred because an invalid gateway request was issued to the service. For
42
+ * more information, see the error and message fields.</p>
43
+ *
44
+ *
45
+ * @example To delete bandwidth rate limits of gateway
46
+ * ```javascript
47
+ * // Deletes the bandwidth rate limits of a gateway; either the upload or download limit, or both.
48
+ * const input = {
49
+ * "BandwidthType": "All",
50
+ * "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
51
+ * };
52
+ * const command = new DeleteBandwidthRateLimitCommand(input);
53
+ * const response = await client.send(command);
54
+ * /* response ==
55
+ * {
56
+ * "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
57
+ * }
58
+ * *\/
59
+ * // example id: to-delete-bandwidth-rate-limits-of-gateway-1471373225520
60
+ * ```
61
+ *
36
62
  */
37
63
  export declare class DeleteBandwidthRateLimitCommand extends $Command<DeleteBandwidthRateLimitCommandInput, DeleteBandwidthRateLimitCommandOutput, StorageGatewayClientResolvedConfig> {
38
64
  readonly input: DeleteBandwidthRateLimitCommandInput;