@aws-sdk/client-storage-gateway 3.775.0 → 3.777.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.
- package/dist-types/commands/ActivateGatewayCommand.d.ts +11 -11
- package/dist-types/commands/AddCacheCommand.d.ts +6 -6
- package/dist-types/commands/AddTagsToResourceCommand.d.ts +8 -8
- package/dist-types/commands/AddUploadBufferCommand.d.ts +6 -6
- package/dist-types/commands/AddWorkingStorageCommand.d.ts +6 -6
- package/dist-types/commands/AssignTapePoolCommand.d.ts +1 -0
- package/dist-types/commands/AssociateFileSystemCommand.d.ts +1 -0
- package/dist-types/commands/AttachVolumeCommand.d.ts +1 -0
- package/dist-types/commands/CancelArchivalCommand.d.ts +6 -6
- package/dist-types/commands/CancelCacheReportCommand.d.ts +1 -0
- package/dist-types/commands/CancelRetrievalCommand.d.ts +6 -6
- package/dist-types/commands/CreateCachediSCSIVolumeCommand.d.ts +11 -11
- package/dist-types/commands/CreateNFSFileShareCommand.d.ts +1 -0
- package/dist-types/commands/CreateSMBFileShareCommand.d.ts +1 -0
- package/dist-types/commands/CreateSnapshotCommand.d.ts +7 -7
- package/dist-types/commands/CreateSnapshotFromVolumeRecoveryPointCommand.d.ts +8 -8
- package/dist-types/commands/CreateStorediSCSIVolumeCommand.d.ts +12 -12
- package/dist-types/commands/CreateTapePoolCommand.d.ts +1 -0
- package/dist-types/commands/CreateTapeWithBarcodeCommand.d.ts +7 -7
- package/dist-types/commands/CreateTapesCommand.d.ts +9 -9
- package/dist-types/commands/DeleteAutomaticTapeCreationPolicyCommand.d.ts +1 -0
- package/dist-types/commands/DeleteBandwidthRateLimitCommand.d.ts +6 -6
- package/dist-types/commands/DeleteCacheReportCommand.d.ts +1 -0
- package/dist-types/commands/DeleteChapCredentialsCommand.d.ts +7 -7
- package/dist-types/commands/DeleteFileShareCommand.d.ts +1 -0
- package/dist-types/commands/DeleteGatewayCommand.d.ts +5 -5
- package/dist-types/commands/DeleteSnapshotScheduleCommand.d.ts +5 -5
- package/dist-types/commands/DeleteTapeArchiveCommand.d.ts +5 -5
- package/dist-types/commands/DeleteTapeCommand.d.ts +6 -6
- package/dist-types/commands/DeleteTapePoolCommand.d.ts +1 -0
- package/dist-types/commands/DeleteVolumeCommand.d.ts +5 -5
- package/dist-types/commands/DescribeAvailabilityMonitorTestCommand.d.ts +1 -0
- package/dist-types/commands/DescribeBandwidthRateLimitCommand.d.ts +7 -7
- package/dist-types/commands/DescribeBandwidthRateLimitScheduleCommand.d.ts +1 -0
- package/dist-types/commands/DescribeCacheCommand.d.ts +11 -11
- package/dist-types/commands/DescribeCacheReportCommand.d.ts +1 -0
- package/dist-types/commands/DescribeCachediSCSIVolumesCommand.d.ts +16 -16
- package/dist-types/commands/DescribeChapCredentialsCommand.d.ts +9 -9
- package/dist-types/commands/DescribeFileSystemAssociationsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeGatewayInformationCommand.d.ts +14 -14
- package/dist-types/commands/DescribeMaintenanceStartTimeCommand.d.ts +9 -9
- package/dist-types/commands/DescribeNFSFileSharesCommand.d.ts +1 -0
- package/dist-types/commands/DescribeSMBFileSharesCommand.d.ts +1 -0
- package/dist-types/commands/DescribeSMBSettingsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeSnapshotScheduleCommand.d.ts +9 -9
- package/dist-types/commands/DescribeStorediSCSIVolumesCommand.d.ts +17 -17
- package/dist-types/commands/DescribeTapeArchivesCommand.d.ts +1 -37
- package/dist-types/commands/DescribeTapeRecoveryPointsCommand.d.ts +1 -27
- package/dist-types/commands/DescribeTapesCommand.d.ts +17 -17
- package/dist-types/commands/DescribeUploadBufferCommand.d.ts +18 -19
- package/dist-types/commands/DescribeVTLDevicesCommand.d.ts +37 -37
- package/dist-types/commands/DescribeWorkingStorageCommand.d.ts +8 -8
- package/dist-types/commands/DetachVolumeCommand.d.ts +1 -0
- package/dist-types/commands/DisableGatewayCommand.d.ts +5 -5
- package/dist-types/commands/DisassociateFileSystemCommand.d.ts +1 -0
- package/dist-types/commands/EvictFilesFailingUploadCommand.d.ts +1 -0
- package/dist-types/commands/JoinDomainCommand.d.ts +1 -0
- package/dist-types/commands/ListAutomaticTapeCreationPoliciesCommand.d.ts +1 -0
- package/dist-types/commands/ListCacheReportsCommand.d.ts +1 -0
- package/dist-types/commands/ListFileSharesCommand.d.ts +1 -0
- package/dist-types/commands/ListFileSystemAssociationsCommand.d.ts +1 -0
- package/dist-types/commands/ListGatewaysCommand.d.ts +9 -9
- package/dist-types/commands/ListLocalDisksCommand.d.ts +19 -19
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -11
- package/dist-types/commands/ListTapePoolsCommand.d.ts +1 -0
- package/dist-types/commands/ListTapesCommand.d.ts +1 -0
- package/dist-types/commands/ListVolumeInitiatorsCommand.d.ts +1 -0
- package/dist-types/commands/ListVolumeRecoveryPointsCommand.d.ts +9 -9
- package/dist-types/commands/ListVolumesCommand.d.ts +21 -21
- package/dist-types/commands/NotifyWhenUploadedCommand.d.ts +1 -0
- package/dist-types/commands/RefreshCacheCommand.d.ts +1 -0
- package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +6 -6
- package/dist-types/commands/ResetCacheCommand.d.ts +5 -5
- package/dist-types/commands/RetrieveTapeArchiveCommand.d.ts +6 -6
- package/dist-types/commands/RetrieveTapeRecoveryPointCommand.d.ts +6 -6
- package/dist-types/commands/SetLocalConsolePasswordCommand.d.ts +6 -6
- package/dist-types/commands/SetSMBGuestPasswordCommand.d.ts +1 -0
- package/dist-types/commands/ShutdownGatewayCommand.d.ts +5 -5
- package/dist-types/commands/StartAvailabilityMonitorTestCommand.d.ts +1 -0
- package/dist-types/commands/StartCacheReportCommand.d.ts +1 -0
- package/dist-types/commands/StartGatewayCommand.d.ts +5 -5
- package/dist-types/commands/UpdateAutomaticTapeCreationPolicyCommand.d.ts +1 -0
- package/dist-types/commands/UpdateBandwidthRateLimitCommand.d.ts +7 -7
- package/dist-types/commands/UpdateBandwidthRateLimitScheduleCommand.d.ts +1 -0
- package/dist-types/commands/UpdateChapCredentialsCommand.d.ts +9 -9
- package/dist-types/commands/UpdateFileSystemAssociationCommand.d.ts +1 -0
- package/dist-types/commands/UpdateGatewayInformationCommand.d.ts +8 -8
- package/dist-types/commands/UpdateGatewaySoftwareNowCommand.d.ts +5 -5
- package/dist-types/commands/UpdateMaintenanceStartTimeCommand.d.ts +8 -8
- package/dist-types/commands/UpdateNFSFileShareCommand.d.ts +1 -0
- package/dist-types/commands/UpdateSMBFileShareCommand.d.ts +1 -0
- package/dist-types/commands/UpdateSMBFileShareVisibilityCommand.d.ts +1 -0
- package/dist-types/commands/UpdateSMBLocalGroupsCommand.d.ts +1 -0
- package/dist-types/commands/UpdateSMBSecurityStrategyCommand.d.ts +1 -0
- package/dist-types/commands/UpdateSnapshotScheduleCommand.d.ts +8 -8
- package/dist-types/commands/UpdateVTLDeviceTypeCommand.d.ts +6 -6
- package/package.json +2 -2
|
@@ -84,44 +84,44 @@ declare const ListVolumesCommand_base: {
|
|
|
84
84
|
* @throws {@link StorageGatewayServiceException}
|
|
85
85
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
86
86
|
*
|
|
87
|
-
*
|
|
87
|
+
*
|
|
88
88
|
* @example To list the iSCSI stored volumes of a gateway
|
|
89
89
|
* ```javascript
|
|
90
90
|
* // Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN up to a maximum of 100 volumes.
|
|
91
91
|
* const input = {
|
|
92
|
-
*
|
|
93
|
-
*
|
|
94
|
-
*
|
|
92
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
|
93
|
+
* Limit: 2,
|
|
94
|
+
* Marker: "1"
|
|
95
95
|
* };
|
|
96
96
|
* const command = new ListVolumesCommand(input);
|
|
97
97
|
* const response = await client.send(command);
|
|
98
|
-
* /* response
|
|
98
|
+
* /* response is
|
|
99
99
|
* {
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
*
|
|
100
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
|
101
|
+
* Marker: "1",
|
|
102
|
+
* VolumeInfos: [
|
|
103
103
|
* {
|
|
104
|
-
*
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
104
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
|
105
|
+
* GatewayId: "sgw-12A3456B",
|
|
106
|
+
* VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
|
|
107
|
+
* VolumeId: "vol-1122AABB",
|
|
108
|
+
* VolumeSizeInBytes: 107374182400,
|
|
109
|
+
* VolumeType: "STORED"
|
|
110
110
|
* },
|
|
111
111
|
* {
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
*
|
|
115
|
-
*
|
|
116
|
-
*
|
|
117
|
-
*
|
|
112
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C",
|
|
113
|
+
* GatewayId: "sgw-gw-13B4567C",
|
|
114
|
+
* VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C/volume/vol-3344CCDD",
|
|
115
|
+
* VolumeId: "vol-1122AABB",
|
|
116
|
+
* VolumeSizeInBytes: 107374182400,
|
|
117
|
+
* VolumeType: "STORED"
|
|
118
118
|
* }
|
|
119
119
|
* ]
|
|
120
120
|
* }
|
|
121
121
|
* *\/
|
|
122
|
-
* // example id: to-list-the-iscsi-stored-volumes-of-a-gateway-1472145723653
|
|
123
122
|
* ```
|
|
124
123
|
*
|
|
124
|
+
* @public
|
|
125
125
|
*/
|
|
126
126
|
export declare class ListVolumesCommand extends ListVolumesCommand_base {
|
|
127
127
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -73,6 +73,7 @@ declare const NotifyWhenUploadedCommand_base: {
|
|
|
73
73
|
* @throws {@link StorageGatewayServiceException}
|
|
74
74
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
75
75
|
*
|
|
76
|
+
*
|
|
76
77
|
* @public
|
|
77
78
|
*/
|
|
78
79
|
export declare class NotifyWhenUploadedCommand extends NotifyWhenUploadedCommand_base {
|
|
@@ -107,6 +107,7 @@ declare const RefreshCacheCommand_base: {
|
|
|
107
107
|
* @throws {@link StorageGatewayServiceException}
|
|
108
108
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
109
109
|
*
|
|
110
|
+
*
|
|
110
111
|
* @public
|
|
111
112
|
*/
|
|
112
113
|
export declare class RefreshCacheCommand extends RefreshCacheCommand_base {
|
|
@@ -66,27 +66,27 @@ declare const RemoveTagsFromResourceCommand_base: {
|
|
|
66
66
|
* @throws {@link StorageGatewayServiceException}
|
|
67
67
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
68
68
|
*
|
|
69
|
-
*
|
|
69
|
+
*
|
|
70
70
|
* @example To remove tags from a resource
|
|
71
71
|
* ```javascript
|
|
72
72
|
* // Lists the iSCSI stored volumes of a gateway. Removes one or more tags from the specified resource.
|
|
73
73
|
* const input = {
|
|
74
|
-
*
|
|
75
|
-
*
|
|
74
|
+
* ResourceARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B",
|
|
75
|
+
* TagKeys: [
|
|
76
76
|
* "Dev Gatgeway Region",
|
|
77
77
|
* "East Coast"
|
|
78
78
|
* ]
|
|
79
79
|
* };
|
|
80
80
|
* const command = new RemoveTagsFromResourceCommand(input);
|
|
81
81
|
* const response = await client.send(command);
|
|
82
|
-
* /* response
|
|
82
|
+
* /* response is
|
|
83
83
|
* {
|
|
84
|
-
*
|
|
84
|
+
* ResourceARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B"
|
|
85
85
|
* }
|
|
86
86
|
* *\/
|
|
87
|
-
* // example id: to-remove-tags-from-a-resource-1472147210553
|
|
88
87
|
* ```
|
|
89
88
|
*
|
|
89
|
+
* @public
|
|
90
90
|
*/
|
|
91
91
|
export declare class RemoveTagsFromResourceCommand extends RemoveTagsFromResourceCommand_base {
|
|
92
92
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -73,23 +73,23 @@ declare const ResetCacheCommand_base: {
|
|
|
73
73
|
* @throws {@link StorageGatewayServiceException}
|
|
74
74
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
75
75
|
*
|
|
76
|
-
*
|
|
76
|
+
*
|
|
77
77
|
* @example To reset cache disks in error status
|
|
78
78
|
* ```javascript
|
|
79
79
|
* // Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage.
|
|
80
80
|
* const input = {
|
|
81
|
-
*
|
|
81
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C"
|
|
82
82
|
* };
|
|
83
83
|
* const command = new ResetCacheCommand(input);
|
|
84
84
|
* const response = await client.send(command);
|
|
85
|
-
* /* response
|
|
85
|
+
* /* response is
|
|
86
86
|
* {
|
|
87
|
-
*
|
|
87
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C"
|
|
88
88
|
* }
|
|
89
89
|
* *\/
|
|
90
|
-
* // example id: to-reset-cache-disks-in-error-status-1472148909807
|
|
91
90
|
* ```
|
|
92
91
|
*
|
|
92
|
+
* @public
|
|
93
93
|
*/
|
|
94
94
|
export declare class ResetCacheCommand extends ResetCacheCommand_base {
|
|
95
95
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -69,24 +69,24 @@ declare const RetrieveTapeArchiveCommand_base: {
|
|
|
69
69
|
* @throws {@link StorageGatewayServiceException}
|
|
70
70
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
71
71
|
*
|
|
72
|
-
*
|
|
72
|
+
*
|
|
73
73
|
* @example To retrieve an archived tape from the VTS
|
|
74
74
|
* ```javascript
|
|
75
75
|
* // Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL. Virtual tapes archived in the VTS are not associated with any gateway.
|
|
76
76
|
* const input = {
|
|
77
|
-
*
|
|
78
|
-
*
|
|
77
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
|
|
78
|
+
* TapeARN: "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF"
|
|
79
79
|
* };
|
|
80
80
|
* const command = new RetrieveTapeArchiveCommand(input);
|
|
81
81
|
* const response = await client.send(command);
|
|
82
|
-
* /* response
|
|
82
|
+
* /* response is
|
|
83
83
|
* {
|
|
84
|
-
*
|
|
84
|
+
* TapeARN: "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF"
|
|
85
85
|
* }
|
|
86
86
|
* *\/
|
|
87
|
-
* // example id: to-retrieve-an-archived-tape-from-the-vts-1472149812358
|
|
88
87
|
* ```
|
|
89
88
|
*
|
|
89
|
+
* @public
|
|
90
90
|
*/
|
|
91
91
|
export declare class RetrieveTapeArchiveCommand extends RetrieveTapeArchiveCommand_base {
|
|
92
92
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -72,24 +72,24 @@ declare const RetrieveTapeRecoveryPointCommand_base: {
|
|
|
72
72
|
* @throws {@link StorageGatewayServiceException}
|
|
73
73
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
74
74
|
*
|
|
75
|
-
*
|
|
75
|
+
*
|
|
76
76
|
* @example To retrieve the recovery point of a virtual tape
|
|
77
77
|
* ```javascript
|
|
78
78
|
* // Retrieves the recovery point for the specified virtual tape.
|
|
79
79
|
* const input = {
|
|
80
|
-
*
|
|
81
|
-
*
|
|
80
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
|
|
81
|
+
* TapeARN: "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF"
|
|
82
82
|
* };
|
|
83
83
|
* const command = new RetrieveTapeRecoveryPointCommand(input);
|
|
84
84
|
* const response = await client.send(command);
|
|
85
|
-
* /* response
|
|
85
|
+
* /* response is
|
|
86
86
|
* {
|
|
87
|
-
*
|
|
87
|
+
* TapeARN: "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF"
|
|
88
88
|
* }
|
|
89
89
|
* *\/
|
|
90
|
-
* // example id: to-retrieve-the-recovery-point-of-a-virtual-tape-1472150014805
|
|
91
90
|
* ```
|
|
92
91
|
*
|
|
92
|
+
* @public
|
|
93
93
|
*/
|
|
94
94
|
export declare class RetrieveTapeRecoveryPointCommand extends RetrieveTapeRecoveryPointCommand_base {
|
|
95
95
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -66,24 +66,24 @@ declare const SetLocalConsolePasswordCommand_base: {
|
|
|
66
66
|
* @throws {@link StorageGatewayServiceException}
|
|
67
67
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
68
68
|
*
|
|
69
|
-
*
|
|
69
|
+
*
|
|
70
70
|
* @example To set a password for your VM
|
|
71
71
|
* ```javascript
|
|
72
72
|
* // Sets the password for your VM local console.
|
|
73
73
|
* const input = {
|
|
74
|
-
*
|
|
75
|
-
*
|
|
74
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
|
|
75
|
+
* LocalConsolePassword: "PassWordMustBeAtLeast6Chars."
|
|
76
76
|
* };
|
|
77
77
|
* const command = new SetLocalConsolePasswordCommand(input);
|
|
78
78
|
* const response = await client.send(command);
|
|
79
|
-
* /* response
|
|
79
|
+
* /* response is
|
|
80
80
|
* {
|
|
81
|
-
*
|
|
81
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"
|
|
82
82
|
* }
|
|
83
83
|
* *\/
|
|
84
|
-
* // example id: to-set-a-password-for-your-vm-1472150202632
|
|
85
84
|
* ```
|
|
86
85
|
*
|
|
86
|
+
* @public
|
|
87
87
|
*/
|
|
88
88
|
export declare class SetLocalConsolePasswordCommand extends SetLocalConsolePasswordCommand_base {
|
|
89
89
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -65,6 +65,7 @@ declare const SetSMBGuestPasswordCommand_base: {
|
|
|
65
65
|
* @throws {@link StorageGatewayServiceException}
|
|
66
66
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
67
67
|
*
|
|
68
|
+
*
|
|
68
69
|
* @public
|
|
69
70
|
*/
|
|
70
71
|
export declare class SetSMBGuestPasswordCommand extends SetSMBGuestPasswordCommand_base {
|
|
@@ -84,23 +84,23 @@ declare const ShutdownGatewayCommand_base: {
|
|
|
84
84
|
* @throws {@link StorageGatewayServiceException}
|
|
85
85
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
86
86
|
*
|
|
87
|
-
*
|
|
87
|
+
*
|
|
88
88
|
* @example To shut down a gateway service
|
|
89
89
|
* ```javascript
|
|
90
90
|
* // This operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the VM.
|
|
91
91
|
* const input = {
|
|
92
|
-
*
|
|
92
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"
|
|
93
93
|
* };
|
|
94
94
|
* const command = new ShutdownGatewayCommand(input);
|
|
95
95
|
* const response = await client.send(command);
|
|
96
|
-
* /* response
|
|
96
|
+
* /* response is
|
|
97
97
|
* {
|
|
98
|
-
*
|
|
98
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"
|
|
99
99
|
* }
|
|
100
100
|
* *\/
|
|
101
|
-
* // example id: to-shut-down-a-gateway-service-1472150508835
|
|
102
101
|
* ```
|
|
103
102
|
*
|
|
103
|
+
* @public
|
|
104
104
|
*/
|
|
105
105
|
export declare class ShutdownGatewayCommand extends ShutdownGatewayCommand_base {
|
|
106
106
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -69,6 +69,7 @@ declare const StartAvailabilityMonitorTestCommand_base: {
|
|
|
69
69
|
* @throws {@link StorageGatewayServiceException}
|
|
70
70
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
71
71
|
*
|
|
72
|
+
*
|
|
72
73
|
* @public
|
|
73
74
|
*/
|
|
74
75
|
export declare class StartAvailabilityMonitorTestCommand extends StartAvailabilityMonitorTestCommand_base {
|
|
@@ -123,6 +123,7 @@ declare const StartCacheReportCommand_base: {
|
|
|
123
123
|
* @throws {@link StorageGatewayServiceException}
|
|
124
124
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
125
125
|
*
|
|
126
|
+
*
|
|
126
127
|
* @public
|
|
127
128
|
*/
|
|
128
129
|
export declare class StartCacheReportCommand extends StartCacheReportCommand_base {
|
|
@@ -72,23 +72,23 @@ declare const StartGatewayCommand_base: {
|
|
|
72
72
|
* @throws {@link StorageGatewayServiceException}
|
|
73
73
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
74
74
|
*
|
|
75
|
-
*
|
|
75
|
+
*
|
|
76
76
|
* @example To start a gateway service
|
|
77
77
|
* ```javascript
|
|
78
78
|
* // Starts a gateway service that was previously shut down.
|
|
79
79
|
* const input = {
|
|
80
|
-
*
|
|
80
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"
|
|
81
81
|
* };
|
|
82
82
|
* const command = new StartGatewayCommand(input);
|
|
83
83
|
* const response = await client.send(command);
|
|
84
|
-
* /* response
|
|
84
|
+
* /* response is
|
|
85
85
|
* {
|
|
86
|
-
*
|
|
86
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"
|
|
87
87
|
* }
|
|
88
88
|
* *\/
|
|
89
|
-
* // example id: to-start-a-gateway-service-1472150722315
|
|
90
89
|
* ```
|
|
91
90
|
*
|
|
91
|
+
* @public
|
|
92
92
|
*/
|
|
93
93
|
export declare class StartGatewayCommand extends StartGatewayCommand_base {
|
|
94
94
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -77,6 +77,7 @@ declare const UpdateAutomaticTapeCreationPolicyCommand_base: {
|
|
|
77
77
|
* @throws {@link StorageGatewayServiceException}
|
|
78
78
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
79
79
|
*
|
|
80
|
+
*
|
|
80
81
|
* @public
|
|
81
82
|
*/
|
|
82
83
|
export declare class UpdateAutomaticTapeCreationPolicyCommand extends UpdateAutomaticTapeCreationPolicyCommand_base {
|
|
@@ -73,25 +73,25 @@ declare const UpdateBandwidthRateLimitCommand_base: {
|
|
|
73
73
|
* @throws {@link StorageGatewayServiceException}
|
|
74
74
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
75
75
|
*
|
|
76
|
-
*
|
|
76
|
+
*
|
|
77
77
|
* @example To update the bandwidth rate limits of a gateway
|
|
78
78
|
* ```javascript
|
|
79
79
|
* // Updates the bandwidth rate limits of a gateway. Both the upload and download bandwidth rate limit can be set, or either one of the two. If a new limit is not set, the existing rate limit remains.
|
|
80
80
|
* const input = {
|
|
81
|
-
*
|
|
82
|
-
*
|
|
83
|
-
*
|
|
81
|
+
* AverageDownloadRateLimitInBitsPerSec: 102400,
|
|
82
|
+
* AverageUploadRateLimitInBitsPerSec: 51200,
|
|
83
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
|
|
84
84
|
* };
|
|
85
85
|
* const command = new UpdateBandwidthRateLimitCommand(input);
|
|
86
86
|
* const response = await client.send(command);
|
|
87
|
-
* /* response
|
|
87
|
+
* /* response is
|
|
88
88
|
* {
|
|
89
|
-
*
|
|
89
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
|
|
90
90
|
* }
|
|
91
91
|
* *\/
|
|
92
|
-
* // example id: to-update-the-bandwidth-rate-limits-of-a-gateway-1472151016202
|
|
93
92
|
* ```
|
|
94
93
|
*
|
|
94
|
+
* @public
|
|
95
95
|
*/
|
|
96
96
|
export declare class UpdateBandwidthRateLimitCommand extends UpdateBandwidthRateLimitCommand_base {
|
|
97
97
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -80,6 +80,7 @@ declare const UpdateBandwidthRateLimitScheduleCommand_base: {
|
|
|
80
80
|
* @throws {@link StorageGatewayServiceException}
|
|
81
81
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
82
82
|
*
|
|
83
|
+
*
|
|
83
84
|
* @public
|
|
84
85
|
*/
|
|
85
86
|
export declare class UpdateBandwidthRateLimitScheduleCommand extends UpdateBandwidthRateLimitScheduleCommand_base {
|
|
@@ -73,27 +73,27 @@ declare const UpdateChapCredentialsCommand_base: {
|
|
|
73
73
|
* @throws {@link StorageGatewayServiceException}
|
|
74
74
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
75
75
|
*
|
|
76
|
-
*
|
|
76
|
+
*
|
|
77
77
|
* @example To update CHAP credentials for an iSCSI target
|
|
78
78
|
* ```javascript
|
|
79
79
|
* // Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target.
|
|
80
80
|
* const input = {
|
|
81
|
-
*
|
|
82
|
-
*
|
|
83
|
-
*
|
|
84
|
-
*
|
|
81
|
+
* InitiatorName: "iqn.1991-05.com.microsoft:computername.domain.example.com",
|
|
82
|
+
* SecretToAuthenticateInitiator: "111111111111",
|
|
83
|
+
* SecretToAuthenticateTarget: "222222222222",
|
|
84
|
+
* TargetARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
|
|
85
85
|
* };
|
|
86
86
|
* const command = new UpdateChapCredentialsCommand(input);
|
|
87
87
|
* const response = await client.send(command);
|
|
88
|
-
* /* response
|
|
88
|
+
* /* response is
|
|
89
89
|
* {
|
|
90
|
-
*
|
|
91
|
-
*
|
|
90
|
+
* InitiatorName: "iqn.1991-05.com.microsoft:computername.domain.example.com",
|
|
91
|
+
* TargetARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
|
|
92
92
|
* }
|
|
93
93
|
* *\/
|
|
94
|
-
* // example id: to-update-chap-credentials-for-an-iscsi-target-1472151325795
|
|
95
94
|
* ```
|
|
96
95
|
*
|
|
96
|
+
* @public
|
|
97
97
|
*/
|
|
98
98
|
export declare class UpdateChapCredentialsCommand extends UpdateChapCredentialsCommand_base {
|
|
99
99
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -69,6 +69,7 @@ declare const UpdateFileSystemAssociationCommand_base: {
|
|
|
69
69
|
* @throws {@link StorageGatewayServiceException}
|
|
70
70
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
71
71
|
*
|
|
72
|
+
*
|
|
72
73
|
* @public
|
|
73
74
|
*/
|
|
74
75
|
export declare class UpdateFileSystemAssociationCommand extends UpdateFileSystemAssociationCommand_base {
|
|
@@ -74,26 +74,26 @@ declare const UpdateGatewayInformationCommand_base: {
|
|
|
74
74
|
* @throws {@link StorageGatewayServiceException}
|
|
75
75
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
76
76
|
*
|
|
77
|
-
*
|
|
77
|
+
*
|
|
78
78
|
* @example To update a gateway's metadata
|
|
79
79
|
* ```javascript
|
|
80
80
|
* // Updates a gateway's metadata, which includes the gateway's name and time zone.
|
|
81
81
|
* const input = {
|
|
82
|
-
*
|
|
83
|
-
*
|
|
84
|
-
*
|
|
82
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
|
83
|
+
* GatewayName: "MyGateway2",
|
|
84
|
+
* GatewayTimezone: "GMT-12:00"
|
|
85
85
|
* };
|
|
86
86
|
* const command = new UpdateGatewayInformationCommand(input);
|
|
87
87
|
* const response = await client.send(command);
|
|
88
|
-
* /* response
|
|
88
|
+
* /* response is
|
|
89
89
|
* {
|
|
90
|
-
*
|
|
91
|
-
*
|
|
90
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
|
91
|
+
* GatewayName: ""
|
|
92
92
|
* }
|
|
93
93
|
* *\/
|
|
94
|
-
* // example id: to-update-a-gateways-metadata-1472151688693
|
|
95
94
|
* ```
|
|
96
95
|
*
|
|
96
|
+
* @public
|
|
97
97
|
*/
|
|
98
98
|
export declare class UpdateGatewayInformationCommand extends UpdateGatewayInformationCommand_base {
|
|
99
99
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -75,23 +75,23 @@ declare const UpdateGatewaySoftwareNowCommand_base: {
|
|
|
75
75
|
* @throws {@link StorageGatewayServiceException}
|
|
76
76
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
77
77
|
*
|
|
78
|
-
*
|
|
78
|
+
*
|
|
79
79
|
* @example To update a gateway's VM software
|
|
80
80
|
* ```javascript
|
|
81
81
|
* // Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.
|
|
82
82
|
* const input = {
|
|
83
|
-
*
|
|
83
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
|
|
84
84
|
* };
|
|
85
85
|
* const command = new UpdateGatewaySoftwareNowCommand(input);
|
|
86
86
|
* const response = await client.send(command);
|
|
87
|
-
* /* response
|
|
87
|
+
* /* response is
|
|
88
88
|
* {
|
|
89
|
-
*
|
|
89
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
|
|
90
90
|
* }
|
|
91
91
|
* *\/
|
|
92
|
-
* // example id: to-update-a-gateways-vm-software-1472152020929
|
|
93
92
|
* ```
|
|
94
93
|
*
|
|
94
|
+
* @public
|
|
95
95
|
*/
|
|
96
96
|
export declare class UpdateGatewaySoftwareNowCommand extends UpdateGatewaySoftwareNowCommand_base {
|
|
97
97
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -84,26 +84,26 @@ declare const UpdateMaintenanceStartTimeCommand_base: {
|
|
|
84
84
|
* @throws {@link StorageGatewayServiceException}
|
|
85
85
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
86
86
|
*
|
|
87
|
-
*
|
|
87
|
+
*
|
|
88
88
|
* @example To update a gateway's maintenance start time
|
|
89
89
|
* ```javascript
|
|
90
90
|
* // Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is in your gateway's time zone.
|
|
91
91
|
* const input = {
|
|
92
|
-
*
|
|
93
|
-
*
|
|
94
|
-
*
|
|
95
|
-
*
|
|
92
|
+
* DayOfWeek: 2,
|
|
93
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
|
94
|
+
* HourOfDay: 0,
|
|
95
|
+
* MinuteOfHour: 30
|
|
96
96
|
* };
|
|
97
97
|
* const command = new UpdateMaintenanceStartTimeCommand(input);
|
|
98
98
|
* const response = await client.send(command);
|
|
99
|
-
* /* response
|
|
99
|
+
* /* response is
|
|
100
100
|
* {
|
|
101
|
-
*
|
|
101
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
|
|
102
102
|
* }
|
|
103
103
|
* *\/
|
|
104
|
-
* // example id: to-update-a-gateways-maintenance-start-time-1472152552031
|
|
105
104
|
* ```
|
|
106
105
|
*
|
|
106
|
+
* @public
|
|
107
107
|
*/
|
|
108
108
|
export declare class UpdateMaintenanceStartTimeCommand extends UpdateMaintenanceStartTimeCommand_base {
|
|
109
109
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -109,6 +109,7 @@ declare const UpdateNFSFileShareCommand_base: {
|
|
|
109
109
|
* @throws {@link StorageGatewayServiceException}
|
|
110
110
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
111
111
|
*
|
|
112
|
+
*
|
|
112
113
|
* @public
|
|
113
114
|
*/
|
|
114
115
|
export declare class UpdateNFSFileShareCommand extends UpdateNFSFileShareCommand_base {
|
|
@@ -105,6 +105,7 @@ declare const UpdateSMBFileShareCommand_base: {
|
|
|
105
105
|
* @throws {@link StorageGatewayServiceException}
|
|
106
106
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
107
107
|
*
|
|
108
|
+
*
|
|
108
109
|
* @public
|
|
109
110
|
*/
|
|
110
111
|
export declare class UpdateSMBFileShareCommand extends UpdateSMBFileShareCommand_base {
|
|
@@ -64,6 +64,7 @@ declare const UpdateSMBFileShareVisibilityCommand_base: {
|
|
|
64
64
|
* @throws {@link StorageGatewayServiceException}
|
|
65
65
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
66
66
|
*
|
|
67
|
+
*
|
|
67
68
|
* @public
|
|
68
69
|
*/
|
|
69
70
|
export declare class UpdateSMBFileShareVisibilityCommand extends UpdateSMBFileShareVisibilityCommand_base {
|
|
@@ -68,6 +68,7 @@ declare const UpdateSMBLocalGroupsCommand_base: {
|
|
|
68
68
|
* @throws {@link StorageGatewayServiceException}
|
|
69
69
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
70
70
|
*
|
|
71
|
+
*
|
|
71
72
|
* @public
|
|
72
73
|
*/
|
|
73
74
|
export declare class UpdateSMBLocalGroupsCommand extends UpdateSMBLocalGroupsCommand_base {
|
|
@@ -70,6 +70,7 @@ declare const UpdateSMBSecurityStrategyCommand_base: {
|
|
|
70
70
|
* @throws {@link StorageGatewayServiceException}
|
|
71
71
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
72
72
|
*
|
|
73
|
+
*
|
|
73
74
|
* @public
|
|
74
75
|
*/
|
|
75
76
|
export declare class UpdateSMBSecurityStrategyCommand extends UpdateSMBSecurityStrategyCommand_base {
|
|
@@ -78,26 +78,26 @@ declare const UpdateSnapshotScheduleCommand_base: {
|
|
|
78
78
|
* @throws {@link StorageGatewayServiceException}
|
|
79
79
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
80
80
|
*
|
|
81
|
-
*
|
|
81
|
+
*
|
|
82
82
|
* @example To update a volume snapshot schedule
|
|
83
83
|
* ```javascript
|
|
84
84
|
* // Updates a snapshot schedule configured for a gateway volume.
|
|
85
85
|
* const input = {
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
86
|
+
* Description: "Hourly snapshot",
|
|
87
|
+
* RecurrenceInHours: 1,
|
|
88
|
+
* StartAt: 0,
|
|
89
|
+
* VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
|
|
90
90
|
* };
|
|
91
91
|
* const command = new UpdateSnapshotScheduleCommand(input);
|
|
92
92
|
* const response = await client.send(command);
|
|
93
|
-
* /* response
|
|
93
|
+
* /* response is
|
|
94
94
|
* {
|
|
95
|
-
*
|
|
95
|
+
* VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
|
|
96
96
|
* }
|
|
97
97
|
* *\/
|
|
98
|
-
* // example id: to-update-a-volume-snapshot-schedule-1472152757068
|
|
99
98
|
* ```
|
|
100
99
|
*
|
|
100
|
+
* @public
|
|
101
101
|
*/
|
|
102
102
|
export declare class UpdateSnapshotScheduleCommand extends UpdateSnapshotScheduleCommand_base {
|
|
103
103
|
/** @internal type navigation helper, not in runtime. */
|