@aws-sdk/client-storage-gateway 3.315.0 → 3.316.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.
@@ -90,1365 +90,618 @@ import { UpdateSMBSecurityStrategyCommandInput, UpdateSMBSecurityStrategyCommand
90
90
  import { UpdateSnapshotScheduleCommandInput, UpdateSnapshotScheduleCommandOutput } from "./commands/UpdateSnapshotScheduleCommand";
91
91
  import { UpdateVTLDeviceTypeCommandInput, UpdateVTLDeviceTypeCommandOutput } from "./commands/UpdateVTLDeviceTypeCommand";
92
92
  import { StorageGatewayClient } from "./StorageGatewayClient";
93
- /**
94
- * @public
95
- * <fullname>Storage Gateway Service</fullname>
96
- *
97
- * <p>Storage Gateway is the service that connects an on-premises software appliance
98
- * with cloud-based storage to provide seamless and secure integration between an
99
- * organization's on-premises IT environment and the Amazon Web Services storage
100
- * infrastructure. The service enables you to securely upload data to the Amazon Web Services Cloud for cost effective backup and rapid disaster recovery.</p>
101
- *
102
- * <p>Use the following links to get started using the <i>Storage Gateway
103
- * Service API Reference</i>:</p>
104
- *
105
- * <ul>
106
- * <li>
107
- * <p>
108
- * <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewayHTTPRequestsHeaders">Storage Gateway required request headers</a>: Describes the required
109
- * headers that you must send with every POST request to Storage Gateway.</p>
110
- * </li>
111
- * <li>
112
- * <p>
113
- * <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewaySigningRequests">Signing requests</a>: Storage Gateway requires that you authenticate
114
- * every request you send; this topic describes how sign such a request.</p>
115
- * </li>
116
- * <li>
117
- * <p>
118
- * <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#APIErrorResponses">Error responses</a>: Provides reference information about Storage Gateway errors.</p>
119
- * </li>
120
- * <li>
121
- * <p>
122
- * <a href="https://docs.aws.amazon.com/storagegateway/latest/APIReference/API_Operations.html">Operations in Storage Gateway</a>: Contains detailed descriptions of all Storage Gateway operations, their request parameters, response elements, possible errors, and
123
- * examples of requests and responses.</p>
124
- * </li>
125
- * <li>
126
- * <p>
127
- * <a href="https://docs.aws.amazon.com/general/latest/gr/sg.html">Storage Gateway
128
- * endpoints and quotas</a>: Provides a list of each Amazon Web Services Region
129
- * and the endpoints available for use with Storage Gateway.</p>
130
- * </li>
131
- * </ul>
132
- *
133
- * <note>
134
- * <p>Storage Gateway resource IDs are in uppercase. When you use these resource IDs
135
- * with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change
136
- * your resource ID to lowercase to use it with the EC2 API. For example, in Storage
137
- * Gateway the ID for a volume might be <code>vol-AA22BB012345DAF670</code>. When you use
138
- * this ID with the EC2 API, you must change it to <code>vol-aa22bb012345daf670</code>.
139
- * Otherwise, the EC2 API might not behave as expected.</p>
140
- * </note>
141
- *
142
- * <important>
143
- * <p>IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway
144
- * volumes are changing to a longer format. Starting in December 2016, all new volumes and
145
- * snapshots will be created with a 17-character string. Starting in April 2016, you will
146
- * be able to use these longer IDs so you can test your systems with the new format. For
147
- * more information, see <a href="http://aws.amazon.com/ec2/faqs/#longer-ids">Longer EC2 and
148
- * EBS resource IDs</a>.</p>
149
- *
150
- * <p>For example, a volume Amazon Resource Name (ARN) with the longer volume ID format
151
- * looks like the following:</p>
152
- *
153
- * <p>
154
- * <code>arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG</code>.</p>
155
- *
156
- * <p>A snapshot ID with the longer ID format looks like the following:
157
- * <code>snap-78e226633445566ee</code>.</p>
158
- *
159
- * <p>For more information, see <a href="http://forums.aws.amazon.com/ann.jspa?annID=3557">Announcement:
160
- * Heads-up – Longer Storage Gateway volume and snapshot IDs coming in
161
- * 2016</a>.</p>
162
- * </important>
163
- */
164
- export declare class StorageGateway extends StorageGatewayClient {
165
- /**
166
- * @public
167
- * <p>Activates the gateway you previously deployed on your host. In the activation process,
168
- * you specify information such as the Amazon Web Services Region that you want to use for
169
- * storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot
170
- * schedule window, an activation key, and a name for your gateway. The activation process
171
- * also associates your gateway with your account. For more information, see <a>UpdateGatewayInformation</a>.</p>
172
- * <note>
173
- * <p>You must turn on the gateway VM before you can activate your gateway.</p>
174
- * </note>
93
+ export interface StorageGateway {
94
+ /**
95
+ * @see {@link ActivateGatewayCommand}
175
96
  */
176
97
  activateGateway(args: ActivateGatewayCommandInput, options?: __HttpHandlerOptions): Promise<ActivateGatewayCommandOutput>;
177
98
  activateGateway(args: ActivateGatewayCommandInput, cb: (err: any, data?: ActivateGatewayCommandOutput) => void): void;
178
99
  activateGateway(args: ActivateGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ActivateGatewayCommandOutput) => void): void;
179
100
  /**
180
- * @public
181
- * <p>Configures one or more gateway local disks as cache for a gateway. This operation is
182
- * only supported in the cached volume, tape, and file gateway type (see <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/StorageGatewayConcepts.html">How Storage Gateway works (architecture)</a>.</p>
183
- *
184
- * <p>In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to
185
- * add cache, and one or more disk IDs that you want to configure as cache.</p>
101
+ * @see {@link AddCacheCommand}
186
102
  */
187
103
  addCache(args: AddCacheCommandInput, options?: __HttpHandlerOptions): Promise<AddCacheCommandOutput>;
188
104
  addCache(args: AddCacheCommandInput, cb: (err: any, data?: AddCacheCommandOutput) => void): void;
189
105
  addCache(args: AddCacheCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddCacheCommandOutput) => void): void;
190
106
  /**
191
- * @public
192
- * <p>Adds one or more tags to the specified resource. You use tags to add metadata to
193
- * resources, which you can use to categorize these resources. For example, you can categorize
194
- * resources by purpose, owner, environment, or team. Each tag consists of a key and a value,
195
- * which you define. You can add tags to the following Storage Gateway resources:</p>
196
- *
197
- * <ul>
198
- * <li>
199
- * <p>Storage gateways of all types</p>
200
- * </li>
201
- * <li>
202
- * <p>Storage volumes</p>
203
- * </li>
204
- * <li>
205
- * <p>Virtual tapes</p>
206
- * </li>
207
- * <li>
208
- * <p>NFS and SMB file shares</p>
209
- * </li>
210
- * <li>
211
- * <p>File System associations</p>
212
- * </li>
213
- * </ul>
214
- *
215
- * <p>You can create a maximum of 50 tags for each resource. Virtual tapes and storage volumes
216
- * that are recovered to a new gateway maintain their tags.</p>
107
+ * @see {@link AddTagsToResourceCommand}
217
108
  */
218
109
  addTagsToResource(args: AddTagsToResourceCommandInput, options?: __HttpHandlerOptions): Promise<AddTagsToResourceCommandOutput>;
219
110
  addTagsToResource(args: AddTagsToResourceCommandInput, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void): void;
220
111
  addTagsToResource(args: AddTagsToResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void): void;
221
112
  /**
222
- * @public
223
- * <p>Configures one or more gateway local disks as upload buffer for a specified gateway.
224
- * This operation is supported for the stored volume, cached volume, and tape gateway
225
- * types.</p>
226
- *
227
- * <p>In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to
228
- * add upload buffer, and one or more disk IDs that you want to configure as upload
229
- * buffer.</p>
113
+ * @see {@link AddUploadBufferCommand}
230
114
  */
231
115
  addUploadBuffer(args: AddUploadBufferCommandInput, options?: __HttpHandlerOptions): Promise<AddUploadBufferCommandOutput>;
232
116
  addUploadBuffer(args: AddUploadBufferCommandInput, cb: (err: any, data?: AddUploadBufferCommandOutput) => void): void;
233
117
  addUploadBuffer(args: AddUploadBufferCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddUploadBufferCommandOutput) => void): void;
234
118
  /**
235
- * @public
236
- * <p>Configures one or more gateway local disks as working storage for a gateway. This
237
- * operation is only supported in the stored volume gateway type. This operation is deprecated
238
- * in cached volume API version 20120630. Use <a>AddUploadBuffer</a>
239
- * instead.</p>
240
- *
241
- * <note>
242
- * <p>Working storage is also referred to as upload buffer. You can also use the <a>AddUploadBuffer</a> operation to add upload buffer to a stored volume
243
- * gateway.</p>
244
- * </note>
245
- *
246
- * <p>In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to
247
- * add working storage, and one or more disk IDs that you want to configure as working
248
- * storage.</p>
119
+ * @see {@link AddWorkingStorageCommand}
249
120
  */
250
121
  addWorkingStorage(args: AddWorkingStorageCommandInput, options?: __HttpHandlerOptions): Promise<AddWorkingStorageCommandOutput>;
251
122
  addWorkingStorage(args: AddWorkingStorageCommandInput, cb: (err: any, data?: AddWorkingStorageCommandOutput) => void): void;
252
123
  addWorkingStorage(args: AddWorkingStorageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddWorkingStorageCommandOutput) => void): void;
253
124
  /**
254
- * @public
255
- * <p>Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in
256
- * the S3 storage class that is associated with the pool. When you use your backup application
257
- * to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or
258
- * S3 Glacier Deep Archive) that corresponds to the pool.</p>
125
+ * @see {@link AssignTapePoolCommand}
259
126
  */
260
127
  assignTapePool(args: AssignTapePoolCommandInput, options?: __HttpHandlerOptions): Promise<AssignTapePoolCommandOutput>;
261
128
  assignTapePool(args: AssignTapePoolCommandInput, cb: (err: any, data?: AssignTapePoolCommandOutput) => void): void;
262
129
  assignTapePool(args: AssignTapePoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssignTapePoolCommandOutput) => void): void;
263
130
  /**
264
- * @public
265
- * <p>Associate an Amazon FSx file system with the FSx File Gateway. After the
266
- * association process is complete, the file shares on the Amazon FSx file system are
267
- * available for access through the gateway. This operation only supports the FSx File Gateway
268
- * type.</p>
131
+ * @see {@link AssociateFileSystemCommand}
269
132
  */
270
133
  associateFileSystem(args: AssociateFileSystemCommandInput, options?: __HttpHandlerOptions): Promise<AssociateFileSystemCommandOutput>;
271
134
  associateFileSystem(args: AssociateFileSystemCommandInput, cb: (err: any, data?: AssociateFileSystemCommandOutput) => void): void;
272
135
  associateFileSystem(args: AssociateFileSystemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateFileSystemCommandOutput) => void): void;
273
136
  /**
274
- * @public
275
- * <p>Connects a volume to an iSCSI connection and then attaches the volume to the specified
276
- * gateway. Detaching and attaching a volume enables you to recover your data from one gateway
277
- * to a different gateway without creating a snapshot. It also makes it easier to move your
278
- * volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance.</p>
137
+ * @see {@link AttachVolumeCommand}
279
138
  */
280
139
  attachVolume(args: AttachVolumeCommandInput, options?: __HttpHandlerOptions): Promise<AttachVolumeCommandOutput>;
281
140
  attachVolume(args: AttachVolumeCommandInput, cb: (err: any, data?: AttachVolumeCommandOutput) => void): void;
282
141
  attachVolume(args: AttachVolumeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachVolumeCommandOutput) => void): void;
283
142
  /**
284
- * @public
285
- * <p>Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving
286
- * process is initiated. This operation is only supported in the tape gateway type.</p>
143
+ * @see {@link CancelArchivalCommand}
287
144
  */
288
145
  cancelArchival(args: CancelArchivalCommandInput, options?: __HttpHandlerOptions): Promise<CancelArchivalCommandOutput>;
289
146
  cancelArchival(args: CancelArchivalCommandInput, cb: (err: any, data?: CancelArchivalCommandOutput) => void): void;
290
147
  cancelArchival(args: CancelArchivalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelArchivalCommandOutput) => void): void;
291
148
  /**
292
- * @public
293
- * <p>Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after
294
- * the retrieval process is initiated. The virtual tape is returned to the VTS. This operation
295
- * is only supported in the tape gateway type.</p>
149
+ * @see {@link CancelRetrievalCommand}
296
150
  */
297
151
  cancelRetrieval(args: CancelRetrievalCommandInput, options?: __HttpHandlerOptions): Promise<CancelRetrievalCommandOutput>;
298
152
  cancelRetrieval(args: CancelRetrievalCommandInput, cb: (err: any, data?: CancelRetrievalCommandOutput) => void): void;
299
153
  cancelRetrieval(args: CancelRetrievalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelRetrievalCommandOutput) => void): void;
300
154
  /**
301
- * @public
302
- * <p>Creates a cached volume on a specified cached volume gateway. This operation is only
303
- * supported in the cached volume gateway type.</p>
304
- *
305
- * <note>
306
- * <p>Cache storage must be allocated to the gateway before you can create a cached volume.
307
- * Use the <a>AddCache</a> operation to add cache storage to a gateway.</p>
308
- * </note>
309
- *
310
- * <p>In the request, you must specify the gateway, size of the volume in bytes, the iSCSI
311
- * target name, an IP address on which to expose the target, and a unique client token. In
312
- * response, the gateway creates the volume and returns information about it. This information
313
- * includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that
314
- * initiators can use to connect to the volume target.</p>
315
- *
316
- * <p>Optionally, you can provide the ARN for an existing volume as the
317
- * <code>SourceVolumeARN</code> for this cached volume, which creates an exact copy of the
318
- * existing volume’s latest recovery point. The <code>VolumeSizeInBytes</code> value must be
319
- * equal to or larger than the size of the copied volume, in bytes.</p>
155
+ * @see {@link CreateCachediSCSIVolumeCommand}
320
156
  */
321
157
  createCachediSCSIVolume(args: CreateCachediSCSIVolumeCommandInput, options?: __HttpHandlerOptions): Promise<CreateCachediSCSIVolumeCommandOutput>;
322
158
  createCachediSCSIVolume(args: CreateCachediSCSIVolumeCommandInput, cb: (err: any, data?: CreateCachediSCSIVolumeCommandOutput) => void): void;
323
159
  createCachediSCSIVolume(args: CreateCachediSCSIVolumeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCachediSCSIVolumeCommandOutput) => void): void;
324
160
  /**
325
- * @public
326
- * <p>Creates a Network File System (NFS) file share on an existing S3 File Gateway. In
327
- * Storage Gateway, a file share is a file system mount point backed by Amazon S3
328
- * cloud storage. Storage Gateway exposes file shares using an NFS interface. This operation
329
- * is only supported for S3 File Gateways.</p>
330
- *
331
- * <important>
332
- * <p>S3 File gateway requires Security Token Service (Amazon Web Services STS) to be
333
- * activated to enable you to create a file share. Make sure Amazon Web Services STS is
334
- * activated in the Amazon Web Services Region you are creating your S3 File Gateway in. If
335
- * Amazon Web Services STS is not activated in the Amazon Web Services Region, activate
336
- * it. For information about how to activate Amazon Web Services STS, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and
337
- * deactivating Amazon Web Services STS in an Amazon Web Services Region</a> in the
338
- * <i>Identity and Access Management User Guide</i>.</p>
339
- *
340
- * <p>S3 File Gateways do not support creating hard or symbolic links on a file
341
- * share.</p>
342
- * </important>
161
+ * @see {@link CreateNFSFileShareCommand}
343
162
  */
344
163
  createNFSFileShare(args: CreateNFSFileShareCommandInput, options?: __HttpHandlerOptions): Promise<CreateNFSFileShareCommandOutput>;
345
164
  createNFSFileShare(args: CreateNFSFileShareCommandInput, cb: (err: any, data?: CreateNFSFileShareCommandOutput) => void): void;
346
165
  createNFSFileShare(args: CreateNFSFileShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNFSFileShareCommandOutput) => void): void;
347
166
  /**
348
- * @public
349
- * <p>Creates a Server Message Block (SMB) file share on an existing S3 File Gateway. In
350
- * Storage Gateway, a file share is a file system mount point backed by Amazon S3
351
- * cloud storage. Storage Gateway exposes file shares using an SMB interface. This operation
352
- * is only supported for S3 File Gateways.</p>
353
- *
354
- * <important>
355
- * <p>S3 File Gateways require Security Token Service (Amazon Web Services STS) to be
356
- * activated to enable you to create a file share. Make sure that Amazon Web Services STS
357
- * is activated in the Amazon Web Services Region you are creating your S3 File Gateway in.
358
- * If Amazon Web Services STS is not activated in this Amazon Web Services Region, activate
359
- * it. For information about how to activate Amazon Web Services STS, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and
360
- * deactivating Amazon Web Services STS in an Amazon Web Services Region</a> in the
361
- * <i>Identity and Access Management User Guide</i>.</p>
362
- *
363
- * <p>File gateways don't support creating hard or symbolic links on a file
364
- * share.</p>
365
- * </important>
167
+ * @see {@link CreateSMBFileShareCommand}
366
168
  */
367
169
  createSMBFileShare(args: CreateSMBFileShareCommandInput, options?: __HttpHandlerOptions): Promise<CreateSMBFileShareCommandOutput>;
368
170
  createSMBFileShare(args: CreateSMBFileShareCommandInput, cb: (err: any, data?: CreateSMBFileShareCommandOutput) => void): void;
369
171
  createSMBFileShare(args: CreateSMBFileShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSMBFileShareCommandOutput) => void): void;
370
172
  /**
371
- * @public
372
- * <p>Initiates a snapshot of a volume.</p>
373
- *
374
- * <p>Storage Gateway provides the ability to back up point-in-time snapshots of your
375
- * data to Amazon Simple Storage (Amazon S3) for durable off-site recovery, and also
376
- * import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute
377
- * Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis.
378
- * This API enables you to take an ad hoc snapshot. For more information, see <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#SchedulingSnapshot">Editing a
379
- * snapshot schedule</a>.</p>
380
- *
381
- * <p>In the <code>CreateSnapshot</code> request, you identify the volume by providing its
382
- * Amazon Resource Name (ARN). You must also provide description for the snapshot. When
383
- * Storage Gateway takes the snapshot of specified volume, the snapshot and
384
- * description appears in the Storage Gateway console. In response, Storage Gateway
385
- * returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or
386
- * later use it when you want to create a volume from a snapshot. This operation is only
387
- * supported in stored and cached volume gateway type.</p>
388
- *
389
- * <note>
390
- * <p>To list or delete a snapshot, you must use the Amazon EC2 API. For more information,
391
- * see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html">DescribeSnapshots</a>
392
- * or <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html">DeleteSnapshot</a> in the <i>Amazon Elastic Compute Cloud API
393
- * Reference</i>.</p>
394
- * </note>
395
- *
396
- * <important>
397
- * <p>Volume and snapshot IDs are changing to a longer length ID format. For more
398
- * information, see the important note on the <a href="https://docs.aws.amazon.com/storagegateway/latest/APIReference/Welcome.html">Welcome</a> page.</p>
399
- * </important>
173
+ * @see {@link CreateSnapshotCommand}
400
174
  */
401
175
  createSnapshot(args: CreateSnapshotCommandInput, options?: __HttpHandlerOptions): Promise<CreateSnapshotCommandOutput>;
402
176
  createSnapshot(args: CreateSnapshotCommandInput, cb: (err: any, data?: CreateSnapshotCommandOutput) => void): void;
403
177
  createSnapshot(args: CreateSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSnapshotCommandOutput) => void): void;
404
178
  /**
405
- * @public
406
- * <p>Initiates a snapshot of a gateway from a volume recovery point. This operation is only
407
- * supported in the cached volume gateway type.</p>
408
- *
409
- * <p>A volume recovery point is a point in time at which all data of the volume is consistent
410
- * and from which you can create a snapshot. To get a list of volume recovery point for cached
411
- * volume gateway, use <a>ListVolumeRecoveryPoints</a>.</p>
412
- *
413
- * <p>In the <code>CreateSnapshotFromVolumeRecoveryPoint</code> request, you identify the
414
- * volume by providing its Amazon Resource Name (ARN). You must also provide a description for
415
- * the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and
416
- * its description appear in the Storage Gateway console.
417
- * In response, the gateway returns
418
- * you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use
419
- * it when you want to create a volume from a snapshot.</p>
420
- *
421
- * <note>
422
- * <p>To list or delete a snapshot, you must use the Amazon EC2 API. For more information,
423
- * see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html">DescribeSnapshots</a>
424
- * or <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html">DeleteSnapshot</a> in the <i>Amazon Elastic Compute Cloud API
425
- * Reference</i>.</p>
426
- * </note>
179
+ * @see {@link CreateSnapshotFromVolumeRecoveryPointCommand}
427
180
  */
428
181
  createSnapshotFromVolumeRecoveryPoint(args: CreateSnapshotFromVolumeRecoveryPointCommandInput, options?: __HttpHandlerOptions): Promise<CreateSnapshotFromVolumeRecoveryPointCommandOutput>;
429
182
  createSnapshotFromVolumeRecoveryPoint(args: CreateSnapshotFromVolumeRecoveryPointCommandInput, cb: (err: any, data?: CreateSnapshotFromVolumeRecoveryPointCommandOutput) => void): void;
430
183
  createSnapshotFromVolumeRecoveryPoint(args: CreateSnapshotFromVolumeRecoveryPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSnapshotFromVolumeRecoveryPointCommandOutput) => void): void;
431
184
  /**
432
- * @public
433
- * <p>Creates a volume on a specified gateway. This operation is only supported in the stored
434
- * volume gateway type.</p>
435
- *
436
- * <p>The size of the volume to create is inferred from the disk size. You can choose to
437
- * preserve existing data on the disk, create volume from an existing snapshot, or create an
438
- * empty volume. If you choose to create an empty gateway volume, then any existing data on
439
- * the disk is erased.</p>
440
- *
441
- * <p>In the request, you must specify the gateway and the disk information on which you are
442
- * creating the volume. In response, the gateway creates the volume and returns volume
443
- * information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target
444
- * ARN that initiators can use to connect to the volume target.</p>
185
+ * @see {@link CreateStorediSCSIVolumeCommand}
445
186
  */
446
187
  createStorediSCSIVolume(args: CreateStorediSCSIVolumeCommandInput, options?: __HttpHandlerOptions): Promise<CreateStorediSCSIVolumeCommandOutput>;
447
188
  createStorediSCSIVolume(args: CreateStorediSCSIVolumeCommandInput, cb: (err: any, data?: CreateStorediSCSIVolumeCommandOutput) => void): void;
448
189
  createStorediSCSIVolume(args: CreateStorediSCSIVolumeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStorediSCSIVolumeCommandOutput) => void): void;
449
190
  /**
450
- * @public
451
- * <p>Creates a new custom tape pool. You can use custom tape pool to enable tape retention
452
- * lock on tapes that are archived in the custom pool.</p>
191
+ * @see {@link CreateTapePoolCommand}
453
192
  */
454
193
  createTapePool(args: CreateTapePoolCommandInput, options?: __HttpHandlerOptions): Promise<CreateTapePoolCommandOutput>;
455
194
  createTapePool(args: CreateTapePoolCommandInput, cb: (err: any, data?: CreateTapePoolCommandOutput) => void): void;
456
195
  createTapePool(args: CreateTapePoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTapePoolCommandOutput) => void): void;
457
196
  /**
458
- * @public
459
- * <p>Creates one or more virtual tapes. You write data to the virtual tapes and then archive
460
- * the tapes. This operation is only supported in the tape gateway type.</p>
461
- *
462
- * <note>
463
- * <p>Cache storage must be allocated to the gateway before you can create virtual tapes.
464
- * Use the <a>AddCache</a> operation to add cache storage to a gateway.</p>
465
- * </note>
197
+ * @see {@link CreateTapesCommand}
466
198
  */
467
199
  createTapes(args: CreateTapesCommandInput, options?: __HttpHandlerOptions): Promise<CreateTapesCommandOutput>;
468
200
  createTapes(args: CreateTapesCommandInput, cb: (err: any, data?: CreateTapesCommandOutput) => void): void;
469
201
  createTapes(args: CreateTapesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTapesCommandOutput) => void): void;
470
202
  /**
471
- * @public
472
- * <p>Creates a virtual tape by using your own barcode. You write data to the virtual tape and
473
- * then archive the tape. A barcode is unique and cannot be reused if it has already been used
474
- * on a tape. This applies to barcodes used on deleted tapes. This operation is only supported
475
- * in the tape gateway type.</p>
476
- *
477
- * <note>
478
- * <p>Cache storage must be allocated to the gateway before you can create a virtual tape.
479
- * Use the <a>AddCache</a> operation to add cache storage to a gateway.</p>
480
- * </note>
203
+ * @see {@link CreateTapeWithBarcodeCommand}
481
204
  */
482
205
  createTapeWithBarcode(args: CreateTapeWithBarcodeCommandInput, options?: __HttpHandlerOptions): Promise<CreateTapeWithBarcodeCommandOutput>;
483
206
  createTapeWithBarcode(args: CreateTapeWithBarcodeCommandInput, cb: (err: any, data?: CreateTapeWithBarcodeCommandOutput) => void): void;
484
207
  createTapeWithBarcode(args: CreateTapeWithBarcodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTapeWithBarcodeCommandOutput) => void): void;
485
208
  /**
486
- * @public
487
- * <p>Deletes the automatic tape creation policy of a gateway. If you delete this policy, new
488
- * virtual tapes must be created manually. Use the Amazon Resource Name (ARN) of the gateway
489
- * in your request to remove the policy.</p>
209
+ * @see {@link DeleteAutomaticTapeCreationPolicyCommand}
490
210
  */
491
211
  deleteAutomaticTapeCreationPolicy(args: DeleteAutomaticTapeCreationPolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAutomaticTapeCreationPolicyCommandOutput>;
492
212
  deleteAutomaticTapeCreationPolicy(args: DeleteAutomaticTapeCreationPolicyCommandInput, cb: (err: any, data?: DeleteAutomaticTapeCreationPolicyCommandOutput) => void): void;
493
213
  deleteAutomaticTapeCreationPolicy(args: DeleteAutomaticTapeCreationPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAutomaticTapeCreationPolicyCommandOutput) => void): void;
494
214
  /**
495
- * @public
496
- * <p>Deletes the bandwidth rate limits of a gateway. You can delete either the upload and
497
- * download bandwidth rate limit, or you can delete both. If you delete only one of the
498
- * limits, the other limit remains unchanged. To specify which gateway to work with, use the
499
- * Amazon Resource Name (ARN) of the gateway in your request. This operation is supported only
500
- * for the stored volume, cached volume, and tape gateway types.</p>
215
+ * @see {@link DeleteBandwidthRateLimitCommand}
501
216
  */
502
217
  deleteBandwidthRateLimit(args: DeleteBandwidthRateLimitCommandInput, options?: __HttpHandlerOptions): Promise<DeleteBandwidthRateLimitCommandOutput>;
503
218
  deleteBandwidthRateLimit(args: DeleteBandwidthRateLimitCommandInput, cb: (err: any, data?: DeleteBandwidthRateLimitCommandOutput) => void): void;
504
219
  deleteBandwidthRateLimit(args: DeleteBandwidthRateLimitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBandwidthRateLimitCommandOutput) => void): void;
505
220
  /**
506
- * @public
507
- * <p>Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified
508
- * iSCSI target and initiator pair. This operation is supported in volume and tape gateway
509
- * types.</p>
221
+ * @see {@link DeleteChapCredentialsCommand}
510
222
  */
511
223
  deleteChapCredentials(args: DeleteChapCredentialsCommandInput, options?: __HttpHandlerOptions): Promise<DeleteChapCredentialsCommandOutput>;
512
224
  deleteChapCredentials(args: DeleteChapCredentialsCommandInput, cb: (err: any, data?: DeleteChapCredentialsCommandOutput) => void): void;
513
225
  deleteChapCredentials(args: DeleteChapCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChapCredentialsCommandOutput) => void): void;
514
226
  /**
515
- * @public
516
- * <p>Deletes a file share from an S3 File Gateway. This operation is only supported for S3
517
- * File Gateways.</p>
227
+ * @see {@link DeleteFileShareCommand}
518
228
  */
519
229
  deleteFileShare(args: DeleteFileShareCommandInput, options?: __HttpHandlerOptions): Promise<DeleteFileShareCommandOutput>;
520
230
  deleteFileShare(args: DeleteFileShareCommandInput, cb: (err: any, data?: DeleteFileShareCommandOutput) => void): void;
521
231
  deleteFileShare(args: DeleteFileShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFileShareCommandOutput) => void): void;
522
232
  /**
523
- * @public
524
- * <p>Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name
525
- * (ARN) of the gateway in your request. The operation deletes the gateway; however, it does
526
- * not delete the gateway virtual machine (VM) from your host computer.</p>
527
- *
528
- * <p>After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway
529
- * volumes are not deleted upon deleting the gateway, however, pending snapshots will not
530
- * complete. After you delete a gateway, your next step is to remove it from your
531
- * environment.</p>
532
- *
533
- * <important>
534
- * <p>You no longer pay software charges after the gateway is deleted; however, your
535
- * existing Amazon EBS snapshots persist and you will continue to be billed for these
536
- * snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your
537
- * Amazon EC2 subscription.  If you prefer not to cancel your Amazon EC2 subscription, you
538
- * can delete your snapshots using the Amazon EC2 console. For more information, see the
539
- * <a href="http://aws.amazon.com/storagegateway">Storage Gateway detail
540
- * page</a>.</p>
541
- * </important>
233
+ * @see {@link DeleteGatewayCommand}
542
234
  */
543
235
  deleteGateway(args: DeleteGatewayCommandInput, options?: __HttpHandlerOptions): Promise<DeleteGatewayCommandOutput>;
544
236
  deleteGateway(args: DeleteGatewayCommandInput, cb: (err: any, data?: DeleteGatewayCommandOutput) => void): void;
545
237
  deleteGateway(args: DeleteGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGatewayCommandOutput) => void): void;
546
238
  /**
547
- * @public
548
- * <p>Deletes a snapshot of a volume.</p>
549
- *
550
- * <p>You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API
551
- * action enables you to delete a snapshot schedule for a volume. For more information, see
552
- * <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/backing-up-volumes.html">Backing up your
553
- * volumes</a>. In the <code>DeleteSnapshotSchedule</code> request, you identify the
554
- * volume by providing its Amazon Resource Name (ARN). This operation is only supported for
555
- * cached volume gateway types.</p>
556
- *
557
- * <note>
558
- *
559
- * <p>To list or delete a snapshot, you must use the Amazon EC2 API. For more information,
560
- * go to <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html">DescribeSnapshots</a>
561
- * in the <i>Amazon Elastic Compute Cloud API Reference</i>.</p>
562
- * </note>
239
+ * @see {@link DeleteSnapshotScheduleCommand}
563
240
  */
564
241
  deleteSnapshotSchedule(args: DeleteSnapshotScheduleCommandInput, options?: __HttpHandlerOptions): Promise<DeleteSnapshotScheduleCommandOutput>;
565
242
  deleteSnapshotSchedule(args: DeleteSnapshotScheduleCommandInput, cb: (err: any, data?: DeleteSnapshotScheduleCommandOutput) => void): void;
566
243
  deleteSnapshotSchedule(args: DeleteSnapshotScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSnapshotScheduleCommandOutput) => void): void;
567
244
  /**
568
- * @public
569
- * <p>Deletes the specified virtual tape. This operation is only supported in the tape gateway
570
- * type.</p>
245
+ * @see {@link DeleteTapeCommand}
571
246
  */
572
247
  deleteTape(args: DeleteTapeCommandInput, options?: __HttpHandlerOptions): Promise<DeleteTapeCommandOutput>;
573
248
  deleteTape(args: DeleteTapeCommandInput, cb: (err: any, data?: DeleteTapeCommandOutput) => void): void;
574
249
  deleteTape(args: DeleteTapeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTapeCommandOutput) => void): void;
575
250
  /**
576
- * @public
577
- * <p>Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is
578
- * only supported in the tape gateway type.</p>
251
+ * @see {@link DeleteTapeArchiveCommand}
579
252
  */
580
253
  deleteTapeArchive(args: DeleteTapeArchiveCommandInput, options?: __HttpHandlerOptions): Promise<DeleteTapeArchiveCommandOutput>;
581
254
  deleteTapeArchive(args: DeleteTapeArchiveCommandInput, cb: (err: any, data?: DeleteTapeArchiveCommandOutput) => void): void;
582
255
  deleteTapeArchive(args: DeleteTapeArchiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTapeArchiveCommandOutput) => void): void;
583
256
  /**
584
- * @public
585
- * <p>Delete a custom tape pool. A custom tape pool can only be deleted if there are no tapes
586
- * in the pool and if there are no automatic tape creation policies that reference the custom
587
- * tape pool.</p>
257
+ * @see {@link DeleteTapePoolCommand}
588
258
  */
589
259
  deleteTapePool(args: DeleteTapePoolCommandInput, options?: __HttpHandlerOptions): Promise<DeleteTapePoolCommandOutput>;
590
260
  deleteTapePool(args: DeleteTapePoolCommandInput, cb: (err: any, data?: DeleteTapePoolCommandOutput) => void): void;
591
261
  deleteTapePool(args: DeleteTapePoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTapePoolCommandOutput) => void): void;
592
262
  /**
593
- * @public
594
- * <p>Deletes the specified storage volume that you previously created using the <a>CreateCachediSCSIVolume</a> or <a>CreateStorediSCSIVolume</a> API.
595
- * This operation is only supported in the cached volume and stored volume types. For stored
596
- * volume gateways, the local disk that was configured as the storage volume is not deleted.
597
- * You can reuse the local disk to create another storage volume.</p>
598
- *
599
- * <p>Before you delete a volume, make sure there are no iSCSI connections to the volume you
600
- * are deleting. You should also make sure there is no snapshot in progress. You can use the
601
- * Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are
602
- * deleting and check the snapshot status. For more information, go to <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html">DescribeSnapshots</a> in the <i>Amazon Elastic Compute Cloud API
603
- * Reference</i>.</p>
604
- *
605
- * <p>In the request, you must provide the Amazon Resource Name (ARN) of the storage volume
606
- * you want to delete.</p>
263
+ * @see {@link DeleteVolumeCommand}
607
264
  */
608
265
  deleteVolume(args: DeleteVolumeCommandInput, options?: __HttpHandlerOptions): Promise<DeleteVolumeCommandOutput>;
609
266
  deleteVolume(args: DeleteVolumeCommandInput, cb: (err: any, data?: DeleteVolumeCommandOutput) => void): void;
610
267
  deleteVolume(args: DeleteVolumeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVolumeCommandOutput) => void): void;
611
268
  /**
612
- * @public
613
- * <p>Returns information about the most recent high availability monitoring test that was
614
- * performed on the host in a cluster. If a test isn't performed, the status and start
615
- * time in the response would be null.</p>
269
+ * @see {@link DescribeAvailabilityMonitorTestCommand}
616
270
  */
617
271
  describeAvailabilityMonitorTest(args: DescribeAvailabilityMonitorTestCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAvailabilityMonitorTestCommandOutput>;
618
272
  describeAvailabilityMonitorTest(args: DescribeAvailabilityMonitorTestCommandInput, cb: (err: any, data?: DescribeAvailabilityMonitorTestCommandOutput) => void): void;
619
273
  describeAvailabilityMonitorTest(args: DescribeAvailabilityMonitorTestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAvailabilityMonitorTestCommandOutput) => void): void;
620
274
  /**
621
- * @public
622
- * <p>Returns the bandwidth rate limits of a gateway. By default, these limits are not set,
623
- * which means no bandwidth rate limiting is in effect. This operation is supported only for
624
- * the stored volume, cached volume, and tape gateway types. To describe bandwidth rate limits
625
- * for S3 file gateways, use <a>DescribeBandwidthRateLimitSchedule</a>.</p>
626
- *
627
- * <p>This operation returns a value for a bandwidth rate limit only if the limit is set. If
628
- * no limits are set for the gateway, then this operation returns only the gateway ARN in the
629
- * response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of
630
- * the gateway in your request.</p>
275
+ * @see {@link DescribeBandwidthRateLimitCommand}
631
276
  */
632
277
  describeBandwidthRateLimit(args: DescribeBandwidthRateLimitCommandInput, options?: __HttpHandlerOptions): Promise<DescribeBandwidthRateLimitCommandOutput>;
633
278
  describeBandwidthRateLimit(args: DescribeBandwidthRateLimitCommandInput, cb: (err: any, data?: DescribeBandwidthRateLimitCommandOutput) => void): void;
634
279
  describeBandwidthRateLimit(args: DescribeBandwidthRateLimitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBandwidthRateLimitCommandOutput) => void): void;
635
280
  /**
636
- * @public
637
- * <p> Returns information about the bandwidth rate limit schedule of a gateway. By default,
638
- * gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting
639
- * is in effect. This operation is supported only for volume, tape and S3 file gateways. FSx
640
- * file gateways do not support bandwidth rate limits.</p>
641
- *
642
- * <p>This operation returns information about a gateway's bandwidth rate limit schedule. A
643
- * bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A
644
- * bandwidth rate limit interval defines a period of time on one or more days of the week,
645
- * during which bandwidth rate limits are specified for uploading, downloading, or both. </p>
646
- *
647
- * <p> A bandwidth rate limit interval consists of one or more days of the week, a start hour
648
- * and minute, an ending hour and minute, and bandwidth rate limits for uploading and
649
- * downloading </p>
650
- *
651
- * <p> If no bandwidth rate limit schedule intervals are set for the gateway, this operation
652
- * returns an empty response. To specify which gateway to describe, use the Amazon Resource
653
- * Name (ARN) of the gateway in your request.</p>
281
+ * @see {@link DescribeBandwidthRateLimitScheduleCommand}
654
282
  */
655
283
  describeBandwidthRateLimitSchedule(args: DescribeBandwidthRateLimitScheduleCommandInput, options?: __HttpHandlerOptions): Promise<DescribeBandwidthRateLimitScheduleCommandOutput>;
656
284
  describeBandwidthRateLimitSchedule(args: DescribeBandwidthRateLimitScheduleCommandInput, cb: (err: any, data?: DescribeBandwidthRateLimitScheduleCommandOutput) => void): void;
657
285
  describeBandwidthRateLimitSchedule(args: DescribeBandwidthRateLimitScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBandwidthRateLimitScheduleCommandOutput) => void): void;
658
286
  /**
659
- * @public
660
- * <p>Returns information about the cache of a gateway. This operation is only supported in
661
- * the cached volume, tape, and file gateway types.</p>
662
- *
663
- * <p>The response includes disk IDs that are configured as cache, and it includes the amount
664
- * of cache allocated and used.</p>
287
+ * @see {@link DescribeCacheCommand}
665
288
  */
666
289
  describeCache(args: DescribeCacheCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCacheCommandOutput>;
667
290
  describeCache(args: DescribeCacheCommandInput, cb: (err: any, data?: DescribeCacheCommandOutput) => void): void;
668
291
  describeCache(args: DescribeCacheCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCacheCommandOutput) => void): void;
669
292
  /**
670
- * @public
671
- * <p>Returns a description of the gateway volumes specified in the request. This operation is
672
- * only supported in the cached volume gateway types.</p>
673
- *
674
- * <p>The list of gateway volumes in the request must be from one gateway. In the response,
675
- * Storage Gateway returns volume information sorted by volume Amazon Resource Name
676
- * (ARN).</p>
293
+ * @see {@link DescribeCachediSCSIVolumesCommand}
677
294
  */
678
295
  describeCachediSCSIVolumes(args: DescribeCachediSCSIVolumesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCachediSCSIVolumesCommandOutput>;
679
296
  describeCachediSCSIVolumes(args: DescribeCachediSCSIVolumesCommandInput, cb: (err: any, data?: DescribeCachediSCSIVolumesCommandOutput) => void): void;
680
297
  describeCachediSCSIVolumes(args: DescribeCachediSCSIVolumesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCachediSCSIVolumesCommandOutput) => void): void;
681
298
  /**
682
- * @public
683
- * <p>Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials
684
- * information for a specified iSCSI target, one for each target-initiator pair. This
685
- * operation is supported in the volume and tape gateway types.</p>
299
+ * @see {@link DescribeChapCredentialsCommand}
686
300
  */
687
301
  describeChapCredentials(args: DescribeChapCredentialsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeChapCredentialsCommandOutput>;
688
302
  describeChapCredentials(args: DescribeChapCredentialsCommandInput, cb: (err: any, data?: DescribeChapCredentialsCommandOutput) => void): void;
689
303
  describeChapCredentials(args: DescribeChapCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChapCredentialsCommandOutput) => void): void;
690
304
  /**
691
- * @public
692
- * <p>Gets the file system association information. This operation is only supported for FSx
693
- * File Gateways.</p>
305
+ * @see {@link DescribeFileSystemAssociationsCommand}
694
306
  */
695
307
  describeFileSystemAssociations(args: DescribeFileSystemAssociationsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFileSystemAssociationsCommandOutput>;
696
308
  describeFileSystemAssociations(args: DescribeFileSystemAssociationsCommandInput, cb: (err: any, data?: DescribeFileSystemAssociationsCommandOutput) => void): void;
697
309
  describeFileSystemAssociations(args: DescribeFileSystemAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFileSystemAssociationsCommandOutput) => void): void;
698
310
  /**
699
- * @public
700
- * <p>Returns metadata about a gateway such as its name, network interfaces, configured time
701
- * zone, and the state (whether the gateway is running or not). To specify which gateway to
702
- * describe, use the Amazon Resource Name (ARN) of the gateway in your request.</p>
311
+ * @see {@link DescribeGatewayInformationCommand}
703
312
  */
704
313
  describeGatewayInformation(args: DescribeGatewayInformationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeGatewayInformationCommandOutput>;
705
314
  describeGatewayInformation(args: DescribeGatewayInformationCommandInput, cb: (err: any, data?: DescribeGatewayInformationCommandOutput) => void): void;
706
315
  describeGatewayInformation(args: DescribeGatewayInformationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGatewayInformationCommandOutput) => void): void;
707
316
  /**
708
- * @public
709
- * <p>Returns your gateway's weekly maintenance start time including the day and time of
710
- * the week. Note that values are in terms of the gateway's time zone.</p>
317
+ * @see {@link DescribeMaintenanceStartTimeCommand}
711
318
  */
712
319
  describeMaintenanceStartTime(args: DescribeMaintenanceStartTimeCommandInput, options?: __HttpHandlerOptions): Promise<DescribeMaintenanceStartTimeCommandOutput>;
713
320
  describeMaintenanceStartTime(args: DescribeMaintenanceStartTimeCommandInput, cb: (err: any, data?: DescribeMaintenanceStartTimeCommandOutput) => void): void;
714
321
  describeMaintenanceStartTime(args: DescribeMaintenanceStartTimeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMaintenanceStartTimeCommandOutput) => void): void;
715
322
  /**
716
- * @public
717
- * <p>Gets a description for one or more Network File System (NFS) file shares from an S3 File
718
- * Gateway. This operation is only supported for S3 File Gateways.</p>
323
+ * @see {@link DescribeNFSFileSharesCommand}
719
324
  */
720
325
  describeNFSFileShares(args: DescribeNFSFileSharesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeNFSFileSharesCommandOutput>;
721
326
  describeNFSFileShares(args: DescribeNFSFileSharesCommandInput, cb: (err: any, data?: DescribeNFSFileSharesCommandOutput) => void): void;
722
327
  describeNFSFileShares(args: DescribeNFSFileSharesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeNFSFileSharesCommandOutput) => void): void;
723
328
  /**
724
- * @public
725
- * <p>Gets a description for one or more Server Message Block (SMB) file shares from a S3 File
726
- * Gateway. This operation is only supported for S3 File Gateways.</p>
329
+ * @see {@link DescribeSMBFileSharesCommand}
727
330
  */
728
331
  describeSMBFileShares(args: DescribeSMBFileSharesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSMBFileSharesCommandOutput>;
729
332
  describeSMBFileShares(args: DescribeSMBFileSharesCommandInput, cb: (err: any, data?: DescribeSMBFileSharesCommandOutput) => void): void;
730
333
  describeSMBFileShares(args: DescribeSMBFileSharesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSMBFileSharesCommandOutput) => void): void;
731
334
  /**
732
- * @public
733
- * <p>Gets a description of a Server Message Block (SMB) file share settings from a file
734
- * gateway. This operation is only supported for file gateways.</p>
335
+ * @see {@link DescribeSMBSettingsCommand}
735
336
  */
736
337
  describeSMBSettings(args: DescribeSMBSettingsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSMBSettingsCommandOutput>;
737
338
  describeSMBSettings(args: DescribeSMBSettingsCommandInput, cb: (err: any, data?: DescribeSMBSettingsCommandOutput) => void): void;
738
339
  describeSMBSettings(args: DescribeSMBSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSMBSettingsCommandOutput) => void): void;
739
340
  /**
740
- * @public
741
- * <p>Describes the snapshot schedule for the specified gateway volume. The snapshot schedule
742
- * information includes intervals at which snapshots are automatically initiated on the
743
- * volume. This operation is only supported in the cached volume and stored volume
744
- * types.</p>
341
+ * @see {@link DescribeSnapshotScheduleCommand}
745
342
  */
746
343
  describeSnapshotSchedule(args: DescribeSnapshotScheduleCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSnapshotScheduleCommandOutput>;
747
344
  describeSnapshotSchedule(args: DescribeSnapshotScheduleCommandInput, cb: (err: any, data?: DescribeSnapshotScheduleCommandOutput) => void): void;
748
345
  describeSnapshotSchedule(args: DescribeSnapshotScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSnapshotScheduleCommandOutput) => void): void;
749
346
  /**
750
- * @public
751
- * <p>Returns the description of the gateway volumes specified in the request. The list of
752
- * gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume ARNs. This operation is only
753
- * supported in stored volume gateway type.</p>
347
+ * @see {@link DescribeStorediSCSIVolumesCommand}
754
348
  */
755
349
  describeStorediSCSIVolumes(args: DescribeStorediSCSIVolumesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeStorediSCSIVolumesCommandOutput>;
756
350
  describeStorediSCSIVolumes(args: DescribeStorediSCSIVolumesCommandInput, cb: (err: any, data?: DescribeStorediSCSIVolumesCommandOutput) => void): void;
757
351
  describeStorediSCSIVolumes(args: DescribeStorediSCSIVolumesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStorediSCSIVolumesCommandOutput) => void): void;
758
352
  /**
759
- * @public
760
- * <p>Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This
761
- * operation is only supported in the tape gateway type.</p>
762
- *
763
- * <p>If a specific <code>TapeARN</code> is not specified, Storage Gateway returns a
764
- * description of all virtual tapes found in the VTS associated with your account.</p>
353
+ * @see {@link DescribeTapeArchivesCommand}
765
354
  */
766
355
  describeTapeArchives(args: DescribeTapeArchivesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTapeArchivesCommandOutput>;
767
356
  describeTapeArchives(args: DescribeTapeArchivesCommandInput, cb: (err: any, data?: DescribeTapeArchivesCommandOutput) => void): void;
768
357
  describeTapeArchives(args: DescribeTapeArchivesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTapeArchivesCommandOutput) => void): void;
769
358
  /**
770
- * @public
771
- * <p>Returns a list of virtual tape recovery points that are available for the specified tape
772
- * gateway.</p>
773
- *
774
- * <p>A recovery point is a point-in-time view of a virtual tape at which all the data on the
775
- * virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery
776
- * points can be recovered to a new gateway. This operation is only supported in the tape
777
- * gateway type.</p>
359
+ * @see {@link DescribeTapeRecoveryPointsCommand}
778
360
  */
779
361
  describeTapeRecoveryPoints(args: DescribeTapeRecoveryPointsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTapeRecoveryPointsCommandOutput>;
780
362
  describeTapeRecoveryPoints(args: DescribeTapeRecoveryPointsCommandInput, cb: (err: any, data?: DescribeTapeRecoveryPointsCommandOutput) => void): void;
781
363
  describeTapeRecoveryPoints(args: DescribeTapeRecoveryPointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTapeRecoveryPointsCommandOutput) => void): void;
782
364
  /**
783
- * @public
784
- * <p>Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a
785
- * <code>TapeARN</code> is not specified, returns a description of all virtual tapes
786
- * associated with the specified gateway. This operation is only supported in the tape gateway
787
- * type.</p>
365
+ * @see {@link DescribeTapesCommand}
788
366
  */
789
367
  describeTapes(args: DescribeTapesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTapesCommandOutput>;
790
368
  describeTapes(args: DescribeTapesCommandInput, cb: (err: any, data?: DescribeTapesCommandOutput) => void): void;
791
369
  describeTapes(args: DescribeTapesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTapesCommandOutput) => void): void;
792
370
  /**
793
- * @public
794
- * <p>Returns information about the upload buffer of a gateway. This operation is supported
795
- * for the stored volume, cached volume, and tape gateway types.</p>
796
- *
797
- * <p>The response includes disk IDs that are configured as upload buffer space, and it
798
- * includes the amount of upload buffer space allocated and used.</p>
371
+ * @see {@link DescribeUploadBufferCommand}
799
372
  */
800
373
  describeUploadBuffer(args: DescribeUploadBufferCommandInput, options?: __HttpHandlerOptions): Promise<DescribeUploadBufferCommandOutput>;
801
374
  describeUploadBuffer(args: DescribeUploadBufferCommandInput, cb: (err: any, data?: DescribeUploadBufferCommandOutput) => void): void;
802
375
  describeUploadBuffer(args: DescribeUploadBufferCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeUploadBufferCommandOutput) => void): void;
803
376
  /**
804
- * @public
805
- * <p>Returns a description of virtual tape library (VTL) devices for the specified tape
806
- * gateway. In the response, Storage Gateway returns VTL device information.</p>
807
- *
808
- * <p>This operation is only supported in the tape gateway type.</p>
377
+ * @see {@link DescribeVTLDevicesCommand}
809
378
  */
810
379
  describeVTLDevices(args: DescribeVTLDevicesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeVTLDevicesCommandOutput>;
811
380
  describeVTLDevices(args: DescribeVTLDevicesCommandInput, cb: (err: any, data?: DescribeVTLDevicesCommandOutput) => void): void;
812
381
  describeVTLDevices(args: DescribeVTLDevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVTLDevicesCommandOutput) => void): void;
813
382
  /**
814
- * @public
815
- * <p>Returns information about the working storage of a gateway. This operation is only
816
- * supported in the stored volumes gateway type. This operation is deprecated in cached
817
- * volumes API version (20120630). Use DescribeUploadBuffer instead.</p>
818
- *
819
- * <note>
820
- * <p>Working storage is also referred to as upload buffer. You can also use the
821
- * DescribeUploadBuffer operation to add upload buffer to a stored volume gateway.</p>
822
- * </note>
823
- *
824
- * <p>The response includes disk IDs that are configured as working storage, and it includes
825
- * the amount of working storage allocated and used.</p>
383
+ * @see {@link DescribeWorkingStorageCommand}
826
384
  */
827
385
  describeWorkingStorage(args: DescribeWorkingStorageCommandInput, options?: __HttpHandlerOptions): Promise<DescribeWorkingStorageCommandOutput>;
828
386
  describeWorkingStorage(args: DescribeWorkingStorageCommandInput, cb: (err: any, data?: DescribeWorkingStorageCommandOutput) => void): void;
829
387
  describeWorkingStorage(args: DescribeWorkingStorageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkingStorageCommandOutput) => void): void;
830
388
  /**
831
- * @public
832
- * <p>Disconnects a volume from an iSCSI connection and then detaches the volume from the
833
- * specified gateway. Detaching and attaching a volume enables you to recover your data from
834
- * one gateway to a different gateway without creating a snapshot. It also makes it easier to
835
- * move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2
836
- * instance. This operation is only supported in the volume gateway type.</p>
389
+ * @see {@link DetachVolumeCommand}
837
390
  */
838
391
  detachVolume(args: DetachVolumeCommandInput, options?: __HttpHandlerOptions): Promise<DetachVolumeCommandOutput>;
839
392
  detachVolume(args: DetachVolumeCommandInput, cb: (err: any, data?: DetachVolumeCommandOutput) => void): void;
840
393
  detachVolume(args: DetachVolumeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachVolumeCommandOutput) => void): void;
841
394
  /**
842
- * @public
843
- * <p>Disables a tape gateway when the gateway is no longer functioning. For example, if your
844
- * gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.</p>
845
- *
846
- * <p>Use this operation for a tape gateway that is not reachable or not functioning. This
847
- * operation is only supported in the tape gateway type.</p>
848
- *
849
- * <important>
850
- * <p>After a gateway is disabled, it cannot be enabled.</p>
851
- * </important>
395
+ * @see {@link DisableGatewayCommand}
852
396
  */
853
397
  disableGateway(args: DisableGatewayCommandInput, options?: __HttpHandlerOptions): Promise<DisableGatewayCommandOutput>;
854
398
  disableGateway(args: DisableGatewayCommandInput, cb: (err: any, data?: DisableGatewayCommandOutput) => void): void;
855
399
  disableGateway(args: DisableGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableGatewayCommandOutput) => void): void;
856
400
  /**
857
- * @public
858
- * <p>Disassociates an Amazon FSx file system from the specified gateway. After the
859
- * disassociation process finishes, the gateway can no longer access the Amazon FSx
860
- * file system. This operation is only supported in the FSx File Gateway type.</p>
401
+ * @see {@link DisassociateFileSystemCommand}
861
402
  */
862
403
  disassociateFileSystem(args: DisassociateFileSystemCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateFileSystemCommandOutput>;
863
404
  disassociateFileSystem(args: DisassociateFileSystemCommandInput, cb: (err: any, data?: DisassociateFileSystemCommandOutput) => void): void;
864
405
  disassociateFileSystem(args: DisassociateFileSystemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateFileSystemCommandOutput) => void): void;
865
406
  /**
866
- * @public
867
- * <p>Adds a file gateway to an Active Directory domain. This operation is only supported for
868
- * file gateways that support the SMB file protocol.</p>
407
+ * @see {@link JoinDomainCommand}
869
408
  */
870
409
  joinDomain(args: JoinDomainCommandInput, options?: __HttpHandlerOptions): Promise<JoinDomainCommandOutput>;
871
410
  joinDomain(args: JoinDomainCommandInput, cb: (err: any, data?: JoinDomainCommandOutput) => void): void;
872
411
  joinDomain(args: JoinDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JoinDomainCommandOutput) => void): void;
873
412
  /**
874
- * @public
875
- * <p>Lists the automatic tape creation policies for a gateway. If there are no automatic tape
876
- * creation policies for the gateway, it returns an empty list.</p>
877
- *
878
- * <p>This operation is only supported for tape gateways.</p>
413
+ * @see {@link ListAutomaticTapeCreationPoliciesCommand}
879
414
  */
880
415
  listAutomaticTapeCreationPolicies(args: ListAutomaticTapeCreationPoliciesCommandInput, options?: __HttpHandlerOptions): Promise<ListAutomaticTapeCreationPoliciesCommandOutput>;
881
416
  listAutomaticTapeCreationPolicies(args: ListAutomaticTapeCreationPoliciesCommandInput, cb: (err: any, data?: ListAutomaticTapeCreationPoliciesCommandOutput) => void): void;
882
417
  listAutomaticTapeCreationPolicies(args: ListAutomaticTapeCreationPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAutomaticTapeCreationPoliciesCommandOutput) => void): void;
883
418
  /**
884
- * @public
885
- * <p>Gets a list of the file shares for a specific S3 File Gateway, or the list of file
886
- * shares that belong to the calling user account. This operation is only supported for S3
887
- * File Gateways.</p>
419
+ * @see {@link ListFileSharesCommand}
888
420
  */
889
421
  listFileShares(args: ListFileSharesCommandInput, options?: __HttpHandlerOptions): Promise<ListFileSharesCommandOutput>;
890
422
  listFileShares(args: ListFileSharesCommandInput, cb: (err: any, data?: ListFileSharesCommandOutput) => void): void;
891
423
  listFileShares(args: ListFileSharesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFileSharesCommandOutput) => void): void;
892
424
  /**
893
- * @public
894
- * <p>Gets a list of <code>FileSystemAssociationSummary</code> objects. Each object contains a
895
- * summary of a file system association. This operation is only supported for FSx File
896
- * Gateways.</p>
425
+ * @see {@link ListFileSystemAssociationsCommand}
897
426
  */
898
427
  listFileSystemAssociations(args: ListFileSystemAssociationsCommandInput, options?: __HttpHandlerOptions): Promise<ListFileSystemAssociationsCommandOutput>;
899
428
  listFileSystemAssociations(args: ListFileSystemAssociationsCommandInput, cb: (err: any, data?: ListFileSystemAssociationsCommandOutput) => void): void;
900
429
  listFileSystemAssociations(args: ListFileSystemAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFileSystemAssociationsCommandOutput) => void): void;
901
430
  /**
902
- * @public
903
- * <p>Lists gateways owned by an Amazon Web Services account in an Amazon Web Services Region
904
- * specified in the request. The returned list is ordered by gateway Amazon Resource Name
905
- * (ARN).</p>
906
- *
907
- * <p>By default, the operation returns a maximum of 100 gateways. This operation supports
908
- * pagination that allows you to optionally reduce the number of gateways returned in a
909
- * response.</p>
910
- *
911
- * <p>If you have more gateways than are returned in a response (that is, the response returns
912
- * only a truncated list of your gateways), the response contains a marker that you can
913
- * specify in your next request to fetch the next page of gateways.</p>
431
+ * @see {@link ListGatewaysCommand}
914
432
  */
915
433
  listGateways(args: ListGatewaysCommandInput, options?: __HttpHandlerOptions): Promise<ListGatewaysCommandOutput>;
916
434
  listGateways(args: ListGatewaysCommandInput, cb: (err: any, data?: ListGatewaysCommandOutput) => void): void;
917
435
  listGateways(args: ListGatewaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGatewaysCommandOutput) => void): void;
918
436
  /**
919
- * @public
920
- * <p>Returns a list of the gateway's local disks. To specify which gateway to describe,
921
- * you use the Amazon Resource Name (ARN) of the gateway in the body of the request.</p>
922
- *
923
- * <p>The request returns a list of all disks, specifying which are configured as working
924
- * storage, cache storage, or stored volume or not configured at all. The response includes a
925
- * <code>DiskStatus</code> field. This field can have a value of present (the disk is
926
- * available to use), missing (the disk is no longer connected to the gateway), or mismatch
927
- * (the disk node is occupied by a disk that has incorrect metadata or the disk content is
928
- * corrupted).</p>
437
+ * @see {@link ListLocalDisksCommand}
929
438
  */
930
439
  listLocalDisks(args: ListLocalDisksCommandInput, options?: __HttpHandlerOptions): Promise<ListLocalDisksCommandOutput>;
931
440
  listLocalDisks(args: ListLocalDisksCommandInput, cb: (err: any, data?: ListLocalDisksCommandOutput) => void): void;
932
441
  listLocalDisks(args: ListLocalDisksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLocalDisksCommandOutput) => void): void;
933
442
  /**
934
- * @public
935
- * <p>Lists the tags that have been added to the specified resource. This operation is
936
- * supported in storage gateways of all types.</p>
443
+ * @see {@link ListTagsForResourceCommand}
937
444
  */
938
445
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
939
446
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
940
447
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
941
448
  /**
942
- * @public
943
- * <p>Lists custom tape pools. You specify custom tape pools to list by specifying one or more
944
- * custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN,
945
- * the operation lists all custom tape pools.</p>
946
- *
947
- * <p>This operation supports pagination. You can optionally specify the <code>Limit</code>
948
- * parameter in the body to limit the number of tape pools in the response. If the number of
949
- * tape pools returned in the response is truncated, the response includes a
950
- * <code>Marker</code> element that you can use in your subsequent request to retrieve the
951
- * next set of tape pools.</p>
449
+ * @see {@link ListTapePoolsCommand}
952
450
  */
953
451
  listTapePools(args: ListTapePoolsCommandInput, options?: __HttpHandlerOptions): Promise<ListTapePoolsCommandOutput>;
954
452
  listTapePools(args: ListTapePoolsCommandInput, cb: (err: any, data?: ListTapePoolsCommandOutput) => void): void;
955
453
  listTapePools(args: ListTapePoolsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTapePoolsCommandOutput) => void): void;
956
454
  /**
957
- * @public
958
- * <p>Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf
959
- * (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names
960
- * (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both
961
- * your VTL and VTS.</p>
962
- *
963
- * <p>This operation supports pagination. By default, the operation returns a maximum of up to
964
- * 100 tapes. You can optionally specify the <code>Limit</code> parameter in the body to limit
965
- * the number of tapes in the response. If the number of tapes returned in the response is
966
- * truncated, the response includes a <code>Marker</code> element that you can use in your
967
- * subsequent request to retrieve the next set of tapes. This operation is only supported in
968
- * the tape gateway type.</p>
455
+ * @see {@link ListTapesCommand}
969
456
  */
970
457
  listTapes(args: ListTapesCommandInput, options?: __HttpHandlerOptions): Promise<ListTapesCommandOutput>;
971
458
  listTapes(args: ListTapesCommandInput, cb: (err: any, data?: ListTapesCommandOutput) => void): void;
972
459
  listTapes(args: ListTapesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTapesCommandOutput) => void): void;
973
460
  /**
974
- * @public
975
- * <p>Lists iSCSI initiators that are connected to a volume. You can use this operation to
976
- * determine whether a volume is being used or not. This operation is only supported in the
977
- * cached volume and stored volume gateway types.</p>
461
+ * @see {@link ListVolumeInitiatorsCommand}
978
462
  */
979
463
  listVolumeInitiators(args: ListVolumeInitiatorsCommandInput, options?: __HttpHandlerOptions): Promise<ListVolumeInitiatorsCommandOutput>;
980
464
  listVolumeInitiators(args: ListVolumeInitiatorsCommandInput, cb: (err: any, data?: ListVolumeInitiatorsCommandOutput) => void): void;
981
465
  listVolumeInitiators(args: ListVolumeInitiatorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVolumeInitiatorsCommandOutput) => void): void;
982
466
  /**
983
- * @public
984
- * <p>Lists the recovery points for a specified gateway. This operation is only supported in
985
- * the cached volume gateway type.</p>
986
- *
987
- * <p>Each cache volume has one recovery point. A volume recovery point is a point in time at
988
- * which all data of the volume is consistent and from which you can create a snapshot or
989
- * clone a new cached volume from a source volume. To create a snapshot from a volume recovery
990
- * point use the <a>CreateSnapshotFromVolumeRecoveryPoint</a> operation.</p>
467
+ * @see {@link ListVolumeRecoveryPointsCommand}
991
468
  */
992
469
  listVolumeRecoveryPoints(args: ListVolumeRecoveryPointsCommandInput, options?: __HttpHandlerOptions): Promise<ListVolumeRecoveryPointsCommandOutput>;
993
470
  listVolumeRecoveryPoints(args: ListVolumeRecoveryPointsCommandInput, cb: (err: any, data?: ListVolumeRecoveryPointsCommandOutput) => void): void;
994
471
  listVolumeRecoveryPoints(args: ListVolumeRecoveryPointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVolumeRecoveryPointsCommandOutput) => void): void;
995
472
  /**
996
- * @public
997
- * <p>Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The
998
- * response includes only the volume ARNs. If you want additional volume information, use the
999
- * <a>DescribeStorediSCSIVolumes</a> or the <a>DescribeCachediSCSIVolumes</a> API.</p>
1000
- *
1001
- * <p>The operation supports pagination. By default, the operation returns a maximum of up to
1002
- * 100 volumes. You can optionally specify the <code>Limit</code> field in the body to limit
1003
- * the number of volumes in the response. If the number of volumes returned in the response is
1004
- * truncated, the response includes a Marker field. You can use this Marker value in your
1005
- * subsequent request to retrieve the next set of volumes. This operation is only supported in
1006
- * the cached volume and stored volume gateway types.</p>
473
+ * @see {@link ListVolumesCommand}
1007
474
  */
1008
475
  listVolumes(args: ListVolumesCommandInput, options?: __HttpHandlerOptions): Promise<ListVolumesCommandOutput>;
1009
476
  listVolumes(args: ListVolumesCommandInput, cb: (err: any, data?: ListVolumesCommandOutput) => void): void;
1010
477
  listVolumes(args: ListVolumesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVolumesCommandOutput) => void): void;
1011
478
  /**
1012
- * @public
1013
- * <p>Sends you notification through CloudWatch Events when all files written to your file
1014
- * share have been uploaded to S3. Amazon S3.</p>
1015
- *
1016
- * <p>Storage Gateway can send a notification through Amazon CloudWatch Events when all
1017
- * files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you
1018
- * make a request for notification. When the upload is done, Storage Gateway sends you
1019
- * notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to
1020
- * send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.</p>
1021
- *
1022
- *
1023
- *
1024
- * <p>For more information, see <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification">Getting file upload notification</a> in the <i>Storage Gateway User
1025
- * Guide</i>.</p>
479
+ * @see {@link NotifyWhenUploadedCommand}
1026
480
  */
1027
481
  notifyWhenUploaded(args: NotifyWhenUploadedCommandInput, options?: __HttpHandlerOptions): Promise<NotifyWhenUploadedCommandOutput>;
1028
482
  notifyWhenUploaded(args: NotifyWhenUploadedCommandInput, cb: (err: any, data?: NotifyWhenUploadedCommandOutput) => void): void;
1029
483
  notifyWhenUploaded(args: NotifyWhenUploadedCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NotifyWhenUploadedCommandOutput) => void): void;
1030
484
  /**
1031
- * @public
1032
- * <p>Refreshes the cached inventory of objects for the specified file share. This operation
1033
- * finds objects in the Amazon S3 bucket that were added, removed, or replaced since
1034
- * the gateway last listed the bucket's contents and cached the results. This operation
1035
- * does not import files into the S3 File Gateway cache storage. It only updates the cached
1036
- * inventory to reflect changes in the inventory of the objects in the S3 bucket. This
1037
- * operation is only supported in the S3 File Gateway types.</p>
1038
- *
1039
- * <p>You can subscribe to be notified through an Amazon CloudWatch event when your
1040
- * <code>RefreshCache</code> operation completes. For more information, see <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification">Getting notified about file operations</a> in the <i>Storage Gateway
1041
- * User Guide</i>. This operation is Only supported for S3 File Gateways.</p>
1042
- *
1043
- * <p>When this API is called, it only initiates the refresh operation. When the API call
1044
- * completes and returns a success code, it doesn't necessarily mean that the file
1045
- * refresh has completed. You should use the refresh-complete notification to determine that
1046
- * the operation has completed before you check for new files on the gateway file share. You
1047
- * can subscribe to be notified through a CloudWatch event when your <code>RefreshCache</code>
1048
- * operation completes.</p>
1049
- *
1050
- * <p>Throttle limit: This API is asynchronous, so the gateway will accept no more than two
1051
- * refreshes at any time. We recommend using the refresh-complete CloudWatch event
1052
- * notification before issuing additional requests. For more information, see <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification">Getting notified about file operations</a> in the <i>Storage Gateway
1053
- * User Guide</i>.</p>
1054
- *
1055
- * <important>
1056
- * <ul>
1057
- * <li>
1058
- * <p>Wait at least 60 seconds between consecutive RefreshCache API requests.</p>
1059
- * </li>
1060
- * <li>
1061
- * <p>RefreshCache does not evict cache entries if invoked consecutively within 60
1062
- * seconds of a previous RefreshCache request.</p>
1063
- * </li>
1064
- * <li>
1065
- * <p>If you invoke the RefreshCache API when two requests are already being
1066
- * processed, any new request will cause an
1067
- * <code>InvalidGatewayRequestException</code> error because too many requests
1068
- * were sent to the server.</p>
1069
- * </li>
1070
- * </ul>
1071
- * </important>
1072
- *
1073
- * <note>
1074
- * <p>The S3 bucket name does not need to be included when entering the list of folders in
1075
- * the FolderList parameter.</p>
1076
- * </note>
1077
- *
1078
- *
1079
- *
1080
- * <p>For more information, see <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification">Getting notified about file operations</a> in the <i>Storage Gateway
1081
- * User Guide</i>.</p>
485
+ * @see {@link RefreshCacheCommand}
1082
486
  */
1083
487
  refreshCache(args: RefreshCacheCommandInput, options?: __HttpHandlerOptions): Promise<RefreshCacheCommandOutput>;
1084
488
  refreshCache(args: RefreshCacheCommandInput, cb: (err: any, data?: RefreshCacheCommandOutput) => void): void;
1085
489
  refreshCache(args: RefreshCacheCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RefreshCacheCommandOutput) => void): void;
1086
490
  /**
1087
- * @public
1088
- * <p>Removes one or more tags from the specified resource. This operation is supported in
1089
- * storage gateways of all types.</p>
491
+ * @see {@link RemoveTagsFromResourceCommand}
1090
492
  */
1091
493
  removeTagsFromResource(args: RemoveTagsFromResourceCommandInput, options?: __HttpHandlerOptions): Promise<RemoveTagsFromResourceCommandOutput>;
1092
494
  removeTagsFromResource(args: RemoveTagsFromResourceCommandInput, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void): void;
1093
495
  removeTagsFromResource(args: RemoveTagsFromResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void): void;
1094
496
  /**
1095
- * @public
1096
- * <p>Resets all cache disks that have encountered an error and makes the disks available for
1097
- * reconfiguration as cache storage. If your cache disk encounters an error, the gateway
1098
- * prevents read and write operations on virtual tapes in the gateway. For example, an error
1099
- * can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the
1100
- * gateway loses its cache storage. At this point, you can reconfigure the disks as cache
1101
- * disks. This operation is only supported in the cached volume and tape types.</p>
1102
- *
1103
- * <important>
1104
- * <p>If the cache disk you are resetting contains data that has not been uploaded to
1105
- * Amazon S3 yet, that data can be lost. After you reset cache disks, there will
1106
- * be no configured cache disks left in the gateway, so you must configure at least one new
1107
- * cache disk for your gateway to function properly.</p>
1108
- * </important>
497
+ * @see {@link ResetCacheCommand}
1109
498
  */
1110
499
  resetCache(args: ResetCacheCommandInput, options?: __HttpHandlerOptions): Promise<ResetCacheCommandOutput>;
1111
500
  resetCache(args: ResetCacheCommandInput, cb: (err: any, data?: ResetCacheCommandOutput) => void): void;
1112
501
  resetCache(args: ResetCacheCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetCacheCommandOutput) => void): void;
1113
502
  /**
1114
- * @public
1115
- * <p>Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway.
1116
- * Virtual tapes archived in the VTS are not associated with any gateway. However after a tape
1117
- * is retrieved, it is associated with a gateway, even though it is also listed in the VTS,
1118
- * that is, archive. This operation is only supported in the tape gateway type.</p>
1119
- *
1120
- * <p>Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to
1121
- * another gateway. You must archive the tape again before you can retrieve it to another
1122
- * gateway. This operation is only supported in the tape gateway type.</p>
503
+ * @see {@link RetrieveTapeArchiveCommand}
1123
504
  */
1124
505
  retrieveTapeArchive(args: RetrieveTapeArchiveCommandInput, options?: __HttpHandlerOptions): Promise<RetrieveTapeArchiveCommandOutput>;
1125
506
  retrieveTapeArchive(args: RetrieveTapeArchiveCommandInput, cb: (err: any, data?: RetrieveTapeArchiveCommandOutput) => void): void;
1126
507
  retrieveTapeArchive(args: RetrieveTapeArchiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RetrieveTapeArchiveCommandOutput) => void): void;
1127
508
  /**
1128
- * @public
1129
- * <p>Retrieves the recovery point for the specified virtual tape. This operation is only
1130
- * supported in the tape gateway type.</p>
1131
- *
1132
- * <p>A recovery point is a point in time view of a virtual tape at which all the data on the
1133
- * tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be
1134
- * recovered to a new gateway.</p>
1135
- *
1136
- * <note>
1137
- * <p>The virtual tape can be retrieved to only one gateway. The retrieved tape is
1138
- * read-only. The virtual tape can be retrieved to only a tape gateway. There is no charge
1139
- * for retrieving recovery points.</p>
1140
- * </note>
509
+ * @see {@link RetrieveTapeRecoveryPointCommand}
1141
510
  */
1142
511
  retrieveTapeRecoveryPoint(args: RetrieveTapeRecoveryPointCommandInput, options?: __HttpHandlerOptions): Promise<RetrieveTapeRecoveryPointCommandOutput>;
1143
512
  retrieveTapeRecoveryPoint(args: RetrieveTapeRecoveryPointCommandInput, cb: (err: any, data?: RetrieveTapeRecoveryPointCommandOutput) => void): void;
1144
513
  retrieveTapeRecoveryPoint(args: RetrieveTapeRecoveryPointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RetrieveTapeRecoveryPointCommandOutput) => void): void;
1145
514
  /**
1146
- * @public
1147
- * <p>Sets the password for your VM local console. When you log in to the local console for
1148
- * the first time, you log in to the VM with the default credentials. We recommend that you
1149
- * set a new password. You don't need to know the default password to set a new
1150
- * password.</p>
515
+ * @see {@link SetLocalConsolePasswordCommand}
1151
516
  */
1152
517
  setLocalConsolePassword(args: SetLocalConsolePasswordCommandInput, options?: __HttpHandlerOptions): Promise<SetLocalConsolePasswordCommandOutput>;
1153
518
  setLocalConsolePassword(args: SetLocalConsolePasswordCommandInput, cb: (err: any, data?: SetLocalConsolePasswordCommandOutput) => void): void;
1154
519
  setLocalConsolePassword(args: SetLocalConsolePasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetLocalConsolePasswordCommandOutput) => void): void;
1155
520
  /**
1156
- * @public
1157
- * <p>Sets the password for the guest user <code>smbguest</code>. The <code>smbguest</code>
1158
- * user is the user when the authentication method for the file share is set to
1159
- * <code>GuestAccess</code>. This operation only supported for S3 File Gateways</p>
521
+ * @see {@link SetSMBGuestPasswordCommand}
1160
522
  */
1161
523
  setSMBGuestPassword(args: SetSMBGuestPasswordCommandInput, options?: __HttpHandlerOptions): Promise<SetSMBGuestPasswordCommandOutput>;
1162
524
  setSMBGuestPassword(args: SetSMBGuestPasswordCommandInput, cb: (err: any, data?: SetSMBGuestPasswordCommandOutput) => void): void;
1163
525
  setSMBGuestPassword(args: SetSMBGuestPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetSMBGuestPasswordCommandOutput) => void): void;
1164
526
  /**
1165
- * @public
1166
- * <p>Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource
1167
- * Name (ARN) of the gateway in the body of your request.</p>
1168
- *
1169
- * <p>The operation shuts down the gateway service component running in the gateway's
1170
- * virtual machine (VM) and not the host VM.</p>
1171
- *
1172
- * <note>
1173
- * <p>If you want to shut down the VM, it is recommended that you first shut down the
1174
- * gateway component in the VM to avoid unpredictable conditions.</p>
1175
- * </note>
1176
- *
1177
- * <p>After the gateway is shutdown, you cannot call any other API except <a>StartGateway</a>, <a>DescribeGatewayInformation</a>, and <a>ListGateways</a>. For more information, see <a>ActivateGateway</a>.
1178
- * Your applications cannot read from or write to the gateway's storage volumes, and
1179
- * there are no snapshots taken.</p>
1180
- *
1181
- * <note>
1182
- * <p>When you make a shutdown request, you will get a <code>200 OK</code> success response
1183
- * immediately. However, it might take some time for the gateway to shut down. You can call
1184
- * the <a>DescribeGatewayInformation</a> API to check the status. For more
1185
- * information, see <a>ActivateGateway</a>.</p>
1186
- * </note>
1187
- *
1188
- * <p>If do not intend to use the gateway again, you must delete the gateway (using <a>DeleteGateway</a>) to no longer pay software charges associated with the
1189
- * gateway.</p>
527
+ * @see {@link ShutdownGatewayCommand}
1190
528
  */
1191
529
  shutdownGateway(args: ShutdownGatewayCommandInput, options?: __HttpHandlerOptions): Promise<ShutdownGatewayCommandOutput>;
1192
530
  shutdownGateway(args: ShutdownGatewayCommandInput, cb: (err: any, data?: ShutdownGatewayCommandOutput) => void): void;
1193
531
  shutdownGateway(args: ShutdownGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ShutdownGatewayCommandOutput) => void): void;
1194
532
  /**
1195
- * @public
1196
- * <p>Start a test that verifies that the specified gateway is configured for High
1197
- * Availability monitoring in your host environment. This request only initiates the test and
1198
- * that a successful response only indicates that the test was started. It doesn't
1199
- * indicate that the test passed. For the status of the test, invoke the
1200
- * <code>DescribeAvailabilityMonitorTest</code> API.</p>
1201
- * <note>
1202
- * <p>Starting this test will cause your gateway to go offline for a brief period.</p>
1203
- * </note>
533
+ * @see {@link StartAvailabilityMonitorTestCommand}
1204
534
  */
1205
535
  startAvailabilityMonitorTest(args: StartAvailabilityMonitorTestCommandInput, options?: __HttpHandlerOptions): Promise<StartAvailabilityMonitorTestCommandOutput>;
1206
536
  startAvailabilityMonitorTest(args: StartAvailabilityMonitorTestCommandInput, cb: (err: any, data?: StartAvailabilityMonitorTestCommandOutput) => void): void;
1207
537
  startAvailabilityMonitorTest(args: StartAvailabilityMonitorTestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartAvailabilityMonitorTestCommandOutput) => void): void;
1208
538
  /**
1209
- * @public
1210
- * <p>Starts a gateway that you previously shut down (see <a>ShutdownGateway</a>).
1211
- * After the gateway starts, you can then make other API calls, your applications can read
1212
- * from or write to the gateway's storage volumes and you will be able to take snapshot
1213
- * backups.</p>
1214
- *
1215
- * <note>
1216
- * <p>When you make a request, you will get a 200 OK success response immediately. However,
1217
- * it might take some time for the gateway to be ready. You should call <a>DescribeGatewayInformation</a> and check the status before making any
1218
- * additional API calls. For more information, see <a>ActivateGateway</a>.</p>
1219
- * </note>
1220
- *
1221
- * <p>To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in
1222
- * your request.</p>
539
+ * @see {@link StartGatewayCommand}
1223
540
  */
1224
541
  startGateway(args: StartGatewayCommandInput, options?: __HttpHandlerOptions): Promise<StartGatewayCommandOutput>;
1225
542
  startGateway(args: StartGatewayCommandInput, cb: (err: any, data?: StartGatewayCommandOutput) => void): void;
1226
543
  startGateway(args: StartGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartGatewayCommandOutput) => void): void;
1227
544
  /**
1228
- * @public
1229
- * <p>Updates the automatic tape creation policy of a gateway. Use this to update the policy
1230
- * with a new set of automatic tape creation rules. This is only supported for tape
1231
- * gateways.</p>
1232
- *
1233
- * <p>By default, there is no automatic tape creation policy.</p>
1234
- *
1235
- * <note>
1236
- * <p>A gateway can have only one automatic tape creation policy.</p>
1237
- * </note>
545
+ * @see {@link UpdateAutomaticTapeCreationPolicyCommand}
1238
546
  */
1239
547
  updateAutomaticTapeCreationPolicy(args: UpdateAutomaticTapeCreationPolicyCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAutomaticTapeCreationPolicyCommandOutput>;
1240
548
  updateAutomaticTapeCreationPolicy(args: UpdateAutomaticTapeCreationPolicyCommandInput, cb: (err: any, data?: UpdateAutomaticTapeCreationPolicyCommandOutput) => void): void;
1241
549
  updateAutomaticTapeCreationPolicy(args: UpdateAutomaticTapeCreationPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAutomaticTapeCreationPolicyCommandOutput) => void): void;
1242
550
  /**
1243
- * @public
1244
- * <p>Updates the bandwidth rate limits of a gateway. You can update both the upload and
1245
- * download bandwidth rate limit or specify only one of the two. If you don't set a
1246
- * bandwidth rate limit, the existing rate limit remains. This operation is supported only for
1247
- * the stored volume, cached volume, and tape gateway types. To update bandwidth rate limits
1248
- * for S3 file gateways, use <a>UpdateBandwidthRateLimitSchedule</a>.</p>
1249
- *
1250
- * <p>By default, a gateway's bandwidth rate limits are not set. If you don't set
1251
- * any limit, the gateway does not have any limitations on its bandwidth usage and could
1252
- * potentially use the maximum available bandwidth.</p>
1253
- *
1254
- * <p>To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in
1255
- * your request.</p>
551
+ * @see {@link UpdateBandwidthRateLimitCommand}
1256
552
  */
1257
553
  updateBandwidthRateLimit(args: UpdateBandwidthRateLimitCommandInput, options?: __HttpHandlerOptions): Promise<UpdateBandwidthRateLimitCommandOutput>;
1258
554
  updateBandwidthRateLimit(args: UpdateBandwidthRateLimitCommandInput, cb: (err: any, data?: UpdateBandwidthRateLimitCommandOutput) => void): void;
1259
555
  updateBandwidthRateLimit(args: UpdateBandwidthRateLimitCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBandwidthRateLimitCommandOutput) => void): void;
1260
556
  /**
1261
- * @public
1262
- * <p> Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways
1263
- * do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in
1264
- * effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This
1265
- * operation is supported only for volume, tape and S3 file gateways. FSx file gateways do not
1266
- * support bandwidth rate limits.</p>
557
+ * @see {@link UpdateBandwidthRateLimitScheduleCommand}
1267
558
  */
1268
559
  updateBandwidthRateLimitSchedule(args: UpdateBandwidthRateLimitScheduleCommandInput, options?: __HttpHandlerOptions): Promise<UpdateBandwidthRateLimitScheduleCommandOutput>;
1269
560
  updateBandwidthRateLimitSchedule(args: UpdateBandwidthRateLimitScheduleCommandInput, cb: (err: any, data?: UpdateBandwidthRateLimitScheduleCommandOutput) => void): void;
1270
561
  updateBandwidthRateLimitSchedule(args: UpdateBandwidthRateLimitScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBandwidthRateLimitScheduleCommandOutput) => void): void;
1271
562
  /**
1272
- * @public
1273
- * <p>Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a
1274
- * specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for
1275
- * added security, you might use it. This operation is supported in the volume and tape
1276
- * gateway types.</p>
1277
- *
1278
- * <important>
1279
- * <p>When you update CHAP credentials, all existing connections on the target are closed
1280
- * and initiators must reconnect with the new credentials.</p>
1281
- * </important>
563
+ * @see {@link UpdateChapCredentialsCommand}
1282
564
  */
1283
565
  updateChapCredentials(args: UpdateChapCredentialsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateChapCredentialsCommandOutput>;
1284
566
  updateChapCredentials(args: UpdateChapCredentialsCommandInput, cb: (err: any, data?: UpdateChapCredentialsCommandOutput) => void): void;
1285
567
  updateChapCredentials(args: UpdateChapCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChapCredentialsCommandOutput) => void): void;
1286
568
  /**
1287
- * @public
1288
- * <p>Updates a file system association. This operation is only supported in the FSx File
1289
- * Gateways.</p>
569
+ * @see {@link UpdateFileSystemAssociationCommand}
1290
570
  */
1291
571
  updateFileSystemAssociation(args: UpdateFileSystemAssociationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateFileSystemAssociationCommandOutput>;
1292
572
  updateFileSystemAssociation(args: UpdateFileSystemAssociationCommandInput, cb: (err: any, data?: UpdateFileSystemAssociationCommandOutput) => void): void;
1293
573
  updateFileSystemAssociation(args: UpdateFileSystemAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFileSystemAssociationCommandOutput) => void): void;
1294
574
  /**
1295
- * @public
1296
- * <p>Updates a gateway's metadata, which includes the gateway's name and time zone.
1297
- * To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in
1298
- * your request.</p>
1299
- *
1300
- * <note>
1301
- * <p>For gateways activated after September 2, 2015, the gateway's ARN contains the
1302
- * gateway ID rather than the gateway name. However, changing the name of the gateway has
1303
- * no effect on the gateway's ARN.</p>
1304
- * </note>
575
+ * @see {@link UpdateGatewayInformationCommand}
1305
576
  */
1306
577
  updateGatewayInformation(args: UpdateGatewayInformationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateGatewayInformationCommandOutput>;
1307
578
  updateGatewayInformation(args: UpdateGatewayInformationCommandInput, cb: (err: any, data?: UpdateGatewayInformationCommandOutput) => void): void;
1308
579
  updateGatewayInformation(args: UpdateGatewayInformationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGatewayInformationCommandOutput) => void): void;
1309
580
  /**
1310
- * @public
1311
- * <p>Updates the gateway virtual machine (VM) software. The request immediately triggers the
1312
- * software update.</p>
1313
- *
1314
- * <note>
1315
- * <p>When you make this request, you get a <code>200 OK</code> success response
1316
- * immediately. However, it might take some time for the update to complete. You can call
1317
- * <a>DescribeGatewayInformation</a> to verify the gateway is in the
1318
- * <code>STATE_RUNNING</code> state.</p>
1319
- * </note>
1320
- *
1321
- * <important>
1322
- * <p>A software update forces a system restart of your gateway. You can minimize the
1323
- * chance of any disruption to your applications by increasing your iSCSI Initiators'
1324
- * timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and
1325
- * Linux, see <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorWindowsClient.html#CustomizeWindowsiSCSISettings">Customizing your Windows iSCSI settings</a> and <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorRedHatClient.html#CustomizeLinuxiSCSISettings">Customizing your Linux iSCSI settings</a>, respectively.</p>
1326
- * </important>
581
+ * @see {@link UpdateGatewaySoftwareNowCommand}
1327
582
  */
1328
583
  updateGatewaySoftwareNow(args: UpdateGatewaySoftwareNowCommandInput, options?: __HttpHandlerOptions): Promise<UpdateGatewaySoftwareNowCommandOutput>;
1329
584
  updateGatewaySoftwareNow(args: UpdateGatewaySoftwareNowCommandInput, cb: (err: any, data?: UpdateGatewaySoftwareNowCommandOutput) => void): void;
1330
585
  updateGatewaySoftwareNow(args: UpdateGatewaySoftwareNowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGatewaySoftwareNowCommandOutput) => void): void;
1331
586
  /**
1332
- * @public
1333
- * <p>Updates a gateway's weekly maintenance start time information, including day and
1334
- * time of the week. The maintenance time is the time in your gateway's time zone.</p>
587
+ * @see {@link UpdateMaintenanceStartTimeCommand}
1335
588
  */
1336
589
  updateMaintenanceStartTime(args: UpdateMaintenanceStartTimeCommandInput, options?: __HttpHandlerOptions): Promise<UpdateMaintenanceStartTimeCommandOutput>;
1337
590
  updateMaintenanceStartTime(args: UpdateMaintenanceStartTimeCommandInput, cb: (err: any, data?: UpdateMaintenanceStartTimeCommandOutput) => void): void;
1338
591
  updateMaintenanceStartTime(args: UpdateMaintenanceStartTimeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMaintenanceStartTimeCommandOutput) => void): void;
1339
592
  /**
1340
- * @public
1341
- * <p>Updates a Network File System (NFS) file share. This operation is only supported in S3
1342
- * File Gateways.</p>
1343
- *
1344
- * <note>
1345
- * <p>To leave a file share field unchanged, set the corresponding input field to
1346
- * null.</p>
1347
- * </note>
1348
- *
1349
- * <p>Updates the following file share settings:</p>
1350
- *
1351
- * <ul>
1352
- * <li>
1353
- * <p>Default storage class for your S3 bucket</p>
1354
- * </li>
1355
- * <li>
1356
- * <p>Metadata defaults for your S3 bucket</p>
1357
- * </li>
1358
- * <li>
1359
- * <p>Allowed NFS clients for your file share</p>
1360
- * </li>
1361
- * <li>
1362
- * <p>Squash settings</p>
1363
- * </li>
1364
- * <li>
1365
- * <p>Write status of your file share</p>
1366
- * </li>
1367
- * </ul>
593
+ * @see {@link UpdateNFSFileShareCommand}
1368
594
  */
1369
595
  updateNFSFileShare(args: UpdateNFSFileShareCommandInput, options?: __HttpHandlerOptions): Promise<UpdateNFSFileShareCommandOutput>;
1370
596
  updateNFSFileShare(args: UpdateNFSFileShareCommandInput, cb: (err: any, data?: UpdateNFSFileShareCommandOutput) => void): void;
1371
597
  updateNFSFileShare(args: UpdateNFSFileShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNFSFileShareCommandOutput) => void): void;
1372
598
  /**
1373
- * @public
1374
- * <p>Updates a Server Message Block (SMB) file share. This operation is only supported for S3
1375
- * File Gateways.</p>
1376
- *
1377
- * <note>
1378
- * <p>To leave a file share field unchanged, set the corresponding input field to
1379
- * null.</p>
1380
- * </note>
1381
- *
1382
- * <important>
1383
- * <p>File gateways require Security Token Service (Amazon Web Services STS) to be
1384
- * activated to enable you to create a file share. Make sure that Amazon Web Services STS
1385
- * is activated in the Amazon Web Services Region you are creating your file gateway in. If
1386
- * Amazon Web Services STS is not activated in this Amazon Web Services Region, activate
1387
- * it. For information about how to activate Amazon Web Services STS, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and
1388
- * deactivating Amazon Web Services STS in an Amazon Web Services Region</a> in the
1389
- * <i>Identity and Access Management User Guide</i>.</p>
1390
- *
1391
- * <p>File gateways don't support creating hard or symbolic links on a file
1392
- * share.</p>
1393
- * </important>
599
+ * @see {@link UpdateSMBFileShareCommand}
1394
600
  */
1395
601
  updateSMBFileShare(args: UpdateSMBFileShareCommandInput, options?: __HttpHandlerOptions): Promise<UpdateSMBFileShareCommandOutput>;
1396
602
  updateSMBFileShare(args: UpdateSMBFileShareCommandInput, cb: (err: any, data?: UpdateSMBFileShareCommandOutput) => void): void;
1397
603
  updateSMBFileShare(args: UpdateSMBFileShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSMBFileShareCommandOutput) => void): void;
1398
604
  /**
1399
- * @public
1400
- * <p>Controls whether the shares on an S3 File Gateway are visible in a net view or browse
1401
- * list. The operation is only supported for S3 File Gateways.</p>
605
+ * @see {@link UpdateSMBFileShareVisibilityCommand}
1402
606
  */
1403
607
  updateSMBFileShareVisibility(args: UpdateSMBFileShareVisibilityCommandInput, options?: __HttpHandlerOptions): Promise<UpdateSMBFileShareVisibilityCommandOutput>;
1404
608
  updateSMBFileShareVisibility(args: UpdateSMBFileShareVisibilityCommandInput, cb: (err: any, data?: UpdateSMBFileShareVisibilityCommandOutput) => void): void;
1405
609
  updateSMBFileShareVisibility(args: UpdateSMBFileShareVisibilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSMBFileShareVisibilityCommandOutput) => void): void;
1406
610
  /**
1407
- * @public
1408
- * <p>Updates the list of Active Directory users and groups that have special permissions for
1409
- * SMB file shares on the gateway.</p>
611
+ * @see {@link UpdateSMBLocalGroupsCommand}
1410
612
  */
1411
613
  updateSMBLocalGroups(args: UpdateSMBLocalGroupsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateSMBLocalGroupsCommandOutput>;
1412
614
  updateSMBLocalGroups(args: UpdateSMBLocalGroupsCommandInput, cb: (err: any, data?: UpdateSMBLocalGroupsCommandOutput) => void): void;
1413
615
  updateSMBLocalGroups(args: UpdateSMBLocalGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSMBLocalGroupsCommandOutput) => void): void;
1414
616
  /**
1415
- * @public
1416
- * <p>Updates the SMB security strategy on a file gateway. This action is only supported in
1417
- * file gateways.</p>
1418
- *
1419
- * <note>
1420
- * <p>This API is called Security level in the User Guide.</p>
1421
- *
1422
- * <p>A higher security level can affect performance of the gateway.</p>
1423
- * </note>
617
+ * @see {@link UpdateSMBSecurityStrategyCommand}
1424
618
  */
1425
619
  updateSMBSecurityStrategy(args: UpdateSMBSecurityStrategyCommandInput, options?: __HttpHandlerOptions): Promise<UpdateSMBSecurityStrategyCommandOutput>;
1426
620
  updateSMBSecurityStrategy(args: UpdateSMBSecurityStrategyCommandInput, cb: (err: any, data?: UpdateSMBSecurityStrategyCommandOutput) => void): void;
1427
621
  updateSMBSecurityStrategy(args: UpdateSMBSecurityStrategyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSMBSecurityStrategyCommandOutput) => void): void;
1428
622
  /**
1429
- * @public
1430
- * <p>Updates a snapshot schedule configured for a gateway volume. This operation is only
1431
- * supported in the cached volume and stored volume gateway types.</p>
1432
- *
1433
- * <p>The default snapshot schedule for volume is once every 24 hours, starting at the
1434
- * creation time of the volume. You can use this API to change the snapshot schedule
1435
- * configured for the volume.</p>
1436
- *
1437
- * <p>In the request you must identify the gateway volume whose snapshot schedule you want to
1438
- * update, and the schedule information, including when you want the snapshot to begin on a
1439
- * day and the frequency (in hours) of snapshots.</p>
623
+ * @see {@link UpdateSnapshotScheduleCommand}
1440
624
  */
1441
625
  updateSnapshotSchedule(args: UpdateSnapshotScheduleCommandInput, options?: __HttpHandlerOptions): Promise<UpdateSnapshotScheduleCommandOutput>;
1442
626
  updateSnapshotSchedule(args: UpdateSnapshotScheduleCommandInput, cb: (err: any, data?: UpdateSnapshotScheduleCommandOutput) => void): void;
1443
627
  updateSnapshotSchedule(args: UpdateSnapshotScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateSnapshotScheduleCommandOutput) => void): void;
1444
628
  /**
1445
- * @public
1446
- * <p>Updates the type of medium changer in a tape gateway. When you activate a tape gateway,
1447
- * you select a medium changer type for the tape gateway. This operation enables you to select
1448
- * a different type of medium changer after a tape gateway is activated. This operation is
1449
- * only supported in the tape gateway type.</p>
629
+ * @see {@link UpdateVTLDeviceTypeCommand}
1450
630
  */
1451
631
  updateVTLDeviceType(args: UpdateVTLDeviceTypeCommandInput, options?: __HttpHandlerOptions): Promise<UpdateVTLDeviceTypeCommandOutput>;
1452
632
  updateVTLDeviceType(args: UpdateVTLDeviceTypeCommandInput, cb: (err: any, data?: UpdateVTLDeviceTypeCommandOutput) => void): void;
1453
633
  updateVTLDeviceType(args: UpdateVTLDeviceTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVTLDeviceTypeCommandOutput) => void): void;
1454
634
  }
635
+ /**
636
+ * @public
637
+ * <fullname>Storage Gateway Service</fullname>
638
+ *
639
+ * <p>Storage Gateway is the service that connects an on-premises software appliance
640
+ * with cloud-based storage to provide seamless and secure integration between an
641
+ * organization's on-premises IT environment and the Amazon Web Services storage
642
+ * infrastructure. The service enables you to securely upload data to the Amazon Web Services Cloud for cost effective backup and rapid disaster recovery.</p>
643
+ *
644
+ * <p>Use the following links to get started using the <i>Storage Gateway
645
+ * Service API Reference</i>:</p>
646
+ *
647
+ * <ul>
648
+ * <li>
649
+ * <p>
650
+ * <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewayHTTPRequestsHeaders">Storage Gateway required request headers</a>: Describes the required
651
+ * headers that you must send with every POST request to Storage Gateway.</p>
652
+ * </li>
653
+ * <li>
654
+ * <p>
655
+ * <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewaySigningRequests">Signing requests</a>: Storage Gateway requires that you authenticate
656
+ * every request you send; this topic describes how sign such a request.</p>
657
+ * </li>
658
+ * <li>
659
+ * <p>
660
+ * <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#APIErrorResponses">Error responses</a>: Provides reference information about Storage Gateway errors.</p>
661
+ * </li>
662
+ * <li>
663
+ * <p>
664
+ * <a href="https://docs.aws.amazon.com/storagegateway/latest/APIReference/API_Operations.html">Operations in Storage Gateway</a>: Contains detailed descriptions of all Storage Gateway operations, their request parameters, response elements, possible errors, and
665
+ * examples of requests and responses.</p>
666
+ * </li>
667
+ * <li>
668
+ * <p>
669
+ * <a href="https://docs.aws.amazon.com/general/latest/gr/sg.html">Storage Gateway
670
+ * endpoints and quotas</a>: Provides a list of each Amazon Web Services Region
671
+ * and the endpoints available for use with Storage Gateway.</p>
672
+ * </li>
673
+ * </ul>
674
+ *
675
+ * <note>
676
+ * <p>Storage Gateway resource IDs are in uppercase. When you use these resource IDs
677
+ * with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change
678
+ * your resource ID to lowercase to use it with the EC2 API. For example, in Storage
679
+ * Gateway the ID for a volume might be <code>vol-AA22BB012345DAF670</code>. When you use
680
+ * this ID with the EC2 API, you must change it to <code>vol-aa22bb012345daf670</code>.
681
+ * Otherwise, the EC2 API might not behave as expected.</p>
682
+ * </note>
683
+ *
684
+ * <important>
685
+ * <p>IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway
686
+ * volumes are changing to a longer format. Starting in December 2016, all new volumes and
687
+ * snapshots will be created with a 17-character string. Starting in April 2016, you will
688
+ * be able to use these longer IDs so you can test your systems with the new format. For
689
+ * more information, see <a href="http://aws.amazon.com/ec2/faqs/#longer-ids">Longer EC2 and
690
+ * EBS resource IDs</a>.</p>
691
+ *
692
+ * <p>For example, a volume Amazon Resource Name (ARN) with the longer volume ID format
693
+ * looks like the following:</p>
694
+ *
695
+ * <p>
696
+ * <code>arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG</code>.</p>
697
+ *
698
+ * <p>A snapshot ID with the longer ID format looks like the following:
699
+ * <code>snap-78e226633445566ee</code>.</p>
700
+ *
701
+ * <p>For more information, see <a href="http://forums.aws.amazon.com/ann.jspa?annID=3557">Announcement:
702
+ * Heads-up – Longer Storage Gateway volume and snapshot IDs coming in
703
+ * 2016</a>.</p>
704
+ * </important>
705
+ */
706
+ export declare class StorageGateway extends StorageGatewayClient implements StorageGateway {
707
+ }