@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.
- package/dist-types/commands/ActivateGatewayCommand.d.ts +31 -0
- package/dist-types/commands/AddCacheCommand.d.ts +29 -0
- package/dist-types/commands/AddTagsToResourceCommand.d.ts +31 -0
- package/dist-types/commands/AddUploadBufferCommand.d.ts +29 -0
- package/dist-types/commands/AddWorkingStorageCommand.d.ts +29 -0
- package/dist-types/commands/AssignTapePoolCommand.d.ts +9 -0
- package/dist-types/commands/AssociateFileSystemCommand.d.ts +9 -0
- package/dist-types/commands/AttachVolumeCommand.d.ts +9 -0
- package/dist-types/commands/CancelArchivalCommand.d.ts +26 -0
- package/dist-types/commands/CancelRetrievalCommand.d.ts +26 -0
- package/dist-types/commands/CreateCachediSCSIVolumeCommand.d.ts +31 -0
- package/dist-types/commands/CreateNFSFileShareCommand.d.ts +9 -0
- package/dist-types/commands/CreateSMBFileShareCommand.d.ts +9 -0
- package/dist-types/commands/CreateSnapshotCommand.d.ts +31 -0
- package/dist-types/commands/CreateSnapshotFromVolumeRecoveryPointCommand.d.ts +32 -0
- package/dist-types/commands/CreateStorediSCSIVolumeCommand.d.ts +32 -0
- package/dist-types/commands/CreateTapePoolCommand.d.ts +9 -0
- package/dist-types/commands/CreateTapeWithBarcodeCommand.d.ts +27 -0
- package/dist-types/commands/CreateTapesCommand.d.ts +33 -0
- package/dist-types/commands/DeleteAutomaticTapeCreationPolicyCommand.d.ts +9 -0
- package/dist-types/commands/DeleteBandwidthRateLimitCommand.d.ts +26 -0
- package/dist-types/commands/DeleteChapCredentialsCommand.d.ts +27 -0
- package/dist-types/commands/DeleteFileShareCommand.d.ts +9 -0
- package/dist-types/commands/DeleteGatewayCommand.d.ts +25 -0
- package/dist-types/commands/DeleteSnapshotScheduleCommand.d.ts +25 -0
- package/dist-types/commands/DeleteTapeArchiveCommand.d.ts +25 -0
- package/dist-types/commands/DeleteTapeCommand.d.ts +26 -0
- package/dist-types/commands/DeleteTapePoolCommand.d.ts +9 -0
- package/dist-types/commands/DeleteVolumeCommand.d.ts +25 -0
- package/dist-types/commands/DescribeAvailabilityMonitorTestCommand.d.ts +9 -0
- package/dist-types/commands/DescribeBandwidthRateLimitCommand.d.ts +27 -0
- package/dist-types/commands/DescribeBandwidthRateLimitScheduleCommand.d.ts +9 -0
- package/dist-types/commands/DescribeCacheCommand.d.ts +34 -0
- package/dist-types/commands/DescribeCachediSCSIVolumesCommand.d.ts +42 -0
- package/dist-types/commands/DescribeChapCredentialsCommand.d.ts +32 -0
- package/dist-types/commands/DescribeFileSystemAssociationsCommand.d.ts +9 -0
- package/dist-types/commands/DescribeGatewayInformationCommand.d.ts +37 -0
- package/dist-types/commands/DescribeMaintenanceStartTimeCommand.d.ts +29 -0
- package/dist-types/commands/DescribeNFSFileSharesCommand.d.ts +9 -0
- package/dist-types/commands/DescribeSMBFileSharesCommand.d.ts +9 -0
- package/dist-types/commands/DescribeSMBSettingsCommand.d.ts +9 -0
- package/dist-types/commands/DescribeSnapshotScheduleCommand.d.ts +29 -0
- package/dist-types/commands/DescribeStorediSCSIVolumesCommand.d.ts +43 -0
- package/dist-types/commands/DescribeTapeArchivesCommand.d.ts +46 -0
- package/dist-types/commands/DescribeTapeRecoveryPointsCommand.d.ts +36 -0
- package/dist-types/commands/DescribeTapesCommand.d.ts +45 -0
- package/dist-types/commands/DescribeUploadBufferCommand.d.ts +53 -0
- package/dist-types/commands/DescribeVTLDevicesCommand.d.ts +67 -0
- package/dist-types/commands/DescribeWorkingStorageCommand.d.ts +31 -0
- package/dist-types/commands/DetachVolumeCommand.d.ts +9 -0
- package/dist-types/commands/DisableGatewayCommand.d.ts +25 -0
- package/dist-types/commands/DisassociateFileSystemCommand.d.ts +9 -0
- package/dist-types/commands/JoinDomainCommand.d.ts +9 -0
- package/dist-types/commands/ListAutomaticTapeCreationPoliciesCommand.d.ts +9 -0
- package/dist-types/commands/ListFileSharesCommand.d.ts +9 -0
- package/dist-types/commands/ListFileSystemAssociationsCommand.d.ts +9 -0
- package/dist-types/commands/ListGatewaysCommand.d.ts +34 -0
- package/dist-types/commands/ListLocalDisksCommand.d.ts +44 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +34 -0
- package/dist-types/commands/ListTapePoolsCommand.d.ts +9 -0
- package/dist-types/commands/ListTapesCommand.d.ts +9 -0
- package/dist-types/commands/ListVolumeInitiatorsCommand.d.ts +9 -0
- package/dist-types/commands/ListVolumeRecoveryPointsCommand.d.ts +32 -0
- package/dist-types/commands/ListVolumesCommand.d.ts +46 -0
- package/dist-types/commands/NotifyWhenUploadedCommand.d.ts +9 -0
- package/dist-types/commands/RefreshCacheCommand.d.ts +9 -0
- package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +29 -0
- package/dist-types/commands/ResetCacheCommand.d.ts +25 -0
- package/dist-types/commands/RetrieveTapeArchiveCommand.d.ts +26 -0
- package/dist-types/commands/RetrieveTapeRecoveryPointCommand.d.ts +26 -0
- package/dist-types/commands/SetLocalConsolePasswordCommand.d.ts +26 -0
- package/dist-types/commands/SetSMBGuestPasswordCommand.d.ts +9 -0
- package/dist-types/commands/ShutdownGatewayCommand.d.ts +25 -0
- package/dist-types/commands/StartAvailabilityMonitorTestCommand.d.ts +9 -0
- package/dist-types/commands/StartGatewayCommand.d.ts +25 -0
- package/dist-types/commands/UpdateAutomaticTapeCreationPolicyCommand.d.ts +9 -0
- package/dist-types/commands/UpdateBandwidthRateLimitCommand.d.ts +27 -0
- package/dist-types/commands/UpdateBandwidthRateLimitScheduleCommand.d.ts +9 -0
- package/dist-types/commands/UpdateChapCredentialsCommand.d.ts +29 -0
- package/dist-types/commands/UpdateFileSystemAssociationCommand.d.ts +9 -0
- package/dist-types/commands/UpdateGatewayInformationCommand.d.ts +28 -0
- package/dist-types/commands/UpdateGatewaySoftwareNowCommand.d.ts +25 -0
- package/dist-types/commands/UpdateMaintenanceStartTimeCommand.d.ts +28 -0
- package/dist-types/commands/UpdateNFSFileShareCommand.d.ts +9 -0
- package/dist-types/commands/UpdateSMBFileShareCommand.d.ts +9 -0
- package/dist-types/commands/UpdateSMBFileShareVisibilityCommand.d.ts +9 -0
- package/dist-types/commands/UpdateSMBLocalGroupsCommand.d.ts +9 -0
- package/dist-types/commands/UpdateSMBSecurityStrategyCommand.d.ts +9 -0
- package/dist-types/commands/UpdateSnapshotScheduleCommand.d.ts +28 -0
- package/dist-types/commands/UpdateVTLDeviceTypeCommand.d.ts +26 -0
- package/package.json +29 -29
|
@@ -31,6 +31,33 @@ export interface DeleteChapCredentialsCommandOutput extends DeleteChapCredential
|
|
|
31
31
|
* @see {@link DeleteChapCredentialsCommandOutput} 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 delete CHAP credentials
|
|
44
|
+
* ```javascript
|
|
45
|
+
* // Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.
|
|
46
|
+
* const input = {
|
|
47
|
+
* "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com",
|
|
48
|
+
* "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
|
|
49
|
+
* };
|
|
50
|
+
* const command = new DeleteChapCredentialsCommand(input);
|
|
51
|
+
* const response = await client.send(command);
|
|
52
|
+
* /* response ==
|
|
53
|
+
* {
|
|
54
|
+
* "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com",
|
|
55
|
+
* "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
|
|
56
|
+
* }
|
|
57
|
+
* *\/
|
|
58
|
+
* // example id: to-delete-chap-credentials-1471375025612
|
|
59
|
+
* ```
|
|
60
|
+
*
|
|
34
61
|
*/
|
|
35
62
|
export declare class DeleteChapCredentialsCommand extends $Command<DeleteChapCredentialsCommandInput, DeleteChapCredentialsCommandOutput, StorageGatewayClientResolvedConfig> {
|
|
36
63
|
readonly input: DeleteChapCredentialsCommandInput;
|
|
@@ -30,6 +30,15 @@ export interface DeleteFileShareCommandOutput extends DeleteFileShareOutput, __M
|
|
|
30
30
|
* @see {@link DeleteFileShareCommandOutput} 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 DeleteFileShareCommand extends $Command<DeleteFileShareCommandInput, DeleteFileShareCommandOutput, StorageGatewayClientResolvedConfig> {
|
|
35
44
|
readonly input: DeleteFileShareCommandInput;
|
|
@@ -46,6 +46,31 @@ export interface DeleteGatewayCommandOutput extends DeleteGatewayOutput, __Metad
|
|
|
46
46
|
* @see {@link DeleteGatewayCommandOutput} 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 delete a gatgeway
|
|
59
|
+
* ```javascript
|
|
60
|
+
* // This operation deletes the gateway, but not the gateway's VM from the host computer.
|
|
61
|
+
* const input = {
|
|
62
|
+
* "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
|
|
63
|
+
* };
|
|
64
|
+
* const command = new DeleteGatewayCommand(input);
|
|
65
|
+
* const response = await client.send(command);
|
|
66
|
+
* /* response ==
|
|
67
|
+
* {
|
|
68
|
+
* "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
|
|
69
|
+
* }
|
|
70
|
+
* *\/
|
|
71
|
+
* // example id: to-delete-a-gatgeway-1471381697333
|
|
72
|
+
* ```
|
|
73
|
+
*
|
|
49
74
|
*/
|
|
50
75
|
export declare class DeleteGatewayCommand extends $Command<DeleteGatewayCommandInput, DeleteGatewayCommandOutput, StorageGatewayClientResolvedConfig> {
|
|
51
76
|
readonly input: DeleteGatewayCommandInput;
|
|
@@ -43,6 +43,31 @@ export interface DeleteSnapshotScheduleCommandOutput extends DeleteSnapshotSched
|
|
|
43
43
|
* @see {@link DeleteSnapshotScheduleCommandOutput} for command's `response` shape.
|
|
44
44
|
* @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
|
|
45
45
|
*
|
|
46
|
+
* @throws {@link InternalServerError} (server fault)
|
|
47
|
+
* <p>An internal server error has occurred during the request. For more information, see the
|
|
48
|
+
* error and message fields.</p>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link InvalidGatewayRequestException} (client fault)
|
|
51
|
+
* <p>An exception occurred because an invalid gateway request was issued to the service. For
|
|
52
|
+
* more information, see the error and message fields.</p>
|
|
53
|
+
*
|
|
54
|
+
*
|
|
55
|
+
* @example To delete a snapshot of a volume
|
|
56
|
+
* ```javascript
|
|
57
|
+
* // This action enables you to delete a snapshot schedule for a volume.
|
|
58
|
+
* const input = {
|
|
59
|
+
* "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
|
|
60
|
+
* };
|
|
61
|
+
* const command = new DeleteSnapshotScheduleCommand(input);
|
|
62
|
+
* const response = await client.send(command);
|
|
63
|
+
* /* response ==
|
|
64
|
+
* {
|
|
65
|
+
* "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
|
|
66
|
+
* }
|
|
67
|
+
* *\/
|
|
68
|
+
* // example id: to-delete-a-snapshot-of-a-volume-1471382234377
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
46
71
|
*/
|
|
47
72
|
export declare class DeleteSnapshotScheduleCommand extends $Command<DeleteSnapshotScheduleCommandInput, DeleteSnapshotScheduleCommandOutput, StorageGatewayClientResolvedConfig> {
|
|
48
73
|
readonly input: DeleteSnapshotScheduleCommandInput;
|
|
@@ -30,6 +30,31 @@ export interface DeleteTapeArchiveCommandOutput extends DeleteTapeArchiveOutput,
|
|
|
30
30
|
* @see {@link DeleteTapeArchiveCommandOutput} 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 delete a virtual tape from the shelf (VTS)
|
|
43
|
+
* ```javascript
|
|
44
|
+
* // Deletes the specified virtual tape from the virtual tape shelf (VTS).
|
|
45
|
+
* const input = {
|
|
46
|
+
* "TapeARN": "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0"
|
|
47
|
+
* };
|
|
48
|
+
* const command = new DeleteTapeArchiveCommand(input);
|
|
49
|
+
* const response = await client.send(command);
|
|
50
|
+
* /* response ==
|
|
51
|
+
* {
|
|
52
|
+
* "TapeARN": "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0"
|
|
53
|
+
* }
|
|
54
|
+
* *\/
|
|
55
|
+
* // example id: to-delete-a-virtual-tape-from-the-shelf-vts-1471383964329
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
33
58
|
*/
|
|
34
59
|
export declare class DeleteTapeArchiveCommand extends $Command<DeleteTapeArchiveCommandInput, DeleteTapeArchiveCommandOutput, StorageGatewayClientResolvedConfig> {
|
|
35
60
|
readonly input: DeleteTapeArchiveCommandInput;
|
|
@@ -30,6 +30,32 @@ export interface DeleteTapeCommandOutput extends DeleteTapeOutput, __MetadataBea
|
|
|
30
30
|
* @see {@link DeleteTapeCommandOutput} 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 delete a virtual tape
|
|
43
|
+
* ```javascript
|
|
44
|
+
* // This example deletes the specified virtual tape.
|
|
45
|
+
* const input = {
|
|
46
|
+
* "GatewayARN": "arn:aws:storagegateway:us-east-1:204469490176:gateway/sgw-12A3456B",
|
|
47
|
+
* "TapeARN": "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0"
|
|
48
|
+
* };
|
|
49
|
+
* const command = new DeleteTapeCommand(input);
|
|
50
|
+
* const response = await client.send(command);
|
|
51
|
+
* /* response ==
|
|
52
|
+
* {
|
|
53
|
+
* "TapeARN": "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0"
|
|
54
|
+
* }
|
|
55
|
+
* *\/
|
|
56
|
+
* // example id: to-delete-a-virtual-tape-1471382444157
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
33
59
|
*/
|
|
34
60
|
export declare class DeleteTapeCommand extends $Command<DeleteTapeCommandInput, DeleteTapeCommandOutput, StorageGatewayClientResolvedConfig> {
|
|
35
61
|
readonly input: DeleteTapeCommandInput;
|
|
@@ -31,6 +31,15 @@ export interface DeleteTapePoolCommandOutput extends DeleteTapePoolOutput, __Met
|
|
|
31
31
|
* @see {@link DeleteTapePoolCommandOutput} 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 DeleteTapePoolCommand extends $Command<DeleteTapePoolCommandInput, DeleteTapePoolCommandOutput, StorageGatewayClientResolvedConfig> {
|
|
36
45
|
readonly input: DeleteTapePoolCommandInput;
|
|
@@ -41,6 +41,31 @@ export interface DeleteVolumeCommandOutput extends DeleteVolumeOutput, __Metadat
|
|
|
41
41
|
* @see {@link DeleteVolumeCommandOutput} 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 delete a gateway volume
|
|
54
|
+
* ```javascript
|
|
55
|
+
* // Deletes the specified gateway volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API.
|
|
56
|
+
* const input = {
|
|
57
|
+
* "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
|
|
58
|
+
* };
|
|
59
|
+
* const command = new DeleteVolumeCommand(input);
|
|
60
|
+
* const response = await client.send(command);
|
|
61
|
+
* /* response ==
|
|
62
|
+
* {
|
|
63
|
+
* "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
|
|
64
|
+
* }
|
|
65
|
+
* *\/
|
|
66
|
+
* // example id: to-delete-a-gateway-volume-1471384418416
|
|
67
|
+
* ```
|
|
68
|
+
*
|
|
44
69
|
*/
|
|
45
70
|
export declare class DeleteVolumeCommand extends $Command<DeleteVolumeCommandInput, DeleteVolumeCommandOutput, StorageGatewayClientResolvedConfig> {
|
|
46
71
|
readonly input: DeleteVolumeCommandInput;
|
|
@@ -31,6 +31,15 @@ export interface DescribeAvailabilityMonitorTestCommandOutput extends DescribeAv
|
|
|
31
31
|
* @see {@link DescribeAvailabilityMonitorTestCommandOutput} 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 DescribeAvailabilityMonitorTestCommand extends $Command<DescribeAvailabilityMonitorTestCommandInput, DescribeAvailabilityMonitorTestCommandOutput, StorageGatewayClientResolvedConfig> {
|
|
36
45
|
readonly input: DescribeAvailabilityMonitorTestCommandInput;
|
|
@@ -37,6 +37,33 @@ export interface DescribeBandwidthRateLimitCommandOutput extends DescribeBandwid
|
|
|
37
37
|
* @see {@link DescribeBandwidthRateLimitCommandOutput} 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 describe the bandwidth rate limits of a gateway
|
|
50
|
+
* ```javascript
|
|
51
|
+
* // Returns a value for a bandwidth rate limit if set. If not set, then only the gateway ARN is returned.
|
|
52
|
+
* const input = {
|
|
53
|
+
* "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
|
|
54
|
+
* };
|
|
55
|
+
* const command = new DescribeBandwidthRateLimitCommand(input);
|
|
56
|
+
* const response = await client.send(command);
|
|
57
|
+
* /* response ==
|
|
58
|
+
* {
|
|
59
|
+
* "AverageDownloadRateLimitInBitsPerSec": 204800,
|
|
60
|
+
* "AverageUploadRateLimitInBitsPerSec": 102400,
|
|
61
|
+
* "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
|
|
62
|
+
* }
|
|
63
|
+
* *\/
|
|
64
|
+
* // example id: to-describe-the-bandwidth-rate-limits-of-a-gateway-1471384826404
|
|
65
|
+
* ```
|
|
66
|
+
*
|
|
40
67
|
*/
|
|
41
68
|
export declare class DescribeBandwidthRateLimitCommand extends $Command<DescribeBandwidthRateLimitCommandInput, DescribeBandwidthRateLimitCommandOutput, StorageGatewayClientResolvedConfig> {
|
|
42
69
|
readonly input: DescribeBandwidthRateLimitCommandInput;
|
|
@@ -45,6 +45,15 @@ export interface DescribeBandwidthRateLimitScheduleCommandOutput extends Describ
|
|
|
45
45
|
* @see {@link DescribeBandwidthRateLimitScheduleCommandOutput} 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 DescribeBandwidthRateLimitScheduleCommand extends $Command<DescribeBandwidthRateLimitScheduleCommandInput, DescribeBandwidthRateLimitScheduleCommandOutput, StorageGatewayClientResolvedConfig> {
|
|
50
59
|
readonly input: DescribeBandwidthRateLimitScheduleCommandInput;
|
|
@@ -33,6 +33,40 @@ export interface DescribeCacheCommandOutput extends DescribeCacheOutput, __Metad
|
|
|
33
33
|
* @see {@link DescribeCacheCommandOutput} 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 describe cache information
|
|
46
|
+
* ```javascript
|
|
47
|
+
* // Returns information about the cache of a gateway.
|
|
48
|
+
* const input = {
|
|
49
|
+
* "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
|
|
50
|
+
* };
|
|
51
|
+
* const command = new DescribeCacheCommand(input);
|
|
52
|
+
* const response = await client.send(command);
|
|
53
|
+
* /* response ==
|
|
54
|
+
* {
|
|
55
|
+
* "CacheAllocatedInBytes": 2199023255552,
|
|
56
|
+
* "CacheDirtyPercentage": 0.07,
|
|
57
|
+
* "CacheHitPercentage": 99.68,
|
|
58
|
+
* "CacheMissPercentage": 0.32,
|
|
59
|
+
* "CacheUsedPercentage": 0.07,
|
|
60
|
+
* "DiskIds": [
|
|
61
|
+
* "pci-0000:03:00.0-scsi-0:0:0:0",
|
|
62
|
+
* "pci-0000:04:00.0-scsi-0:1:0:0"
|
|
63
|
+
* ],
|
|
64
|
+
* "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
|
|
65
|
+
* }
|
|
66
|
+
* *\/
|
|
67
|
+
* // example id: to-describe-cache-information-1471385756036
|
|
68
|
+
* ```
|
|
69
|
+
*
|
|
36
70
|
*/
|
|
37
71
|
export declare class DescribeCacheCommand extends $Command<DescribeCacheCommandInput, DescribeCacheCommandOutput, StorageGatewayClientResolvedConfig> {
|
|
38
72
|
readonly input: DescribeCacheCommandInput;
|
|
@@ -34,6 +34,48 @@ export interface DescribeCachediSCSIVolumesCommandOutput extends DescribeCachedi
|
|
|
34
34
|
* @see {@link DescribeCachediSCSIVolumesCommandOutput} for command's `response` shape.
|
|
35
35
|
* @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape.
|
|
36
36
|
*
|
|
37
|
+
* @throws {@link InternalServerError} (server fault)
|
|
38
|
+
* <p>An internal server error has occurred during the request. For more information, see the
|
|
39
|
+
* error and message fields.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link InvalidGatewayRequestException} (client fault)
|
|
42
|
+
* <p>An exception occurred because an invalid gateway request was issued to the service. For
|
|
43
|
+
* more information, see the error and message fields.</p>
|
|
44
|
+
*
|
|
45
|
+
*
|
|
46
|
+
* @example To describe gateway cached iSCSI volumes
|
|
47
|
+
* ```javascript
|
|
48
|
+
* // Returns a description of the gateway cached iSCSI volumes specified in the request.
|
|
49
|
+
* const input = {
|
|
50
|
+
* "VolumeARNs": [
|
|
51
|
+
* "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
|
|
52
|
+
* ]
|
|
53
|
+
* };
|
|
54
|
+
* const command = new DescribeCachediSCSIVolumesCommand(input);
|
|
55
|
+
* const response = await client.send(command);
|
|
56
|
+
* /* response ==
|
|
57
|
+
* {
|
|
58
|
+
* "CachediSCSIVolumes": [
|
|
59
|
+
* {
|
|
60
|
+
* "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
|
|
61
|
+
* "VolumeId": "vol-1122AABB",
|
|
62
|
+
* "VolumeSizeInBytes": 1099511627776,
|
|
63
|
+
* "VolumeStatus": "AVAILABLE",
|
|
64
|
+
* "VolumeType": "CACHED iSCSI",
|
|
65
|
+
* "VolumeiSCSIAttributes": {
|
|
66
|
+
* "ChapEnabled": true,
|
|
67
|
+
* "LunNumber": 1,
|
|
68
|
+
* "NetworkInterfaceId": "10.243.43.207",
|
|
69
|
+
* "NetworkInterfacePort": 3260,
|
|
70
|
+
* "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
|
|
71
|
+
* }
|
|
72
|
+
* }
|
|
73
|
+
* ]
|
|
74
|
+
* }
|
|
75
|
+
* *\/
|
|
76
|
+
* // example id: to-describe-gateway-cached-iscsi-volumes-1471458094649
|
|
77
|
+
* ```
|
|
78
|
+
*
|
|
37
79
|
*/
|
|
38
80
|
export declare class DescribeCachediSCSIVolumesCommand extends $Command<DescribeCachediSCSIVolumesCommandInput, DescribeCachediSCSIVolumesCommandOutput, StorageGatewayClientResolvedConfig> {
|
|
39
81
|
readonly input: DescribeCachediSCSIVolumesCommandInput;
|
|
@@ -31,6 +31,38 @@ export interface DescribeChapCredentialsCommandOutput extends DescribeChapCreden
|
|
|
31
31
|
* @see {@link DescribeChapCredentialsCommandOutput} 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 describe CHAP credetnitals for an iSCSI
|
|
44
|
+
* ```javascript
|
|
45
|
+
* // Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.
|
|
46
|
+
* const input = {
|
|
47
|
+
* "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
|
|
48
|
+
* };
|
|
49
|
+
* const command = new DescribeChapCredentialsCommand(input);
|
|
50
|
+
* const response = await client.send(command);
|
|
51
|
+
* /* response ==
|
|
52
|
+
* {
|
|
53
|
+
* "ChapCredentials": [
|
|
54
|
+
* {
|
|
55
|
+
* "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com",
|
|
56
|
+
* "SecretToAuthenticateInitiator": "111111111111",
|
|
57
|
+
* "SecretToAuthenticateTarget": "222222222222",
|
|
58
|
+
* "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume"
|
|
59
|
+
* }
|
|
60
|
+
* ]
|
|
61
|
+
* }
|
|
62
|
+
* *\/
|
|
63
|
+
* // example id: to-describe-chap-credetnitals-for-an-iscsi-1471467462967
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
34
66
|
*/
|
|
35
67
|
export declare class DescribeChapCredentialsCommand extends $Command<DescribeChapCredentialsCommandInput, DescribeChapCredentialsCommandOutput, StorageGatewayClientResolvedConfig> {
|
|
36
68
|
readonly input: DescribeChapCredentialsCommandInput;
|
|
@@ -30,6 +30,15 @@ export interface DescribeFileSystemAssociationsCommandOutput extends DescribeFil
|
|
|
30
30
|
* @see {@link DescribeFileSystemAssociationsCommandOutput} 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 DescribeFileSystemAssociationsCommand extends $Command<DescribeFileSystemAssociationsCommandInput, DescribeFileSystemAssociationsCommandOutput, StorageGatewayClientResolvedConfig> {
|
|
35
44
|
readonly input: DescribeFileSystemAssociationsCommandInput;
|
|
@@ -31,6 +31,43 @@ export interface DescribeGatewayInformationCommandOutput extends DescribeGateway
|
|
|
31
31
|
* @see {@link DescribeGatewayInformationCommandOutput} 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 describe metadata about the gateway
|
|
44
|
+
* ```javascript
|
|
45
|
+
* // Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not).
|
|
46
|
+
* const input = {
|
|
47
|
+
* "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
|
|
48
|
+
* };
|
|
49
|
+
* const command = new DescribeGatewayInformationCommand(input);
|
|
50
|
+
* const response = await client.send(command);
|
|
51
|
+
* /* response ==
|
|
52
|
+
* {
|
|
53
|
+
* "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
|
54
|
+
* "GatewayId": "sgw-AABB1122",
|
|
55
|
+
* "GatewayName": "My_Gateway",
|
|
56
|
+
* "GatewayNetworkInterfaces": [
|
|
57
|
+
* {
|
|
58
|
+
* "Ipv4Address": "10.35.69.216"
|
|
59
|
+
* }
|
|
60
|
+
* ],
|
|
61
|
+
* "GatewayState": "STATE_RUNNING",
|
|
62
|
+
* "GatewayTimezone": "GMT-8:00",
|
|
63
|
+
* "GatewayType": "STORED",
|
|
64
|
+
* "LastSoftwareUpdate": "2016-01-02T16:00:00",
|
|
65
|
+
* "NextUpdateAvailabilityDate": "2017-01-02T16:00:00"
|
|
66
|
+
* }
|
|
67
|
+
* *\/
|
|
68
|
+
* // example id: to-describe-metadata-about-the-gateway-1471467849079
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
34
71
|
*/
|
|
35
72
|
export declare class DescribeGatewayInformationCommand extends $Command<DescribeGatewayInformationCommandInput, DescribeGatewayInformationCommandOutput, StorageGatewayClientResolvedConfig> {
|
|
36
73
|
readonly input: DescribeGatewayInformationCommandInput;
|
|
@@ -30,6 +30,35 @@ export interface DescribeMaintenanceStartTimeCommandOutput extends DescribeMaint
|
|
|
30
30
|
* @see {@link DescribeMaintenanceStartTimeCommandOutput} 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 describe gateway's maintenance start time
|
|
43
|
+
* ```javascript
|
|
44
|
+
* // Returns your gateway's weekly maintenance start time including the day and time of the week.
|
|
45
|
+
* const input = {
|
|
46
|
+
* "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
|
|
47
|
+
* };
|
|
48
|
+
* const command = new DescribeMaintenanceStartTimeCommand(input);
|
|
49
|
+
* const response = await client.send(command);
|
|
50
|
+
* /* response ==
|
|
51
|
+
* {
|
|
52
|
+
* "DayOfWeek": 2,
|
|
53
|
+
* "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
|
|
54
|
+
* "HourOfDay": 15,
|
|
55
|
+
* "MinuteOfHour": 35,
|
|
56
|
+
* "Timezone": "GMT+7:00"
|
|
57
|
+
* }
|
|
58
|
+
* *\/
|
|
59
|
+
* // example id: to-describe-gateways-maintenance-start-time-1471470727387
|
|
60
|
+
* ```
|
|
61
|
+
*
|
|
33
62
|
*/
|
|
34
63
|
export declare class DescribeMaintenanceStartTimeCommand extends $Command<DescribeMaintenanceStartTimeCommandInput, DescribeMaintenanceStartTimeCommandOutput, StorageGatewayClientResolvedConfig> {
|
|
35
64
|
readonly input: DescribeMaintenanceStartTimeCommandInput;
|
|
@@ -30,6 +30,15 @@ export interface DescribeNFSFileSharesCommandOutput extends DescribeNFSFileShare
|
|
|
30
30
|
* @see {@link DescribeNFSFileSharesCommandOutput} 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 DescribeNFSFileSharesCommand extends $Command<DescribeNFSFileSharesCommandInput, DescribeNFSFileSharesCommandOutput, StorageGatewayClientResolvedConfig> {
|
|
35
44
|
readonly input: DescribeNFSFileSharesCommandInput;
|
|
@@ -30,6 +30,15 @@ export interface DescribeSMBFileSharesCommandOutput extends DescribeSMBFileShare
|
|
|
30
30
|
* @see {@link DescribeSMBFileSharesCommandOutput} 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 DescribeSMBFileSharesCommand extends $Command<DescribeSMBFileSharesCommandInput, DescribeSMBFileSharesCommandOutput, StorageGatewayClientResolvedConfig> {
|
|
35
44
|
readonly input: DescribeSMBFileSharesCommandInput;
|
|
@@ -30,6 +30,15 @@ export interface DescribeSMBSettingsCommandOutput extends DescribeSMBSettingsOut
|
|
|
30
30
|
* @see {@link DescribeSMBSettingsCommandOutput} 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 DescribeSMBSettingsCommand extends $Command<DescribeSMBSettingsCommandInput, DescribeSMBSettingsCommandOutput, StorageGatewayClientResolvedConfig> {
|
|
35
44
|
readonly input: DescribeSMBSettingsCommandInput;
|
|
@@ -32,6 +32,35 @@ export interface DescribeSnapshotScheduleCommandOutput extends DescribeSnapshotS
|
|
|
32
32
|
* @see {@link DescribeSnapshotScheduleCommandOutput} 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
|
+
*
|
|
44
|
+
* @example To describe snapshot schedule for gateway volume
|
|
45
|
+
* ```javascript
|
|
46
|
+
* // Describes the snapshot schedule for the specified gateway volume including intervals at which snapshots are automatically initiated.
|
|
47
|
+
* const input = {
|
|
48
|
+
* "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
|
|
49
|
+
* };
|
|
50
|
+
* const command = new DescribeSnapshotScheduleCommand(input);
|
|
51
|
+
* const response = await client.send(command);
|
|
52
|
+
* /* response ==
|
|
53
|
+
* {
|
|
54
|
+
* "Description": "sgw-AABB1122:vol-AABB1122:Schedule",
|
|
55
|
+
* "RecurrenceInHours": 24,
|
|
56
|
+
* "StartAt": 6,
|
|
57
|
+
* "Timezone": "GMT+7:00",
|
|
58
|
+
* "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
|
|
59
|
+
* }
|
|
60
|
+
* *\/
|
|
61
|
+
* // example id: to-describe-snapshot-schedule-for-gateway-volume-1471471139538
|
|
62
|
+
* ```
|
|
63
|
+
*
|
|
35
64
|
*/
|
|
36
65
|
export declare class DescribeSnapshotScheduleCommand extends $Command<DescribeSnapshotScheduleCommandInput, DescribeSnapshotScheduleCommandOutput, StorageGatewayClientResolvedConfig> {
|
|
37
66
|
readonly input: DescribeSnapshotScheduleCommandInput;
|