@aws-sdk/client-storage-gateway 3.774.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-cjs/auth/httpAuthSchemeProvider.js +1 -3
- package/dist-cjs/index.js +17 -18
- package/dist-es/StorageGatewayClient.js +2 -1
- package/dist-es/auth/httpAuthSchemeProvider.js +1 -3
- package/dist-es/endpoint/EndpointParameters.js +2 -3
- package/dist-es/runtimeExtensions.js +2 -14
- 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 +33 -33
|
@@ -81,25 +81,25 @@ declare const CreateTapeWithBarcodeCommand_base: {
|
|
|
81
81
|
* @throws {@link StorageGatewayServiceException}
|
|
82
82
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
83
83
|
*
|
|
84
|
-
*
|
|
84
|
+
*
|
|
85
85
|
* @example To create a virtual tape using a barcode
|
|
86
86
|
* ```javascript
|
|
87
87
|
* // Creates a virtual tape by using your own barcode.
|
|
88
88
|
* const input = {
|
|
89
|
-
*
|
|
90
|
-
*
|
|
91
|
-
*
|
|
89
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
|
|
90
|
+
* TapeBarcode: "TEST12345",
|
|
91
|
+
* TapeSizeInBytes: 107374182400
|
|
92
92
|
* };
|
|
93
93
|
* const command = new CreateTapeWithBarcodeCommand(input);
|
|
94
94
|
* const response = await client.send(command);
|
|
95
|
-
* /* response
|
|
95
|
+
* /* response is
|
|
96
96
|
* {
|
|
97
|
-
*
|
|
97
|
+
* TapeARN: "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST12345"
|
|
98
98
|
* }
|
|
99
99
|
* *\/
|
|
100
|
-
* // example id: to-create-a-virtual-tape-using-a-barcode-1471371842452
|
|
101
100
|
* ```
|
|
102
101
|
*
|
|
102
|
+
* @public
|
|
103
103
|
*/
|
|
104
104
|
export declare class CreateTapeWithBarcodeCommand extends CreateTapeWithBarcodeCommand_base {
|
|
105
105
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -83,31 +83,31 @@ declare const CreateTapesCommand_base: {
|
|
|
83
83
|
* @throws {@link StorageGatewayServiceException}
|
|
84
84
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
85
85
|
*
|
|
86
|
-
*
|
|
86
|
+
*
|
|
87
87
|
* @example To create a virtual tape
|
|
88
88
|
* ```javascript
|
|
89
89
|
* // Creates one or more virtual tapes.
|
|
90
90
|
* const input = {
|
|
91
|
-
*
|
|
92
|
-
*
|
|
93
|
-
*
|
|
94
|
-
*
|
|
95
|
-
*
|
|
91
|
+
* ClientToken: "77777",
|
|
92
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
|
|
93
|
+
* NumTapesToCreate: 3,
|
|
94
|
+
* TapeBarcodePrefix: "TEST",
|
|
95
|
+
* TapeSizeInBytes: 107374182400
|
|
96
96
|
* };
|
|
97
97
|
* const command = new CreateTapesCommand(input);
|
|
98
98
|
* const response = await client.send(command);
|
|
99
|
-
* /* response
|
|
99
|
+
* /* response is
|
|
100
100
|
* {
|
|
101
|
-
*
|
|
101
|
+
* TapeARNs: [
|
|
102
102
|
* "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST38A29D",
|
|
103
103
|
* "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST3AA29F",
|
|
104
104
|
* "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST3BA29E"
|
|
105
105
|
* ]
|
|
106
106
|
* }
|
|
107
107
|
* *\/
|
|
108
|
-
* // example id: to-create-a-virtual-tape-1471372061659
|
|
109
108
|
* ```
|
|
110
109
|
*
|
|
110
|
+
* @public
|
|
111
111
|
*/
|
|
112
112
|
export declare class CreateTapesCommand extends CreateTapesCommand_base {
|
|
113
113
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -64,6 +64,7 @@ declare const DeleteAutomaticTapeCreationPolicyCommand_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 DeleteAutomaticTapeCreationPolicyCommand extends DeleteAutomaticTapeCreationPolicyCommand_base {
|
|
@@ -67,24 +67,24 @@ declare const DeleteBandwidthRateLimitCommand_base: {
|
|
|
67
67
|
* @throws {@link StorageGatewayServiceException}
|
|
68
68
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
69
69
|
*
|
|
70
|
-
*
|
|
70
|
+
*
|
|
71
71
|
* @example To delete bandwidth rate limits of gateway
|
|
72
72
|
* ```javascript
|
|
73
73
|
* // Deletes the bandwidth rate limits of a gateway; either the upload or download limit, or both.
|
|
74
74
|
* const input = {
|
|
75
|
-
*
|
|
76
|
-
*
|
|
75
|
+
* BandwidthType: "All",
|
|
76
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
|
|
77
77
|
* };
|
|
78
78
|
* const command = new DeleteBandwidthRateLimitCommand(input);
|
|
79
79
|
* const response = await client.send(command);
|
|
80
|
-
* /* response
|
|
80
|
+
* /* response is
|
|
81
81
|
* {
|
|
82
|
-
*
|
|
82
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
|
|
83
83
|
* }
|
|
84
84
|
* *\/
|
|
85
|
-
* // example id: to-delete-bandwidth-rate-limits-of-gateway-1471373225520
|
|
86
85
|
* ```
|
|
87
86
|
*
|
|
87
|
+
* @public
|
|
88
88
|
*/
|
|
89
89
|
export declare class DeleteBandwidthRateLimitCommand extends DeleteBandwidthRateLimitCommand_base {
|
|
90
90
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -68,6 +68,7 @@ declare const DeleteCacheReportCommand_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 DeleteCacheReportCommand extends DeleteCacheReportCommand_base {
|
|
@@ -66,25 +66,25 @@ declare const DeleteChapCredentialsCommand_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 delete CHAP credentials
|
|
71
71
|
* ```javascript
|
|
72
72
|
* // Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
|
|
73
73
|
* const input = {
|
|
74
|
-
*
|
|
75
|
-
*
|
|
74
|
+
* InitiatorName: "iqn.1991-05.com.microsoft:computername.domain.example.com",
|
|
75
|
+
* TargetARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
|
|
76
76
|
* };
|
|
77
77
|
* const command = new DeleteChapCredentialsCommand(input);
|
|
78
78
|
* const response = await client.send(command);
|
|
79
|
-
* /* response
|
|
79
|
+
* /* response is
|
|
80
80
|
* {
|
|
81
|
-
*
|
|
82
|
-
*
|
|
81
|
+
* InitiatorName: "iqn.1991-05.com.microsoft:computername.domain.example.com",
|
|
82
|
+
* TargetARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
|
|
83
83
|
* }
|
|
84
84
|
* *\/
|
|
85
|
-
* // example id: to-delete-chap-credentials-1471375025612
|
|
86
85
|
* ```
|
|
87
86
|
*
|
|
87
|
+
* @public
|
|
88
88
|
*/
|
|
89
89
|
export declare class DeleteChapCredentialsCommand extends DeleteChapCredentialsCommand_base {
|
|
90
90
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -64,6 +64,7 @@ declare const DeleteFileShareCommand_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 DeleteFileShareCommand extends DeleteFileShareCommand_base {
|
|
@@ -77,23 +77,23 @@ declare const DeleteGatewayCommand_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
81
|
* @example To delete a gatgeway
|
|
82
82
|
* ```javascript
|
|
83
83
|
* // This operation deletes the gateway, but not the gateway's VM from the host computer.
|
|
84
84
|
* const input = {
|
|
85
|
-
*
|
|
85
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
|
|
86
86
|
* };
|
|
87
87
|
* const command = new DeleteGatewayCommand(input);
|
|
88
88
|
* const response = await client.send(command);
|
|
89
|
-
* /* response
|
|
89
|
+
* /* response is
|
|
90
90
|
* {
|
|
91
|
-
*
|
|
91
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
|
|
92
92
|
* }
|
|
93
93
|
* *\/
|
|
94
|
-
* // example id: to-delete-a-gatgeway-1471381697333
|
|
95
94
|
* ```
|
|
96
95
|
*
|
|
96
|
+
* @public
|
|
97
97
|
*/
|
|
98
98
|
export declare class DeleteGatewayCommand extends DeleteGatewayCommand_base {
|
|
99
99
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -73,23 +73,23 @@ declare const DeleteSnapshotScheduleCommand_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 delete a snapshot of a volume
|
|
78
78
|
* ```javascript
|
|
79
79
|
* // This action enables you to delete a snapshot schedule for a volume.
|
|
80
80
|
* const input = {
|
|
81
|
-
*
|
|
81
|
+
* VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
|
|
82
82
|
* };
|
|
83
83
|
* const command = new DeleteSnapshotScheduleCommand(input);
|
|
84
84
|
* const response = await client.send(command);
|
|
85
|
-
* /* response
|
|
85
|
+
* /* response is
|
|
86
86
|
* {
|
|
87
|
-
*
|
|
87
|
+
* VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
|
|
88
88
|
* }
|
|
89
89
|
* *\/
|
|
90
|
-
* // example id: to-delete-a-snapshot-of-a-volume-1471382234377
|
|
91
90
|
* ```
|
|
92
91
|
*
|
|
92
|
+
* @public
|
|
93
93
|
*/
|
|
94
94
|
export declare class DeleteSnapshotScheduleCommand extends DeleteSnapshotScheduleCommand_base {
|
|
95
95
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -64,23 +64,23 @@ declare const DeleteTapeArchiveCommand_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
68
|
* @example To delete a virtual tape from the shelf (VTS)
|
|
69
69
|
* ```javascript
|
|
70
70
|
* // Deletes the specified virtual tape from the virtual tape shelf (VTS).
|
|
71
71
|
* const input = {
|
|
72
|
-
*
|
|
72
|
+
* TapeARN: "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0"
|
|
73
73
|
* };
|
|
74
74
|
* const command = new DeleteTapeArchiveCommand(input);
|
|
75
75
|
* const response = await client.send(command);
|
|
76
|
-
* /* response
|
|
76
|
+
* /* response is
|
|
77
77
|
* {
|
|
78
|
-
*
|
|
78
|
+
* TapeARN: "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0"
|
|
79
79
|
* }
|
|
80
80
|
* *\/
|
|
81
|
-
* // example id: to-delete-a-virtual-tape-from-the-shelf-vts-1471383964329
|
|
82
81
|
* ```
|
|
83
82
|
*
|
|
83
|
+
* @public
|
|
84
84
|
*/
|
|
85
85
|
export declare class DeleteTapeArchiveCommand extends DeleteTapeArchiveCommand_base {
|
|
86
86
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -65,24 +65,24 @@ declare const DeleteTapeCommand_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
69
|
* @example To delete a virtual tape
|
|
70
70
|
* ```javascript
|
|
71
71
|
* // This example deletes the specified virtual tape.
|
|
72
72
|
* const input = {
|
|
73
|
-
*
|
|
74
|
-
*
|
|
73
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:204469490176:gateway/sgw-12A3456B",
|
|
74
|
+
* TapeARN: "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0"
|
|
75
75
|
* };
|
|
76
76
|
* const command = new DeleteTapeCommand(input);
|
|
77
77
|
* const response = await client.send(command);
|
|
78
|
-
* /* response
|
|
78
|
+
* /* response is
|
|
79
79
|
* {
|
|
80
|
-
*
|
|
80
|
+
* TapeARN: "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0"
|
|
81
81
|
* }
|
|
82
82
|
* *\/
|
|
83
|
-
* // example id: to-delete-a-virtual-tape-1471382444157
|
|
84
83
|
* ```
|
|
85
84
|
*
|
|
85
|
+
* @public
|
|
86
86
|
*/
|
|
87
87
|
export declare class DeleteTapeCommand extends DeleteTapeCommand_base {
|
|
88
88
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -64,6 +64,7 @@ declare const DeleteTapePoolCommand_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 DeleteTapePoolCommand extends DeleteTapePoolCommand_base {
|
|
@@ -72,23 +72,23 @@ declare const DeleteVolumeCommand_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 delete a gateway volume
|
|
77
77
|
* ```javascript
|
|
78
78
|
* // Deletes the specified gateway volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API.
|
|
79
79
|
* const input = {
|
|
80
|
-
*
|
|
80
|
+
* VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
|
|
81
81
|
* };
|
|
82
82
|
* const command = new DeleteVolumeCommand(input);
|
|
83
83
|
* const response = await client.send(command);
|
|
84
|
-
* /* response
|
|
84
|
+
* /* response is
|
|
85
85
|
* {
|
|
86
|
-
*
|
|
86
|
+
* VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
|
|
87
87
|
* }
|
|
88
88
|
* *\/
|
|
89
|
-
* // example id: to-delete-a-gateway-volume-1471384418416
|
|
90
89
|
* ```
|
|
91
90
|
*
|
|
91
|
+
* @public
|
|
92
92
|
*/
|
|
93
93
|
export declare class DeleteVolumeCommand extends DeleteVolumeCommand_base {
|
|
94
94
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -66,6 +66,7 @@ declare const DescribeAvailabilityMonitorTestCommand_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
|
* @public
|
|
70
71
|
*/
|
|
71
72
|
export declare class DescribeAvailabilityMonitorTestCommand extends DescribeAvailabilityMonitorTestCommand_base {
|
|
@@ -71,25 +71,25 @@ declare const DescribeBandwidthRateLimitCommand_base: {
|
|
|
71
71
|
* @throws {@link StorageGatewayServiceException}
|
|
72
72
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
73
73
|
*
|
|
74
|
-
*
|
|
74
|
+
*
|
|
75
75
|
* @example To describe the bandwidth rate limits of a gateway
|
|
76
76
|
* ```javascript
|
|
77
77
|
* // Returns a value for a bandwidth rate limit if set. If not set, then only the gateway ARN is returned.
|
|
78
78
|
* const input = {
|
|
79
|
-
*
|
|
79
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
|
|
80
80
|
* };
|
|
81
81
|
* const command = new DescribeBandwidthRateLimitCommand(input);
|
|
82
82
|
* const response = await client.send(command);
|
|
83
|
-
* /* response
|
|
83
|
+
* /* response is
|
|
84
84
|
* {
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
*
|
|
85
|
+
* AverageDownloadRateLimitInBitsPerSec: 204800,
|
|
86
|
+
* AverageUploadRateLimitInBitsPerSec: 102400,
|
|
87
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
|
|
88
88
|
* }
|
|
89
89
|
* *\/
|
|
90
|
-
* // example id: to-describe-the-bandwidth-rate-limits-of-a-gateway-1471384826404
|
|
91
90
|
* ```
|
|
92
91
|
*
|
|
92
|
+
* @public
|
|
93
93
|
*/
|
|
94
94
|
export declare class DescribeBandwidthRateLimitCommand extends DescribeBandwidthRateLimitCommand_base {
|
|
95
95
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -88,6 +88,7 @@ declare const DescribeBandwidthRateLimitScheduleCommand_base: {
|
|
|
88
88
|
* @throws {@link StorageGatewayServiceException}
|
|
89
89
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
90
90
|
*
|
|
91
|
+
*
|
|
91
92
|
* @public
|
|
92
93
|
*/
|
|
93
94
|
export declare class DescribeBandwidthRateLimitScheduleCommand extends DescribeBandwidthRateLimitScheduleCommand_base {
|
|
@@ -73,32 +73,32 @@ declare const DescribeCacheCommand_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 describe cache information
|
|
78
78
|
* ```javascript
|
|
79
79
|
* // Returns information about the cache of a gateway.
|
|
80
80
|
* const input = {
|
|
81
|
-
*
|
|
81
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
|
|
82
82
|
* };
|
|
83
83
|
* const command = new DescribeCacheCommand(input);
|
|
84
84
|
* const response = await client.send(command);
|
|
85
|
-
* /* response
|
|
85
|
+
* /* response is
|
|
86
86
|
* {
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
*
|
|
87
|
+
* CacheAllocatedInBytes: 2199023255552,
|
|
88
|
+
* CacheDirtyPercentage: 0.07,
|
|
89
|
+
* CacheHitPercentage: 99.68,
|
|
90
|
+
* CacheMissPercentage: 0.32,
|
|
91
|
+
* CacheUsedPercentage: 0.07,
|
|
92
|
+
* DiskIds: [
|
|
93
93
|
* "pci-0000:03:00.0-scsi-0:0:0:0",
|
|
94
94
|
* "pci-0000:04:00.0-scsi-0:1:0:0"
|
|
95
95
|
* ],
|
|
96
|
-
*
|
|
96
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
|
|
97
97
|
* }
|
|
98
98
|
* *\/
|
|
99
|
-
* // example id: to-describe-cache-information-1471385756036
|
|
100
99
|
* ```
|
|
101
100
|
*
|
|
101
|
+
* @public
|
|
102
102
|
*/
|
|
103
103
|
export declare class DescribeCacheCommand extends DescribeCacheCommand_base {
|
|
104
104
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -95,6 +95,7 @@ declare const DescribeCacheReportCommand_base: {
|
|
|
95
95
|
* @throws {@link StorageGatewayServiceException}
|
|
96
96
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
97
97
|
*
|
|
98
|
+
*
|
|
98
99
|
* @public
|
|
99
100
|
*/
|
|
100
101
|
export declare class DescribeCacheReportCommand extends DescribeCacheReportCommand_base {
|
|
@@ -90,40 +90,40 @@ declare const DescribeCachediSCSIVolumesCommand_base: {
|
|
|
90
90
|
* @throws {@link StorageGatewayServiceException}
|
|
91
91
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
92
92
|
*
|
|
93
|
-
*
|
|
93
|
+
*
|
|
94
94
|
* @example To describe gateway cached iSCSI volumes
|
|
95
95
|
* ```javascript
|
|
96
96
|
* // Returns a description of the gateway cached iSCSI volumes specified in the request.
|
|
97
97
|
* const input = {
|
|
98
|
-
*
|
|
98
|
+
* VolumeARNs: [
|
|
99
99
|
* "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
|
|
100
100
|
* ]
|
|
101
101
|
* };
|
|
102
102
|
* const command = new DescribeCachediSCSIVolumesCommand(input);
|
|
103
103
|
* const response = await client.send(command);
|
|
104
|
-
* /* response
|
|
104
|
+
* /* response is
|
|
105
105
|
* {
|
|
106
|
-
*
|
|
106
|
+
* CachediSCSIVolumes: [
|
|
107
107
|
* {
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
*
|
|
115
|
-
*
|
|
116
|
-
*
|
|
117
|
-
*
|
|
118
|
-
*
|
|
108
|
+
* VolumeARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
|
|
109
|
+
* VolumeId: "vol-1122AABB",
|
|
110
|
+
* VolumeSizeInBytes: 1099511627776,
|
|
111
|
+
* VolumeStatus: "AVAILABLE",
|
|
112
|
+
* VolumeType: "CACHED iSCSI",
|
|
113
|
+
* VolumeiSCSIAttributes: {
|
|
114
|
+
* ChapEnabled: true,
|
|
115
|
+
* LunNumber: 1,
|
|
116
|
+
* NetworkInterfaceId: "10.243.43.207",
|
|
117
|
+
* NetworkInterfacePort: 3260,
|
|
118
|
+
* TargetARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
|
|
119
119
|
* }
|
|
120
120
|
* }
|
|
121
121
|
* ]
|
|
122
122
|
* }
|
|
123
123
|
* *\/
|
|
124
|
-
* // example id: to-describe-gateway-cached-iscsi-volumes-1471458094649
|
|
125
124
|
* ```
|
|
126
125
|
*
|
|
126
|
+
* @public
|
|
127
127
|
*/
|
|
128
128
|
export declare class DescribeCachediSCSIVolumesCommand extends DescribeCachediSCSIVolumesCommand_base {
|
|
129
129
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -71,30 +71,30 @@ declare const DescribeChapCredentialsCommand_base: {
|
|
|
71
71
|
* @throws {@link StorageGatewayServiceException}
|
|
72
72
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
73
73
|
*
|
|
74
|
-
*
|
|
74
|
+
*
|
|
75
75
|
* @example To describe CHAP credetnitals for an iSCSI
|
|
76
76
|
* ```javascript
|
|
77
77
|
* // Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
|
|
78
78
|
* const input = {
|
|
79
|
-
*
|
|
79
|
+
* TargetARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
|
|
80
80
|
* };
|
|
81
81
|
* const command = new DescribeChapCredentialsCommand(input);
|
|
82
82
|
* const response = await client.send(command);
|
|
83
|
-
* /* response
|
|
83
|
+
* /* response is
|
|
84
84
|
* {
|
|
85
|
-
*
|
|
85
|
+
* ChapCredentials: [
|
|
86
86
|
* {
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
90
|
-
*
|
|
87
|
+
* InitiatorName: "iqn.1991-05.com.microsoft:computername.domain.example.com",
|
|
88
|
+
* SecretToAuthenticateInitiator: "111111111111",
|
|
89
|
+
* SecretToAuthenticateTarget: "222222222222",
|
|
90
|
+
* TargetARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
|
|
91
91
|
* }
|
|
92
92
|
* ]
|
|
93
93
|
* }
|
|
94
94
|
* *\/
|
|
95
|
-
* // example id: to-describe-chap-credetnitals-for-an-iscsi-1471467462967
|
|
96
95
|
* ```
|
|
97
96
|
*
|
|
97
|
+
* @public
|
|
98
98
|
*/
|
|
99
99
|
export declare class DescribeChapCredentialsCommand extends DescribeChapCredentialsCommand_base {
|
|
100
100
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -92,6 +92,7 @@ declare const DescribeFileSystemAssociationsCommand_base: {
|
|
|
92
92
|
* @throws {@link StorageGatewayServiceException}
|
|
93
93
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
94
94
|
*
|
|
95
|
+
*
|
|
95
96
|
* @public
|
|
96
97
|
*/
|
|
97
98
|
export declare class DescribeFileSystemAssociationsCommand extends DescribeFileSystemAssociationsCommand_base {
|
|
@@ -98,35 +98,35 @@ declare const DescribeGatewayInformationCommand_base: {
|
|
|
98
98
|
* @throws {@link StorageGatewayServiceException}
|
|
99
99
|
* <p>Base exception class for all service exceptions from StorageGateway service.</p>
|
|
100
100
|
*
|
|
101
|
-
*
|
|
101
|
+
*
|
|
102
102
|
* @example To describe metadata about the gateway
|
|
103
103
|
* ```javascript
|
|
104
104
|
* // Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not).
|
|
105
105
|
* const input = {
|
|
106
|
-
*
|
|
106
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
|
|
107
107
|
* };
|
|
108
108
|
* const command = new DescribeGatewayInformationCommand(input);
|
|
109
109
|
* const response = await client.send(command);
|
|
110
|
-
* /* response
|
|
110
|
+
* /* response is
|
|
111
111
|
* {
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
*
|
|
115
|
-
*
|
|
112
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
|
113
|
+
* GatewayId: "sgw-AABB1122",
|
|
114
|
+
* GatewayName: "My_Gateway",
|
|
115
|
+
* GatewayNetworkInterfaces: [
|
|
116
116
|
* {
|
|
117
|
-
*
|
|
117
|
+
* Ipv4Address: "10.35.69.216"
|
|
118
118
|
* }
|
|
119
119
|
* ],
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
120
|
+
* GatewayState: "STATE_RUNNING",
|
|
121
|
+
* GatewayTimezone: "GMT-8:00",
|
|
122
|
+
* GatewayType: "STORED",
|
|
123
|
+
* LastSoftwareUpdate: "2016-01-02T16:00:00",
|
|
124
|
+
* NextUpdateAvailabilityDate: "2017-01-02T16:00:00"
|
|
125
125
|
* }
|
|
126
126
|
* *\/
|
|
127
|
-
* // example id: to-describe-metadata-about-the-gateway-1471467849079
|
|
128
127
|
* ```
|
|
129
128
|
*
|
|
129
|
+
* @public
|
|
130
130
|
*/
|
|
131
131
|
export declare class DescribeGatewayInformationCommand extends DescribeGatewayInformationCommand_base {
|
|
132
132
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -72,27 +72,27 @@ declare const DescribeMaintenanceStartTimeCommand_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 describe gateway's maintenance start time
|
|
77
77
|
* ```javascript
|
|
78
78
|
* // Returns your gateway's weekly maintenance start time including the day and time of the week.
|
|
79
79
|
* const input = {
|
|
80
|
-
*
|
|
80
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
|
|
81
81
|
* };
|
|
82
82
|
* const command = new DescribeMaintenanceStartTimeCommand(input);
|
|
83
83
|
* const response = await client.send(command);
|
|
84
|
-
* /* response
|
|
84
|
+
* /* response is
|
|
85
85
|
* {
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
90
|
-
*
|
|
86
|
+
* DayOfWeek: 2,
|
|
87
|
+
* GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
|
88
|
+
* HourOfDay: 15,
|
|
89
|
+
* MinuteOfHour: 35,
|
|
90
|
+
* Timezone: "GMT+7:00"
|
|
91
91
|
* }
|
|
92
92
|
* *\/
|
|
93
|
-
* // example id: to-describe-gateways-maintenance-start-time-1471470727387
|
|
94
93
|
* ```
|
|
95
94
|
*
|
|
95
|
+
* @public
|
|
96
96
|
*/
|
|
97
97
|
export declare class DescribeMaintenanceStartTimeCommand extends DescribeMaintenanceStartTimeCommand_base {
|
|
98
98
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -107,6 +107,7 @@ declare const DescribeNFSFileSharesCommand_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 DescribeNFSFileSharesCommand extends DescribeNFSFileSharesCommand_base {
|