@aws-sdk/client-storage-gateway 3.379.1 → 3.385.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/models/models_0.d.ts +702 -0
- package/package.json +5 -5
|
@@ -8,10 +8,12 @@ import { StorageGatewayServiceException as __BaseException } from "./StorageGate
|
|
|
8
8
|
*/
|
|
9
9
|
export interface Tag {
|
|
10
10
|
/**
|
|
11
|
+
* @public
|
|
11
12
|
* <p>Tag key. The key can't start with aws:.</p>
|
|
12
13
|
*/
|
|
13
14
|
Key: string | undefined;
|
|
14
15
|
/**
|
|
16
|
+
* @public
|
|
15
17
|
* <p>Value of the tag key.</p>
|
|
16
18
|
*/
|
|
17
19
|
Value: string | undefined;
|
|
@@ -60,6 +62,7 @@ export interface Tag {
|
|
|
60
62
|
*/
|
|
61
63
|
export interface ActivateGatewayInput {
|
|
62
64
|
/**
|
|
65
|
+
* @public
|
|
63
66
|
* <p>Your gateway activation key. You can obtain the activation key by sending an HTTP GET
|
|
64
67
|
* request with redirects enabled to the gateway IP address (port 80). The redirect URL
|
|
65
68
|
* returned in the response provides you the activation key for your gateway in the query
|
|
@@ -75,10 +78,12 @@ export interface ActivateGatewayInput {
|
|
|
75
78
|
*/
|
|
76
79
|
ActivationKey: string | undefined;
|
|
77
80
|
/**
|
|
81
|
+
* @public
|
|
78
82
|
* <p>The name you configured for your gateway.</p>
|
|
79
83
|
*/
|
|
80
84
|
GatewayName: string | undefined;
|
|
81
85
|
/**
|
|
86
|
+
* @public
|
|
82
87
|
* <p>A value that indicates the time zone you want to set for the gateway. The time zone is
|
|
83
88
|
* of the format "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4
|
|
84
89
|
* hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is
|
|
@@ -87,6 +92,7 @@ export interface ActivateGatewayInput {
|
|
|
87
92
|
*/
|
|
88
93
|
GatewayTimezone: string | undefined;
|
|
89
94
|
/**
|
|
95
|
+
* @public
|
|
90
96
|
* <p>A value that indicates the Amazon Web Services Region where you want to store your data.
|
|
91
97
|
* The gateway Amazon Web Services Region specified must be the same Amazon Web Services Region
|
|
92
98
|
* as the Amazon Web Services Region in your <code>Host</code> header in the request. For more
|
|
@@ -102,6 +108,7 @@ export interface ActivateGatewayInput {
|
|
|
102
108
|
*/
|
|
103
109
|
GatewayRegion: string | undefined;
|
|
104
110
|
/**
|
|
111
|
+
* @public
|
|
105
112
|
* <p>A value that defines the type of gateway to activate. The type specified is critical to
|
|
106
113
|
* all later functions of the gateway and cannot be changed after activation. The default
|
|
107
114
|
* value is <code>CACHED</code>.</p>
|
|
@@ -112,6 +119,7 @@ export interface ActivateGatewayInput {
|
|
|
112
119
|
*/
|
|
113
120
|
GatewayType?: string;
|
|
114
121
|
/**
|
|
122
|
+
* @public
|
|
115
123
|
* <p>The value that indicates the type of tape drive to use for tape gateway. This field is
|
|
116
124
|
* optional.</p>
|
|
117
125
|
*
|
|
@@ -120,6 +128,7 @@ export interface ActivateGatewayInput {
|
|
|
120
128
|
*/
|
|
121
129
|
TapeDriveType?: string;
|
|
122
130
|
/**
|
|
131
|
+
* @public
|
|
123
132
|
* <p>The value that indicates the type of medium changer to use for tape gateway. This field
|
|
124
133
|
* is optional.</p>
|
|
125
134
|
*
|
|
@@ -129,6 +138,7 @@ export interface ActivateGatewayInput {
|
|
|
129
138
|
*/
|
|
130
139
|
MediumChangerType?: string;
|
|
131
140
|
/**
|
|
141
|
+
* @public
|
|
132
142
|
* <p>A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value
|
|
133
143
|
* pair.</p>
|
|
134
144
|
*
|
|
@@ -155,6 +165,7 @@ export interface ActivateGatewayInput {
|
|
|
155
165
|
*/
|
|
156
166
|
export interface ActivateGatewayOutput {
|
|
157
167
|
/**
|
|
168
|
+
* @public
|
|
158
169
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
159
170
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
160
171
|
*/
|
|
@@ -172,10 +183,12 @@ export type ErrorCode = "ActivationKeyExpired" | "ActivationKeyInvalid" | "Activ
|
|
|
172
183
|
*/
|
|
173
184
|
export interface StorageGatewayError {
|
|
174
185
|
/**
|
|
186
|
+
* @public
|
|
175
187
|
* <p>Additional information about the error.</p>
|
|
176
188
|
*/
|
|
177
189
|
errorCode?: ErrorCode | string;
|
|
178
190
|
/**
|
|
191
|
+
* @public
|
|
179
192
|
* <p>Human-readable text that provides detail about the error that occurred.</p>
|
|
180
193
|
*/
|
|
181
194
|
errorDetails?: Record<string, string>;
|
|
@@ -189,6 +202,7 @@ export declare class InternalServerError extends __BaseException {
|
|
|
189
202
|
readonly name: "InternalServerError";
|
|
190
203
|
readonly $fault: "server";
|
|
191
204
|
/**
|
|
205
|
+
* @public
|
|
192
206
|
* <p>A <a>StorageGatewayError</a> that provides more information about the cause
|
|
193
207
|
* of the error.</p>
|
|
194
208
|
*/
|
|
@@ -207,6 +221,7 @@ export declare class InvalidGatewayRequestException extends __BaseException {
|
|
|
207
221
|
readonly name: "InvalidGatewayRequestException";
|
|
208
222
|
readonly $fault: "client";
|
|
209
223
|
/**
|
|
224
|
+
* @public
|
|
210
225
|
* <p>A <a>StorageGatewayError</a> that provides more detail about the cause of the
|
|
211
226
|
* error.</p>
|
|
212
227
|
*/
|
|
@@ -225,11 +240,13 @@ export type ActiveDirectoryStatus = "ACCESS_DENIED" | "DETACHED" | "JOINED" | "J
|
|
|
225
240
|
*/
|
|
226
241
|
export interface AddCacheInput {
|
|
227
242
|
/**
|
|
243
|
+
* @public
|
|
228
244
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
229
245
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
230
246
|
*/
|
|
231
247
|
GatewayARN: string | undefined;
|
|
232
248
|
/**
|
|
249
|
+
* @public
|
|
233
250
|
* <p>An array of strings that identify disks that are to be configured as working storage.
|
|
234
251
|
* Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs
|
|
235
252
|
* from the <a>ListLocalDisks</a> API.</p>
|
|
@@ -241,6 +258,7 @@ export interface AddCacheInput {
|
|
|
241
258
|
*/
|
|
242
259
|
export interface AddCacheOutput {
|
|
243
260
|
/**
|
|
261
|
+
* @public
|
|
244
262
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
245
263
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
246
264
|
*/
|
|
@@ -252,10 +270,12 @@ export interface AddCacheOutput {
|
|
|
252
270
|
*/
|
|
253
271
|
export interface AddTagsToResourceInput {
|
|
254
272
|
/**
|
|
273
|
+
* @public
|
|
255
274
|
* <p>The Amazon Resource Name (ARN) of the resource you want to add tags to.</p>
|
|
256
275
|
*/
|
|
257
276
|
ResourceARN: string | undefined;
|
|
258
277
|
/**
|
|
278
|
+
* @public
|
|
259
279
|
* <p>The key-value pair that represents the tag you want to add to the resource. The value
|
|
260
280
|
* can be an empty string.</p>
|
|
261
281
|
*
|
|
@@ -274,6 +294,7 @@ export interface AddTagsToResourceInput {
|
|
|
274
294
|
*/
|
|
275
295
|
export interface AddTagsToResourceOutput {
|
|
276
296
|
/**
|
|
297
|
+
* @public
|
|
277
298
|
* <p>The Amazon Resource Name (ARN) of the resource you want to add tags to.</p>
|
|
278
299
|
*/
|
|
279
300
|
ResourceARN?: string;
|
|
@@ -283,11 +304,13 @@ export interface AddTagsToResourceOutput {
|
|
|
283
304
|
*/
|
|
284
305
|
export interface AddUploadBufferInput {
|
|
285
306
|
/**
|
|
307
|
+
* @public
|
|
286
308
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
287
309
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
288
310
|
*/
|
|
289
311
|
GatewayARN: string | undefined;
|
|
290
312
|
/**
|
|
313
|
+
* @public
|
|
291
314
|
* <p>An array of strings that identify disks that are to be configured as working storage.
|
|
292
315
|
* Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs
|
|
293
316
|
* from the <a>ListLocalDisks</a> API.</p>
|
|
@@ -299,6 +322,7 @@ export interface AddUploadBufferInput {
|
|
|
299
322
|
*/
|
|
300
323
|
export interface AddUploadBufferOutput {
|
|
301
324
|
/**
|
|
325
|
+
* @public
|
|
302
326
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
303
327
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
304
328
|
*/
|
|
@@ -318,11 +342,13 @@ export interface AddUploadBufferOutput {
|
|
|
318
342
|
*/
|
|
319
343
|
export interface AddWorkingStorageInput {
|
|
320
344
|
/**
|
|
345
|
+
* @public
|
|
321
346
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
322
347
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
323
348
|
*/
|
|
324
349
|
GatewayARN: string | undefined;
|
|
325
350
|
/**
|
|
351
|
+
* @public
|
|
326
352
|
* <p>An array of strings that identify disks that are to be configured as working storage.
|
|
327
353
|
* Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs
|
|
328
354
|
* from the <a>ListLocalDisks</a> API.</p>
|
|
@@ -336,6 +362,7 @@ export interface AddWorkingStorageInput {
|
|
|
336
362
|
*/
|
|
337
363
|
export interface AddWorkingStorageOutput {
|
|
338
364
|
/**
|
|
365
|
+
* @public
|
|
339
366
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
340
367
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
341
368
|
*/
|
|
@@ -346,11 +373,13 @@ export interface AddWorkingStorageOutput {
|
|
|
346
373
|
*/
|
|
347
374
|
export interface AssignTapePoolInput {
|
|
348
375
|
/**
|
|
376
|
+
* @public
|
|
349
377
|
* <p>The unique Amazon Resource Name (ARN) of the virtual tape that you want to add to the
|
|
350
378
|
* tape pool.</p>
|
|
351
379
|
*/
|
|
352
380
|
TapeARN: string | undefined;
|
|
353
381
|
/**
|
|
382
|
+
* @public
|
|
354
383
|
* <p>The ID of the pool that you want to add your tape to for archiving. The tape in this
|
|
355
384
|
* pool is archived in the S3 storage class that is associated with the pool. When you use
|
|
356
385
|
* your backup application to eject the tape, the tape is archived directly into the storage
|
|
@@ -358,6 +387,7 @@ export interface AssignTapePoolInput {
|
|
|
358
387
|
*/
|
|
359
388
|
PoolId: string | undefined;
|
|
360
389
|
/**
|
|
390
|
+
* @public
|
|
361
391
|
* <p>Set permissions to bypass governance retention. If the lock type of the archived tape is
|
|
362
392
|
* <code>Governance</code>, the tape's archived age is not older than
|
|
363
393
|
* <code>RetentionLockInDays</code>, and the user does not already have
|
|
@@ -375,6 +405,7 @@ export interface AssignTapePoolInput {
|
|
|
375
405
|
*/
|
|
376
406
|
export interface AssignTapePoolOutput {
|
|
377
407
|
/**
|
|
408
|
+
* @public
|
|
378
409
|
* <p>The unique Amazon Resource Names (ARN) of the virtual tape that was added to the tape
|
|
379
410
|
* pool.</p>
|
|
380
411
|
*/
|
|
@@ -386,6 +417,7 @@ export interface AssignTapePoolOutput {
|
|
|
386
417
|
*/
|
|
387
418
|
export interface CacheAttributes {
|
|
388
419
|
/**
|
|
420
|
+
* @public
|
|
389
421
|
* <p>Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of
|
|
390
422
|
* time since the last refresh after which access to the directory would cause the file
|
|
391
423
|
* gateway to first refresh that directory's contents from the Amazon S3 bucket
|
|
@@ -401,6 +433,7 @@ export interface CacheAttributes {
|
|
|
401
433
|
*/
|
|
402
434
|
export interface EndpointNetworkConfiguration {
|
|
403
435
|
/**
|
|
436
|
+
* @public
|
|
404
437
|
* <p>A list of gateway IP addresses on which the associated Amazon FSx file system is
|
|
405
438
|
* available.</p>
|
|
406
439
|
* <note>
|
|
@@ -415,44 +448,53 @@ export interface EndpointNetworkConfiguration {
|
|
|
415
448
|
*/
|
|
416
449
|
export interface AssociateFileSystemInput {
|
|
417
450
|
/**
|
|
451
|
+
* @public
|
|
418
452
|
* <p>The user name of the user credential that has permission to access the root share D$ of
|
|
419
453
|
* the Amazon FSx file system. The user account must belong to the Amazon FSx
|
|
420
454
|
* delegated admin user group.</p>
|
|
421
455
|
*/
|
|
422
456
|
UserName: string | undefined;
|
|
423
457
|
/**
|
|
458
|
+
* @public
|
|
424
459
|
* <p>The password of the user credential.</p>
|
|
425
460
|
*/
|
|
426
461
|
Password: string | undefined;
|
|
427
462
|
/**
|
|
463
|
+
* @public
|
|
428
464
|
* <p>A unique string value that you supply that is used by the FSx File Gateway to ensure
|
|
429
465
|
* idempotent file system association creation.</p>
|
|
430
466
|
*/
|
|
431
467
|
ClientToken: string | undefined;
|
|
432
468
|
/**
|
|
469
|
+
* @public
|
|
433
470
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
434
471
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
435
472
|
*/
|
|
436
473
|
GatewayARN: string | undefined;
|
|
437
474
|
/**
|
|
475
|
+
* @public
|
|
438
476
|
* <p>The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with
|
|
439
477
|
* the FSx File Gateway.</p>
|
|
440
478
|
*/
|
|
441
479
|
LocationARN: string | undefined;
|
|
442
480
|
/**
|
|
481
|
+
* @public
|
|
443
482
|
* <p>A list of up to 50 tags that can be assigned to the file system association. Each tag is
|
|
444
483
|
* a key-value pair.</p>
|
|
445
484
|
*/
|
|
446
485
|
Tags?: Tag[];
|
|
447
486
|
/**
|
|
487
|
+
* @public
|
|
448
488
|
* <p>The Amazon Resource Name (ARN) of the storage used for the audit logs.</p>
|
|
449
489
|
*/
|
|
450
490
|
AuditDestinationARN?: string;
|
|
451
491
|
/**
|
|
492
|
+
* @public
|
|
452
493
|
* <p>The refresh cache information for the file share or FSx file systems.</p>
|
|
453
494
|
*/
|
|
454
495
|
CacheAttributes?: CacheAttributes;
|
|
455
496
|
/**
|
|
497
|
+
* @public
|
|
456
498
|
* <p>Specifies the network configuration information for the gateway associated with the
|
|
457
499
|
* Amazon FSx file system.</p>
|
|
458
500
|
* <note>
|
|
@@ -467,6 +509,7 @@ export interface AssociateFileSystemInput {
|
|
|
467
509
|
*/
|
|
468
510
|
export interface AssociateFileSystemOutput {
|
|
469
511
|
/**
|
|
512
|
+
* @public
|
|
470
513
|
* <p>The ARN of the newly created file system association.</p>
|
|
471
514
|
*/
|
|
472
515
|
FileSystemAssociationARN?: string;
|
|
@@ -477,11 +520,13 @@ export interface AssociateFileSystemOutput {
|
|
|
477
520
|
*/
|
|
478
521
|
export interface AttachVolumeInput {
|
|
479
522
|
/**
|
|
523
|
+
* @public
|
|
480
524
|
* <p>The Amazon Resource Name (ARN) of the gateway that you want to attach the volume
|
|
481
525
|
* to.</p>
|
|
482
526
|
*/
|
|
483
527
|
GatewayARN: string | undefined;
|
|
484
528
|
/**
|
|
529
|
+
* @public
|
|
485
530
|
* <p>The name of the iSCSI target used by an initiator to connect to a volume and used as a
|
|
486
531
|
* suffix for the target ARN. For example, specifying <code>TargetName</code> as
|
|
487
532
|
* <i>myvolume</i> results in the target ARN of
|
|
@@ -493,10 +538,12 @@ export interface AttachVolumeInput {
|
|
|
493
538
|
*/
|
|
494
539
|
TargetName?: string;
|
|
495
540
|
/**
|
|
541
|
+
* @public
|
|
496
542
|
* <p>The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.</p>
|
|
497
543
|
*/
|
|
498
544
|
VolumeARN: string | undefined;
|
|
499
545
|
/**
|
|
546
|
+
* @public
|
|
500
547
|
* <p>The network interface of the gateway on which to expose the iSCSI target. Only IPv4
|
|
501
548
|
* addresses are accepted. Use <a>DescribeGatewayInformation</a> to get a list of
|
|
502
549
|
* the network interfaces available on a gateway.</p>
|
|
@@ -505,6 +552,7 @@ export interface AttachVolumeInput {
|
|
|
505
552
|
*/
|
|
506
553
|
NetworkInterfaceId: string | undefined;
|
|
507
554
|
/**
|
|
555
|
+
* @public
|
|
508
556
|
* <p>The unique device ID or other distinguishing data that identifies the local disk used to
|
|
509
557
|
* create the volume. This value is only required when you are attaching a stored
|
|
510
558
|
* volume.</p>
|
|
@@ -517,10 +565,12 @@ export interface AttachVolumeInput {
|
|
|
517
565
|
*/
|
|
518
566
|
export interface AttachVolumeOutput {
|
|
519
567
|
/**
|
|
568
|
+
* @public
|
|
520
569
|
* <p>The Amazon Resource Name (ARN) of the volume that was attached to the gateway.</p>
|
|
521
570
|
*/
|
|
522
571
|
VolumeARN?: string;
|
|
523
572
|
/**
|
|
573
|
+
* @public
|
|
524
574
|
* <p>The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name for
|
|
525
575
|
* the initiator that was used to connect to the target.</p>
|
|
526
576
|
*/
|
|
@@ -534,6 +584,7 @@ export interface AttachVolumeOutput {
|
|
|
534
584
|
*/
|
|
535
585
|
export interface AutomaticTapeCreationRule {
|
|
536
586
|
/**
|
|
587
|
+
* @public
|
|
537
588
|
* <p>A prefix that you append to the barcode of the virtual tape that you are creating. This
|
|
538
589
|
* prefix makes the barcode unique.</p>
|
|
539
590
|
*
|
|
@@ -544,6 +595,7 @@ export interface AutomaticTapeCreationRule {
|
|
|
544
595
|
*/
|
|
545
596
|
TapeBarcodePrefix: string | undefined;
|
|
546
597
|
/**
|
|
598
|
+
* @public
|
|
547
599
|
* <p>The ID of the pool that you want to add your tape to for archiving. The tape in this
|
|
548
600
|
* pool is archived in the Amazon S3 storage class that is associated with the pool.
|
|
549
601
|
* When you use your backup application to eject the tape, the tape is archived directly into
|
|
@@ -552,10 +604,12 @@ export interface AutomaticTapeCreationRule {
|
|
|
552
604
|
*/
|
|
553
605
|
PoolId: string | undefined;
|
|
554
606
|
/**
|
|
607
|
+
* @public
|
|
555
608
|
* <p>The size, in bytes, of the virtual tape capacity.</p>
|
|
556
609
|
*/
|
|
557
610
|
TapeSizeInBytes: number | undefined;
|
|
558
611
|
/**
|
|
612
|
+
* @public
|
|
559
613
|
* <p>The minimum number of available virtual tapes that the gateway maintains at all times.
|
|
560
614
|
* If the number of tapes on the gateway goes below this value, the gateway creates as many
|
|
561
615
|
* new tapes as are needed to have <code>MinimumNumTapes</code> on the gateway. For more
|
|
@@ -563,6 +617,7 @@ export interface AutomaticTapeCreationRule {
|
|
|
563
617
|
*/
|
|
564
618
|
MinimumNumTapes: number | undefined;
|
|
565
619
|
/**
|
|
620
|
+
* @public
|
|
566
621
|
* <p>Set to <code>true</code> to indicate that tapes are to be archived as
|
|
567
622
|
* write-once-read-many (WORM). Set to <code>false</code> when WORM is not enabled for
|
|
568
623
|
* tapes.</p>
|
|
@@ -576,12 +631,14 @@ export interface AutomaticTapeCreationRule {
|
|
|
576
631
|
*/
|
|
577
632
|
export interface AutomaticTapeCreationPolicyInfo {
|
|
578
633
|
/**
|
|
634
|
+
* @public
|
|
579
635
|
* <p>An automatic tape creation policy consists of a list of automatic tape creation rules.
|
|
580
636
|
* This returns the rules that determine when and how to automatically create new
|
|
581
637
|
* tapes.</p>
|
|
582
638
|
*/
|
|
583
639
|
AutomaticTapeCreationRules?: AutomaticTapeCreationRule[];
|
|
584
640
|
/**
|
|
641
|
+
* @public
|
|
585
642
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
586
643
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
587
644
|
*/
|
|
@@ -600,20 +657,24 @@ export type AvailabilityMonitorTestStatus = "COMPLETE" | "FAILED" | "PENDING";
|
|
|
600
657
|
*/
|
|
601
658
|
export interface BandwidthRateLimitInterval {
|
|
602
659
|
/**
|
|
660
|
+
* @public
|
|
603
661
|
* <p> The hour of the day to start the bandwidth rate limit interval. </p>
|
|
604
662
|
*/
|
|
605
663
|
StartHourOfDay: number | undefined;
|
|
606
664
|
/**
|
|
665
|
+
* @public
|
|
607
666
|
* <p> The minute of the hour to start the bandwidth rate limit interval. The interval begins
|
|
608
667
|
* at the start of that minute. To begin an interval exactly at the start of the hour, use the
|
|
609
668
|
* value <code>0</code>. </p>
|
|
610
669
|
*/
|
|
611
670
|
StartMinuteOfHour: number | undefined;
|
|
612
671
|
/**
|
|
672
|
+
* @public
|
|
613
673
|
* <p> The hour of the day to end the bandwidth rate limit interval. </p>
|
|
614
674
|
*/
|
|
615
675
|
EndHourOfDay: number | undefined;
|
|
616
676
|
/**
|
|
677
|
+
* @public
|
|
617
678
|
* <p> The minute of the hour to end the bandwidth rate limit interval. </p>
|
|
618
679
|
*
|
|
619
680
|
* <important>
|
|
@@ -623,17 +684,20 @@ export interface BandwidthRateLimitInterval {
|
|
|
623
684
|
*/
|
|
624
685
|
EndMinuteOfHour: number | undefined;
|
|
625
686
|
/**
|
|
687
|
+
* @public
|
|
626
688
|
* <p> The days of the week component of the bandwidth rate limit interval, represented as
|
|
627
689
|
* ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents Saturday. </p>
|
|
628
690
|
*/
|
|
629
691
|
DaysOfWeek: number[] | undefined;
|
|
630
692
|
/**
|
|
693
|
+
* @public
|
|
631
694
|
* <p> The average upload rate limit component of the bandwidth rate limit interval, in bits
|
|
632
695
|
* per second. This field does not appear in the response if the upload rate limit is not set.
|
|
633
696
|
* </p>
|
|
634
697
|
*/
|
|
635
698
|
AverageUploadRateLimitInBitsPerSec?: number;
|
|
636
699
|
/**
|
|
700
|
+
* @public
|
|
637
701
|
* <p> The average download rate limit component of the bandwidth rate limit interval, in bits
|
|
638
702
|
* per second. This field does not appear in the response if the download rate limit is not
|
|
639
703
|
* set. </p>
|
|
@@ -646,22 +710,27 @@ export interface BandwidthRateLimitInterval {
|
|
|
646
710
|
*/
|
|
647
711
|
export interface VolumeiSCSIAttributes {
|
|
648
712
|
/**
|
|
713
|
+
* @public
|
|
649
714
|
* <p>The Amazon Resource Name (ARN) of the volume target.</p>
|
|
650
715
|
*/
|
|
651
716
|
TargetARN?: string;
|
|
652
717
|
/**
|
|
718
|
+
* @public
|
|
653
719
|
* <p>The network interface identifier.</p>
|
|
654
720
|
*/
|
|
655
721
|
NetworkInterfaceId?: string;
|
|
656
722
|
/**
|
|
723
|
+
* @public
|
|
657
724
|
* <p>The port used to communicate with iSCSI targets.</p>
|
|
658
725
|
*/
|
|
659
726
|
NetworkInterfacePort?: number;
|
|
660
727
|
/**
|
|
728
|
+
* @public
|
|
661
729
|
* <p>The logical disk number.</p>
|
|
662
730
|
*/
|
|
663
731
|
LunNumber?: number;
|
|
664
732
|
/**
|
|
733
|
+
* @public
|
|
665
734
|
* <p>Indicates whether mutual CHAP is enabled for the iSCSI target.</p>
|
|
666
735
|
*/
|
|
667
736
|
ChapEnabled?: boolean;
|
|
@@ -672,53 +741,64 @@ export interface VolumeiSCSIAttributes {
|
|
|
672
741
|
*/
|
|
673
742
|
export interface CachediSCSIVolume {
|
|
674
743
|
/**
|
|
744
|
+
* @public
|
|
675
745
|
* <p>The Amazon Resource Name (ARN) of the storage volume.</p>
|
|
676
746
|
*/
|
|
677
747
|
VolumeARN?: string;
|
|
678
748
|
/**
|
|
749
|
+
* @public
|
|
679
750
|
* <p>The unique identifier of the volume, e.g., vol-AE4B946D.</p>
|
|
680
751
|
*/
|
|
681
752
|
VolumeId?: string;
|
|
682
753
|
/**
|
|
754
|
+
* @public
|
|
683
755
|
* <p>One of the VolumeType enumeration values that describes the type of the volume.</p>
|
|
684
756
|
*/
|
|
685
757
|
VolumeType?: string;
|
|
686
758
|
/**
|
|
759
|
+
* @public
|
|
687
760
|
* <p>One of the VolumeStatus values that indicates the state of the storage volume.</p>
|
|
688
761
|
*/
|
|
689
762
|
VolumeStatus?: string;
|
|
690
763
|
/**
|
|
764
|
+
* @public
|
|
691
765
|
* <p>A value that indicates whether a storage volume is attached to or detached from a
|
|
692
766
|
* gateway. For more information, see <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#attach-detach-volume">Moving
|
|
693
767
|
* your volumes to a different gateway</a>.</p>
|
|
694
768
|
*/
|
|
695
769
|
VolumeAttachmentStatus?: string;
|
|
696
770
|
/**
|
|
771
|
+
* @public
|
|
697
772
|
* <p>The size, in bytes, of the volume capacity.</p>
|
|
698
773
|
*/
|
|
699
774
|
VolumeSizeInBytes?: number;
|
|
700
775
|
/**
|
|
776
|
+
* @public
|
|
701
777
|
* <p>Represents the percentage complete if the volume is restoring or bootstrapping that
|
|
702
778
|
* represents the percent of data transferred. This field does not appear in the response if
|
|
703
779
|
* the cached volume is not restoring or bootstrapping.</p>
|
|
704
780
|
*/
|
|
705
781
|
VolumeProgress?: number;
|
|
706
782
|
/**
|
|
783
|
+
* @public
|
|
707
784
|
* <p>If the cached volume was created from a snapshot, this field contains the snapshot ID
|
|
708
785
|
* used, e.g., snap-78e22663. Otherwise, this field is not included.</p>
|
|
709
786
|
*/
|
|
710
787
|
SourceSnapshotId?: string;
|
|
711
788
|
/**
|
|
789
|
+
* @public
|
|
712
790
|
* <p>An <a>VolumeiSCSIAttributes</a> object that represents a collection of iSCSI
|
|
713
791
|
* attributes for one stored volume.</p>
|
|
714
792
|
*/
|
|
715
793
|
VolumeiSCSIAttributes?: VolumeiSCSIAttributes;
|
|
716
794
|
/**
|
|
795
|
+
* @public
|
|
717
796
|
* <p>The date the volume was created. Volumes created prior to March 28, 2017 don’t have this
|
|
718
797
|
* timestamp.</p>
|
|
719
798
|
*/
|
|
720
799
|
CreatedDate?: Date;
|
|
721
800
|
/**
|
|
801
|
+
* @public
|
|
722
802
|
* <p>The size of the data stored on the volume in bytes. This value is calculated based on
|
|
723
803
|
* the number of blocks that are touched, instead of the actual amount of data written. This
|
|
724
804
|
* value can be useful for sequential write patterns but less accurate for random write
|
|
@@ -738,11 +818,13 @@ export interface CachediSCSIVolume {
|
|
|
738
818
|
*/
|
|
739
819
|
VolumeUsedInBytes?: number;
|
|
740
820
|
/**
|
|
821
|
+
* @public
|
|
741
822
|
* <p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
|
|
742
823
|
* value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>
|
|
743
824
|
*/
|
|
744
825
|
KMSKey?: string;
|
|
745
826
|
/**
|
|
827
|
+
* @public
|
|
746
828
|
* <p>The name of the iSCSI target used by an initiator to connect to a volume and used as a
|
|
747
829
|
* suffix for the target ARN. For example, specifying <code>TargetName</code> as
|
|
748
830
|
* <i>myvolume</i> results in the target ARN of
|
|
@@ -760,11 +842,13 @@ export interface CachediSCSIVolume {
|
|
|
760
842
|
*/
|
|
761
843
|
export interface CancelArchivalInput {
|
|
762
844
|
/**
|
|
845
|
+
* @public
|
|
763
846
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
764
847
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
765
848
|
*/
|
|
766
849
|
GatewayARN: string | undefined;
|
|
767
850
|
/**
|
|
851
|
+
* @public
|
|
768
852
|
* <p>The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving
|
|
769
853
|
* for.</p>
|
|
770
854
|
*/
|
|
@@ -776,6 +860,7 @@ export interface CancelArchivalInput {
|
|
|
776
860
|
*/
|
|
777
861
|
export interface CancelArchivalOutput {
|
|
778
862
|
/**
|
|
863
|
+
* @public
|
|
779
864
|
* <p>The Amazon Resource Name (ARN) of the virtual tape for which archiving was
|
|
780
865
|
* canceled.</p>
|
|
781
866
|
*/
|
|
@@ -787,11 +872,13 @@ export interface CancelArchivalOutput {
|
|
|
787
872
|
*/
|
|
788
873
|
export interface CancelRetrievalInput {
|
|
789
874
|
/**
|
|
875
|
+
* @public
|
|
790
876
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
791
877
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
792
878
|
*/
|
|
793
879
|
GatewayARN: string | undefined;
|
|
794
880
|
/**
|
|
881
|
+
* @public
|
|
795
882
|
* <p>The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval
|
|
796
883
|
* for.</p>
|
|
797
884
|
*/
|
|
@@ -803,6 +890,7 @@ export interface CancelRetrievalInput {
|
|
|
803
890
|
*/
|
|
804
891
|
export interface CancelRetrievalOutput {
|
|
805
892
|
/**
|
|
893
|
+
* @public
|
|
806
894
|
* <p>The Amazon Resource Name (ARN) of the virtual tape for which retrieval was
|
|
807
895
|
* canceled.</p>
|
|
808
896
|
*/
|
|
@@ -819,21 +907,25 @@ export type CaseSensitivity = "CaseSensitive" | "ClientSpecified";
|
|
|
819
907
|
*/
|
|
820
908
|
export interface ChapInfo {
|
|
821
909
|
/**
|
|
910
|
+
* @public
|
|
822
911
|
* <p>The Amazon Resource Name (ARN) of the volume.</p>
|
|
823
912
|
*
|
|
824
913
|
* <p>Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).</p>
|
|
825
914
|
*/
|
|
826
915
|
TargetARN?: string;
|
|
827
916
|
/**
|
|
917
|
+
* @public
|
|
828
918
|
* <p>The secret key that the initiator (for example, the Windows client) must provide to
|
|
829
919
|
* participate in mutual CHAP with the target.</p>
|
|
830
920
|
*/
|
|
831
921
|
SecretToAuthenticateInitiator?: string;
|
|
832
922
|
/**
|
|
923
|
+
* @public
|
|
833
924
|
* <p>The iSCSI initiator that connects to the target.</p>
|
|
834
925
|
*/
|
|
835
926
|
InitiatorName?: string;
|
|
836
927
|
/**
|
|
928
|
+
* @public
|
|
837
929
|
* <p>The secret key that the target must provide to participate in mutual CHAP with the
|
|
838
930
|
* initiator (e.g., Windows client).</p>
|
|
839
931
|
*/
|
|
@@ -844,15 +936,18 @@ export interface ChapInfo {
|
|
|
844
936
|
*/
|
|
845
937
|
export interface CreateCachediSCSIVolumeInput {
|
|
846
938
|
/**
|
|
939
|
+
* @public
|
|
847
940
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
848
941
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
849
942
|
*/
|
|
850
943
|
GatewayARN: string | undefined;
|
|
851
944
|
/**
|
|
945
|
+
* @public
|
|
852
946
|
* <p>The size of the volume in bytes.</p>
|
|
853
947
|
*/
|
|
854
948
|
VolumeSizeInBytes: number | undefined;
|
|
855
949
|
/**
|
|
950
|
+
* @public
|
|
856
951
|
* <p>The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new cached
|
|
857
952
|
* volume. Specify this field if you want to create the iSCSI storage volume from a snapshot;
|
|
858
953
|
* otherwise, do not include this field. To list snapshots for your account use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html">DescribeSnapshots</a> in the <i>Amazon Elastic Compute Cloud API
|
|
@@ -860,6 +955,7 @@ export interface CreateCachediSCSIVolumeInput {
|
|
|
860
955
|
*/
|
|
861
956
|
SnapshotId?: string;
|
|
862
957
|
/**
|
|
958
|
+
* @public
|
|
863
959
|
* <p>The name of the iSCSI target used by an initiator to connect to a volume and used as a
|
|
864
960
|
* suffix for the target ARN. For example, specifying <code>TargetName</code> as
|
|
865
961
|
* <i>myvolume</i> results in the target ARN of
|
|
@@ -871,6 +967,7 @@ export interface CreateCachediSCSIVolumeInput {
|
|
|
871
967
|
*/
|
|
872
968
|
TargetName: string | undefined;
|
|
873
969
|
/**
|
|
970
|
+
* @public
|
|
874
971
|
* <p>The ARN for an existing volume. Specifying this ARN makes the new volume into an exact
|
|
875
972
|
* copy of the specified existing volume's latest recovery point. The
|
|
876
973
|
* <code>VolumeSizeInBytes</code> value for this new volume must be equal to or larger than
|
|
@@ -878,6 +975,7 @@ export interface CreateCachediSCSIVolumeInput {
|
|
|
878
975
|
*/
|
|
879
976
|
SourceVolumeARN?: string;
|
|
880
977
|
/**
|
|
978
|
+
* @public
|
|
881
979
|
* <p>The network interface of the gateway on which to expose the iSCSI target. Only IPv4
|
|
882
980
|
* addresses are accepted. Use <a>DescribeGatewayInformation</a> to get a list of
|
|
883
981
|
* the network interfaces available on a gateway.</p>
|
|
@@ -886,11 +984,13 @@ export interface CreateCachediSCSIVolumeInput {
|
|
|
886
984
|
*/
|
|
887
985
|
NetworkInterfaceId: string | undefined;
|
|
888
986
|
/**
|
|
987
|
+
* @public
|
|
889
988
|
* <p>A unique identifier that you use to retry a request. If you retry a request, use the
|
|
890
989
|
* same <code>ClientToken</code> you specified in the initial request.</p>
|
|
891
990
|
*/
|
|
892
991
|
ClientToken: string | undefined;
|
|
893
992
|
/**
|
|
993
|
+
* @public
|
|
894
994
|
* <p>Set to <code>true</code> to use Amazon S3 server-side encryption with your own
|
|
895
995
|
* KMS key, or <code>false</code> to use a key managed by Amazon S3.
|
|
896
996
|
* Optional.</p>
|
|
@@ -900,11 +1000,13 @@ export interface CreateCachediSCSIVolumeInput {
|
|
|
900
1000
|
*/
|
|
901
1001
|
KMSEncrypted?: boolean;
|
|
902
1002
|
/**
|
|
1003
|
+
* @public
|
|
903
1004
|
* <p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
|
|
904
1005
|
* value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>
|
|
905
1006
|
*/
|
|
906
1007
|
KMSKey?: string;
|
|
907
1008
|
/**
|
|
1009
|
+
* @public
|
|
908
1010
|
* <p>A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value
|
|
909
1011
|
* pair.</p>
|
|
910
1012
|
*
|
|
@@ -922,10 +1024,12 @@ export interface CreateCachediSCSIVolumeInput {
|
|
|
922
1024
|
*/
|
|
923
1025
|
export interface CreateCachediSCSIVolumeOutput {
|
|
924
1026
|
/**
|
|
1027
|
+
* @public
|
|
925
1028
|
* <p>The Amazon Resource Name (ARN) of the configured volume.</p>
|
|
926
1029
|
*/
|
|
927
1030
|
VolumeARN?: string;
|
|
928
1031
|
/**
|
|
1032
|
+
* @public
|
|
929
1033
|
* <p>The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that
|
|
930
1034
|
* initiators can use to connect to the target.</p>
|
|
931
1035
|
*/
|
|
@@ -941,22 +1045,26 @@ export interface CreateCachediSCSIVolumeOutput {
|
|
|
941
1045
|
*/
|
|
942
1046
|
export interface NFSFileShareDefaults {
|
|
943
1047
|
/**
|
|
1048
|
+
* @public
|
|
944
1049
|
* <p>The Unix file mode in the form "nnnn". For example, <code>0666</code> represents the
|
|
945
1050
|
* default file mode inside the file share. The default value is <code>0666</code>.</p>
|
|
946
1051
|
*/
|
|
947
1052
|
FileMode?: string;
|
|
948
1053
|
/**
|
|
1054
|
+
* @public
|
|
949
1055
|
* <p>The Unix directory mode in the form "nnnn". For example, <code>0666</code> represents
|
|
950
1056
|
* the default access mode for all directories inside the file share. The default value is
|
|
951
1057
|
* <code>0777</code>.</p>
|
|
952
1058
|
*/
|
|
953
1059
|
DirectoryMode?: string;
|
|
954
1060
|
/**
|
|
1061
|
+
* @public
|
|
955
1062
|
* <p>The default group ID for the file share (unless the files have another group ID
|
|
956
1063
|
* specified). The default value is <code>nfsnobody</code>.</p>
|
|
957
1064
|
*/
|
|
958
1065
|
GroupId?: number;
|
|
959
1066
|
/**
|
|
1067
|
+
* @public
|
|
960
1068
|
* <p>The default owner ID for files in the file share (unless the files have another owner ID
|
|
961
1069
|
* specified). The default value is <code>nfsnobody</code>.</p>
|
|
962
1070
|
*/
|
|
@@ -972,20 +1080,24 @@ export type ObjectACL = "authenticated-read" | "aws-exec-read" | "bucket-owner-f
|
|
|
972
1080
|
*/
|
|
973
1081
|
export interface CreateNFSFileShareInput {
|
|
974
1082
|
/**
|
|
1083
|
+
* @public
|
|
975
1084
|
* <p>A unique string value that you supply that is used by S3 File Gateway to ensure
|
|
976
1085
|
* idempotent file share creation.</p>
|
|
977
1086
|
*/
|
|
978
1087
|
ClientToken: string | undefined;
|
|
979
1088
|
/**
|
|
1089
|
+
* @public
|
|
980
1090
|
* <p>File share default values. Optional.</p>
|
|
981
1091
|
*/
|
|
982
1092
|
NFSFileShareDefaults?: NFSFileShareDefaults;
|
|
983
1093
|
/**
|
|
1094
|
+
* @public
|
|
984
1095
|
* <p>The Amazon Resource Name (ARN) of the S3 File Gateway on which you want to create a file
|
|
985
1096
|
* share.</p>
|
|
986
1097
|
*/
|
|
987
1098
|
GatewayARN: string | undefined;
|
|
988
1099
|
/**
|
|
1100
|
+
* @public
|
|
989
1101
|
* <p>Set to <code>true</code> to use Amazon S3 server-side encryption with your own
|
|
990
1102
|
* KMS key, or <code>false</code> to use a key managed by Amazon S3.
|
|
991
1103
|
* Optional.</p>
|
|
@@ -995,16 +1107,19 @@ export interface CreateNFSFileShareInput {
|
|
|
995
1107
|
*/
|
|
996
1108
|
KMSEncrypted?: boolean;
|
|
997
1109
|
/**
|
|
1110
|
+
* @public
|
|
998
1111
|
* <p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
|
|
999
1112
|
* value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>
|
|
1000
1113
|
*/
|
|
1001
1114
|
KMSKey?: string;
|
|
1002
1115
|
/**
|
|
1116
|
+
* @public
|
|
1003
1117
|
* <p>The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it
|
|
1004
1118
|
* accesses the underlying storage.</p>
|
|
1005
1119
|
*/
|
|
1006
1120
|
Role: string | undefined;
|
|
1007
1121
|
/**
|
|
1122
|
+
* @public
|
|
1008
1123
|
* <p>A custom ARN for the backend storage used for storing data for file shares. It includes
|
|
1009
1124
|
* a resource ARN with an optional prefix concatenation. The prefix must end with a forward
|
|
1010
1125
|
* slash (/).</p>
|
|
@@ -1033,6 +1148,7 @@ export interface CreateNFSFileShareInput {
|
|
|
1033
1148
|
*/
|
|
1034
1149
|
LocationARN: string | undefined;
|
|
1035
1150
|
/**
|
|
1151
|
+
* @public
|
|
1036
1152
|
* <p>The default storage class for objects put into an Amazon S3 bucket by the S3
|
|
1037
1153
|
* File Gateway. The default value is <code>S3_STANDARD</code>. Optional.</p>
|
|
1038
1154
|
*
|
|
@@ -1042,16 +1158,19 @@ export interface CreateNFSFileShareInput {
|
|
|
1042
1158
|
*/
|
|
1043
1159
|
DefaultStorageClass?: string;
|
|
1044
1160
|
/**
|
|
1161
|
+
* @public
|
|
1045
1162
|
* <p>A value that sets the access control list (ACL) permission for objects in the S3 bucket
|
|
1046
1163
|
* that a S3 File Gateway puts objects into. The default value is <code>private</code>.</p>
|
|
1047
1164
|
*/
|
|
1048
1165
|
ObjectACL?: ObjectACL | string;
|
|
1049
1166
|
/**
|
|
1167
|
+
* @public
|
|
1050
1168
|
* <p>The list of clients that are allowed to access the S3 File Gateway. The list must
|
|
1051
1169
|
* contain either valid IP addresses or valid CIDR blocks.</p>
|
|
1052
1170
|
*/
|
|
1053
1171
|
ClientList?: string[];
|
|
1054
1172
|
/**
|
|
1173
|
+
* @public
|
|
1055
1174
|
* <p>A value that maps a user to anonymous user.</p>
|
|
1056
1175
|
*
|
|
1057
1176
|
* <p>Valid values are the following:</p>
|
|
@@ -1073,6 +1192,7 @@ export interface CreateNFSFileShareInput {
|
|
|
1073
1192
|
*/
|
|
1074
1193
|
Squash?: string;
|
|
1075
1194
|
/**
|
|
1195
|
+
* @public
|
|
1076
1196
|
* <p>A value that sets the write status of a file share. Set this value to <code>true</code>
|
|
1077
1197
|
* to set the write status to read-only, otherwise set to <code>false</code>.</p>
|
|
1078
1198
|
*
|
|
@@ -1081,6 +1201,7 @@ export interface CreateNFSFileShareInput {
|
|
|
1081
1201
|
*/
|
|
1082
1202
|
ReadOnly?: boolean;
|
|
1083
1203
|
/**
|
|
1204
|
+
* @public
|
|
1084
1205
|
* <p>A value that enables guessing of the MIME type for uploaded objects based on file
|
|
1085
1206
|
* extensions. Set this value to <code>true</code> to enable MIME type guessing, otherwise set
|
|
1086
1207
|
* to <code>false</code>. The default value is <code>true</code>.</p>
|
|
@@ -1090,6 +1211,7 @@ export interface CreateNFSFileShareInput {
|
|
|
1090
1211
|
*/
|
|
1091
1212
|
GuessMIMETypeEnabled?: boolean;
|
|
1092
1213
|
/**
|
|
1214
|
+
* @public
|
|
1093
1215
|
* <p>A value that sets who pays the cost of the request and the cost associated with data
|
|
1094
1216
|
* download from the S3 bucket. If this value is set to <code>true</code>, the requester pays
|
|
1095
1217
|
* the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays
|
|
@@ -1107,6 +1229,7 @@ export interface CreateNFSFileShareInput {
|
|
|
1107
1229
|
*/
|
|
1108
1230
|
RequesterPays?: boolean;
|
|
1109
1231
|
/**
|
|
1232
|
+
* @public
|
|
1110
1233
|
* <p>A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a
|
|
1111
1234
|
* key-value pair.</p>
|
|
1112
1235
|
*
|
|
@@ -1119,6 +1242,7 @@ export interface CreateNFSFileShareInput {
|
|
|
1119
1242
|
*/
|
|
1120
1243
|
Tags?: Tag[];
|
|
1121
1244
|
/**
|
|
1245
|
+
* @public
|
|
1122
1246
|
* <p>The name of the file share. Optional.</p>
|
|
1123
1247
|
*
|
|
1124
1248
|
* <note>
|
|
@@ -1129,10 +1253,12 @@ export interface CreateNFSFileShareInput {
|
|
|
1129
1253
|
*/
|
|
1130
1254
|
FileShareName?: string;
|
|
1131
1255
|
/**
|
|
1256
|
+
* @public
|
|
1132
1257
|
* <p>Specifies refresh cache information for the file share.</p>
|
|
1133
1258
|
*/
|
|
1134
1259
|
CacheAttributes?: CacheAttributes;
|
|
1135
1260
|
/**
|
|
1261
|
+
* @public
|
|
1136
1262
|
* <p>The notification policy of the file share. <code>SettlingTimeInSeconds</code> controls
|
|
1137
1263
|
* the number of seconds to wait after the last point in time a client wrote to a file before
|
|
1138
1264
|
* generating an <code>ObjectUploaded</code> notification. Because clients can make many small
|
|
@@ -1160,6 +1286,7 @@ export interface CreateNFSFileShareInput {
|
|
|
1160
1286
|
*/
|
|
1161
1287
|
NotificationPolicy?: string;
|
|
1162
1288
|
/**
|
|
1289
|
+
* @public
|
|
1163
1290
|
* <p>Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to
|
|
1164
1291
|
* Amazon S3.</p>
|
|
1165
1292
|
* <note>
|
|
@@ -1170,6 +1297,7 @@ export interface CreateNFSFileShareInput {
|
|
|
1170
1297
|
*/
|
|
1171
1298
|
VPCEndpointDNSName?: string;
|
|
1172
1299
|
/**
|
|
1300
|
+
* @public
|
|
1173
1301
|
* <p>Specifies the Region of the S3 bucket where the NFS file share stores files.</p>
|
|
1174
1302
|
* <note>
|
|
1175
1303
|
* <p>This parameter is required for NFS file shares that connect to Amazon S3
|
|
@@ -1179,6 +1307,7 @@ export interface CreateNFSFileShareInput {
|
|
|
1179
1307
|
*/
|
|
1180
1308
|
BucketRegion?: string;
|
|
1181
1309
|
/**
|
|
1310
|
+
* @public
|
|
1182
1311
|
* <p>The Amazon Resource Name (ARN) of the storage used for audit logs.</p>
|
|
1183
1312
|
*/
|
|
1184
1313
|
AuditDestinationARN?: string;
|
|
@@ -1189,6 +1318,7 @@ export interface CreateNFSFileShareInput {
|
|
|
1189
1318
|
*/
|
|
1190
1319
|
export interface CreateNFSFileShareOutput {
|
|
1191
1320
|
/**
|
|
1321
|
+
* @public
|
|
1192
1322
|
* <p>The Amazon Resource Name (ARN) of the newly created file share.</p>
|
|
1193
1323
|
*/
|
|
1194
1324
|
FileShareARN?: string;
|
|
@@ -1199,15 +1329,18 @@ export interface CreateNFSFileShareOutput {
|
|
|
1199
1329
|
*/
|
|
1200
1330
|
export interface CreateSMBFileShareInput {
|
|
1201
1331
|
/**
|
|
1332
|
+
* @public
|
|
1202
1333
|
* <p>A unique string value that you supply that is used by S3 File Gateway to ensure
|
|
1203
1334
|
* idempotent file share creation.</p>
|
|
1204
1335
|
*/
|
|
1205
1336
|
ClientToken: string | undefined;
|
|
1206
1337
|
/**
|
|
1338
|
+
* @public
|
|
1207
1339
|
* <p>The ARN of the S3 File Gateway on which you want to create a file share.</p>
|
|
1208
1340
|
*/
|
|
1209
1341
|
GatewayARN: string | undefined;
|
|
1210
1342
|
/**
|
|
1343
|
+
* @public
|
|
1211
1344
|
* <p>Set to <code>true</code> to use Amazon S3 server-side encryption with your own
|
|
1212
1345
|
* KMS key, or <code>false</code> to use a key managed by Amazon S3.
|
|
1213
1346
|
* Optional.</p>
|
|
@@ -1217,16 +1350,19 @@ export interface CreateSMBFileShareInput {
|
|
|
1217
1350
|
*/
|
|
1218
1351
|
KMSEncrypted?: boolean;
|
|
1219
1352
|
/**
|
|
1353
|
+
* @public
|
|
1220
1354
|
* <p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
|
|
1221
1355
|
* value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>
|
|
1222
1356
|
*/
|
|
1223
1357
|
KMSKey?: string;
|
|
1224
1358
|
/**
|
|
1359
|
+
* @public
|
|
1225
1360
|
* <p>The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it
|
|
1226
1361
|
* accesses the underlying storage.</p>
|
|
1227
1362
|
*/
|
|
1228
1363
|
Role: string | undefined;
|
|
1229
1364
|
/**
|
|
1365
|
+
* @public
|
|
1230
1366
|
* <p>A custom ARN for the backend storage used for storing data for file shares. It includes
|
|
1231
1367
|
* a resource ARN with an optional prefix concatenation. The prefix must end with a forward
|
|
1232
1368
|
* slash (/).</p>
|
|
@@ -1255,6 +1391,7 @@ export interface CreateSMBFileShareInput {
|
|
|
1255
1391
|
*/
|
|
1256
1392
|
LocationARN: string | undefined;
|
|
1257
1393
|
/**
|
|
1394
|
+
* @public
|
|
1258
1395
|
* <p>The default storage class for objects put into an Amazon S3 bucket by the S3
|
|
1259
1396
|
* File Gateway. The default value is <code>S3_STANDARD</code>. Optional.</p>
|
|
1260
1397
|
*
|
|
@@ -1264,11 +1401,13 @@ export interface CreateSMBFileShareInput {
|
|
|
1264
1401
|
*/
|
|
1265
1402
|
DefaultStorageClass?: string;
|
|
1266
1403
|
/**
|
|
1404
|
+
* @public
|
|
1267
1405
|
* <p>A value that sets the access control list (ACL) permission for objects in the S3 bucket
|
|
1268
1406
|
* that a S3 File Gateway puts objects into. The default value is <code>private</code>.</p>
|
|
1269
1407
|
*/
|
|
1270
1408
|
ObjectACL?: ObjectACL | string;
|
|
1271
1409
|
/**
|
|
1410
|
+
* @public
|
|
1272
1411
|
* <p>A value that sets the write status of a file share. Set this value to <code>true</code>
|
|
1273
1412
|
* to set the write status to read-only, otherwise set to <code>false</code>.</p>
|
|
1274
1413
|
*
|
|
@@ -1277,6 +1416,7 @@ export interface CreateSMBFileShareInput {
|
|
|
1277
1416
|
*/
|
|
1278
1417
|
ReadOnly?: boolean;
|
|
1279
1418
|
/**
|
|
1419
|
+
* @public
|
|
1280
1420
|
* <p>A value that enables guessing of the MIME type for uploaded objects based on file
|
|
1281
1421
|
* extensions. Set this value to <code>true</code> to enable MIME type guessing, otherwise set
|
|
1282
1422
|
* to <code>false</code>. The default value is <code>true</code>.</p>
|
|
@@ -1286,6 +1426,7 @@ export interface CreateSMBFileShareInput {
|
|
|
1286
1426
|
*/
|
|
1287
1427
|
GuessMIMETypeEnabled?: boolean;
|
|
1288
1428
|
/**
|
|
1429
|
+
* @public
|
|
1289
1430
|
* <p>A value that sets who pays the cost of the request and the cost associated with data
|
|
1290
1431
|
* download from the S3 bucket. If this value is set to <code>true</code>, the requester pays
|
|
1291
1432
|
* the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays
|
|
@@ -1303,6 +1444,7 @@ export interface CreateSMBFileShareInput {
|
|
|
1303
1444
|
*/
|
|
1304
1445
|
RequesterPays?: boolean;
|
|
1305
1446
|
/**
|
|
1447
|
+
* @public
|
|
1306
1448
|
* <p>Set this value to <code>true</code> to enable access control list (ACL) on the SMB file
|
|
1307
1449
|
* share. Set it to <code>false</code> to map file and directory permissions to the POSIX
|
|
1308
1450
|
* permissions.</p>
|
|
@@ -1318,11 +1460,13 @@ export interface CreateSMBFileShareInput {
|
|
|
1318
1460
|
*/
|
|
1319
1461
|
SMBACLEnabled?: boolean;
|
|
1320
1462
|
/**
|
|
1463
|
+
* @public
|
|
1321
1464
|
* <p>The files and folders on this share will only be visible to users with read
|
|
1322
1465
|
* access.</p>
|
|
1323
1466
|
*/
|
|
1324
1467
|
AccessBasedEnumeration?: boolean;
|
|
1325
1468
|
/**
|
|
1469
|
+
* @public
|
|
1326
1470
|
* <p>A list of users or groups in the Active Directory that will be granted administrator
|
|
1327
1471
|
* privileges on the file share. These users can do all file operations as the super-user.
|
|
1328
1472
|
* Acceptable formats include: <code>DOMAIN\User1</code>, <code>user1</code>,
|
|
@@ -1335,6 +1479,7 @@ export interface CreateSMBFileShareInput {
|
|
|
1335
1479
|
*/
|
|
1336
1480
|
AdminUserList?: string[];
|
|
1337
1481
|
/**
|
|
1482
|
+
* @public
|
|
1338
1483
|
* <p>A list of users or groups in the Active Directory that are allowed to access the file
|
|
1339
1484
|
* <a href=""></a> share. A group must be prefixed with the @ character. Acceptable formats
|
|
1340
1485
|
* include: <code>DOMAIN\User1</code>, <code>user1</code>, <code>@group1</code>, and
|
|
@@ -1343,6 +1488,7 @@ export interface CreateSMBFileShareInput {
|
|
|
1343
1488
|
*/
|
|
1344
1489
|
ValidUserList?: string[];
|
|
1345
1490
|
/**
|
|
1491
|
+
* @public
|
|
1346
1492
|
* <p>A list of users or groups in the Active Directory that are not allowed to access the
|
|
1347
1493
|
* file share. A group must be prefixed with the @ character. Acceptable formats include:
|
|
1348
1494
|
* <code>DOMAIN\User1</code>, <code>user1</code>, <code>@group1</code>, and
|
|
@@ -1351,10 +1497,12 @@ export interface CreateSMBFileShareInput {
|
|
|
1351
1497
|
*/
|
|
1352
1498
|
InvalidUserList?: string[];
|
|
1353
1499
|
/**
|
|
1500
|
+
* @public
|
|
1354
1501
|
* <p>The Amazon Resource Name (ARN) of the storage used for audit logs.</p>
|
|
1355
1502
|
*/
|
|
1356
1503
|
AuditDestinationARN?: string;
|
|
1357
1504
|
/**
|
|
1505
|
+
* @public
|
|
1358
1506
|
* <p>The authentication method that users use to access the file share. The default is
|
|
1359
1507
|
* <code>ActiveDirectory</code>.</p>
|
|
1360
1508
|
*
|
|
@@ -1363,6 +1511,7 @@ export interface CreateSMBFileShareInput {
|
|
|
1363
1511
|
*/
|
|
1364
1512
|
Authentication?: string;
|
|
1365
1513
|
/**
|
|
1514
|
+
* @public
|
|
1366
1515
|
* <p>The case of an object name in an Amazon S3 bucket. For
|
|
1367
1516
|
* <code>ClientSpecified</code>, the client determines the case sensitivity. For
|
|
1368
1517
|
* <code>CaseSensitive</code>, the gateway determines the case sensitivity. The default
|
|
@@ -1370,6 +1519,7 @@ export interface CreateSMBFileShareInput {
|
|
|
1370
1519
|
*/
|
|
1371
1520
|
CaseSensitivity?: CaseSensitivity | string;
|
|
1372
1521
|
/**
|
|
1522
|
+
* @public
|
|
1373
1523
|
* <p>A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a
|
|
1374
1524
|
* key-value pair.</p>
|
|
1375
1525
|
*
|
|
@@ -1382,6 +1532,7 @@ export interface CreateSMBFileShareInput {
|
|
|
1382
1532
|
*/
|
|
1383
1533
|
Tags?: Tag[];
|
|
1384
1534
|
/**
|
|
1535
|
+
* @public
|
|
1385
1536
|
* <p>The name of the file share. Optional.</p>
|
|
1386
1537
|
*
|
|
1387
1538
|
* <note>
|
|
@@ -1392,10 +1543,12 @@ export interface CreateSMBFileShareInput {
|
|
|
1392
1543
|
*/
|
|
1393
1544
|
FileShareName?: string;
|
|
1394
1545
|
/**
|
|
1546
|
+
* @public
|
|
1395
1547
|
* <p>Specifies refresh cache information for the file share.</p>
|
|
1396
1548
|
*/
|
|
1397
1549
|
CacheAttributes?: CacheAttributes;
|
|
1398
1550
|
/**
|
|
1551
|
+
* @public
|
|
1399
1552
|
* <p>The notification policy of the file share. <code>SettlingTimeInSeconds</code> controls
|
|
1400
1553
|
* the number of seconds to wait after the last point in time a client wrote to a file before
|
|
1401
1554
|
* generating an <code>ObjectUploaded</code> notification. Because clients can make many small
|
|
@@ -1423,6 +1576,7 @@ export interface CreateSMBFileShareInput {
|
|
|
1423
1576
|
*/
|
|
1424
1577
|
NotificationPolicy?: string;
|
|
1425
1578
|
/**
|
|
1579
|
+
* @public
|
|
1426
1580
|
* <p>Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to
|
|
1427
1581
|
* Amazon S3.</p>
|
|
1428
1582
|
* <note>
|
|
@@ -1433,6 +1587,7 @@ export interface CreateSMBFileShareInput {
|
|
|
1433
1587
|
*/
|
|
1434
1588
|
VPCEndpointDNSName?: string;
|
|
1435
1589
|
/**
|
|
1590
|
+
* @public
|
|
1436
1591
|
* <p>Specifies the Region of the S3 bucket where the SMB file share stores files.</p>
|
|
1437
1592
|
* <note>
|
|
1438
1593
|
* <p>This parameter is required for SMB file shares that connect to Amazon S3
|
|
@@ -1442,6 +1597,7 @@ export interface CreateSMBFileShareInput {
|
|
|
1442
1597
|
*/
|
|
1443
1598
|
BucketRegion?: string;
|
|
1444
1599
|
/**
|
|
1600
|
+
* @public
|
|
1445
1601
|
* <p>Specifies whether opportunistic locking is enabled for the SMB file share.</p>
|
|
1446
1602
|
* <note>
|
|
1447
1603
|
* <p>Enabling opportunistic locking on case-sensitive shares is not recommended for
|
|
@@ -1458,6 +1614,7 @@ export interface CreateSMBFileShareInput {
|
|
|
1458
1614
|
*/
|
|
1459
1615
|
export interface CreateSMBFileShareOutput {
|
|
1460
1616
|
/**
|
|
1617
|
+
* @public
|
|
1461
1618
|
* <p>The Amazon Resource Name (ARN) of the newly created file share.</p>
|
|
1462
1619
|
*/
|
|
1463
1620
|
FileShareARN?: string;
|
|
@@ -1481,11 +1638,13 @@ export interface CreateSMBFileShareOutput {
|
|
|
1481
1638
|
*/
|
|
1482
1639
|
export interface CreateSnapshotInput {
|
|
1483
1640
|
/**
|
|
1641
|
+
* @public
|
|
1484
1642
|
* <p>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a>
|
|
1485
1643
|
* operation to return a list of gateway volumes.</p>
|
|
1486
1644
|
*/
|
|
1487
1645
|
VolumeARN: string | undefined;
|
|
1488
1646
|
/**
|
|
1647
|
+
* @public
|
|
1489
1648
|
* <p>Textual description of the snapshot that appears in the Amazon EC2 console, Elastic
|
|
1490
1649
|
* Block Store snapshots panel in the <b>Description</b> field, and
|
|
1491
1650
|
* in the Storage Gateway snapshot <b>Details</b> pane,
|
|
@@ -1493,6 +1652,7 @@ export interface CreateSnapshotInput {
|
|
|
1493
1652
|
*/
|
|
1494
1653
|
SnapshotDescription: string | undefined;
|
|
1495
1654
|
/**
|
|
1655
|
+
* @public
|
|
1496
1656
|
* <p>A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value
|
|
1497
1657
|
* pair.</p>
|
|
1498
1658
|
*
|
|
@@ -1511,10 +1671,12 @@ export interface CreateSnapshotInput {
|
|
|
1511
1671
|
*/
|
|
1512
1672
|
export interface CreateSnapshotOutput {
|
|
1513
1673
|
/**
|
|
1674
|
+
* @public
|
|
1514
1675
|
* <p>The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.</p>
|
|
1515
1676
|
*/
|
|
1516
1677
|
VolumeARN?: string;
|
|
1517
1678
|
/**
|
|
1679
|
+
* @public
|
|
1518
1680
|
* <p>The snapshot ID that is used to refer to the snapshot in future operations such as
|
|
1519
1681
|
* describing snapshots (Amazon Elastic Compute Cloud API <code>DescribeSnapshots</code>) or
|
|
1520
1682
|
* creating a volume from a snapshot (<a>CreateStorediSCSIVolume</a>).</p>
|
|
@@ -1530,6 +1692,7 @@ export declare class ServiceUnavailableError extends __BaseException {
|
|
|
1530
1692
|
readonly name: "ServiceUnavailableError";
|
|
1531
1693
|
readonly $fault: "server";
|
|
1532
1694
|
/**
|
|
1695
|
+
* @public
|
|
1533
1696
|
* <p>A <a>StorageGatewayError</a> that provides more information about the cause
|
|
1534
1697
|
* of the error.</p>
|
|
1535
1698
|
*/
|
|
@@ -1544,11 +1707,13 @@ export declare class ServiceUnavailableError extends __BaseException {
|
|
|
1544
1707
|
*/
|
|
1545
1708
|
export interface CreateSnapshotFromVolumeRecoveryPointInput {
|
|
1546
1709
|
/**
|
|
1710
|
+
* @public
|
|
1547
1711
|
* <p>The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <a>DescribeStorediSCSIVolumes</a> operation to return to retrieve the TargetARN for
|
|
1548
1712
|
* specified VolumeARN.</p>
|
|
1549
1713
|
*/
|
|
1550
1714
|
VolumeARN: string | undefined;
|
|
1551
1715
|
/**
|
|
1716
|
+
* @public
|
|
1552
1717
|
* <p>Textual description of the snapshot that appears in the Amazon EC2 console, Elastic
|
|
1553
1718
|
* Block Store snapshots panel in the <b>Description</b> field, and
|
|
1554
1719
|
* in the Storage Gateway snapshot <b>Details</b> pane,
|
|
@@ -1556,6 +1721,7 @@ export interface CreateSnapshotFromVolumeRecoveryPointInput {
|
|
|
1556
1721
|
*/
|
|
1557
1722
|
SnapshotDescription: string | undefined;
|
|
1558
1723
|
/**
|
|
1724
|
+
* @public
|
|
1559
1725
|
* <p>A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value
|
|
1560
1726
|
* pair.</p>
|
|
1561
1727
|
*
|
|
@@ -1573,15 +1739,18 @@ export interface CreateSnapshotFromVolumeRecoveryPointInput {
|
|
|
1573
1739
|
*/
|
|
1574
1740
|
export interface CreateSnapshotFromVolumeRecoveryPointOutput {
|
|
1575
1741
|
/**
|
|
1742
|
+
* @public
|
|
1576
1743
|
* <p>The ID of the snapshot.</p>
|
|
1577
1744
|
*/
|
|
1578
1745
|
SnapshotId?: string;
|
|
1579
1746
|
/**
|
|
1747
|
+
* @public
|
|
1580
1748
|
* <p>The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <a>DescribeStorediSCSIVolumes</a> operation to return to retrieve the TargetARN for
|
|
1581
1749
|
* specified VolumeARN.</p>
|
|
1582
1750
|
*/
|
|
1583
1751
|
VolumeARN?: string;
|
|
1584
1752
|
/**
|
|
1753
|
+
* @public
|
|
1585
1754
|
* <p>The time the volume was created from the recovery point.</p>
|
|
1586
1755
|
*/
|
|
1587
1756
|
VolumeRecoveryPointTime?: string;
|
|
@@ -1620,17 +1789,20 @@ export interface CreateSnapshotFromVolumeRecoveryPointOutput {
|
|
|
1620
1789
|
*/
|
|
1621
1790
|
export interface CreateStorediSCSIVolumeInput {
|
|
1622
1791
|
/**
|
|
1792
|
+
* @public
|
|
1623
1793
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
1624
1794
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
1625
1795
|
*/
|
|
1626
1796
|
GatewayARN: string | undefined;
|
|
1627
1797
|
/**
|
|
1798
|
+
* @public
|
|
1628
1799
|
* <p>The unique identifier for the gateway local disk that is configured as a stored volume.
|
|
1629
1800
|
* Use <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/API_ListLocalDisks.html">ListLocalDisks</a> to
|
|
1630
1801
|
* list disk IDs for a gateway.</p>
|
|
1631
1802
|
*/
|
|
1632
1803
|
DiskId: string | undefined;
|
|
1633
1804
|
/**
|
|
1805
|
+
* @public
|
|
1634
1806
|
* <p>The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored
|
|
1635
1807
|
* volume. Specify this field if you want to create the iSCSI storage volume from a snapshot;
|
|
1636
1808
|
* otherwise, do not include this field. To list snapshots for your account use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html">DescribeSnapshots</a> in the <i>Amazon Elastic Compute Cloud API
|
|
@@ -1638,6 +1810,7 @@ export interface CreateStorediSCSIVolumeInput {
|
|
|
1638
1810
|
*/
|
|
1639
1811
|
SnapshotId?: string;
|
|
1640
1812
|
/**
|
|
1813
|
+
* @public
|
|
1641
1814
|
* <p>Set to <code>true</code> if you want to preserve the data on the local disk. Otherwise,
|
|
1642
1815
|
* set to <code>false</code> to create an empty volume.</p>
|
|
1643
1816
|
*
|
|
@@ -1646,6 +1819,7 @@ export interface CreateStorediSCSIVolumeInput {
|
|
|
1646
1819
|
*/
|
|
1647
1820
|
PreserveExistingData: boolean | undefined;
|
|
1648
1821
|
/**
|
|
1822
|
+
* @public
|
|
1649
1823
|
* <p>The name of the iSCSI target used by an initiator to connect to a volume and used as a
|
|
1650
1824
|
* suffix for the target ARN. For example, specifying <code>TargetName</code> as
|
|
1651
1825
|
* <i>myvolume</i> results in the target ARN of
|
|
@@ -1657,6 +1831,7 @@ export interface CreateStorediSCSIVolumeInput {
|
|
|
1657
1831
|
*/
|
|
1658
1832
|
TargetName: string | undefined;
|
|
1659
1833
|
/**
|
|
1834
|
+
* @public
|
|
1660
1835
|
* <p>The network interface of the gateway on which to expose the iSCSI target. Only IPv4
|
|
1661
1836
|
* addresses are accepted. Use <a>DescribeGatewayInformation</a> to get a list of
|
|
1662
1837
|
* the network interfaces available on a gateway.</p>
|
|
@@ -1665,6 +1840,7 @@ export interface CreateStorediSCSIVolumeInput {
|
|
|
1665
1840
|
*/
|
|
1666
1841
|
NetworkInterfaceId: string | undefined;
|
|
1667
1842
|
/**
|
|
1843
|
+
* @public
|
|
1668
1844
|
* <p>Set to <code>true</code> to use Amazon S3 server-side encryption with your own
|
|
1669
1845
|
* KMS key, or <code>false</code> to use a key managed by Amazon S3.
|
|
1670
1846
|
* Optional.</p>
|
|
@@ -1674,11 +1850,13 @@ export interface CreateStorediSCSIVolumeInput {
|
|
|
1674
1850
|
*/
|
|
1675
1851
|
KMSEncrypted?: boolean;
|
|
1676
1852
|
/**
|
|
1853
|
+
* @public
|
|
1677
1854
|
* <p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
|
|
1678
1855
|
* value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>
|
|
1679
1856
|
*/
|
|
1680
1857
|
KMSKey?: string;
|
|
1681
1858
|
/**
|
|
1859
|
+
* @public
|
|
1682
1860
|
* <p>A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value
|
|
1683
1861
|
* pair.</p>
|
|
1684
1862
|
*
|
|
@@ -1697,14 +1875,17 @@ export interface CreateStorediSCSIVolumeInput {
|
|
|
1697
1875
|
*/
|
|
1698
1876
|
export interface CreateStorediSCSIVolumeOutput {
|
|
1699
1877
|
/**
|
|
1878
|
+
* @public
|
|
1700
1879
|
* <p>The Amazon Resource Name (ARN) of the configured volume.</p>
|
|
1701
1880
|
*/
|
|
1702
1881
|
VolumeARN?: string;
|
|
1703
1882
|
/**
|
|
1883
|
+
* @public
|
|
1704
1884
|
* <p>The size of the volume in bytes.</p>
|
|
1705
1885
|
*/
|
|
1706
1886
|
VolumeSizeInBytes?: number;
|
|
1707
1887
|
/**
|
|
1888
|
+
* @public
|
|
1708
1889
|
* <p>The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that
|
|
1709
1890
|
* initiators can use to connect to the target.</p>
|
|
1710
1891
|
*/
|
|
@@ -1723,16 +1904,19 @@ export type TapeStorageClass = "DEEP_ARCHIVE" | "GLACIER";
|
|
|
1723
1904
|
*/
|
|
1724
1905
|
export interface CreateTapePoolInput {
|
|
1725
1906
|
/**
|
|
1907
|
+
* @public
|
|
1726
1908
|
* <p>The name of the new custom tape pool.</p>
|
|
1727
1909
|
*/
|
|
1728
1910
|
PoolName: string | undefined;
|
|
1729
1911
|
/**
|
|
1912
|
+
* @public
|
|
1730
1913
|
* <p>The storage class that is associated with the new custom pool. When you use your backup
|
|
1731
1914
|
* application to eject the tape, the tape is archived directly into the storage class (S3
|
|
1732
1915
|
* Glacier or S3 Glacier Deep Archive) that corresponds to the pool.</p>
|
|
1733
1916
|
*/
|
|
1734
1917
|
StorageClass: TapeStorageClass | string | undefined;
|
|
1735
1918
|
/**
|
|
1919
|
+
* @public
|
|
1736
1920
|
* <p>Tape retention lock can be configured in two modes. When configured in governance mode,
|
|
1737
1921
|
* Amazon Web Services accounts with specific IAM permissions are authorized to remove the
|
|
1738
1922
|
* tape retention lock from archived virtual tapes. When configured in compliance mode, the
|
|
@@ -1740,11 +1924,13 @@ export interface CreateTapePoolInput {
|
|
|
1740
1924
|
*/
|
|
1741
1925
|
RetentionLockType?: RetentionLockType | string;
|
|
1742
1926
|
/**
|
|
1927
|
+
* @public
|
|
1743
1928
|
* <p>Tape retention lock time is set in days. Tape retention lock can be enabled for up to
|
|
1744
1929
|
* 100 years (36,500 days).</p>
|
|
1745
1930
|
*/
|
|
1746
1931
|
RetentionLockTimeInDays?: number;
|
|
1747
1932
|
/**
|
|
1933
|
+
* @public
|
|
1748
1934
|
* <p>A list of up to 50 tags that can be assigned to tape pool. Each tag is a key-value
|
|
1749
1935
|
* pair.</p>
|
|
1750
1936
|
*
|
|
@@ -1762,6 +1948,7 @@ export interface CreateTapePoolInput {
|
|
|
1762
1948
|
*/
|
|
1763
1949
|
export interface CreateTapePoolOutput {
|
|
1764
1950
|
/**
|
|
1951
|
+
* @public
|
|
1765
1952
|
* <p>The unique Amazon Resource Name (ARN) that represents the custom tape pool. Use the
|
|
1766
1953
|
* <a>ListTapePools</a> operation to return a list of tape pools for your
|
|
1767
1954
|
* account and Amazon Web Services Region.</p>
|
|
@@ -1774,12 +1961,14 @@ export interface CreateTapePoolOutput {
|
|
|
1774
1961
|
*/
|
|
1775
1962
|
export interface CreateTapesInput {
|
|
1776
1963
|
/**
|
|
1964
|
+
* @public
|
|
1777
1965
|
* <p>The unique Amazon Resource Name (ARN) that represents the gateway to associate the
|
|
1778
1966
|
* virtual tapes with. Use the <a>ListGateways</a> operation to return a list of
|
|
1779
1967
|
* gateways for your account and Amazon Web Services Region.</p>
|
|
1780
1968
|
*/
|
|
1781
1969
|
GatewayARN: string | undefined;
|
|
1782
1970
|
/**
|
|
1971
|
+
* @public
|
|
1783
1972
|
* <p>The size, in bytes, of the virtual tapes that you want to create.</p>
|
|
1784
1973
|
*
|
|
1785
1974
|
* <note>
|
|
@@ -1788,6 +1977,7 @@ export interface CreateTapesInput {
|
|
|
1788
1977
|
*/
|
|
1789
1978
|
TapeSizeInBytes: number | undefined;
|
|
1790
1979
|
/**
|
|
1980
|
+
* @public
|
|
1791
1981
|
* <p>A unique identifier that you use to retry a request. If you retry a request, use the
|
|
1792
1982
|
* same <code>ClientToken</code> you specified in the initial request.</p>
|
|
1793
1983
|
*
|
|
@@ -1798,10 +1988,12 @@ export interface CreateTapesInput {
|
|
|
1798
1988
|
*/
|
|
1799
1989
|
ClientToken: string | undefined;
|
|
1800
1990
|
/**
|
|
1991
|
+
* @public
|
|
1801
1992
|
* <p>The number of virtual tapes that you want to create.</p>
|
|
1802
1993
|
*/
|
|
1803
1994
|
NumTapesToCreate: number | undefined;
|
|
1804
1995
|
/**
|
|
1996
|
+
* @public
|
|
1805
1997
|
* <p>A prefix that you append to the barcode of the virtual tape you are creating. This
|
|
1806
1998
|
* prefix makes the barcode unique.</p>
|
|
1807
1999
|
*
|
|
@@ -1812,6 +2004,7 @@ export interface CreateTapesInput {
|
|
|
1812
2004
|
*/
|
|
1813
2005
|
TapeBarcodePrefix: string | undefined;
|
|
1814
2006
|
/**
|
|
2007
|
+
* @public
|
|
1815
2008
|
* <p>Set to <code>true</code> to use Amazon S3 server-side encryption with your own
|
|
1816
2009
|
* KMS key, or <code>false</code> to use a key managed by Amazon S3.
|
|
1817
2010
|
* Optional.</p>
|
|
@@ -1821,11 +2014,13 @@ export interface CreateTapesInput {
|
|
|
1821
2014
|
*/
|
|
1822
2015
|
KMSEncrypted?: boolean;
|
|
1823
2016
|
/**
|
|
2017
|
+
* @public
|
|
1824
2018
|
* <p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
|
|
1825
2019
|
* value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>
|
|
1826
2020
|
*/
|
|
1827
2021
|
KMSKey?: string;
|
|
1828
2022
|
/**
|
|
2023
|
+
* @public
|
|
1829
2024
|
* <p>The ID of the pool that you want to add your tape to for archiving. The tape in this
|
|
1830
2025
|
* pool is archived in the S3 storage class that is associated with the pool. When you use
|
|
1831
2026
|
* your backup application to eject the tape, the tape is archived directly into the storage
|
|
@@ -1833,11 +2028,13 @@ export interface CreateTapesInput {
|
|
|
1833
2028
|
*/
|
|
1834
2029
|
PoolId?: string;
|
|
1835
2030
|
/**
|
|
2031
|
+
* @public
|
|
1836
2032
|
* <p>Set to <code>TRUE</code> if the tape you are creating is to be configured as a
|
|
1837
2033
|
* write-once-read-many (WORM) tape.</p>
|
|
1838
2034
|
*/
|
|
1839
2035
|
Worm?: boolean;
|
|
1840
2036
|
/**
|
|
2037
|
+
* @public
|
|
1841
2038
|
* <p>A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value
|
|
1842
2039
|
* pair.</p>
|
|
1843
2040
|
*
|
|
@@ -1856,6 +2053,7 @@ export interface CreateTapesInput {
|
|
|
1856
2053
|
*/
|
|
1857
2054
|
export interface CreateTapesOutput {
|
|
1858
2055
|
/**
|
|
2056
|
+
* @public
|
|
1859
2057
|
* <p>A list of unique Amazon Resource Names (ARNs) that represents the virtual tapes that
|
|
1860
2058
|
* were created.</p>
|
|
1861
2059
|
*/
|
|
@@ -1867,12 +2065,14 @@ export interface CreateTapesOutput {
|
|
|
1867
2065
|
*/
|
|
1868
2066
|
export interface CreateTapeWithBarcodeInput {
|
|
1869
2067
|
/**
|
|
2068
|
+
* @public
|
|
1870
2069
|
* <p>The unique Amazon Resource Name (ARN) that represents the gateway to associate the
|
|
1871
2070
|
* virtual tape with. Use the <a>ListGateways</a> operation to return a list of
|
|
1872
2071
|
* gateways for your account and Amazon Web Services Region.</p>
|
|
1873
2072
|
*/
|
|
1874
2073
|
GatewayARN: string | undefined;
|
|
1875
2074
|
/**
|
|
2075
|
+
* @public
|
|
1876
2076
|
* <p>The size, in bytes, of the virtual tape that you want to create.</p>
|
|
1877
2077
|
*
|
|
1878
2078
|
* <note>
|
|
@@ -1881,6 +2081,7 @@ export interface CreateTapeWithBarcodeInput {
|
|
|
1881
2081
|
*/
|
|
1882
2082
|
TapeSizeInBytes: number | undefined;
|
|
1883
2083
|
/**
|
|
2084
|
+
* @public
|
|
1884
2085
|
* <p>The barcode that you want to assign to the tape.</p>
|
|
1885
2086
|
*
|
|
1886
2087
|
* <note>
|
|
@@ -1890,6 +2091,7 @@ export interface CreateTapeWithBarcodeInput {
|
|
|
1890
2091
|
*/
|
|
1891
2092
|
TapeBarcode: string | undefined;
|
|
1892
2093
|
/**
|
|
2094
|
+
* @public
|
|
1893
2095
|
* <p>Set to <code>true</code> to use Amazon S3 server-side encryption with your own
|
|
1894
2096
|
* KMS key, or <code>false</code> to use a key managed by Amazon S3.
|
|
1895
2097
|
* Optional.</p>
|
|
@@ -1899,11 +2101,13 @@ export interface CreateTapeWithBarcodeInput {
|
|
|
1899
2101
|
*/
|
|
1900
2102
|
KMSEncrypted?: boolean;
|
|
1901
2103
|
/**
|
|
2104
|
+
* @public
|
|
1902
2105
|
* <p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
|
|
1903
2106
|
* value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>
|
|
1904
2107
|
*/
|
|
1905
2108
|
KMSKey?: string;
|
|
1906
2109
|
/**
|
|
2110
|
+
* @public
|
|
1907
2111
|
* <p>The ID of the pool that you want to add your tape to for archiving. The tape in this
|
|
1908
2112
|
* pool is archived in the S3 storage class that is associated with the pool. When you use
|
|
1909
2113
|
* your backup application to eject the tape, the tape is archived directly into the storage
|
|
@@ -1911,11 +2115,13 @@ export interface CreateTapeWithBarcodeInput {
|
|
|
1911
2115
|
*/
|
|
1912
2116
|
PoolId?: string;
|
|
1913
2117
|
/**
|
|
2118
|
+
* @public
|
|
1914
2119
|
* <p>Set to <code>TRUE</code> if the tape you are creating is to be configured as a
|
|
1915
2120
|
* write-once-read-many (WORM) tape.</p>
|
|
1916
2121
|
*/
|
|
1917
2122
|
Worm?: boolean;
|
|
1918
2123
|
/**
|
|
2124
|
+
* @public
|
|
1919
2125
|
* <p>A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each
|
|
1920
2126
|
* tag is a key-value pair.</p>
|
|
1921
2127
|
*
|
|
@@ -1934,6 +2140,7 @@ export interface CreateTapeWithBarcodeInput {
|
|
|
1934
2140
|
*/
|
|
1935
2141
|
export interface CreateTapeWithBarcodeOutput {
|
|
1936
2142
|
/**
|
|
2143
|
+
* @public
|
|
1937
2144
|
* <p>A unique Amazon Resource Name (ARN) that represents the virtual tape that was
|
|
1938
2145
|
* created.</p>
|
|
1939
2146
|
*/
|
|
@@ -1944,6 +2151,7 @@ export interface CreateTapeWithBarcodeOutput {
|
|
|
1944
2151
|
*/
|
|
1945
2152
|
export interface DeleteAutomaticTapeCreationPolicyInput {
|
|
1946
2153
|
/**
|
|
2154
|
+
* @public
|
|
1947
2155
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
1948
2156
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
1949
2157
|
*/
|
|
@@ -1954,6 +2162,7 @@ export interface DeleteAutomaticTapeCreationPolicyInput {
|
|
|
1954
2162
|
*/
|
|
1955
2163
|
export interface DeleteAutomaticTapeCreationPolicyOutput {
|
|
1956
2164
|
/**
|
|
2165
|
+
* @public
|
|
1957
2166
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
1958
2167
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
1959
2168
|
*/
|
|
@@ -1973,11 +2182,13 @@ export interface DeleteAutomaticTapeCreationPolicyOutput {
|
|
|
1973
2182
|
*/
|
|
1974
2183
|
export interface DeleteBandwidthRateLimitInput {
|
|
1975
2184
|
/**
|
|
2185
|
+
* @public
|
|
1976
2186
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
1977
2187
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
1978
2188
|
*/
|
|
1979
2189
|
GatewayARN: string | undefined;
|
|
1980
2190
|
/**
|
|
2191
|
+
* @public
|
|
1981
2192
|
* <p>One of the BandwidthType values that indicates the gateway bandwidth rate limit to
|
|
1982
2193
|
* delete.</p>
|
|
1983
2194
|
*
|
|
@@ -1993,6 +2204,7 @@ export interface DeleteBandwidthRateLimitInput {
|
|
|
1993
2204
|
*/
|
|
1994
2205
|
export interface DeleteBandwidthRateLimitOutput {
|
|
1995
2206
|
/**
|
|
2207
|
+
* @public
|
|
1996
2208
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
1997
2209
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
1998
2210
|
*/
|
|
@@ -2017,11 +2229,13 @@ export interface DeleteBandwidthRateLimitOutput {
|
|
|
2017
2229
|
*/
|
|
2018
2230
|
export interface DeleteChapCredentialsInput {
|
|
2019
2231
|
/**
|
|
2232
|
+
* @public
|
|
2020
2233
|
* <p>The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <a>DescribeStorediSCSIVolumes</a> operation to return to retrieve the TargetARN for
|
|
2021
2234
|
* specified VolumeARN.</p>
|
|
2022
2235
|
*/
|
|
2023
2236
|
TargetARN: string | undefined;
|
|
2024
2237
|
/**
|
|
2238
|
+
* @public
|
|
2025
2239
|
* <p>The iSCSI initiator that connects to the target.</p>
|
|
2026
2240
|
*/
|
|
2027
2241
|
InitiatorName: string | undefined;
|
|
@@ -2032,10 +2246,12 @@ export interface DeleteChapCredentialsInput {
|
|
|
2032
2246
|
*/
|
|
2033
2247
|
export interface DeleteChapCredentialsOutput {
|
|
2034
2248
|
/**
|
|
2249
|
+
* @public
|
|
2035
2250
|
* <p>The Amazon Resource Name (ARN) of the target.</p>
|
|
2036
2251
|
*/
|
|
2037
2252
|
TargetARN?: string;
|
|
2038
2253
|
/**
|
|
2254
|
+
* @public
|
|
2039
2255
|
* <p>The iSCSI initiator that connects to the target.</p>
|
|
2040
2256
|
*/
|
|
2041
2257
|
InitiatorName?: string;
|
|
@@ -2046,10 +2262,12 @@ export interface DeleteChapCredentialsOutput {
|
|
|
2046
2262
|
*/
|
|
2047
2263
|
export interface DeleteFileShareInput {
|
|
2048
2264
|
/**
|
|
2265
|
+
* @public
|
|
2049
2266
|
* <p>The Amazon Resource Name (ARN) of the file share to be deleted.</p>
|
|
2050
2267
|
*/
|
|
2051
2268
|
FileShareARN: string | undefined;
|
|
2052
2269
|
/**
|
|
2270
|
+
* @public
|
|
2053
2271
|
* <p>If this value is set to <code>true</code>, the operation deletes a file share
|
|
2054
2272
|
* immediately and aborts all data uploads to Amazon Web Services. Otherwise, the file share is
|
|
2055
2273
|
* not deleted until all data is uploaded to Amazon Web Services. This process aborts the data
|
|
@@ -2066,6 +2284,7 @@ export interface DeleteFileShareInput {
|
|
|
2066
2284
|
*/
|
|
2067
2285
|
export interface DeleteFileShareOutput {
|
|
2068
2286
|
/**
|
|
2287
|
+
* @public
|
|
2069
2288
|
* <p>The Amazon Resource Name (ARN) of the deleted file share.</p>
|
|
2070
2289
|
*/
|
|
2071
2290
|
FileShareARN?: string;
|
|
@@ -2076,6 +2295,7 @@ export interface DeleteFileShareOutput {
|
|
|
2076
2295
|
*/
|
|
2077
2296
|
export interface DeleteGatewayInput {
|
|
2078
2297
|
/**
|
|
2298
|
+
* @public
|
|
2079
2299
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
2080
2300
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
2081
2301
|
*/
|
|
@@ -2087,6 +2307,7 @@ export interface DeleteGatewayInput {
|
|
|
2087
2307
|
*/
|
|
2088
2308
|
export interface DeleteGatewayOutput {
|
|
2089
2309
|
/**
|
|
2310
|
+
* @public
|
|
2090
2311
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
2091
2312
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
2092
2313
|
*/
|
|
@@ -2097,6 +2318,7 @@ export interface DeleteGatewayOutput {
|
|
|
2097
2318
|
*/
|
|
2098
2319
|
export interface DeleteSnapshotScheduleInput {
|
|
2099
2320
|
/**
|
|
2321
|
+
* @public
|
|
2100
2322
|
* <p>The volume which snapshot schedule to delete.</p>
|
|
2101
2323
|
*/
|
|
2102
2324
|
VolumeARN: string | undefined;
|
|
@@ -2106,6 +2328,7 @@ export interface DeleteSnapshotScheduleInput {
|
|
|
2106
2328
|
*/
|
|
2107
2329
|
export interface DeleteSnapshotScheduleOutput {
|
|
2108
2330
|
/**
|
|
2331
|
+
* @public
|
|
2109
2332
|
* <p>The volume which snapshot schedule was deleted.</p>
|
|
2110
2333
|
*/
|
|
2111
2334
|
VolumeARN?: string;
|
|
@@ -2116,16 +2339,19 @@ export interface DeleteSnapshotScheduleOutput {
|
|
|
2116
2339
|
*/
|
|
2117
2340
|
export interface DeleteTapeInput {
|
|
2118
2341
|
/**
|
|
2342
|
+
* @public
|
|
2119
2343
|
* <p>The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is
|
|
2120
2344
|
* associated with. Use the <a>ListGateways</a> operation to return a list of
|
|
2121
2345
|
* gateways for your account and Amazon Web Services Region.</p>
|
|
2122
2346
|
*/
|
|
2123
2347
|
GatewayARN: string | undefined;
|
|
2124
2348
|
/**
|
|
2349
|
+
* @public
|
|
2125
2350
|
* <p>The Amazon Resource Name (ARN) of the virtual tape to delete.</p>
|
|
2126
2351
|
*/
|
|
2127
2352
|
TapeARN: string | undefined;
|
|
2128
2353
|
/**
|
|
2354
|
+
* @public
|
|
2129
2355
|
* <p>Set to <code>TRUE</code> to delete an archived tape that belongs to a custom pool with
|
|
2130
2356
|
* tape retention lock. Only archived tapes with tape retention lock set to
|
|
2131
2357
|
* <code>governance</code> can be deleted. Archived tapes with tape retention lock set to
|
|
@@ -2139,6 +2365,7 @@ export interface DeleteTapeInput {
|
|
|
2139
2365
|
*/
|
|
2140
2366
|
export interface DeleteTapeOutput {
|
|
2141
2367
|
/**
|
|
2368
|
+
* @public
|
|
2142
2369
|
* <p>The Amazon Resource Name (ARN) of the deleted virtual tape.</p>
|
|
2143
2370
|
*/
|
|
2144
2371
|
TapeARN?: string;
|
|
@@ -2149,11 +2376,13 @@ export interface DeleteTapeOutput {
|
|
|
2149
2376
|
*/
|
|
2150
2377
|
export interface DeleteTapeArchiveInput {
|
|
2151
2378
|
/**
|
|
2379
|
+
* @public
|
|
2152
2380
|
* <p>The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf
|
|
2153
2381
|
* (VTS).</p>
|
|
2154
2382
|
*/
|
|
2155
2383
|
TapeARN: string | undefined;
|
|
2156
2384
|
/**
|
|
2385
|
+
* @public
|
|
2157
2386
|
* <p>Set to <code>TRUE</code> to delete an archived tape that belongs to a custom pool with
|
|
2158
2387
|
* tape retention lock. Only archived tapes with tape retention lock set to
|
|
2159
2388
|
* <code>governance</code> can be deleted. Archived tapes with tape retention lock set to
|
|
@@ -2167,6 +2396,7 @@ export interface DeleteTapeArchiveInput {
|
|
|
2167
2396
|
*/
|
|
2168
2397
|
export interface DeleteTapeArchiveOutput {
|
|
2169
2398
|
/**
|
|
2399
|
+
* @public
|
|
2170
2400
|
* <p>The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual
|
|
2171
2401
|
* tape shelf (VTS).</p>
|
|
2172
2402
|
*/
|
|
@@ -2177,6 +2407,7 @@ export interface DeleteTapeArchiveOutput {
|
|
|
2177
2407
|
*/
|
|
2178
2408
|
export interface DeleteTapePoolInput {
|
|
2179
2409
|
/**
|
|
2410
|
+
* @public
|
|
2180
2411
|
* <p>The Amazon Resource Name (ARN) of the custom tape pool to delete.</p>
|
|
2181
2412
|
*/
|
|
2182
2413
|
PoolARN: string | undefined;
|
|
@@ -2186,6 +2417,7 @@ export interface DeleteTapePoolInput {
|
|
|
2186
2417
|
*/
|
|
2187
2418
|
export interface DeleteTapePoolOutput {
|
|
2188
2419
|
/**
|
|
2420
|
+
* @public
|
|
2189
2421
|
* <p>The Amazon Resource Name (ARN) of the custom tape pool being deleted.</p>
|
|
2190
2422
|
*/
|
|
2191
2423
|
PoolARN?: string;
|
|
@@ -2197,6 +2429,7 @@ export interface DeleteTapePoolOutput {
|
|
|
2197
2429
|
*/
|
|
2198
2430
|
export interface DeleteVolumeInput {
|
|
2199
2431
|
/**
|
|
2432
|
+
* @public
|
|
2200
2433
|
* <p>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a>
|
|
2201
2434
|
* operation to return a list of gateway volumes.</p>
|
|
2202
2435
|
*/
|
|
@@ -2209,6 +2442,7 @@ export interface DeleteVolumeInput {
|
|
|
2209
2442
|
*/
|
|
2210
2443
|
export interface DeleteVolumeOutput {
|
|
2211
2444
|
/**
|
|
2445
|
+
* @public
|
|
2212
2446
|
* <p>The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same
|
|
2213
2447
|
* ARN you provided in the request.</p>
|
|
2214
2448
|
*/
|
|
@@ -2219,6 +2453,7 @@ export interface DeleteVolumeOutput {
|
|
|
2219
2453
|
*/
|
|
2220
2454
|
export interface DescribeAvailabilityMonitorTestInput {
|
|
2221
2455
|
/**
|
|
2456
|
+
* @public
|
|
2222
2457
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
2223
2458
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
2224
2459
|
*/
|
|
@@ -2229,16 +2464,19 @@ export interface DescribeAvailabilityMonitorTestInput {
|
|
|
2229
2464
|
*/
|
|
2230
2465
|
export interface DescribeAvailabilityMonitorTestOutput {
|
|
2231
2466
|
/**
|
|
2467
|
+
* @public
|
|
2232
2468
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
2233
2469
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
2234
2470
|
*/
|
|
2235
2471
|
GatewayARN?: string;
|
|
2236
2472
|
/**
|
|
2473
|
+
* @public
|
|
2237
2474
|
* <p>The status of the high availability monitoring test. If a test hasn't been
|
|
2238
2475
|
* performed, the value of this field is null.</p>
|
|
2239
2476
|
*/
|
|
2240
2477
|
Status?: AvailabilityMonitorTestStatus | string;
|
|
2241
2478
|
/**
|
|
2479
|
+
* @public
|
|
2242
2480
|
* <p>The time the high availability monitoring test was started. If a test hasn't been
|
|
2243
2481
|
* performed, the value of this field is null.</p>
|
|
2244
2482
|
*/
|
|
@@ -2250,6 +2488,7 @@ export interface DescribeAvailabilityMonitorTestOutput {
|
|
|
2250
2488
|
*/
|
|
2251
2489
|
export interface DescribeBandwidthRateLimitInput {
|
|
2252
2490
|
/**
|
|
2491
|
+
* @public
|
|
2253
2492
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
2254
2493
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
2255
2494
|
*/
|
|
@@ -2261,16 +2500,19 @@ export interface DescribeBandwidthRateLimitInput {
|
|
|
2261
2500
|
*/
|
|
2262
2501
|
export interface DescribeBandwidthRateLimitOutput {
|
|
2263
2502
|
/**
|
|
2503
|
+
* @public
|
|
2264
2504
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
2265
2505
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
2266
2506
|
*/
|
|
2267
2507
|
GatewayARN?: string;
|
|
2268
2508
|
/**
|
|
2509
|
+
* @public
|
|
2269
2510
|
* <p>The average upload bandwidth rate limit in bits per second. This field does not appear
|
|
2270
2511
|
* in the response if the upload rate limit is not set.</p>
|
|
2271
2512
|
*/
|
|
2272
2513
|
AverageUploadRateLimitInBitsPerSec?: number;
|
|
2273
2514
|
/**
|
|
2515
|
+
* @public
|
|
2274
2516
|
* <p>The average download bandwidth rate limit in bits per second. This field does not appear
|
|
2275
2517
|
* in the response if the download rate limit is not set.</p>
|
|
2276
2518
|
*/
|
|
@@ -2281,6 +2523,7 @@ export interface DescribeBandwidthRateLimitOutput {
|
|
|
2281
2523
|
*/
|
|
2282
2524
|
export interface DescribeBandwidthRateLimitScheduleInput {
|
|
2283
2525
|
/**
|
|
2526
|
+
* @public
|
|
2284
2527
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
2285
2528
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
2286
2529
|
*/
|
|
@@ -2291,11 +2534,13 @@ export interface DescribeBandwidthRateLimitScheduleInput {
|
|
|
2291
2534
|
*/
|
|
2292
2535
|
export interface DescribeBandwidthRateLimitScheduleOutput {
|
|
2293
2536
|
/**
|
|
2537
|
+
* @public
|
|
2294
2538
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
2295
2539
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
2296
2540
|
*/
|
|
2297
2541
|
GatewayARN?: string;
|
|
2298
2542
|
/**
|
|
2543
|
+
* @public
|
|
2299
2544
|
* <p> An array that contains the bandwidth rate limit intervals for a tape or volume gateway. </p>
|
|
2300
2545
|
*/
|
|
2301
2546
|
BandwidthRateLimitIntervals?: BandwidthRateLimitInterval[];
|
|
@@ -2305,6 +2550,7 @@ export interface DescribeBandwidthRateLimitScheduleOutput {
|
|
|
2305
2550
|
*/
|
|
2306
2551
|
export interface DescribeCacheInput {
|
|
2307
2552
|
/**
|
|
2553
|
+
* @public
|
|
2308
2554
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
2309
2555
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
2310
2556
|
*/
|
|
@@ -2315,37 +2561,44 @@ export interface DescribeCacheInput {
|
|
|
2315
2561
|
*/
|
|
2316
2562
|
export interface DescribeCacheOutput {
|
|
2317
2563
|
/**
|
|
2564
|
+
* @public
|
|
2318
2565
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
2319
2566
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
2320
2567
|
*/
|
|
2321
2568
|
GatewayARN?: string;
|
|
2322
2569
|
/**
|
|
2570
|
+
* @public
|
|
2323
2571
|
* <p>An array of strings that identify disks that are to be configured as working storage.
|
|
2324
2572
|
* Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs
|
|
2325
2573
|
* from the <a>ListLocalDisks</a> API.</p>
|
|
2326
2574
|
*/
|
|
2327
2575
|
DiskIds?: string[];
|
|
2328
2576
|
/**
|
|
2577
|
+
* @public
|
|
2329
2578
|
* <p>The amount of cache in bytes allocated to a gateway.</p>
|
|
2330
2579
|
*/
|
|
2331
2580
|
CacheAllocatedInBytes?: number;
|
|
2332
2581
|
/**
|
|
2582
|
+
* @public
|
|
2333
2583
|
* <p>Percent use of the gateway's cache storage. This metric applies only to the
|
|
2334
2584
|
* gateway-cached volume setup. The sample is taken at the end of the reporting period.</p>
|
|
2335
2585
|
*/
|
|
2336
2586
|
CacheUsedPercentage?: number;
|
|
2337
2587
|
/**
|
|
2588
|
+
* @public
|
|
2338
2589
|
* <p>The file share's contribution to the overall percentage of the gateway's cache
|
|
2339
2590
|
* that has not been persisted to Amazon Web Services. The sample is taken at the end of the
|
|
2340
2591
|
* reporting period.</p>
|
|
2341
2592
|
*/
|
|
2342
2593
|
CacheDirtyPercentage?: number;
|
|
2343
2594
|
/**
|
|
2595
|
+
* @public
|
|
2344
2596
|
* <p>Percent of application read operations from the file shares that are served from cache.
|
|
2345
2597
|
* The sample is taken at the end of the reporting period.</p>
|
|
2346
2598
|
*/
|
|
2347
2599
|
CacheHitPercentage?: number;
|
|
2348
2600
|
/**
|
|
2601
|
+
* @public
|
|
2349
2602
|
* <p>Percent of application read operations from the file shares that are not served from
|
|
2350
2603
|
* cache. The sample is taken at the end of the reporting period.</p>
|
|
2351
2604
|
*/
|
|
@@ -2356,6 +2609,7 @@ export interface DescribeCacheOutput {
|
|
|
2356
2609
|
*/
|
|
2357
2610
|
export interface DescribeCachediSCSIVolumesInput {
|
|
2358
2611
|
/**
|
|
2612
|
+
* @public
|
|
2359
2613
|
* <p>An array of strings where each string represents the Amazon Resource Name (ARN) of a
|
|
2360
2614
|
* cached volume. All of the specified cached volumes must be from the same gateway. Use <a>ListVolumes</a> to get volume ARNs for a gateway.</p>
|
|
2361
2615
|
*/
|
|
@@ -2367,6 +2621,7 @@ export interface DescribeCachediSCSIVolumesInput {
|
|
|
2367
2621
|
*/
|
|
2368
2622
|
export interface DescribeCachediSCSIVolumesOutput {
|
|
2369
2623
|
/**
|
|
2624
|
+
* @public
|
|
2370
2625
|
* <p>An array of objects where each object contains metadata about one cached volume.</p>
|
|
2371
2626
|
*/
|
|
2372
2627
|
CachediSCSIVolumes?: CachediSCSIVolume[];
|
|
@@ -2378,6 +2633,7 @@ export interface DescribeCachediSCSIVolumesOutput {
|
|
|
2378
2633
|
*/
|
|
2379
2634
|
export interface DescribeChapCredentialsInput {
|
|
2380
2635
|
/**
|
|
2636
|
+
* @public
|
|
2381
2637
|
* <p>The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <a>DescribeStorediSCSIVolumes</a> operation to return to retrieve the TargetARN for
|
|
2382
2638
|
* specified VolumeARN.</p>
|
|
2383
2639
|
*/
|
|
@@ -2389,6 +2645,7 @@ export interface DescribeChapCredentialsInput {
|
|
|
2389
2645
|
*/
|
|
2390
2646
|
export interface DescribeChapCredentialsOutput {
|
|
2391
2647
|
/**
|
|
2648
|
+
* @public
|
|
2392
2649
|
* <p>An array of <a>ChapInfo</a> objects that represent CHAP credentials. Each
|
|
2393
2650
|
* object in the array contains CHAP credential information for one target-initiator pair. If
|
|
2394
2651
|
* no CHAP credentials are set, an empty array is returned. CHAP credential information is
|
|
@@ -2430,6 +2687,7 @@ export interface DescribeChapCredentialsOutput {
|
|
|
2430
2687
|
*/
|
|
2431
2688
|
export interface DescribeFileSystemAssociationsInput {
|
|
2432
2689
|
/**
|
|
2690
|
+
* @public
|
|
2433
2691
|
* <p>An array containing the Amazon Resource Name (ARN) of each file system association to be
|
|
2434
2692
|
* described.</p>
|
|
2435
2693
|
*/
|
|
@@ -2441,6 +2699,7 @@ export interface DescribeFileSystemAssociationsInput {
|
|
|
2441
2699
|
*/
|
|
2442
2700
|
export interface FileSystemAssociationStatusDetail {
|
|
2443
2701
|
/**
|
|
2702
|
+
* @public
|
|
2444
2703
|
* <p>The error code for a given file system association status.</p>
|
|
2445
2704
|
*/
|
|
2446
2705
|
ErrorCode?: string;
|
|
@@ -2452,16 +2711,19 @@ export interface FileSystemAssociationStatusDetail {
|
|
|
2452
2711
|
*/
|
|
2453
2712
|
export interface FileSystemAssociationInfo {
|
|
2454
2713
|
/**
|
|
2714
|
+
* @public
|
|
2455
2715
|
* <p>The Amazon Resource Name (ARN) of the file system association.</p>
|
|
2456
2716
|
*/
|
|
2457
2717
|
FileSystemAssociationARN?: string;
|
|
2458
2718
|
/**
|
|
2719
|
+
* @public
|
|
2459
2720
|
* <p>The ARN of the backend Amazon FSx file system used for storing file data. For
|
|
2460
2721
|
* information, see <a href="https://docs.aws.amazon.com/fsx/latest/APIReference/API_FileSystem.html">FileSystem</a> in the
|
|
2461
2722
|
* <i>Amazon FSx API Reference</i>.</p>
|
|
2462
2723
|
*/
|
|
2463
2724
|
LocationARN?: string;
|
|
2464
2725
|
/**
|
|
2726
|
+
* @public
|
|
2465
2727
|
* <p>The status of the file system association. Valid Values: <code>AVAILABLE</code> |
|
|
2466
2728
|
* <code>CREATING</code> | <code>DELETING</code> | <code>FORCE_DELETING</code> |
|
|
2467
2729
|
* <code>UPDATING</code> | <code>ERROR</code>
|
|
@@ -2469,24 +2731,29 @@ export interface FileSystemAssociationInfo {
|
|
|
2469
2731
|
*/
|
|
2470
2732
|
FileSystemAssociationStatus?: string;
|
|
2471
2733
|
/**
|
|
2734
|
+
* @public
|
|
2472
2735
|
* <p>The Amazon Resource Name (ARN) of the storage used for the audit logs.</p>
|
|
2473
2736
|
*/
|
|
2474
2737
|
AuditDestinationARN?: string;
|
|
2475
2738
|
/**
|
|
2739
|
+
* @public
|
|
2476
2740
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
2477
2741
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
2478
2742
|
*/
|
|
2479
2743
|
GatewayARN?: string;
|
|
2480
2744
|
/**
|
|
2745
|
+
* @public
|
|
2481
2746
|
* <p>A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key
|
|
2482
2747
|
* name. Each tag is a key-value pair.</p>
|
|
2483
2748
|
*/
|
|
2484
2749
|
Tags?: Tag[];
|
|
2485
2750
|
/**
|
|
2751
|
+
* @public
|
|
2486
2752
|
* <p>The refresh cache information for the file share or FSx file systems.</p>
|
|
2487
2753
|
*/
|
|
2488
2754
|
CacheAttributes?: CacheAttributes;
|
|
2489
2755
|
/**
|
|
2756
|
+
* @public
|
|
2490
2757
|
* <p>Specifies network configuration information for the gateway associated with the Amazon FSx file system.</p>
|
|
2491
2758
|
* <note>
|
|
2492
2759
|
* <p>If multiple file systems are associated with this gateway, this parameter's
|
|
@@ -2495,6 +2762,7 @@ export interface FileSystemAssociationInfo {
|
|
|
2495
2762
|
*/
|
|
2496
2763
|
EndpointNetworkConfiguration?: EndpointNetworkConfiguration;
|
|
2497
2764
|
/**
|
|
2765
|
+
* @public
|
|
2498
2766
|
* <p>An array containing the FileSystemAssociationStatusDetail data type, which provides
|
|
2499
2767
|
* detailed information on file system association status.</p>
|
|
2500
2768
|
*/
|
|
@@ -2505,6 +2773,7 @@ export interface FileSystemAssociationInfo {
|
|
|
2505
2773
|
*/
|
|
2506
2774
|
export interface DescribeFileSystemAssociationsOutput {
|
|
2507
2775
|
/**
|
|
2776
|
+
* @public
|
|
2508
2777
|
* <p>An array containing the <code>FileSystemAssociationInfo</code> data type of each file
|
|
2509
2778
|
* system association to be described.
|
|
2510
2779
|
* </p>
|
|
@@ -2517,6 +2786,7 @@ export interface DescribeFileSystemAssociationsOutput {
|
|
|
2517
2786
|
*/
|
|
2518
2787
|
export interface DescribeGatewayInformationInput {
|
|
2519
2788
|
/**
|
|
2789
|
+
* @public
|
|
2520
2790
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
2521
2791
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
2522
2792
|
*/
|
|
@@ -2541,10 +2811,12 @@ export type GatewayCapacity = (typeof GatewayCapacity)[keyof typeof GatewayCapac
|
|
|
2541
2811
|
*/
|
|
2542
2812
|
export interface NetworkInterface {
|
|
2543
2813
|
/**
|
|
2814
|
+
* @public
|
|
2544
2815
|
* <p>The Internet Protocol version 4 (IPv4) address of the interface.</p>
|
|
2545
2816
|
*/
|
|
2546
2817
|
Ipv4Address?: string;
|
|
2547
2818
|
/**
|
|
2819
|
+
* @public
|
|
2548
2820
|
* <p>The Media Access Control (MAC) address of the interface.</p>
|
|
2549
2821
|
*
|
|
2550
2822
|
* <note>
|
|
@@ -2553,6 +2825,7 @@ export interface NetworkInterface {
|
|
|
2553
2825
|
*/
|
|
2554
2826
|
MacAddress?: string;
|
|
2555
2827
|
/**
|
|
2828
|
+
* @public
|
|
2556
2829
|
* <p>The Internet Protocol version 6 (IPv6) address of the interface. <i>Currently not
|
|
2557
2830
|
* supported</i>.</p>
|
|
2558
2831
|
*/
|
|
@@ -2568,44 +2841,53 @@ export type HostEnvironment = "EC2" | "HYPER-V" | "KVM" | "OTHER" | "SNOWBALL" |
|
|
|
2568
2841
|
*/
|
|
2569
2842
|
export interface DescribeGatewayInformationOutput {
|
|
2570
2843
|
/**
|
|
2844
|
+
* @public
|
|
2571
2845
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
2572
2846
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
2573
2847
|
*/
|
|
2574
2848
|
GatewayARN?: string;
|
|
2575
2849
|
/**
|
|
2850
|
+
* @public
|
|
2576
2851
|
* <p>The unique identifier assigned to your gateway during activation. This ID becomes part
|
|
2577
2852
|
* of the gateway Amazon Resource Name (ARN), which you use as input for other
|
|
2578
2853
|
* operations.</p>
|
|
2579
2854
|
*/
|
|
2580
2855
|
GatewayId?: string;
|
|
2581
2856
|
/**
|
|
2857
|
+
* @public
|
|
2582
2858
|
* <p>The name you configured for your gateway.</p>
|
|
2583
2859
|
*/
|
|
2584
2860
|
GatewayName?: string;
|
|
2585
2861
|
/**
|
|
2862
|
+
* @public
|
|
2586
2863
|
* <p>A value that indicates the time zone configured for the gateway.</p>
|
|
2587
2864
|
*/
|
|
2588
2865
|
GatewayTimezone?: string;
|
|
2589
2866
|
/**
|
|
2867
|
+
* @public
|
|
2590
2868
|
* <p>A value that indicates the operating state of the gateway.</p>
|
|
2591
2869
|
*/
|
|
2592
2870
|
GatewayState?: string;
|
|
2593
2871
|
/**
|
|
2872
|
+
* @public
|
|
2594
2873
|
* <p>A <a>NetworkInterface</a> array that contains descriptions of the gateway
|
|
2595
2874
|
* network interfaces.</p>
|
|
2596
2875
|
*/
|
|
2597
2876
|
GatewayNetworkInterfaces?: NetworkInterface[];
|
|
2598
2877
|
/**
|
|
2878
|
+
* @public
|
|
2599
2879
|
* <p>The type of the gateway.</p>
|
|
2600
2880
|
*/
|
|
2601
2881
|
GatewayType?: string;
|
|
2602
2882
|
/**
|
|
2883
|
+
* @public
|
|
2603
2884
|
* <p>The date on which an update to the gateway is available. This date is in the time zone
|
|
2604
2885
|
* of the gateway. If the gateway is not available for an update this field is not returned in
|
|
2605
2886
|
* the response.</p>
|
|
2606
2887
|
*/
|
|
2607
2888
|
NextUpdateAvailabilityDate?: string;
|
|
2608
2889
|
/**
|
|
2890
|
+
* @public
|
|
2609
2891
|
* <p>The date on which the last software update was applied to the gateway. If the gateway
|
|
2610
2892
|
* has never been updated, this field does not return a value in the response. This only only
|
|
2611
2893
|
* exist and returns once it have been chosen and set by the SGW service, based on the OS
|
|
@@ -2613,35 +2895,42 @@ export interface DescribeGatewayInformationOutput {
|
|
|
2613
2895
|
*/
|
|
2614
2896
|
LastSoftwareUpdate?: string;
|
|
2615
2897
|
/**
|
|
2898
|
+
* @public
|
|
2616
2899
|
* <p>The ID of the Amazon EC2 instance that was used to launch the gateway.</p>
|
|
2617
2900
|
*/
|
|
2618
2901
|
Ec2InstanceId?: string;
|
|
2619
2902
|
/**
|
|
2903
|
+
* @public
|
|
2620
2904
|
* <p>The Amazon Web Services Region where the Amazon EC2 instance is located.</p>
|
|
2621
2905
|
*/
|
|
2622
2906
|
Ec2InstanceRegion?: string;
|
|
2623
2907
|
/**
|
|
2908
|
+
* @public
|
|
2624
2909
|
* <p>A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each
|
|
2625
2910
|
* tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all
|
|
2626
2911
|
* tags using the <code>ListTagsForResource</code> API operation.</p>
|
|
2627
2912
|
*/
|
|
2628
2913
|
Tags?: Tag[];
|
|
2629
2914
|
/**
|
|
2915
|
+
* @public
|
|
2630
2916
|
* <p>The configuration settings for the virtual private cloud (VPC) endpoint for your
|
|
2631
2917
|
* gateway.</p>
|
|
2632
2918
|
*/
|
|
2633
2919
|
VPCEndpoint?: string;
|
|
2634
2920
|
/**
|
|
2921
|
+
* @public
|
|
2635
2922
|
* <p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to
|
|
2636
2923
|
* monitor events in the gateway. This field only only exist and returns once it have been
|
|
2637
2924
|
* chosen and set by the SGW service, based on the OS version of the gateway VM</p>
|
|
2638
2925
|
*/
|
|
2639
2926
|
CloudWatchLogGroupARN?: string;
|
|
2640
2927
|
/**
|
|
2928
|
+
* @public
|
|
2641
2929
|
* <p>The type of hardware or software platform on which the gateway is running.</p>
|
|
2642
2930
|
*/
|
|
2643
2931
|
HostEnvironment?: HostEnvironment | string;
|
|
2644
2932
|
/**
|
|
2933
|
+
* @public
|
|
2645
2934
|
* <p>The type of endpoint for your gateway.</p>
|
|
2646
2935
|
*
|
|
2647
2936
|
* <p>Valid Values: <code>STANDARD</code> | <code>FIPS</code>
|
|
@@ -2649,24 +2938,29 @@ export interface DescribeGatewayInformationOutput {
|
|
|
2649
2938
|
*/
|
|
2650
2939
|
EndpointType?: string;
|
|
2651
2940
|
/**
|
|
2941
|
+
* @public
|
|
2652
2942
|
* <p>Date after which this gateway will not receive software updates for new features.</p>
|
|
2653
2943
|
*/
|
|
2654
2944
|
SoftwareUpdatesEndDate?: string;
|
|
2655
2945
|
/**
|
|
2946
|
+
* @public
|
|
2656
2947
|
* <p>Date after which this gateway will not receive software updates for new features and bug
|
|
2657
2948
|
* fixes.</p>
|
|
2658
2949
|
*/
|
|
2659
2950
|
DeprecationDate?: string;
|
|
2660
2951
|
/**
|
|
2952
|
+
* @public
|
|
2661
2953
|
* <p>Specifies the size of the gateway's metadata cache.</p>
|
|
2662
2954
|
*/
|
|
2663
2955
|
GatewayCapacity?: GatewayCapacity | string;
|
|
2664
2956
|
/**
|
|
2957
|
+
* @public
|
|
2665
2958
|
* <p>A list of the metadata cache sizes that the gateway can support based on its current
|
|
2666
2959
|
* hardware specifications.</p>
|
|
2667
2960
|
*/
|
|
2668
2961
|
SupportedGatewayCapacities?: (GatewayCapacity | string)[];
|
|
2669
2962
|
/**
|
|
2963
|
+
* @public
|
|
2670
2964
|
* <p>A unique identifier for the specific instance of the host platform running the gateway.
|
|
2671
2965
|
* This value is only available for certain host environments, and its format depends on the
|
|
2672
2966
|
* host environment type.</p>
|
|
@@ -2679,6 +2973,7 @@ export interface DescribeGatewayInformationOutput {
|
|
|
2679
2973
|
*/
|
|
2680
2974
|
export interface DescribeMaintenanceStartTimeInput {
|
|
2681
2975
|
/**
|
|
2976
|
+
* @public
|
|
2682
2977
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
2683
2978
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
2684
2979
|
*/
|
|
@@ -2718,35 +3013,41 @@ export interface DescribeMaintenanceStartTimeInput {
|
|
|
2718
3013
|
*/
|
|
2719
3014
|
export interface DescribeMaintenanceStartTimeOutput {
|
|
2720
3015
|
/**
|
|
3016
|
+
* @public
|
|
2721
3017
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
2722
3018
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
2723
3019
|
*/
|
|
2724
3020
|
GatewayARN?: string;
|
|
2725
3021
|
/**
|
|
3022
|
+
* @public
|
|
2726
3023
|
* <p>The hour component of the maintenance start time represented as <i>hh</i>,
|
|
2727
3024
|
* where <i>hh</i> is the hour (0 to 23). The hour of the day is in the time
|
|
2728
3025
|
* zone of the gateway.</p>
|
|
2729
3026
|
*/
|
|
2730
3027
|
HourOfDay?: number;
|
|
2731
3028
|
/**
|
|
3029
|
+
* @public
|
|
2732
3030
|
* <p>The minute component of the maintenance start time represented as
|
|
2733
3031
|
* <i>mm</i>, where <i>mm</i> is the minute (0 to 59). The
|
|
2734
3032
|
* minute of the hour is in the time zone of the gateway.</p>
|
|
2735
3033
|
*/
|
|
2736
3034
|
MinuteOfHour?: number;
|
|
2737
3035
|
/**
|
|
3036
|
+
* @public
|
|
2738
3037
|
* <p>An ordinal number between 0 and 6 that represents the day of the week, where 0
|
|
2739
3038
|
* represents Sunday and 6 represents Saturday. The day of week is in the time zone of the
|
|
2740
3039
|
* gateway.</p>
|
|
2741
3040
|
*/
|
|
2742
3041
|
DayOfWeek?: number;
|
|
2743
3042
|
/**
|
|
3043
|
+
* @public
|
|
2744
3044
|
* <p>The day of the month component of the maintenance start time represented as an ordinal
|
|
2745
3045
|
* number from 1 to 28, where 1 represents the first day of the month and 28 represents the
|
|
2746
3046
|
* last day of the month.</p>
|
|
2747
3047
|
*/
|
|
2748
3048
|
DayOfMonth?: number;
|
|
2749
3049
|
/**
|
|
3050
|
+
* @public
|
|
2750
3051
|
* <p>A value that indicates the time zone that is set for the gateway. The start time and day
|
|
2751
3052
|
* of week specified should be in the time zone of the gateway.</p>
|
|
2752
3053
|
*/
|
|
@@ -2758,6 +3059,7 @@ export interface DescribeMaintenanceStartTimeOutput {
|
|
|
2758
3059
|
*/
|
|
2759
3060
|
export interface DescribeNFSFileSharesInput {
|
|
2760
3061
|
/**
|
|
3062
|
+
* @public
|
|
2761
3063
|
* <p>An array containing the Amazon Resource Name (ARN) of each file share to be
|
|
2762
3064
|
* described.</p>
|
|
2763
3065
|
*/
|
|
@@ -2771,6 +3073,7 @@ export interface DescribeNFSFileSharesInput {
|
|
|
2771
3073
|
*/
|
|
2772
3074
|
export interface NFSFileShareInfo {
|
|
2773
3075
|
/**
|
|
3076
|
+
* @public
|
|
2774
3077
|
* <p>Describes Network File System (NFS) file share default values. Files and folders stored
|
|
2775
3078
|
* as Amazon S3 objects in S3 buckets don't, by default, have Unix file
|
|
2776
3079
|
* permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, the S3
|
|
@@ -2779,14 +3082,17 @@ export interface NFSFileShareInfo {
|
|
|
2779
3082
|
*/
|
|
2780
3083
|
NFSFileShareDefaults?: NFSFileShareDefaults;
|
|
2781
3084
|
/**
|
|
3085
|
+
* @public
|
|
2782
3086
|
* <p>The Amazon Resource Name (ARN) of the file share.</p>
|
|
2783
3087
|
*/
|
|
2784
3088
|
FileShareARN?: string;
|
|
2785
3089
|
/**
|
|
3090
|
+
* @public
|
|
2786
3091
|
* <p>The ID of the file share.</p>
|
|
2787
3092
|
*/
|
|
2788
3093
|
FileShareId?: string;
|
|
2789
3094
|
/**
|
|
3095
|
+
* @public
|
|
2790
3096
|
* <p>The status of the file share.</p>
|
|
2791
3097
|
*
|
|
2792
3098
|
* <p>Valid Values: <code>CREATING</code> | <code>UPDATING</code> | <code>AVAILABLE</code> |
|
|
@@ -2795,11 +3101,13 @@ export interface NFSFileShareInfo {
|
|
|
2795
3101
|
*/
|
|
2796
3102
|
FileShareStatus?: string;
|
|
2797
3103
|
/**
|
|
3104
|
+
* @public
|
|
2798
3105
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
2799
3106
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
2800
3107
|
*/
|
|
2801
3108
|
GatewayARN?: string;
|
|
2802
3109
|
/**
|
|
3110
|
+
* @public
|
|
2803
3111
|
* <p>Set to <code>true</code> to use Amazon S3 server-side encryption with your own
|
|
2804
3112
|
* KMS key, or <code>false</code> to use a key managed by Amazon S3.
|
|
2805
3113
|
* Optional.</p>
|
|
@@ -2809,20 +3117,24 @@ export interface NFSFileShareInfo {
|
|
|
2809
3117
|
*/
|
|
2810
3118
|
KMSEncrypted?: boolean;
|
|
2811
3119
|
/**
|
|
3120
|
+
* @public
|
|
2812
3121
|
* <p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
|
|
2813
3122
|
* value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>
|
|
2814
3123
|
*/
|
|
2815
3124
|
KMSKey?: string;
|
|
2816
3125
|
/**
|
|
3126
|
+
* @public
|
|
2817
3127
|
* <p>The file share path used by the NFS client to identify the mount point.</p>
|
|
2818
3128
|
*/
|
|
2819
3129
|
Path?: string;
|
|
2820
3130
|
/**
|
|
3131
|
+
* @public
|
|
2821
3132
|
* <p>The ARN of the IAM role that an S3 File Gateway assumes when it accesses the underlying
|
|
2822
3133
|
* storage.</p>
|
|
2823
3134
|
*/
|
|
2824
3135
|
Role?: string;
|
|
2825
3136
|
/**
|
|
3137
|
+
* @public
|
|
2826
3138
|
* <p>A custom ARN for the backend storage used for storing data for file shares. It includes
|
|
2827
3139
|
* a resource ARN with an optional prefix concatenation. The prefix must end with a forward
|
|
2828
3140
|
* slash (/).</p>
|
|
@@ -2851,6 +3163,7 @@ export interface NFSFileShareInfo {
|
|
|
2851
3163
|
*/
|
|
2852
3164
|
LocationARN?: string;
|
|
2853
3165
|
/**
|
|
3166
|
+
* @public
|
|
2854
3167
|
* <p>The default storage class for objects put into an Amazon S3 bucket by the S3
|
|
2855
3168
|
* File Gateway. The default value is <code>S3_STANDARD</code>. Optional.</p>
|
|
2856
3169
|
*
|
|
@@ -2860,17 +3173,20 @@ export interface NFSFileShareInfo {
|
|
|
2860
3173
|
*/
|
|
2861
3174
|
DefaultStorageClass?: string;
|
|
2862
3175
|
/**
|
|
3176
|
+
* @public
|
|
2863
3177
|
* <p>A value that sets the access control list (ACL) permission for objects in the S3 bucket
|
|
2864
3178
|
* that an S3 File Gateway puts objects into. The default value is
|
|
2865
3179
|
* <code>private</code>.</p>
|
|
2866
3180
|
*/
|
|
2867
3181
|
ObjectACL?: ObjectACL | string;
|
|
2868
3182
|
/**
|
|
3183
|
+
* @public
|
|
2869
3184
|
* <p>The list of clients that are allowed to access the S3 File Gateway. The list must
|
|
2870
3185
|
* contain either valid IP addresses or valid CIDR blocks.</p>
|
|
2871
3186
|
*/
|
|
2872
3187
|
ClientList?: string[];
|
|
2873
3188
|
/**
|
|
3189
|
+
* @public
|
|
2874
3190
|
* <p>The user mapped to anonymous user. Valid options are the following:</p>
|
|
2875
3191
|
*
|
|
2876
3192
|
* <ul>
|
|
@@ -2890,6 +3206,7 @@ export interface NFSFileShareInfo {
|
|
|
2890
3206
|
*/
|
|
2891
3207
|
Squash?: string;
|
|
2892
3208
|
/**
|
|
3209
|
+
* @public
|
|
2893
3210
|
* <p>A value that sets the write status of a file share. Set this value to <code>true</code>
|
|
2894
3211
|
* to set the write status to read-only, otherwise set to <code>false</code>.</p>
|
|
2895
3212
|
*
|
|
@@ -2898,6 +3215,7 @@ export interface NFSFileShareInfo {
|
|
|
2898
3215
|
*/
|
|
2899
3216
|
ReadOnly?: boolean;
|
|
2900
3217
|
/**
|
|
3218
|
+
* @public
|
|
2901
3219
|
* <p>A value that enables guessing of the MIME type for uploaded objects based on file
|
|
2902
3220
|
* extensions. Set this value to <code>true</code> to enable MIME type guessing, otherwise set
|
|
2903
3221
|
* to <code>false</code>. The default value is <code>true</code>.</p>
|
|
@@ -2907,6 +3225,7 @@ export interface NFSFileShareInfo {
|
|
|
2907
3225
|
*/
|
|
2908
3226
|
GuessMIMETypeEnabled?: boolean;
|
|
2909
3227
|
/**
|
|
3228
|
+
* @public
|
|
2910
3229
|
* <p>A value that sets who pays the cost of the request and the cost associated with data
|
|
2911
3230
|
* download from the S3 bucket. If this value is set to <code>true</code>, the requester pays
|
|
2912
3231
|
* the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays
|
|
@@ -2924,12 +3243,14 @@ export interface NFSFileShareInfo {
|
|
|
2924
3243
|
*/
|
|
2925
3244
|
RequesterPays?: boolean;
|
|
2926
3245
|
/**
|
|
3246
|
+
* @public
|
|
2927
3247
|
* <p>A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key
|
|
2928
3248
|
* name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can
|
|
2929
3249
|
* view all tags using the <code>ListTagsForResource</code> API operation.</p>
|
|
2930
3250
|
*/
|
|
2931
3251
|
Tags?: Tag[];
|
|
2932
3252
|
/**
|
|
3253
|
+
* @public
|
|
2933
3254
|
* <p>The name of the file share. Optional.</p>
|
|
2934
3255
|
*
|
|
2935
3256
|
* <note>
|
|
@@ -2940,10 +3261,12 @@ export interface NFSFileShareInfo {
|
|
|
2940
3261
|
*/
|
|
2941
3262
|
FileShareName?: string;
|
|
2942
3263
|
/**
|
|
3264
|
+
* @public
|
|
2943
3265
|
* <p>Refresh cache information for the file share.</p>
|
|
2944
3266
|
*/
|
|
2945
3267
|
CacheAttributes?: CacheAttributes;
|
|
2946
3268
|
/**
|
|
3269
|
+
* @public
|
|
2947
3270
|
* <p>The notification policy of the file share. <code>SettlingTimeInSeconds</code> controls
|
|
2948
3271
|
* the number of seconds to wait after the last point in time a client wrote to a file before
|
|
2949
3272
|
* generating an <code>ObjectUploaded</code> notification. Because clients can make many small
|
|
@@ -2971,6 +3294,7 @@ export interface NFSFileShareInfo {
|
|
|
2971
3294
|
*/
|
|
2972
3295
|
NotificationPolicy?: string;
|
|
2973
3296
|
/**
|
|
3297
|
+
* @public
|
|
2974
3298
|
* <p>Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to
|
|
2975
3299
|
* Amazon S3.</p>
|
|
2976
3300
|
* <note>
|
|
@@ -2981,6 +3305,7 @@ export interface NFSFileShareInfo {
|
|
|
2981
3305
|
*/
|
|
2982
3306
|
VPCEndpointDNSName?: string;
|
|
2983
3307
|
/**
|
|
3308
|
+
* @public
|
|
2984
3309
|
* <p>Specifies the Region of the S3 bucket where the NFS file share stores files.</p>
|
|
2985
3310
|
* <note>
|
|
2986
3311
|
* <p>This parameter is required for NFS file shares that connect to Amazon S3
|
|
@@ -2990,6 +3315,7 @@ export interface NFSFileShareInfo {
|
|
|
2990
3315
|
*/
|
|
2991
3316
|
BucketRegion?: string;
|
|
2992
3317
|
/**
|
|
3318
|
+
* @public
|
|
2993
3319
|
* <p>The Amazon Resource Name (ARN) of the storage used for audit logs.</p>
|
|
2994
3320
|
*/
|
|
2995
3321
|
AuditDestinationARN?: string;
|
|
@@ -3000,6 +3326,7 @@ export interface NFSFileShareInfo {
|
|
|
3000
3326
|
*/
|
|
3001
3327
|
export interface DescribeNFSFileSharesOutput {
|
|
3002
3328
|
/**
|
|
3329
|
+
* @public
|
|
3003
3330
|
* <p>An array containing a description for each requested file share.</p>
|
|
3004
3331
|
*/
|
|
3005
3332
|
NFSFileShareInfoList?: NFSFileShareInfo[];
|
|
@@ -3010,6 +3337,7 @@ export interface DescribeNFSFileSharesOutput {
|
|
|
3010
3337
|
*/
|
|
3011
3338
|
export interface DescribeSMBFileSharesInput {
|
|
3012
3339
|
/**
|
|
3340
|
+
* @public
|
|
3013
3341
|
* <p>An array containing the Amazon Resource Name (ARN) of each file share to be
|
|
3014
3342
|
* described.</p>
|
|
3015
3343
|
*/
|
|
@@ -3023,14 +3351,17 @@ export interface DescribeSMBFileSharesInput {
|
|
|
3023
3351
|
*/
|
|
3024
3352
|
export interface SMBFileShareInfo {
|
|
3025
3353
|
/**
|
|
3354
|
+
* @public
|
|
3026
3355
|
* <p>The Amazon Resource Name (ARN) of the file share.</p>
|
|
3027
3356
|
*/
|
|
3028
3357
|
FileShareARN?: string;
|
|
3029
3358
|
/**
|
|
3359
|
+
* @public
|
|
3030
3360
|
* <p>The ID of the file share.</p>
|
|
3031
3361
|
*/
|
|
3032
3362
|
FileShareId?: string;
|
|
3033
3363
|
/**
|
|
3364
|
+
* @public
|
|
3034
3365
|
* <p>The status of the file share.</p>
|
|
3035
3366
|
*
|
|
3036
3367
|
* <p>Valid Values: <code>CREATING</code> | <code>UPDATING</code> | <code>AVAILABLE</code> |
|
|
@@ -3039,11 +3370,13 @@ export interface SMBFileShareInfo {
|
|
|
3039
3370
|
*/
|
|
3040
3371
|
FileShareStatus?: string;
|
|
3041
3372
|
/**
|
|
3373
|
+
* @public
|
|
3042
3374
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
3043
3375
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
3044
3376
|
*/
|
|
3045
3377
|
GatewayARN?: string;
|
|
3046
3378
|
/**
|
|
3379
|
+
* @public
|
|
3047
3380
|
* <p>Set to <code>true</code> to use Amazon S3 server-side encryption with your own
|
|
3048
3381
|
* KMS key, or <code>false</code> to use a key managed by Amazon S3.
|
|
3049
3382
|
* Optional.</p>
|
|
@@ -3053,20 +3386,24 @@ export interface SMBFileShareInfo {
|
|
|
3053
3386
|
*/
|
|
3054
3387
|
KMSEncrypted?: boolean;
|
|
3055
3388
|
/**
|
|
3389
|
+
* @public
|
|
3056
3390
|
* <p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
|
|
3057
3391
|
* value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>
|
|
3058
3392
|
*/
|
|
3059
3393
|
KMSKey?: string;
|
|
3060
3394
|
/**
|
|
3395
|
+
* @public
|
|
3061
3396
|
* <p>The file share path used by the SMB client to identify the mount point.</p>
|
|
3062
3397
|
*/
|
|
3063
3398
|
Path?: string;
|
|
3064
3399
|
/**
|
|
3400
|
+
* @public
|
|
3065
3401
|
* <p>The ARN of the IAM role that an S3 File Gateway assumes when it accesses the underlying
|
|
3066
3402
|
* storage.</p>
|
|
3067
3403
|
*/
|
|
3068
3404
|
Role?: string;
|
|
3069
3405
|
/**
|
|
3406
|
+
* @public
|
|
3070
3407
|
* <p>A custom ARN for the backend storage used for storing data for file shares. It includes
|
|
3071
3408
|
* a resource ARN with an optional prefix concatenation. The prefix must end with a forward
|
|
3072
3409
|
* slash (/).</p>
|
|
@@ -3095,6 +3432,7 @@ export interface SMBFileShareInfo {
|
|
|
3095
3432
|
*/
|
|
3096
3433
|
LocationARN?: string;
|
|
3097
3434
|
/**
|
|
3435
|
+
* @public
|
|
3098
3436
|
* <p>The default storage class for objects put into an Amazon S3 bucket by the S3
|
|
3099
3437
|
* File Gateway. The default value is <code>S3_STANDARD</code>. Optional.</p>
|
|
3100
3438
|
*
|
|
@@ -3104,12 +3442,14 @@ export interface SMBFileShareInfo {
|
|
|
3104
3442
|
*/
|
|
3105
3443
|
DefaultStorageClass?: string;
|
|
3106
3444
|
/**
|
|
3445
|
+
* @public
|
|
3107
3446
|
* <p>A value that sets the access control list (ACL) permission for objects in the S3 bucket
|
|
3108
3447
|
* that an S3 File Gateway puts objects into. The default value is
|
|
3109
3448
|
* <code>private</code>.</p>
|
|
3110
3449
|
*/
|
|
3111
3450
|
ObjectACL?: ObjectACL | string;
|
|
3112
3451
|
/**
|
|
3452
|
+
* @public
|
|
3113
3453
|
* <p>A value that sets the write status of a file share. Set this value to <code>true</code>
|
|
3114
3454
|
* to set the write status to read-only, otherwise set to <code>false</code>.</p>
|
|
3115
3455
|
*
|
|
@@ -3118,6 +3458,7 @@ export interface SMBFileShareInfo {
|
|
|
3118
3458
|
*/
|
|
3119
3459
|
ReadOnly?: boolean;
|
|
3120
3460
|
/**
|
|
3461
|
+
* @public
|
|
3121
3462
|
* <p>A value that enables guessing of the MIME type for uploaded objects based on file
|
|
3122
3463
|
* extensions. Set this value to <code>true</code> to enable MIME type guessing, otherwise set
|
|
3123
3464
|
* to <code>false</code>. The default value is <code>true</code>.</p>
|
|
@@ -3127,6 +3468,7 @@ export interface SMBFileShareInfo {
|
|
|
3127
3468
|
*/
|
|
3128
3469
|
GuessMIMETypeEnabled?: boolean;
|
|
3129
3470
|
/**
|
|
3471
|
+
* @public
|
|
3130
3472
|
* <p>A value that sets who pays the cost of the request and the cost associated with data
|
|
3131
3473
|
* download from the S3 bucket. If this value is set to <code>true</code>, the requester pays
|
|
3132
3474
|
* the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays
|
|
@@ -3144,6 +3486,7 @@ export interface SMBFileShareInfo {
|
|
|
3144
3486
|
*/
|
|
3145
3487
|
RequesterPays?: boolean;
|
|
3146
3488
|
/**
|
|
3489
|
+
* @public
|
|
3147
3490
|
* <p>If this value is set to <code>true</code>, it indicates that access control list (ACL)
|
|
3148
3491
|
* is enabled on the SMB file share. If it is set to <code>false</code>, it indicates that
|
|
3149
3492
|
* file and directory permissions are mapped to the POSIX permission.</p>
|
|
@@ -3156,10 +3499,12 @@ export interface SMBFileShareInfo {
|
|
|
3156
3499
|
*/
|
|
3157
3500
|
SMBACLEnabled?: boolean;
|
|
3158
3501
|
/**
|
|
3502
|
+
* @public
|
|
3159
3503
|
* <p>Indicates whether <code>AccessBasedEnumeration</code> is enabled.</p>
|
|
3160
3504
|
*/
|
|
3161
3505
|
AccessBasedEnumeration?: boolean;
|
|
3162
3506
|
/**
|
|
3507
|
+
* @public
|
|
3163
3508
|
* <p>A list of users or groups in the Active Directory that have administrator rights to the
|
|
3164
3509
|
* file share. A group must be prefixed with the @ character. Acceptable formats include:
|
|
3165
3510
|
* <code>DOMAIN\User1</code>, <code>user1</code>, <code>@group1</code>, and
|
|
@@ -3168,6 +3513,7 @@ export interface SMBFileShareInfo {
|
|
|
3168
3513
|
*/
|
|
3169
3514
|
AdminUserList?: string[];
|
|
3170
3515
|
/**
|
|
3516
|
+
* @public
|
|
3171
3517
|
* <p>A list of users or groups in the Active Directory that are allowed to access the file
|
|
3172
3518
|
* share. A group must be prefixed with the @ character. Acceptable formats include:
|
|
3173
3519
|
* <code>DOMAIN\User1</code>, <code>user1</code>, <code>@group1</code>, and
|
|
@@ -3176,6 +3522,7 @@ export interface SMBFileShareInfo {
|
|
|
3176
3522
|
*/
|
|
3177
3523
|
ValidUserList?: string[];
|
|
3178
3524
|
/**
|
|
3525
|
+
* @public
|
|
3179
3526
|
* <p>A list of users or groups in the Active Directory that are not allowed to access the
|
|
3180
3527
|
* file share. A group must be prefixed with the @ character. Acceptable formats include:
|
|
3181
3528
|
* <code>DOMAIN\User1</code>, <code>user1</code>, <code>@group1</code>, and
|
|
@@ -3184,10 +3531,12 @@ export interface SMBFileShareInfo {
|
|
|
3184
3531
|
*/
|
|
3185
3532
|
InvalidUserList?: string[];
|
|
3186
3533
|
/**
|
|
3534
|
+
* @public
|
|
3187
3535
|
* <p>The Amazon Resource Name (ARN) of the storage used for audit logs.</p>
|
|
3188
3536
|
*/
|
|
3189
3537
|
AuditDestinationARN?: string;
|
|
3190
3538
|
/**
|
|
3539
|
+
* @public
|
|
3191
3540
|
* <p>The authentication method of the file share. The default is
|
|
3192
3541
|
* <code>ActiveDirectory</code>.</p>
|
|
3193
3542
|
*
|
|
@@ -3196,6 +3545,7 @@ export interface SMBFileShareInfo {
|
|
|
3196
3545
|
*/
|
|
3197
3546
|
Authentication?: string;
|
|
3198
3547
|
/**
|
|
3548
|
+
* @public
|
|
3199
3549
|
* <p>The case of an object name in an Amazon S3 bucket. For
|
|
3200
3550
|
* <code>ClientSpecified</code>, the client determines the case sensitivity. For
|
|
3201
3551
|
* <code>CaseSensitive</code>, the gateway determines the case sensitivity. The default
|
|
@@ -3203,12 +3553,14 @@ export interface SMBFileShareInfo {
|
|
|
3203
3553
|
*/
|
|
3204
3554
|
CaseSensitivity?: CaseSensitivity | string;
|
|
3205
3555
|
/**
|
|
3556
|
+
* @public
|
|
3206
3557
|
* <p>A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key
|
|
3207
3558
|
* name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can
|
|
3208
3559
|
* view all tags using the <code>ListTagsForResource</code> API operation.</p>
|
|
3209
3560
|
*/
|
|
3210
3561
|
Tags?: Tag[];
|
|
3211
3562
|
/**
|
|
3563
|
+
* @public
|
|
3212
3564
|
* <p>The name of the file share. Optional.</p>
|
|
3213
3565
|
*
|
|
3214
3566
|
* <note>
|
|
@@ -3219,10 +3571,12 @@ export interface SMBFileShareInfo {
|
|
|
3219
3571
|
*/
|
|
3220
3572
|
FileShareName?: string;
|
|
3221
3573
|
/**
|
|
3574
|
+
* @public
|
|
3222
3575
|
* <p>Refresh cache information for the file share.</p>
|
|
3223
3576
|
*/
|
|
3224
3577
|
CacheAttributes?: CacheAttributes;
|
|
3225
3578
|
/**
|
|
3579
|
+
* @public
|
|
3226
3580
|
* <p>The notification policy of the file share. <code>SettlingTimeInSeconds</code> controls
|
|
3227
3581
|
* the number of seconds to wait after the last point in time a client wrote to a file before
|
|
3228
3582
|
* generating an <code>ObjectUploaded</code> notification. Because clients can make many small
|
|
@@ -3250,6 +3604,7 @@ export interface SMBFileShareInfo {
|
|
|
3250
3604
|
*/
|
|
3251
3605
|
NotificationPolicy?: string;
|
|
3252
3606
|
/**
|
|
3607
|
+
* @public
|
|
3253
3608
|
* <p>Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to
|
|
3254
3609
|
* Amazon S3.</p>
|
|
3255
3610
|
* <note>
|
|
@@ -3260,6 +3615,7 @@ export interface SMBFileShareInfo {
|
|
|
3260
3615
|
*/
|
|
3261
3616
|
VPCEndpointDNSName?: string;
|
|
3262
3617
|
/**
|
|
3618
|
+
* @public
|
|
3263
3619
|
* <p>Specifies the Region of the S3 bucket where the SMB file share stores files.</p>
|
|
3264
3620
|
* <note>
|
|
3265
3621
|
* <p>This parameter is required for SMB file shares that connect to Amazon S3
|
|
@@ -3269,6 +3625,7 @@ export interface SMBFileShareInfo {
|
|
|
3269
3625
|
*/
|
|
3270
3626
|
BucketRegion?: string;
|
|
3271
3627
|
/**
|
|
3628
|
+
* @public
|
|
3272
3629
|
* <p>Specifies whether opportunistic locking is enabled for the SMB file share.</p>
|
|
3273
3630
|
* <note>
|
|
3274
3631
|
* <p>Enabling opportunistic locking on case-sensitive shares is not recommended for
|
|
@@ -3285,6 +3642,7 @@ export interface SMBFileShareInfo {
|
|
|
3285
3642
|
*/
|
|
3286
3643
|
export interface DescribeSMBFileSharesOutput {
|
|
3287
3644
|
/**
|
|
3645
|
+
* @public
|
|
3288
3646
|
* <p>An array containing a description for each requested file share.</p>
|
|
3289
3647
|
*/
|
|
3290
3648
|
SMBFileShareInfoList?: SMBFileShareInfo[];
|
|
@@ -3294,6 +3652,7 @@ export interface DescribeSMBFileSharesOutput {
|
|
|
3294
3652
|
*/
|
|
3295
3653
|
export interface DescribeSMBSettingsInput {
|
|
3296
3654
|
/**
|
|
3655
|
+
* @public
|
|
3297
3656
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
3298
3657
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
3299
3658
|
*/
|
|
@@ -3306,6 +3665,7 @@ export interface DescribeSMBSettingsInput {
|
|
|
3306
3665
|
*/
|
|
3307
3666
|
export interface SMBLocalGroups {
|
|
3308
3667
|
/**
|
|
3668
|
+
* @public
|
|
3309
3669
|
* <p>A list of Active Directory users and groups that have local Gateway Admin permissions.
|
|
3310
3670
|
* Acceptable formats include: <code>DOMAIN\User1</code>, <code>user1</code>,
|
|
3311
3671
|
* <code>DOMAIN\group1</code>, and <code>group1</code>.</p>
|
|
@@ -3323,15 +3683,18 @@ export type SMBSecurityStrategy = "ClientSpecified" | "MandatoryEncryption" | "M
|
|
|
3323
3683
|
*/
|
|
3324
3684
|
export interface DescribeSMBSettingsOutput {
|
|
3325
3685
|
/**
|
|
3686
|
+
* @public
|
|
3326
3687
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
3327
3688
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
3328
3689
|
*/
|
|
3329
3690
|
GatewayARN?: string;
|
|
3330
3691
|
/**
|
|
3692
|
+
* @public
|
|
3331
3693
|
* <p>The name of the domain that the gateway is joined to.</p>
|
|
3332
3694
|
*/
|
|
3333
3695
|
DomainName?: string;
|
|
3334
3696
|
/**
|
|
3697
|
+
* @public
|
|
3335
3698
|
* <p>Indicates the status of a gateway that is a member of the Active Directory
|
|
3336
3699
|
* domain.</p>
|
|
3337
3700
|
*
|
|
@@ -3374,6 +3737,7 @@ export interface DescribeSMBSettingsOutput {
|
|
|
3374
3737
|
*/
|
|
3375
3738
|
ActiveDirectoryStatus?: ActiveDirectoryStatus | string;
|
|
3376
3739
|
/**
|
|
3740
|
+
* @public
|
|
3377
3741
|
* <p>This value is <code>true</code> if a password for the guest user <code>smbguest</code>
|
|
3378
3742
|
* is set, otherwise <code>false</code>. Only supported for S3 File Gateways.</p>
|
|
3379
3743
|
*
|
|
@@ -3382,6 +3746,7 @@ export interface DescribeSMBSettingsOutput {
|
|
|
3382
3746
|
*/
|
|
3383
3747
|
SMBGuestPasswordSet?: boolean;
|
|
3384
3748
|
/**
|
|
3749
|
+
* @public
|
|
3385
3750
|
* <p>The type of security strategy that was specified for file gateway.</p>
|
|
3386
3751
|
*
|
|
3387
3752
|
* <ul>
|
|
@@ -3409,11 +3774,13 @@ export interface DescribeSMBSettingsOutput {
|
|
|
3409
3774
|
*/
|
|
3410
3775
|
SMBSecurityStrategy?: SMBSecurityStrategy | string;
|
|
3411
3776
|
/**
|
|
3777
|
+
* @public
|
|
3412
3778
|
* <p>The shares on this gateway appear when listing shares. Only supported for S3 File
|
|
3413
3779
|
* Gateways. </p>
|
|
3414
3780
|
*/
|
|
3415
3781
|
FileSharesVisible?: boolean;
|
|
3416
3782
|
/**
|
|
3783
|
+
* @public
|
|
3417
3784
|
* <p>A list of Active Directory users and groups that have special permissions for SMB file
|
|
3418
3785
|
* shares on the gateway.</p>
|
|
3419
3786
|
*/
|
|
@@ -3426,6 +3793,7 @@ export interface DescribeSMBSettingsOutput {
|
|
|
3426
3793
|
*/
|
|
3427
3794
|
export interface DescribeSnapshotScheduleInput {
|
|
3428
3795
|
/**
|
|
3796
|
+
* @public
|
|
3429
3797
|
* <p>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a>
|
|
3430
3798
|
* operation to return a list of gateway volumes.</p>
|
|
3431
3799
|
*/
|
|
@@ -3436,28 +3804,34 @@ export interface DescribeSnapshotScheduleInput {
|
|
|
3436
3804
|
*/
|
|
3437
3805
|
export interface DescribeSnapshotScheduleOutput {
|
|
3438
3806
|
/**
|
|
3807
|
+
* @public
|
|
3439
3808
|
* <p>The Amazon Resource Name (ARN) of the volume that was specified in the request.</p>
|
|
3440
3809
|
*/
|
|
3441
3810
|
VolumeARN?: string;
|
|
3442
3811
|
/**
|
|
3812
|
+
* @public
|
|
3443
3813
|
* <p>The hour of the day at which the snapshot schedule begins represented as
|
|
3444
3814
|
* <i>hh</i>, where <i>hh</i> is the hour (0 to 23). The hour
|
|
3445
3815
|
* of the day is in the time zone of the gateway.</p>
|
|
3446
3816
|
*/
|
|
3447
3817
|
StartAt?: number;
|
|
3448
3818
|
/**
|
|
3819
|
+
* @public
|
|
3449
3820
|
* <p>The number of hours between snapshots.</p>
|
|
3450
3821
|
*/
|
|
3451
3822
|
RecurrenceInHours?: number;
|
|
3452
3823
|
/**
|
|
3824
|
+
* @public
|
|
3453
3825
|
* <p>The snapshot description.</p>
|
|
3454
3826
|
*/
|
|
3455
3827
|
Description?: string;
|
|
3456
3828
|
/**
|
|
3829
|
+
* @public
|
|
3457
3830
|
* <p>A value that indicates the time zone of the gateway.</p>
|
|
3458
3831
|
*/
|
|
3459
3832
|
Timezone?: string;
|
|
3460
3833
|
/**
|
|
3834
|
+
* @public
|
|
3461
3835
|
* <p>A list of up to 50 tags assigned to the snapshot schedule, sorted alphabetically by key
|
|
3462
3836
|
* name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can
|
|
3463
3837
|
* view all tags using the <code>ListTagsForResource</code> API operation.</p>
|
|
@@ -3470,6 +3844,7 @@ export interface DescribeSnapshotScheduleOutput {
|
|
|
3470
3844
|
*/
|
|
3471
3845
|
export interface DescribeStorediSCSIVolumesInput {
|
|
3472
3846
|
/**
|
|
3847
|
+
* @public
|
|
3473
3848
|
* <p>An array of strings where each string represents the Amazon Resource Name (ARN) of a
|
|
3474
3849
|
* stored volume. All of the specified stored volumes must be from the same gateway. Use <a>ListVolumes</a> to get volume ARNs for a gateway.</p>
|
|
3475
3850
|
*/
|
|
@@ -3481,47 +3856,57 @@ export interface DescribeStorediSCSIVolumesInput {
|
|
|
3481
3856
|
*/
|
|
3482
3857
|
export interface StorediSCSIVolume {
|
|
3483
3858
|
/**
|
|
3859
|
+
* @public
|
|
3484
3860
|
* <p>The Amazon Resource Name (ARN) of the storage volume.</p>
|
|
3485
3861
|
*/
|
|
3486
3862
|
VolumeARN?: string;
|
|
3487
3863
|
/**
|
|
3864
|
+
* @public
|
|
3488
3865
|
* <p>The unique identifier of the volume, e.g., vol-AE4B946D.</p>
|
|
3489
3866
|
*/
|
|
3490
3867
|
VolumeId?: string;
|
|
3491
3868
|
/**
|
|
3869
|
+
* @public
|
|
3492
3870
|
* <p>One of the VolumeType enumeration values describing the type of the volume.</p>
|
|
3493
3871
|
*/
|
|
3494
3872
|
VolumeType?: string;
|
|
3495
3873
|
/**
|
|
3874
|
+
* @public
|
|
3496
3875
|
* <p>One of the VolumeStatus values that indicates the state of the storage volume.</p>
|
|
3497
3876
|
*/
|
|
3498
3877
|
VolumeStatus?: string;
|
|
3499
3878
|
/**
|
|
3879
|
+
* @public
|
|
3500
3880
|
* <p>A value that indicates whether a storage volume is attached to, detached from, or is in
|
|
3501
3881
|
* the process of detaching from a gateway. For more information, see <a href="https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#attach-detach-volume">Moving
|
|
3502
3882
|
* your volumes to a different gateway</a>.</p>
|
|
3503
3883
|
*/
|
|
3504
3884
|
VolumeAttachmentStatus?: string;
|
|
3505
3885
|
/**
|
|
3886
|
+
* @public
|
|
3506
3887
|
* <p>The size of the volume in bytes.</p>
|
|
3507
3888
|
*/
|
|
3508
3889
|
VolumeSizeInBytes?: number;
|
|
3509
3890
|
/**
|
|
3891
|
+
* @public
|
|
3510
3892
|
* <p>Represents the percentage complete if the volume is restoring or bootstrapping that
|
|
3511
3893
|
* represents the percent of data transferred. This field does not appear in the response if
|
|
3512
3894
|
* the stored volume is not restoring or bootstrapping.</p>
|
|
3513
3895
|
*/
|
|
3514
3896
|
VolumeProgress?: number;
|
|
3515
3897
|
/**
|
|
3898
|
+
* @public
|
|
3516
3899
|
* <p>The ID of the local disk that was specified in the <a>CreateStorediSCSIVolume</a> operation.</p>
|
|
3517
3900
|
*/
|
|
3518
3901
|
VolumeDiskId?: string;
|
|
3519
3902
|
/**
|
|
3903
|
+
* @public
|
|
3520
3904
|
* <p>If the stored volume was created from a snapshot, this field contains the snapshot ID
|
|
3521
3905
|
* used, e.g. snap-78e22663. Otherwise, this field is not included.</p>
|
|
3522
3906
|
*/
|
|
3523
3907
|
SourceSnapshotId?: string;
|
|
3524
3908
|
/**
|
|
3909
|
+
* @public
|
|
3525
3910
|
* <p>Indicates if when the stored volume was created, existing data on the underlying local
|
|
3526
3911
|
* disk was preserved.</p>
|
|
3527
3912
|
*
|
|
@@ -3530,16 +3915,19 @@ export interface StorediSCSIVolume {
|
|
|
3530
3915
|
*/
|
|
3531
3916
|
PreservedExistingData?: boolean;
|
|
3532
3917
|
/**
|
|
3918
|
+
* @public
|
|
3533
3919
|
* <p>An <a>VolumeiSCSIAttributes</a> object that represents a collection of iSCSI
|
|
3534
3920
|
* attributes for one stored volume.</p>
|
|
3535
3921
|
*/
|
|
3536
3922
|
VolumeiSCSIAttributes?: VolumeiSCSIAttributes;
|
|
3537
3923
|
/**
|
|
3924
|
+
* @public
|
|
3538
3925
|
* <p>The date the volume was created. Volumes created prior to March 28, 2017 don’t have this
|
|
3539
3926
|
* timestamp.</p>
|
|
3540
3927
|
*/
|
|
3541
3928
|
CreatedDate?: Date;
|
|
3542
3929
|
/**
|
|
3930
|
+
* @public
|
|
3543
3931
|
* <p>The size of the data stored on the volume in bytes. This value is calculated based on
|
|
3544
3932
|
* the number of blocks that are touched, instead of the actual amount of data written. This
|
|
3545
3933
|
* value can be useful for sequential write patterns but less accurate for random write
|
|
@@ -3553,11 +3941,13 @@ export interface StorediSCSIVolume {
|
|
|
3553
3941
|
*/
|
|
3554
3942
|
VolumeUsedInBytes?: number;
|
|
3555
3943
|
/**
|
|
3944
|
+
* @public
|
|
3556
3945
|
* <p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
|
|
3557
3946
|
* value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>
|
|
3558
3947
|
*/
|
|
3559
3948
|
KMSKey?: string;
|
|
3560
3949
|
/**
|
|
3950
|
+
* @public
|
|
3561
3951
|
* <p>The name of the iSCSI target used by an initiator to connect to a volume and used as a
|
|
3562
3952
|
* suffix for the target ARN. For example, specifying <code>TargetName</code> as
|
|
3563
3953
|
* <i>myvolume</i> results in the target ARN of
|
|
@@ -3574,6 +3964,7 @@ export interface StorediSCSIVolume {
|
|
|
3574
3964
|
*/
|
|
3575
3965
|
export interface DescribeStorediSCSIVolumesOutput {
|
|
3576
3966
|
/**
|
|
3967
|
+
* @public
|
|
3577
3968
|
* <p>Describes a single unit of output from <a>DescribeStorediSCSIVolumes</a>. The
|
|
3578
3969
|
* following fields are returned:</p>
|
|
3579
3970
|
*
|
|
@@ -3667,16 +4058,19 @@ export interface DescribeStorediSCSIVolumesOutput {
|
|
|
3667
4058
|
*/
|
|
3668
4059
|
export interface DescribeTapeArchivesInput {
|
|
3669
4060
|
/**
|
|
4061
|
+
* @public
|
|
3670
4062
|
* <p>Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual
|
|
3671
4063
|
* tapes you want to describe.</p>
|
|
3672
4064
|
*/
|
|
3673
4065
|
TapeARNs?: string[];
|
|
3674
4066
|
/**
|
|
4067
|
+
* @public
|
|
3675
4068
|
* <p>An opaque string that indicates the position at which to begin describing virtual
|
|
3676
4069
|
* tapes.</p>
|
|
3677
4070
|
*/
|
|
3678
4071
|
Marker?: string;
|
|
3679
4072
|
/**
|
|
4073
|
+
* @public
|
|
3680
4074
|
* <p>Specifies that the number of virtual tapes described be limited to the specified
|
|
3681
4075
|
* number.</p>
|
|
3682
4076
|
*/
|
|
@@ -3688,22 +4082,27 @@ export interface DescribeTapeArchivesInput {
|
|
|
3688
4082
|
*/
|
|
3689
4083
|
export interface TapeArchive {
|
|
3690
4084
|
/**
|
|
4085
|
+
* @public
|
|
3691
4086
|
* <p>The Amazon Resource Name (ARN) of an archived virtual tape.</p>
|
|
3692
4087
|
*/
|
|
3693
4088
|
TapeARN?: string;
|
|
3694
4089
|
/**
|
|
4090
|
+
* @public
|
|
3695
4091
|
* <p>The barcode that identifies the archived virtual tape.</p>
|
|
3696
4092
|
*/
|
|
3697
4093
|
TapeBarcode?: string;
|
|
3698
4094
|
/**
|
|
4095
|
+
* @public
|
|
3699
4096
|
* <p>The date the virtual tape was created.</p>
|
|
3700
4097
|
*/
|
|
3701
4098
|
TapeCreatedDate?: Date;
|
|
3702
4099
|
/**
|
|
4100
|
+
* @public
|
|
3703
4101
|
* <p>The size, in bytes, of the archived virtual tape.</p>
|
|
3704
4102
|
*/
|
|
3705
4103
|
TapeSizeInBytes?: number;
|
|
3706
4104
|
/**
|
|
4105
|
+
* @public
|
|
3707
4106
|
* <p>The time that the archiving of the virtual tape was completed.</p>
|
|
3708
4107
|
*
|
|
3709
4108
|
* <p>The default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z'
|
|
@@ -3711,6 +4110,7 @@ export interface TapeArchive {
|
|
|
3711
4110
|
*/
|
|
3712
4111
|
CompletionTime?: Date;
|
|
3713
4112
|
/**
|
|
4113
|
+
* @public
|
|
3714
4114
|
* <p>The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being
|
|
3715
4115
|
* retrieved to.</p>
|
|
3716
4116
|
*
|
|
@@ -3718,10 +4118,12 @@ export interface TapeArchive {
|
|
|
3718
4118
|
*/
|
|
3719
4119
|
RetrievedTo?: string;
|
|
3720
4120
|
/**
|
|
4121
|
+
* @public
|
|
3721
4122
|
* <p>The current state of the archived virtual tape.</p>
|
|
3722
4123
|
*/
|
|
3723
4124
|
TapeStatus?: string;
|
|
3724
4125
|
/**
|
|
4126
|
+
* @public
|
|
3725
4127
|
* <p>The size, in bytes, of data stored on the virtual tape.</p>
|
|
3726
4128
|
*
|
|
3727
4129
|
* <note>
|
|
@@ -3730,26 +4132,31 @@ export interface TapeArchive {
|
|
|
3730
4132
|
*/
|
|
3731
4133
|
TapeUsedInBytes?: number;
|
|
3732
4134
|
/**
|
|
4135
|
+
* @public
|
|
3733
4136
|
* <p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
|
|
3734
4137
|
* value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>
|
|
3735
4138
|
*/
|
|
3736
4139
|
KMSKey?: string;
|
|
3737
4140
|
/**
|
|
4141
|
+
* @public
|
|
3738
4142
|
* <p>The ID of the pool that was used to archive the tape. The tapes in this pool are
|
|
3739
4143
|
* archived in the S3 storage class that is associated with the pool.</p>
|
|
3740
4144
|
*/
|
|
3741
4145
|
PoolId?: string;
|
|
3742
4146
|
/**
|
|
4147
|
+
* @public
|
|
3743
4148
|
* <p>Set to <code>true</code> if the archived tape is stored as write-once-read-many
|
|
3744
4149
|
* (WORM).</p>
|
|
3745
4150
|
*/
|
|
3746
4151
|
Worm?: boolean;
|
|
3747
4152
|
/**
|
|
4153
|
+
* @public
|
|
3748
4154
|
* <p>If the archived tape is subject to tape retention lock, the date that the archived tape
|
|
3749
4155
|
* started being retained.</p>
|
|
3750
4156
|
*/
|
|
3751
4157
|
RetentionStartDate?: Date;
|
|
3752
4158
|
/**
|
|
4159
|
+
* @public
|
|
3753
4160
|
* <p>The time that the tape entered the custom tape pool.</p>
|
|
3754
4161
|
*
|
|
3755
4162
|
* <p>The default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z'
|
|
@@ -3763,6 +4170,7 @@ export interface TapeArchive {
|
|
|
3763
4170
|
*/
|
|
3764
4171
|
export interface DescribeTapeArchivesOutput {
|
|
3765
4172
|
/**
|
|
4173
|
+
* @public
|
|
3766
4174
|
* <p>An array of virtual tape objects in the virtual tape shelf (VTS). The description
|
|
3767
4175
|
* includes of the Amazon Resource Name (ARN) of the virtual tapes. The information returned
|
|
3768
4176
|
* includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the
|
|
@@ -3770,6 +4178,7 @@ export interface DescribeTapeArchivesOutput {
|
|
|
3770
4178
|
*/
|
|
3771
4179
|
TapeArchives?: TapeArchive[];
|
|
3772
4180
|
/**
|
|
4181
|
+
* @public
|
|
3773
4182
|
* <p>An opaque string that indicates the position at which the virtual tapes that were
|
|
3774
4183
|
* fetched for description ended. Use this marker in your next request to fetch the next set
|
|
3775
4184
|
* of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to
|
|
@@ -3783,16 +4192,19 @@ export interface DescribeTapeArchivesOutput {
|
|
|
3783
4192
|
*/
|
|
3784
4193
|
export interface DescribeTapeRecoveryPointsInput {
|
|
3785
4194
|
/**
|
|
4195
|
+
* @public
|
|
3786
4196
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
3787
4197
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
3788
4198
|
*/
|
|
3789
4199
|
GatewayARN: string | undefined;
|
|
3790
4200
|
/**
|
|
4201
|
+
* @public
|
|
3791
4202
|
* <p>An opaque string that indicates the position at which to begin describing the virtual
|
|
3792
4203
|
* tape recovery points.</p>
|
|
3793
4204
|
*/
|
|
3794
4205
|
Marker?: string;
|
|
3795
4206
|
/**
|
|
4207
|
+
* @public
|
|
3796
4208
|
* <p>Specifies that the number of virtual tape recovery points that are described be limited
|
|
3797
4209
|
* to the specified number.</p>
|
|
3798
4210
|
*/
|
|
@@ -3804,10 +4216,12 @@ export interface DescribeTapeRecoveryPointsInput {
|
|
|
3804
4216
|
*/
|
|
3805
4217
|
export interface TapeRecoveryPointInfo {
|
|
3806
4218
|
/**
|
|
4219
|
+
* @public
|
|
3807
4220
|
* <p>The Amazon Resource Name (ARN) of the virtual tape.</p>
|
|
3808
4221
|
*/
|
|
3809
4222
|
TapeARN?: string;
|
|
3810
4223
|
/**
|
|
4224
|
+
* @public
|
|
3811
4225
|
* <p>The time when the point-in-time view of the virtual tape was replicated for later
|
|
3812
4226
|
* recovery.</p>
|
|
3813
4227
|
*
|
|
@@ -3816,10 +4230,12 @@ export interface TapeRecoveryPointInfo {
|
|
|
3816
4230
|
*/
|
|
3817
4231
|
TapeRecoveryPointTime?: Date;
|
|
3818
4232
|
/**
|
|
4233
|
+
* @public
|
|
3819
4234
|
* <p>The size, in bytes, of the virtual tapes to recover.</p>
|
|
3820
4235
|
*/
|
|
3821
4236
|
TapeSizeInBytes?: number;
|
|
3822
4237
|
/**
|
|
4238
|
+
* @public
|
|
3823
4239
|
* <p>The status of the virtual tapes.</p>
|
|
3824
4240
|
*/
|
|
3825
4241
|
TapeStatus?: string;
|
|
@@ -3830,15 +4246,18 @@ export interface TapeRecoveryPointInfo {
|
|
|
3830
4246
|
*/
|
|
3831
4247
|
export interface DescribeTapeRecoveryPointsOutput {
|
|
3832
4248
|
/**
|
|
4249
|
+
* @public
|
|
3833
4250
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
3834
4251
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
3835
4252
|
*/
|
|
3836
4253
|
GatewayARN?: string;
|
|
3837
4254
|
/**
|
|
4255
|
+
* @public
|
|
3838
4256
|
* <p>An array of TapeRecoveryPointInfos that are available for the specified gateway.</p>
|
|
3839
4257
|
*/
|
|
3840
4258
|
TapeRecoveryPointInfos?: TapeRecoveryPointInfo[];
|
|
3841
4259
|
/**
|
|
4260
|
+
* @public
|
|
3842
4261
|
* <p>An opaque string that indicates the position at which the virtual tape recovery points
|
|
3843
4262
|
* that were listed for description ended.</p>
|
|
3844
4263
|
*
|
|
@@ -3854,17 +4273,20 @@ export interface DescribeTapeRecoveryPointsOutput {
|
|
|
3854
4273
|
*/
|
|
3855
4274
|
export interface DescribeTapesInput {
|
|
3856
4275
|
/**
|
|
4276
|
+
* @public
|
|
3857
4277
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
3858
4278
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
3859
4279
|
*/
|
|
3860
4280
|
GatewayARN: string | undefined;
|
|
3861
4281
|
/**
|
|
4282
|
+
* @public
|
|
3862
4283
|
* <p>Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual
|
|
3863
4284
|
* tapes you want to describe. If this parameter is not specified, Tape gateway returns a
|
|
3864
4285
|
* description of all virtual tapes associated with the specified gateway.</p>
|
|
3865
4286
|
*/
|
|
3866
4287
|
TapeARNs?: string[];
|
|
3867
4288
|
/**
|
|
4289
|
+
* @public
|
|
3868
4290
|
* <p>A marker value, obtained in a previous call to <code>DescribeTapes</code>. This marker
|
|
3869
4291
|
* indicates which page of results to retrieve.</p>
|
|
3870
4292
|
*
|
|
@@ -3872,6 +4294,7 @@ export interface DescribeTapesInput {
|
|
|
3872
4294
|
*/
|
|
3873
4295
|
Marker?: string;
|
|
3874
4296
|
/**
|
|
4297
|
+
* @public
|
|
3875
4298
|
* <p>Specifies that the number of virtual tapes described be limited to the specified
|
|
3876
4299
|
* number.</p>
|
|
3877
4300
|
*
|
|
@@ -3887,30 +4310,37 @@ export interface DescribeTapesInput {
|
|
|
3887
4310
|
*/
|
|
3888
4311
|
export interface Tape {
|
|
3889
4312
|
/**
|
|
4313
|
+
* @public
|
|
3890
4314
|
* <p>The Amazon Resource Name (ARN) of the virtual tape.</p>
|
|
3891
4315
|
*/
|
|
3892
4316
|
TapeARN?: string;
|
|
3893
4317
|
/**
|
|
4318
|
+
* @public
|
|
3894
4319
|
* <p>The barcode that identifies a specific virtual tape.</p>
|
|
3895
4320
|
*/
|
|
3896
4321
|
TapeBarcode?: string;
|
|
3897
4322
|
/**
|
|
4323
|
+
* @public
|
|
3898
4324
|
* <p>The date the virtual tape was created.</p>
|
|
3899
4325
|
*/
|
|
3900
4326
|
TapeCreatedDate?: Date;
|
|
3901
4327
|
/**
|
|
4328
|
+
* @public
|
|
3902
4329
|
* <p>The size, in bytes, of the virtual tape capacity.</p>
|
|
3903
4330
|
*/
|
|
3904
4331
|
TapeSizeInBytes?: number;
|
|
3905
4332
|
/**
|
|
4333
|
+
* @public
|
|
3906
4334
|
* <p>The current state of the virtual tape.</p>
|
|
3907
4335
|
*/
|
|
3908
4336
|
TapeStatus?: string;
|
|
3909
4337
|
/**
|
|
4338
|
+
* @public
|
|
3910
4339
|
* <p>The virtual tape library (VTL) device that the virtual tape is associated with.</p>
|
|
3911
4340
|
*/
|
|
3912
4341
|
VTLDevice?: string;
|
|
3913
4342
|
/**
|
|
4343
|
+
* @public
|
|
3914
4344
|
* <p>For archiving virtual tapes, indicates how much data remains to be uploaded before
|
|
3915
4345
|
* archiving is complete.</p>
|
|
3916
4346
|
*
|
|
@@ -3918,6 +4348,7 @@ export interface Tape {
|
|
|
3918
4348
|
*/
|
|
3919
4349
|
Progress?: number;
|
|
3920
4350
|
/**
|
|
4351
|
+
* @public
|
|
3921
4352
|
* <p>The size, in bytes, of data stored on the virtual tape.</p>
|
|
3922
4353
|
*
|
|
3923
4354
|
* <note>
|
|
@@ -3926,11 +4357,13 @@ export interface Tape {
|
|
|
3926
4357
|
*/
|
|
3927
4358
|
TapeUsedInBytes?: number;
|
|
3928
4359
|
/**
|
|
4360
|
+
* @public
|
|
3929
4361
|
* <p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
|
|
3930
4362
|
* value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>
|
|
3931
4363
|
*/
|
|
3932
4364
|
KMSKey?: string;
|
|
3933
4365
|
/**
|
|
4366
|
+
* @public
|
|
3934
4367
|
* <p>The ID of the pool that contains tapes that will be archived. The tapes in this pool are
|
|
3935
4368
|
* archived in the S3 storage class that is associated with the pool. When you use your backup
|
|
3936
4369
|
* application to eject the tape, the tape is archived directly into the storage class (S3
|
|
@@ -3938,15 +4371,18 @@ export interface Tape {
|
|
|
3938
4371
|
*/
|
|
3939
4372
|
PoolId?: string;
|
|
3940
4373
|
/**
|
|
4374
|
+
* @public
|
|
3941
4375
|
* <p>If the tape is archived as write-once-read-many (WORM), this value is
|
|
3942
4376
|
* <code>true</code>.</p>
|
|
3943
4377
|
*/
|
|
3944
4378
|
Worm?: boolean;
|
|
3945
4379
|
/**
|
|
4380
|
+
* @public
|
|
3946
4381
|
* <p>The date that the tape is first archived with tape retention lock enabled.</p>
|
|
3947
4382
|
*/
|
|
3948
4383
|
RetentionStartDate?: Date;
|
|
3949
4384
|
/**
|
|
4385
|
+
* @public
|
|
3950
4386
|
* <p>The date that the tape enters a custom tape pool.</p>
|
|
3951
4387
|
*/
|
|
3952
4388
|
PoolEntryDate?: Date;
|
|
@@ -3957,10 +4393,12 @@ export interface Tape {
|
|
|
3957
4393
|
*/
|
|
3958
4394
|
export interface DescribeTapesOutput {
|
|
3959
4395
|
/**
|
|
4396
|
+
* @public
|
|
3960
4397
|
* <p>An array of virtual tape descriptions.</p>
|
|
3961
4398
|
*/
|
|
3962
4399
|
Tapes?: Tape[];
|
|
3963
4400
|
/**
|
|
4401
|
+
* @public
|
|
3964
4402
|
* <p>An opaque string that can be used as part of a subsequent <code>DescribeTapes</code>
|
|
3965
4403
|
* call to retrieve the next page of results.</p>
|
|
3966
4404
|
*
|
|
@@ -3974,6 +4412,7 @@ export interface DescribeTapesOutput {
|
|
|
3974
4412
|
*/
|
|
3975
4413
|
export interface DescribeUploadBufferInput {
|
|
3976
4414
|
/**
|
|
4415
|
+
* @public
|
|
3977
4416
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
3978
4417
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
3979
4418
|
*/
|
|
@@ -3984,11 +4423,13 @@ export interface DescribeUploadBufferInput {
|
|
|
3984
4423
|
*/
|
|
3985
4424
|
export interface DescribeUploadBufferOutput {
|
|
3986
4425
|
/**
|
|
4426
|
+
* @public
|
|
3987
4427
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
3988
4428
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
3989
4429
|
*/
|
|
3990
4430
|
GatewayARN?: string;
|
|
3991
4431
|
/**
|
|
4432
|
+
* @public
|
|
3992
4433
|
* <p>An array of the gateway's local disk IDs that are configured as working storage.
|
|
3993
4434
|
* Each local disk ID is specified as a string (minimum length of 1 and maximum length of
|
|
3994
4435
|
* 300). If no local disks are configured as working storage, then the DiskIds array is
|
|
@@ -3996,10 +4437,12 @@ export interface DescribeUploadBufferOutput {
|
|
|
3996
4437
|
*/
|
|
3997
4438
|
DiskIds?: string[];
|
|
3998
4439
|
/**
|
|
4440
|
+
* @public
|
|
3999
4441
|
* <p>The total number of bytes being used in the gateway's upload buffer.</p>
|
|
4000
4442
|
*/
|
|
4001
4443
|
UploadBufferUsedInBytes?: number;
|
|
4002
4444
|
/**
|
|
4445
|
+
* @public
|
|
4003
4446
|
* <p>The total number of bytes allocated in the gateway's as upload buffer.</p>
|
|
4004
4447
|
*/
|
|
4005
4448
|
UploadBufferAllocatedInBytes?: number;
|
|
@@ -4010,11 +4453,13 @@ export interface DescribeUploadBufferOutput {
|
|
|
4010
4453
|
*/
|
|
4011
4454
|
export interface DescribeVTLDevicesInput {
|
|
4012
4455
|
/**
|
|
4456
|
+
* @public
|
|
4013
4457
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
4014
4458
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
4015
4459
|
*/
|
|
4016
4460
|
GatewayARN: string | undefined;
|
|
4017
4461
|
/**
|
|
4462
|
+
* @public
|
|
4018
4463
|
* <p>An array of strings, where each string represents the Amazon Resource Name (ARN) of a
|
|
4019
4464
|
* VTL device.</p>
|
|
4020
4465
|
*
|
|
@@ -4025,11 +4470,13 @@ export interface DescribeVTLDevicesInput {
|
|
|
4025
4470
|
*/
|
|
4026
4471
|
VTLDeviceARNs?: string[];
|
|
4027
4472
|
/**
|
|
4473
|
+
* @public
|
|
4028
4474
|
* <p>An opaque string that indicates the position at which to begin describing the VTL
|
|
4029
4475
|
* devices.</p>
|
|
4030
4476
|
*/
|
|
4031
4477
|
Marker?: string;
|
|
4032
4478
|
/**
|
|
4479
|
+
* @public
|
|
4033
4480
|
* <p>Specifies that the number of VTL devices described be limited to the specified
|
|
4034
4481
|
* number.</p>
|
|
4035
4482
|
*/
|
|
@@ -4041,19 +4488,23 @@ export interface DescribeVTLDevicesInput {
|
|
|
4041
4488
|
*/
|
|
4042
4489
|
export interface DeviceiSCSIAttributes {
|
|
4043
4490
|
/**
|
|
4491
|
+
* @public
|
|
4044
4492
|
* <p>Specifies the unique Amazon Resource Name (ARN) that encodes the iSCSI qualified
|
|
4045
4493
|
* name(iqn) of a tape drive or media changer target.</p>
|
|
4046
4494
|
*/
|
|
4047
4495
|
TargetARN?: string;
|
|
4048
4496
|
/**
|
|
4497
|
+
* @public
|
|
4049
4498
|
* <p>The network interface identifier of the VTL device.</p>
|
|
4050
4499
|
*/
|
|
4051
4500
|
NetworkInterfaceId?: string;
|
|
4052
4501
|
/**
|
|
4502
|
+
* @public
|
|
4053
4503
|
* <p>The port used to communicate with iSCSI VTL device targets.</p>
|
|
4054
4504
|
*/
|
|
4055
4505
|
NetworkInterfacePort?: number;
|
|
4056
4506
|
/**
|
|
4507
|
+
* @public
|
|
4057
4508
|
* <p>Indicates whether mutual CHAP is enabled for the iSCSI target.</p>
|
|
4058
4509
|
*/
|
|
4059
4510
|
ChapEnabled?: boolean;
|
|
@@ -4064,23 +4515,28 @@ export interface DeviceiSCSIAttributes {
|
|
|
4064
4515
|
*/
|
|
4065
4516
|
export interface VTLDevice {
|
|
4066
4517
|
/**
|
|
4518
|
+
* @public
|
|
4067
4519
|
* <p>Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media
|
|
4068
4520
|
* changer).</p>
|
|
4069
4521
|
*/
|
|
4070
4522
|
VTLDeviceARN?: string;
|
|
4071
4523
|
/**
|
|
4524
|
+
* @public
|
|
4072
4525
|
* <p>Specifies the type of device that the VTL device emulates.</p>
|
|
4073
4526
|
*/
|
|
4074
4527
|
VTLDeviceType?: string;
|
|
4075
4528
|
/**
|
|
4529
|
+
* @public
|
|
4076
4530
|
* <p>Specifies the vendor of the device that the VTL device object emulates.</p>
|
|
4077
4531
|
*/
|
|
4078
4532
|
VTLDeviceVendor?: string;
|
|
4079
4533
|
/**
|
|
4534
|
+
* @public
|
|
4080
4535
|
* <p>Specifies the model number of device that the VTL device emulates.</p>
|
|
4081
4536
|
*/
|
|
4082
4537
|
VTLDeviceProductIdentifier?: string;
|
|
4083
4538
|
/**
|
|
4539
|
+
* @public
|
|
4084
4540
|
* <p>A list of iSCSI information about a VTL device.</p>
|
|
4085
4541
|
*/
|
|
4086
4542
|
DeviceiSCSIAttributes?: DeviceiSCSIAttributes;
|
|
@@ -4091,16 +4547,19 @@ export interface VTLDevice {
|
|
|
4091
4547
|
*/
|
|
4092
4548
|
export interface DescribeVTLDevicesOutput {
|
|
4093
4549
|
/**
|
|
4550
|
+
* @public
|
|
4094
4551
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
4095
4552
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
4096
4553
|
*/
|
|
4097
4554
|
GatewayARN?: string;
|
|
4098
4555
|
/**
|
|
4556
|
+
* @public
|
|
4099
4557
|
* <p>An array of VTL device objects composed of the Amazon Resource Name (ARN) of the VTL
|
|
4100
4558
|
* devices.</p>
|
|
4101
4559
|
*/
|
|
4102
4560
|
VTLDevices?: VTLDevice[];
|
|
4103
4561
|
/**
|
|
4562
|
+
* @public
|
|
4104
4563
|
* <p>An opaque string that indicates the position at which the VTL devices that were fetched
|
|
4105
4564
|
* for description ended. Use the marker in your next request to fetch the next set of VTL
|
|
4106
4565
|
* devices in the list. If there are no more VTL devices to describe, this field does not
|
|
@@ -4114,6 +4573,7 @@ export interface DescribeVTLDevicesOutput {
|
|
|
4114
4573
|
*/
|
|
4115
4574
|
export interface DescribeWorkingStorageInput {
|
|
4116
4575
|
/**
|
|
4576
|
+
* @public
|
|
4117
4577
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
4118
4578
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
4119
4579
|
*/
|
|
@@ -4125,11 +4585,13 @@ export interface DescribeWorkingStorageInput {
|
|
|
4125
4585
|
*/
|
|
4126
4586
|
export interface DescribeWorkingStorageOutput {
|
|
4127
4587
|
/**
|
|
4588
|
+
* @public
|
|
4128
4589
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
4129
4590
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
4130
4591
|
*/
|
|
4131
4592
|
GatewayARN?: string;
|
|
4132
4593
|
/**
|
|
4594
|
+
* @public
|
|
4133
4595
|
* <p>An array of the gateway's local disk IDs that are configured as working storage.
|
|
4134
4596
|
* Each local disk ID is specified as a string (minimum length of 1 and maximum length of
|
|
4135
4597
|
* 300). If no local disks are configured as working storage, then the DiskIds array is
|
|
@@ -4137,11 +4599,13 @@ export interface DescribeWorkingStorageOutput {
|
|
|
4137
4599
|
*/
|
|
4138
4600
|
DiskIds?: string[];
|
|
4139
4601
|
/**
|
|
4602
|
+
* @public
|
|
4140
4603
|
* <p>The total working storage in bytes in use by the gateway. If no working storage is
|
|
4141
4604
|
* configured for the gateway, this field returns 0.</p>
|
|
4142
4605
|
*/
|
|
4143
4606
|
WorkingStorageUsedInBytes?: number;
|
|
4144
4607
|
/**
|
|
4608
|
+
* @public
|
|
4145
4609
|
* <p>The total working storage in bytes allocated for the gateway. If no working storage is
|
|
4146
4610
|
* configured for the gateway, this field returns 0.</p>
|
|
4147
4611
|
*/
|
|
@@ -4153,10 +4617,12 @@ export interface DescribeWorkingStorageOutput {
|
|
|
4153
4617
|
*/
|
|
4154
4618
|
export interface DetachVolumeInput {
|
|
4155
4619
|
/**
|
|
4620
|
+
* @public
|
|
4156
4621
|
* <p>The Amazon Resource Name (ARN) of the volume to detach from the gateway.</p>
|
|
4157
4622
|
*/
|
|
4158
4623
|
VolumeARN: string | undefined;
|
|
4159
4624
|
/**
|
|
4625
|
+
* @public
|
|
4160
4626
|
* <p>Set to <code>true</code> to forcibly remove the iSCSI connection of the target volume
|
|
4161
4627
|
* and detach the volume. The default is <code>false</code>. If this value is set to
|
|
4162
4628
|
* <code>false</code>, you must manually disconnect the iSCSI connection from the target
|
|
@@ -4173,6 +4639,7 @@ export interface DetachVolumeInput {
|
|
|
4173
4639
|
*/
|
|
4174
4640
|
export interface DetachVolumeOutput {
|
|
4175
4641
|
/**
|
|
4642
|
+
* @public
|
|
4176
4643
|
* <p>The Amazon Resource Name (ARN) of the volume that was detached.</p>
|
|
4177
4644
|
*/
|
|
4178
4645
|
VolumeARN?: string;
|
|
@@ -4183,6 +4650,7 @@ export interface DetachVolumeOutput {
|
|
|
4183
4650
|
*/
|
|
4184
4651
|
export interface DisableGatewayInput {
|
|
4185
4652
|
/**
|
|
4653
|
+
* @public
|
|
4186
4654
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
4187
4655
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
4188
4656
|
*/
|
|
@@ -4194,6 +4662,7 @@ export interface DisableGatewayInput {
|
|
|
4194
4662
|
*/
|
|
4195
4663
|
export interface DisableGatewayOutput {
|
|
4196
4664
|
/**
|
|
4665
|
+
* @public
|
|
4197
4666
|
* <p>The unique Amazon Resource Name (ARN) of the disabled gateway.</p>
|
|
4198
4667
|
*/
|
|
4199
4668
|
GatewayARN?: string;
|
|
@@ -4203,10 +4672,12 @@ export interface DisableGatewayOutput {
|
|
|
4203
4672
|
*/
|
|
4204
4673
|
export interface DisassociateFileSystemInput {
|
|
4205
4674
|
/**
|
|
4675
|
+
* @public
|
|
4206
4676
|
* <p>The Amazon Resource Name (ARN) of the file system association to be deleted.</p>
|
|
4207
4677
|
*/
|
|
4208
4678
|
FileSystemAssociationARN: string | undefined;
|
|
4209
4679
|
/**
|
|
4680
|
+
* @public
|
|
4210
4681
|
* <p>If this value is set to true, the operation disassociates an Amazon FSx file
|
|
4211
4682
|
* system immediately. It ends all data uploads to the file system, and the file system
|
|
4212
4683
|
* association enters the <code>FORCE_DELETING</code> status. If this value is set to false,
|
|
@@ -4219,6 +4690,7 @@ export interface DisassociateFileSystemInput {
|
|
|
4219
4690
|
*/
|
|
4220
4691
|
export interface DisassociateFileSystemOutput {
|
|
4221
4692
|
/**
|
|
4693
|
+
* @public
|
|
4222
4694
|
* <p>The Amazon Resource Name (ARN) of the deleted file system association.</p>
|
|
4223
4695
|
*/
|
|
4224
4696
|
FileSystemAssociationARN?: string;
|
|
@@ -4229,26 +4701,32 @@ export interface DisassociateFileSystemOutput {
|
|
|
4229
4701
|
*/
|
|
4230
4702
|
export interface Disk {
|
|
4231
4703
|
/**
|
|
4704
|
+
* @public
|
|
4232
4705
|
* <p>The unique device ID or other distinguishing data that identifies a local disk.</p>
|
|
4233
4706
|
*/
|
|
4234
4707
|
DiskId?: string;
|
|
4235
4708
|
/**
|
|
4709
|
+
* @public
|
|
4236
4710
|
* <p>The path of a local disk in the gateway virtual machine (VM).</p>
|
|
4237
4711
|
*/
|
|
4238
4712
|
DiskPath?: string;
|
|
4239
4713
|
/**
|
|
4714
|
+
* @public
|
|
4240
4715
|
* <p>The device node of a local disk as assigned by the virtualization environment.</p>
|
|
4241
4716
|
*/
|
|
4242
4717
|
DiskNode?: string;
|
|
4243
4718
|
/**
|
|
4719
|
+
* @public
|
|
4244
4720
|
* <p>A value that represents the status of a local disk.</p>
|
|
4245
4721
|
*/
|
|
4246
4722
|
DiskStatus?: string;
|
|
4247
4723
|
/**
|
|
4724
|
+
* @public
|
|
4248
4725
|
* <p>The local disk size in bytes.</p>
|
|
4249
4726
|
*/
|
|
4250
4727
|
DiskSizeInBytes?: number;
|
|
4251
4728
|
/**
|
|
4729
|
+
* @public
|
|
4252
4730
|
* <p>One of the <code>DiskAllocationType</code> enumeration values that identifies how a
|
|
4253
4731
|
* local disk is used.</p>
|
|
4254
4732
|
*
|
|
@@ -4257,12 +4735,14 @@ export interface Disk {
|
|
|
4257
4735
|
*/
|
|
4258
4736
|
DiskAllocationType?: string;
|
|
4259
4737
|
/**
|
|
4738
|
+
* @public
|
|
4260
4739
|
* <p>The iSCSI qualified name (IQN) that is defined for a disk. This field is not included in
|
|
4261
4740
|
* the response if the local disk is not defined as an iSCSI target. The format of this field
|
|
4262
4741
|
* is <i>targetIqn::LUNNumber::region-volumeId</i>.</p>
|
|
4263
4742
|
*/
|
|
4264
4743
|
DiskAllocationResource?: string;
|
|
4265
4744
|
/**
|
|
4745
|
+
* @public
|
|
4266
4746
|
* <p>A list of values that represents attributes of a local disk.</p>
|
|
4267
4747
|
*/
|
|
4268
4748
|
DiskAttributeList?: string[];
|
|
@@ -4277,18 +4757,22 @@ export type FileShareType = "NFS" | "SMB";
|
|
|
4277
4757
|
*/
|
|
4278
4758
|
export interface FileShareInfo {
|
|
4279
4759
|
/**
|
|
4760
|
+
* @public
|
|
4280
4761
|
* <p>The type of the file share.</p>
|
|
4281
4762
|
*/
|
|
4282
4763
|
FileShareType?: FileShareType | string;
|
|
4283
4764
|
/**
|
|
4765
|
+
* @public
|
|
4284
4766
|
* <p>The Amazon Resource Name (ARN) of the file share.</p>
|
|
4285
4767
|
*/
|
|
4286
4768
|
FileShareARN?: string;
|
|
4287
4769
|
/**
|
|
4770
|
+
* @public
|
|
4288
4771
|
* <p>The ID of the file share.</p>
|
|
4289
4772
|
*/
|
|
4290
4773
|
FileShareId?: string;
|
|
4291
4774
|
/**
|
|
4775
|
+
* @public
|
|
4292
4776
|
* <p>The status of the file share.</p>
|
|
4293
4777
|
*
|
|
4294
4778
|
* <p>Valid Values: <code>CREATING</code> | <code>UPDATING</code> | <code>AVAILABLE</code> |
|
|
@@ -4297,6 +4781,7 @@ export interface FileShareInfo {
|
|
|
4297
4781
|
*/
|
|
4298
4782
|
FileShareStatus?: string;
|
|
4299
4783
|
/**
|
|
4784
|
+
* @public
|
|
4300
4785
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
4301
4786
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
4302
4787
|
*/
|
|
@@ -4309,14 +4794,17 @@ export interface FileShareInfo {
|
|
|
4309
4794
|
*/
|
|
4310
4795
|
export interface FileSystemAssociationSummary {
|
|
4311
4796
|
/**
|
|
4797
|
+
* @public
|
|
4312
4798
|
* <p>The ID of the file system association.</p>
|
|
4313
4799
|
*/
|
|
4314
4800
|
FileSystemAssociationId?: string;
|
|
4315
4801
|
/**
|
|
4802
|
+
* @public
|
|
4316
4803
|
* <p>The Amazon Resource Name (ARN) of the file system association.</p>
|
|
4317
4804
|
*/
|
|
4318
4805
|
FileSystemAssociationARN?: string;
|
|
4319
4806
|
/**
|
|
4807
|
+
* @public
|
|
4320
4808
|
* <p>The status of the file share. Valid Values: <code>AVAILABLE</code> |
|
|
4321
4809
|
* <code>CREATING</code> | <code>DELETING</code> | <code>FORCE_DELETING</code> |
|
|
4322
4810
|
* <code>UPDATING</code> | <code>ERROR</code>
|
|
@@ -4324,6 +4812,7 @@ export interface FileSystemAssociationSummary {
|
|
|
4324
4812
|
*/
|
|
4325
4813
|
FileSystemAssociationStatus?: string;
|
|
4326
4814
|
/**
|
|
4815
|
+
* @public
|
|
4327
4816
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
4328
4817
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
4329
4818
|
*/
|
|
@@ -4335,21 +4824,25 @@ export interface FileSystemAssociationSummary {
|
|
|
4335
4824
|
*/
|
|
4336
4825
|
export interface GatewayInfo {
|
|
4337
4826
|
/**
|
|
4827
|
+
* @public
|
|
4338
4828
|
* <p>The unique identifier assigned to your gateway during activation. This ID becomes part
|
|
4339
4829
|
* of the gateway Amazon Resource Name (ARN), which you use as input for other
|
|
4340
4830
|
* operations.</p>
|
|
4341
4831
|
*/
|
|
4342
4832
|
GatewayId?: string;
|
|
4343
4833
|
/**
|
|
4834
|
+
* @public
|
|
4344
4835
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
4345
4836
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
4346
4837
|
*/
|
|
4347
4838
|
GatewayARN?: string;
|
|
4348
4839
|
/**
|
|
4840
|
+
* @public
|
|
4349
4841
|
* <p>The type of the gateway.</p>
|
|
4350
4842
|
*/
|
|
4351
4843
|
GatewayType?: string;
|
|
4352
4844
|
/**
|
|
4845
|
+
* @public
|
|
4353
4846
|
* <p>The state of the gateway.</p>
|
|
4354
4847
|
*
|
|
4355
4848
|
* <p>Valid Values: <code>DISABLED</code> | <code>ACTIVE</code>
|
|
@@ -4357,22 +4850,27 @@ export interface GatewayInfo {
|
|
|
4357
4850
|
*/
|
|
4358
4851
|
GatewayOperationalState?: string;
|
|
4359
4852
|
/**
|
|
4853
|
+
* @public
|
|
4360
4854
|
* <p>The name of the gateway.</p>
|
|
4361
4855
|
*/
|
|
4362
4856
|
GatewayName?: string;
|
|
4363
4857
|
/**
|
|
4858
|
+
* @public
|
|
4364
4859
|
* <p>The ID of the Amazon EC2 instance that was used to launch the gateway.</p>
|
|
4365
4860
|
*/
|
|
4366
4861
|
Ec2InstanceId?: string;
|
|
4367
4862
|
/**
|
|
4863
|
+
* @public
|
|
4368
4864
|
* <p>The Amazon Web Services Region where the Amazon EC2 instance is located.</p>
|
|
4369
4865
|
*/
|
|
4370
4866
|
Ec2InstanceRegion?: string;
|
|
4371
4867
|
/**
|
|
4868
|
+
* @public
|
|
4372
4869
|
* <p>The type of hardware or software platform on which the gateway is running.</p>
|
|
4373
4870
|
*/
|
|
4374
4871
|
HostEnvironment?: HostEnvironment | string;
|
|
4375
4872
|
/**
|
|
4873
|
+
* @public
|
|
4376
4874
|
* <p>A unique identifier for the specific instance of the host platform running the gateway.
|
|
4377
4875
|
* This value is only available for certain host environments, and its format depends on the
|
|
4378
4876
|
* host environment type.</p>
|
|
@@ -4385,32 +4883,38 @@ export interface GatewayInfo {
|
|
|
4385
4883
|
*/
|
|
4386
4884
|
export interface JoinDomainInput {
|
|
4387
4885
|
/**
|
|
4886
|
+
* @public
|
|
4388
4887
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <code>ListGateways</code>
|
|
4389
4888
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
4390
4889
|
*/
|
|
4391
4890
|
GatewayARN: string | undefined;
|
|
4392
4891
|
/**
|
|
4892
|
+
* @public
|
|
4393
4893
|
* <p>The name of the domain that you want the gateway to join.</p>
|
|
4394
4894
|
*/
|
|
4395
4895
|
DomainName: string | undefined;
|
|
4396
4896
|
/**
|
|
4897
|
+
* @public
|
|
4397
4898
|
* <p>The organizational unit (OU) is a container in an Active Directory that can hold users,
|
|
4398
4899
|
* groups, computers, and other OUs and this parameter specifies the OU that the gateway will
|
|
4399
4900
|
* join within the AD domain.</p>
|
|
4400
4901
|
*/
|
|
4401
4902
|
OrganizationalUnit?: string;
|
|
4402
4903
|
/**
|
|
4904
|
+
* @public
|
|
4403
4905
|
* <p>List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need
|
|
4404
4906
|
* to specify the port number include it after the colon (“:”). For example,
|
|
4405
4907
|
* <code>mydc.mydomain.com:389</code>.</p>
|
|
4406
4908
|
*/
|
|
4407
4909
|
DomainControllers?: string[];
|
|
4408
4910
|
/**
|
|
4911
|
+
* @public
|
|
4409
4912
|
* <p>Specifies the time in seconds, in which the <code>JoinDomain</code> operation must
|
|
4410
4913
|
* complete. The default is 20 seconds.</p>
|
|
4411
4914
|
*/
|
|
4412
4915
|
TimeoutInSeconds?: number;
|
|
4413
4916
|
/**
|
|
4917
|
+
* @public
|
|
4414
4918
|
* <p>Sets the user name of user who has permission to add the gateway to the Active Directory
|
|
4415
4919
|
* domain. The domain user account should be enabled to join computers to the domain. For
|
|
4416
4920
|
* example, you can use the domain administrator account or an account with delegated
|
|
@@ -4418,6 +4922,7 @@ export interface JoinDomainInput {
|
|
|
4418
4922
|
*/
|
|
4419
4923
|
UserName: string | undefined;
|
|
4420
4924
|
/**
|
|
4925
|
+
* @public
|
|
4421
4926
|
* <p>Sets the password of the user who has permission to add the gateway to the Active
|
|
4422
4927
|
* Directory domain.</p>
|
|
4423
4928
|
*/
|
|
@@ -4429,10 +4934,12 @@ export interface JoinDomainInput {
|
|
|
4429
4934
|
*/
|
|
4430
4935
|
export interface JoinDomainOutput {
|
|
4431
4936
|
/**
|
|
4937
|
+
* @public
|
|
4432
4938
|
* <p>The unique Amazon Resource Name (ARN) of the gateway that joined the domain.</p>
|
|
4433
4939
|
*/
|
|
4434
4940
|
GatewayARN?: string;
|
|
4435
4941
|
/**
|
|
4942
|
+
* @public
|
|
4436
4943
|
* <p>Indicates the status of the gateway as a member of the Active Directory domain.</p>
|
|
4437
4944
|
*
|
|
4438
4945
|
* <ul>
|
|
@@ -4479,6 +4986,7 @@ export interface JoinDomainOutput {
|
|
|
4479
4986
|
*/
|
|
4480
4987
|
export interface ListAutomaticTapeCreationPoliciesInput {
|
|
4481
4988
|
/**
|
|
4989
|
+
* @public
|
|
4482
4990
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
4483
4991
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
4484
4992
|
*/
|
|
@@ -4489,6 +4997,7 @@ export interface ListAutomaticTapeCreationPoliciesInput {
|
|
|
4489
4997
|
*/
|
|
4490
4998
|
export interface ListAutomaticTapeCreationPoliciesOutput {
|
|
4491
4999
|
/**
|
|
5000
|
+
* @public
|
|
4492
5001
|
* <p>Gets a listing of information about the gateway's automatic tape creation policies,
|
|
4493
5002
|
* including the automatic tape creation rules and the gateway that is using the
|
|
4494
5003
|
* policies.</p>
|
|
@@ -4501,16 +5010,19 @@ export interface ListAutomaticTapeCreationPoliciesOutput {
|
|
|
4501
5010
|
*/
|
|
4502
5011
|
export interface ListFileSharesInput {
|
|
4503
5012
|
/**
|
|
5013
|
+
* @public
|
|
4504
5014
|
* <p>The Amazon Resource Name (ARN) of the gateway whose file shares you want to list. If
|
|
4505
5015
|
* this field is not present, all file shares under your account are listed.</p>
|
|
4506
5016
|
*/
|
|
4507
5017
|
GatewayARN?: string;
|
|
4508
5018
|
/**
|
|
5019
|
+
* @public
|
|
4509
5020
|
* <p>The maximum number of file shares to return in the response. The value must be an
|
|
4510
5021
|
* integer with a value greater than zero. Optional.</p>
|
|
4511
5022
|
*/
|
|
4512
5023
|
Limit?: number;
|
|
4513
5024
|
/**
|
|
5025
|
+
* @public
|
|
4514
5026
|
* <p>Opaque pagination token returned from a previous ListFileShares operation. If present,
|
|
4515
5027
|
* <code>Marker</code> specifies where to continue the list from after a previous call to
|
|
4516
5028
|
* ListFileShares. Optional.</p>
|
|
@@ -4523,17 +5035,20 @@ export interface ListFileSharesInput {
|
|
|
4523
5035
|
*/
|
|
4524
5036
|
export interface ListFileSharesOutput {
|
|
4525
5037
|
/**
|
|
5038
|
+
* @public
|
|
4526
5039
|
* <p>If the request includes <code>Marker</code>, the response returns that value in this
|
|
4527
5040
|
* field.</p>
|
|
4528
5041
|
*/
|
|
4529
5042
|
Marker?: string;
|
|
4530
5043
|
/**
|
|
5044
|
+
* @public
|
|
4531
5045
|
* <p>If a value is present, there are more file shares to return. In a subsequent request,
|
|
4532
5046
|
* use <code>NextMarker</code> as the value for <code>Marker</code> to retrieve the next set
|
|
4533
5047
|
* of file shares.</p>
|
|
4534
5048
|
*/
|
|
4535
5049
|
NextMarker?: string;
|
|
4536
5050
|
/**
|
|
5051
|
+
* @public
|
|
4537
5052
|
* <p>An array of information about the S3 File Gateway's file shares.</p>
|
|
4538
5053
|
*/
|
|
4539
5054
|
FileShareInfoList?: FileShareInfo[];
|
|
@@ -4543,16 +5058,19 @@ export interface ListFileSharesOutput {
|
|
|
4543
5058
|
*/
|
|
4544
5059
|
export interface ListFileSystemAssociationsInput {
|
|
4545
5060
|
/**
|
|
5061
|
+
* @public
|
|
4546
5062
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
4547
5063
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
4548
5064
|
*/
|
|
4549
5065
|
GatewayARN?: string;
|
|
4550
5066
|
/**
|
|
5067
|
+
* @public
|
|
4551
5068
|
* <p>The maximum number of file system associations to return in the response. If present,
|
|
4552
5069
|
* <code>Limit</code> must be an integer with a value greater than zero. Optional.</p>
|
|
4553
5070
|
*/
|
|
4554
5071
|
Limit?: number;
|
|
4555
5072
|
/**
|
|
5073
|
+
* @public
|
|
4556
5074
|
* <p>Opaque pagination token returned from a previous <code>ListFileSystemAssociations</code>
|
|
4557
5075
|
* operation. If present, <code>Marker</code> specifies where to continue the list from after
|
|
4558
5076
|
* a previous call to <code>ListFileSystemAssociations</code>. Optional.</p>
|
|
@@ -4564,17 +5082,20 @@ export interface ListFileSystemAssociationsInput {
|
|
|
4564
5082
|
*/
|
|
4565
5083
|
export interface ListFileSystemAssociationsOutput {
|
|
4566
5084
|
/**
|
|
5085
|
+
* @public
|
|
4567
5086
|
* <p>If the request includes <code>Marker</code>, the response returns that value in this
|
|
4568
5087
|
* field.</p>
|
|
4569
5088
|
*/
|
|
4570
5089
|
Marker?: string;
|
|
4571
5090
|
/**
|
|
5091
|
+
* @public
|
|
4572
5092
|
* <p>If a value is present, there are more file system associations to return. In a
|
|
4573
5093
|
* subsequent request, use <code>NextMarker</code> as the value for <code>Marker</code> to
|
|
4574
5094
|
* retrieve the next set of file system associations.</p>
|
|
4575
5095
|
*/
|
|
4576
5096
|
NextMarker?: string;
|
|
4577
5097
|
/**
|
|
5098
|
+
* @public
|
|
4578
5099
|
* <p>An array of information about the Amazon FSx gateway's file system
|
|
4579
5100
|
* associations.</p>
|
|
4580
5101
|
*/
|
|
@@ -4599,11 +5120,13 @@ export interface ListFileSystemAssociationsOutput {
|
|
|
4599
5120
|
*/
|
|
4600
5121
|
export interface ListGatewaysInput {
|
|
4601
5122
|
/**
|
|
5123
|
+
* @public
|
|
4602
5124
|
* <p>An opaque string that indicates the position at which to begin the returned list of
|
|
4603
5125
|
* gateways.</p>
|
|
4604
5126
|
*/
|
|
4605
5127
|
Marker?: string;
|
|
4606
5128
|
/**
|
|
5129
|
+
* @public
|
|
4607
5130
|
* <p>Specifies that the list of gateways returned be limited to the specified number of
|
|
4608
5131
|
* items.</p>
|
|
4609
5132
|
*/
|
|
@@ -4614,10 +5137,12 @@ export interface ListGatewaysInput {
|
|
|
4614
5137
|
*/
|
|
4615
5138
|
export interface ListGatewaysOutput {
|
|
4616
5139
|
/**
|
|
5140
|
+
* @public
|
|
4617
5141
|
* <p>An array of <a>GatewayInfo</a> objects.</p>
|
|
4618
5142
|
*/
|
|
4619
5143
|
Gateways?: GatewayInfo[];
|
|
4620
5144
|
/**
|
|
5145
|
+
* @public
|
|
4621
5146
|
* <p>Use the marker in your next request to fetch the next set of gateways in the list. If
|
|
4622
5147
|
* there are no more gateways to list, this field does not appear in the response.</p>
|
|
4623
5148
|
*/
|
|
@@ -4629,6 +5154,7 @@ export interface ListGatewaysOutput {
|
|
|
4629
5154
|
*/
|
|
4630
5155
|
export interface ListLocalDisksInput {
|
|
4631
5156
|
/**
|
|
5157
|
+
* @public
|
|
4632
5158
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
4633
5159
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
4634
5160
|
*/
|
|
@@ -4639,11 +5165,13 @@ export interface ListLocalDisksInput {
|
|
|
4639
5165
|
*/
|
|
4640
5166
|
export interface ListLocalDisksOutput {
|
|
4641
5167
|
/**
|
|
5168
|
+
* @public
|
|
4642
5169
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
4643
5170
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
4644
5171
|
*/
|
|
4645
5172
|
GatewayARN?: string;
|
|
4646
5173
|
/**
|
|
5174
|
+
* @public
|
|
4647
5175
|
* <p>A JSON object containing the following fields:</p>
|
|
4648
5176
|
*
|
|
4649
5177
|
* <ul>
|
|
@@ -4662,15 +5190,18 @@ export interface ListLocalDisksOutput {
|
|
|
4662
5190
|
*/
|
|
4663
5191
|
export interface ListTagsForResourceInput {
|
|
4664
5192
|
/**
|
|
5193
|
+
* @public
|
|
4665
5194
|
* <p>The Amazon Resource Name (ARN) of the resource for which you want to list tags.</p>
|
|
4666
5195
|
*/
|
|
4667
5196
|
ResourceARN: string | undefined;
|
|
4668
5197
|
/**
|
|
5198
|
+
* @public
|
|
4669
5199
|
* <p>An opaque string that indicates the position at which to begin returning the list of
|
|
4670
5200
|
* tags.</p>
|
|
4671
5201
|
*/
|
|
4672
5202
|
Marker?: string;
|
|
4673
5203
|
/**
|
|
5204
|
+
* @public
|
|
4674
5205
|
* <p>Specifies that the list of tags returned be limited to the specified number of
|
|
4675
5206
|
* items.</p>
|
|
4676
5207
|
*/
|
|
@@ -4682,15 +5213,18 @@ export interface ListTagsForResourceInput {
|
|
|
4682
5213
|
*/
|
|
4683
5214
|
export interface ListTagsForResourceOutput {
|
|
4684
5215
|
/**
|
|
5216
|
+
* @public
|
|
4685
5217
|
* <p>The Amazon Resource Name (ARN) of the resource for which you want to list tags.</p>
|
|
4686
5218
|
*/
|
|
4687
5219
|
ResourceARN?: string;
|
|
4688
5220
|
/**
|
|
5221
|
+
* @public
|
|
4689
5222
|
* <p>An opaque string that indicates the position at which to stop returning the list of
|
|
4690
5223
|
* tags.</p>
|
|
4691
5224
|
*/
|
|
4692
5225
|
Marker?: string;
|
|
4693
5226
|
/**
|
|
5227
|
+
* @public
|
|
4694
5228
|
* <p>An array that contains the tags for the specified resource.</p>
|
|
4695
5229
|
*/
|
|
4696
5230
|
Tags?: Tag[];
|
|
@@ -4700,16 +5234,19 @@ export interface ListTagsForResourceOutput {
|
|
|
4700
5234
|
*/
|
|
4701
5235
|
export interface ListTapePoolsInput {
|
|
4702
5236
|
/**
|
|
5237
|
+
* @public
|
|
4703
5238
|
* <p>The Amazon Resource Name (ARN) of each of the custom tape pools you want to list. If you
|
|
4704
5239
|
* don't specify a custom tape pool ARN, the response lists all custom tape pools. </p>
|
|
4705
5240
|
*/
|
|
4706
5241
|
PoolARNs?: string[];
|
|
4707
5242
|
/**
|
|
5243
|
+
* @public
|
|
4708
5244
|
* <p>A string that indicates the position at which to begin the returned list of tape
|
|
4709
5245
|
* pools.</p>
|
|
4710
5246
|
*/
|
|
4711
5247
|
Marker?: string;
|
|
4712
5248
|
/**
|
|
5249
|
+
* @public
|
|
4713
5250
|
* <p>An optional number limit for the tape pools in the list returned by this call.</p>
|
|
4714
5251
|
*/
|
|
4715
5252
|
Limit?: number;
|
|
@@ -4724,22 +5261,26 @@ export type PoolStatus = "ACTIVE" | "DELETED";
|
|
|
4724
5261
|
*/
|
|
4725
5262
|
export interface PoolInfo {
|
|
4726
5263
|
/**
|
|
5264
|
+
* @public
|
|
4727
5265
|
* <p>The Amazon Resource Name (ARN) of the custom tape pool. Use the <a>ListTapePools</a> operation to return a list of custom tape pools for your
|
|
4728
5266
|
* account and Amazon Web Services Region.</p>
|
|
4729
5267
|
*/
|
|
4730
5268
|
PoolARN?: string;
|
|
4731
5269
|
/**
|
|
5270
|
+
* @public
|
|
4732
5271
|
* <p>The name of the custom tape pool. <code>PoolName</code> can use all ASCII characters,
|
|
4733
5272
|
* except '/' and '\'.</p>
|
|
4734
5273
|
*/
|
|
4735
5274
|
PoolName?: string;
|
|
4736
5275
|
/**
|
|
5276
|
+
* @public
|
|
4737
5277
|
* <p>The storage class that is associated with the custom pool. When you use your backup
|
|
4738
5278
|
* application to eject the tape, the tape is archived directly into the storage class (S3
|
|
4739
5279
|
* Glacier or S3 Glacier Deep Archive) that corresponds to the pool.</p>
|
|
4740
5280
|
*/
|
|
4741
5281
|
StorageClass?: TapeStorageClass | string;
|
|
4742
5282
|
/**
|
|
5283
|
+
* @public
|
|
4743
5284
|
* <p>Tape retention lock type, which can be configured in two modes. When configured in
|
|
4744
5285
|
* governance mode, Amazon Web Services accounts with specific IAM permissions are authorized
|
|
4745
5286
|
* to remove the tape retention lock from archived virtual tapes. When configured in
|
|
@@ -4748,11 +5289,13 @@ export interface PoolInfo {
|
|
|
4748
5289
|
*/
|
|
4749
5290
|
RetentionLockType?: RetentionLockType | string;
|
|
4750
5291
|
/**
|
|
5292
|
+
* @public
|
|
4751
5293
|
* <p>Tape retention lock time is set in days. Tape retention lock can be enabled for up to
|
|
4752
5294
|
* 100 years (36,500 days).</p>
|
|
4753
5295
|
*/
|
|
4754
5296
|
RetentionLockTimeInDays?: number;
|
|
4755
5297
|
/**
|
|
5298
|
+
* @public
|
|
4756
5299
|
* <p>Status of the custom tape pool. Pool can be <code>ACTIVE</code> or
|
|
4757
5300
|
* <code>DELETED</code>.</p>
|
|
4758
5301
|
*/
|
|
@@ -4763,12 +5306,14 @@ export interface PoolInfo {
|
|
|
4763
5306
|
*/
|
|
4764
5307
|
export interface ListTapePoolsOutput {
|
|
4765
5308
|
/**
|
|
5309
|
+
* @public
|
|
4766
5310
|
* <p>An array of <code>PoolInfo</code> objects, where each object describes a single custom
|
|
4767
5311
|
* tape pool. If there are no custom tape pools, the <code>PoolInfos</code> is an empty array.
|
|
4768
5312
|
* </p>
|
|
4769
5313
|
*/
|
|
4770
5314
|
PoolInfos?: PoolInfo[];
|
|
4771
5315
|
/**
|
|
5316
|
+
* @public
|
|
4772
5317
|
* <p>A string that indicates the position at which to begin the returned list of tape pools.
|
|
4773
5318
|
* Use the marker in your next request to continue pagination of tape pools. If there are no
|
|
4774
5319
|
* more tape pools to list, this element does not appear in the response body. </p>
|
|
@@ -4799,16 +5344,19 @@ export interface ListTapePoolsOutput {
|
|
|
4799
5344
|
*/
|
|
4800
5345
|
export interface ListTapesInput {
|
|
4801
5346
|
/**
|
|
5347
|
+
* @public
|
|
4802
5348
|
* <p>The Amazon Resource Name (ARN) of each of the tapes you want to list. If you don't
|
|
4803
5349
|
* specify a tape ARN, the response lists all tapes in both your VTL and VTS.</p>
|
|
4804
5350
|
*/
|
|
4805
5351
|
TapeARNs?: string[];
|
|
4806
5352
|
/**
|
|
5353
|
+
* @public
|
|
4807
5354
|
* <p>A string that indicates the position at which to begin the returned list of
|
|
4808
5355
|
* tapes.</p>
|
|
4809
5356
|
*/
|
|
4810
5357
|
Marker?: string;
|
|
4811
5358
|
/**
|
|
5359
|
+
* @public
|
|
4812
5360
|
* <p>An optional number limit for the tapes in the list returned by this call.</p>
|
|
4813
5361
|
*/
|
|
4814
5362
|
Limit?: number;
|
|
@@ -4819,27 +5367,33 @@ export interface ListTapesInput {
|
|
|
4819
5367
|
*/
|
|
4820
5368
|
export interface TapeInfo {
|
|
4821
5369
|
/**
|
|
5370
|
+
* @public
|
|
4822
5371
|
* <p>The Amazon Resource Name (ARN) of a virtual tape.</p>
|
|
4823
5372
|
*/
|
|
4824
5373
|
TapeARN?: string;
|
|
4825
5374
|
/**
|
|
5375
|
+
* @public
|
|
4826
5376
|
* <p>The barcode that identifies a specific virtual tape.</p>
|
|
4827
5377
|
*/
|
|
4828
5378
|
TapeBarcode?: string;
|
|
4829
5379
|
/**
|
|
5380
|
+
* @public
|
|
4830
5381
|
* <p>The size, in bytes, of a virtual tape.</p>
|
|
4831
5382
|
*/
|
|
4832
5383
|
TapeSizeInBytes?: number;
|
|
4833
5384
|
/**
|
|
5385
|
+
* @public
|
|
4834
5386
|
* <p>The status of the tape.</p>
|
|
4835
5387
|
*/
|
|
4836
5388
|
TapeStatus?: string;
|
|
4837
5389
|
/**
|
|
5390
|
+
* @public
|
|
4838
5391
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
4839
5392
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
4840
5393
|
*/
|
|
4841
5394
|
GatewayARN?: string;
|
|
4842
5395
|
/**
|
|
5396
|
+
* @public
|
|
4843
5397
|
* <p>The ID of the pool that you want to add your tape to for archiving. The tape in this
|
|
4844
5398
|
* pool is archived in the S3 storage class that is associated with the pool. When you use
|
|
4845
5399
|
* your backup application to eject the tape, the tape is archived directly into the storage
|
|
@@ -4847,10 +5401,12 @@ export interface TapeInfo {
|
|
|
4847
5401
|
*/
|
|
4848
5402
|
PoolId?: string;
|
|
4849
5403
|
/**
|
|
5404
|
+
* @public
|
|
4850
5405
|
* <p>The date that the tape became subject to tape retention lock.</p>
|
|
4851
5406
|
*/
|
|
4852
5407
|
RetentionStartDate?: Date;
|
|
4853
5408
|
/**
|
|
5409
|
+
* @public
|
|
4854
5410
|
* <p>The date that the tape entered the custom tape pool with tape retention lock
|
|
4855
5411
|
* enabled.</p>
|
|
4856
5412
|
*/
|
|
@@ -4875,12 +5431,14 @@ export interface TapeInfo {
|
|
|
4875
5431
|
*/
|
|
4876
5432
|
export interface ListTapesOutput {
|
|
4877
5433
|
/**
|
|
5434
|
+
* @public
|
|
4878
5435
|
* <p>An array of <a>TapeInfo</a> objects, where each object describes a single
|
|
4879
5436
|
* tape. If there are no tapes in the tape library or VTS, then the <code>TapeInfos</code> is
|
|
4880
5437
|
* an empty array.</p>
|
|
4881
5438
|
*/
|
|
4882
5439
|
TapeInfos?: TapeInfo[];
|
|
4883
5440
|
/**
|
|
5441
|
+
* @public
|
|
4884
5442
|
* <p>A string that indicates the position at which to begin returning the next list of tapes.
|
|
4885
5443
|
* Use the marker in your next request to continue pagination of tapes. If there are no more
|
|
4886
5444
|
* tapes to list, this element does not appear in the response body.</p>
|
|
@@ -4893,6 +5451,7 @@ export interface ListTapesOutput {
|
|
|
4893
5451
|
*/
|
|
4894
5452
|
export interface ListVolumeInitiatorsInput {
|
|
4895
5453
|
/**
|
|
5454
|
+
* @public
|
|
4896
5455
|
* <p>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a>
|
|
4897
5456
|
* operation to return a list of gateway volumes for the gateway.</p>
|
|
4898
5457
|
*/
|
|
@@ -4904,6 +5463,7 @@ export interface ListVolumeInitiatorsInput {
|
|
|
4904
5463
|
*/
|
|
4905
5464
|
export interface ListVolumeInitiatorsOutput {
|
|
4906
5465
|
/**
|
|
5466
|
+
* @public
|
|
4907
5467
|
* <p>The host names and port numbers of all iSCSI initiators that are connected to the
|
|
4908
5468
|
* gateway.</p>
|
|
4909
5469
|
*/
|
|
@@ -4914,6 +5474,7 @@ export interface ListVolumeInitiatorsOutput {
|
|
|
4914
5474
|
*/
|
|
4915
5475
|
export interface ListVolumeRecoveryPointsInput {
|
|
4916
5476
|
/**
|
|
5477
|
+
* @public
|
|
4917
5478
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
4918
5479
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
4919
5480
|
*/
|
|
@@ -4925,14 +5486,17 @@ export interface ListVolumeRecoveryPointsInput {
|
|
|
4925
5486
|
*/
|
|
4926
5487
|
export interface VolumeRecoveryPointInfo {
|
|
4927
5488
|
/**
|
|
5489
|
+
* @public
|
|
4928
5490
|
* <p>The Amazon Resource Name (ARN) of the volume target.</p>
|
|
4929
5491
|
*/
|
|
4930
5492
|
VolumeARN?: string;
|
|
4931
5493
|
/**
|
|
5494
|
+
* @public
|
|
4932
5495
|
* <p>The size of the volume in bytes.</p>
|
|
4933
5496
|
*/
|
|
4934
5497
|
VolumeSizeInBytes?: number;
|
|
4935
5498
|
/**
|
|
5499
|
+
* @public
|
|
4936
5500
|
* <p>The size of the data stored on the volume in bytes.</p>
|
|
4937
5501
|
*
|
|
4938
5502
|
* <note>
|
|
@@ -4942,6 +5506,7 @@ export interface VolumeRecoveryPointInfo {
|
|
|
4942
5506
|
*/
|
|
4943
5507
|
VolumeUsageInBytes?: number;
|
|
4944
5508
|
/**
|
|
5509
|
+
* @public
|
|
4945
5510
|
* <p>The time the recovery point was taken.</p>
|
|
4946
5511
|
*/
|
|
4947
5512
|
VolumeRecoveryPointTime?: string;
|
|
@@ -4951,11 +5516,13 @@ export interface VolumeRecoveryPointInfo {
|
|
|
4951
5516
|
*/
|
|
4952
5517
|
export interface ListVolumeRecoveryPointsOutput {
|
|
4953
5518
|
/**
|
|
5519
|
+
* @public
|
|
4954
5520
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
4955
5521
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
4956
5522
|
*/
|
|
4957
5523
|
GatewayARN?: string;
|
|
4958
5524
|
/**
|
|
5525
|
+
* @public
|
|
4959
5526
|
* <p>An array of <a>VolumeRecoveryPointInfo</a> objects.</p>
|
|
4960
5527
|
*/
|
|
4961
5528
|
VolumeRecoveryPointInfos?: VolumeRecoveryPointInfo[];
|
|
@@ -4979,16 +5546,19 @@ export interface ListVolumeRecoveryPointsOutput {
|
|
|
4979
5546
|
*/
|
|
4980
5547
|
export interface ListVolumesInput {
|
|
4981
5548
|
/**
|
|
5549
|
+
* @public
|
|
4982
5550
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
4983
5551
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
4984
5552
|
*/
|
|
4985
5553
|
GatewayARN?: string;
|
|
4986
5554
|
/**
|
|
5555
|
+
* @public
|
|
4987
5556
|
* <p>A string that indicates the position at which to begin the returned list of volumes.
|
|
4988
5557
|
* Obtain the marker from the response of a previous List iSCSI Volumes request.</p>
|
|
4989
5558
|
*/
|
|
4990
5559
|
Marker?: string;
|
|
4991
5560
|
/**
|
|
5561
|
+
* @public
|
|
4992
5562
|
* <p>Specifies that the list of volumes returned be limited to the specified number of
|
|
4993
5563
|
* items.</p>
|
|
4994
5564
|
*/
|
|
@@ -5000,6 +5570,7 @@ export interface ListVolumesInput {
|
|
|
5000
5570
|
*/
|
|
5001
5571
|
export interface VolumeInfo {
|
|
5002
5572
|
/**
|
|
5573
|
+
* @public
|
|
5003
5574
|
* <p>The Amazon Resource Name (ARN) for the storage volume. For example, the following is a
|
|
5004
5575
|
* valid ARN:</p>
|
|
5005
5576
|
*
|
|
@@ -5011,6 +5582,7 @@ export interface VolumeInfo {
|
|
|
5011
5582
|
*/
|
|
5012
5583
|
VolumeARN?: string;
|
|
5013
5584
|
/**
|
|
5585
|
+
* @public
|
|
5014
5586
|
* <p>The unique identifier assigned to the volume. This ID becomes part of the volume Amazon
|
|
5015
5587
|
* Resource Name (ARN), which you use as input for other operations.</p>
|
|
5016
5588
|
*
|
|
@@ -5018,11 +5590,13 @@ export interface VolumeInfo {
|
|
|
5018
5590
|
*/
|
|
5019
5591
|
VolumeId?: string;
|
|
5020
5592
|
/**
|
|
5593
|
+
* @public
|
|
5021
5594
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5022
5595
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5023
5596
|
*/
|
|
5024
5597
|
GatewayARN?: string;
|
|
5025
5598
|
/**
|
|
5599
|
+
* @public
|
|
5026
5600
|
* <p>The unique identifier assigned to your gateway during activation. This ID becomes part
|
|
5027
5601
|
* of the gateway Amazon Resource Name (ARN), which you use as input for other
|
|
5028
5602
|
* operations.</p>
|
|
@@ -5031,16 +5605,19 @@ export interface VolumeInfo {
|
|
|
5031
5605
|
*/
|
|
5032
5606
|
GatewayId?: string;
|
|
5033
5607
|
/**
|
|
5608
|
+
* @public
|
|
5034
5609
|
* <p>One of the VolumeType enumeration values describing the type of the volume.</p>
|
|
5035
5610
|
*/
|
|
5036
5611
|
VolumeType?: string;
|
|
5037
5612
|
/**
|
|
5613
|
+
* @public
|
|
5038
5614
|
* <p>The size of the volume in bytes.</p>
|
|
5039
5615
|
*
|
|
5040
5616
|
* <p>Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).</p>
|
|
5041
5617
|
*/
|
|
5042
5618
|
VolumeSizeInBytes?: number;
|
|
5043
5619
|
/**
|
|
5620
|
+
* @public
|
|
5044
5621
|
* <p>One of the VolumeStatus values that indicates the state of the storage volume.</p>
|
|
5045
5622
|
*/
|
|
5046
5623
|
VolumeAttachmentStatus?: string;
|
|
@@ -5064,16 +5641,19 @@ export interface VolumeInfo {
|
|
|
5064
5641
|
*/
|
|
5065
5642
|
export interface ListVolumesOutput {
|
|
5066
5643
|
/**
|
|
5644
|
+
* @public
|
|
5067
5645
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5068
5646
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5069
5647
|
*/
|
|
5070
5648
|
GatewayARN?: string;
|
|
5071
5649
|
/**
|
|
5650
|
+
* @public
|
|
5072
5651
|
* <p>Use the marker in your next request to continue pagination of iSCSI volumes. If there
|
|
5073
5652
|
* are no more volumes to list, this field does not appear in the response body.</p>
|
|
5074
5653
|
*/
|
|
5075
5654
|
Marker?: string;
|
|
5076
5655
|
/**
|
|
5656
|
+
* @public
|
|
5077
5657
|
* <p>An array of <a>VolumeInfo</a> objects, where each object describes an iSCSI
|
|
5078
5658
|
* volume. If no volumes are defined for the gateway, then <code>VolumeInfos</code> is an
|
|
5079
5659
|
* empty array "[]".</p>
|
|
@@ -5085,6 +5665,7 @@ export interface ListVolumesOutput {
|
|
|
5085
5665
|
*/
|
|
5086
5666
|
export interface NotifyWhenUploadedInput {
|
|
5087
5667
|
/**
|
|
5668
|
+
* @public
|
|
5088
5669
|
* <p>The Amazon Resource Name (ARN) of the file share.</p>
|
|
5089
5670
|
*/
|
|
5090
5671
|
FileShareARN: string | undefined;
|
|
@@ -5094,10 +5675,12 @@ export interface NotifyWhenUploadedInput {
|
|
|
5094
5675
|
*/
|
|
5095
5676
|
export interface NotifyWhenUploadedOutput {
|
|
5096
5677
|
/**
|
|
5678
|
+
* @public
|
|
5097
5679
|
* <p>The Amazon Resource Name (ARN) of the file share.</p>
|
|
5098
5680
|
*/
|
|
5099
5681
|
FileShareARN?: string;
|
|
5100
5682
|
/**
|
|
5683
|
+
* @public
|
|
5101
5684
|
* <p>The randomly generated ID of the notification that was sent. This ID is in UUID
|
|
5102
5685
|
* format.</p>
|
|
5103
5686
|
*/
|
|
@@ -5109,16 +5692,19 @@ export interface NotifyWhenUploadedOutput {
|
|
|
5109
5692
|
*/
|
|
5110
5693
|
export interface RefreshCacheInput {
|
|
5111
5694
|
/**
|
|
5695
|
+
* @public
|
|
5112
5696
|
* <p>The Amazon Resource Name (ARN) of the file share you want to refresh.</p>
|
|
5113
5697
|
*/
|
|
5114
5698
|
FileShareARN: string | undefined;
|
|
5115
5699
|
/**
|
|
5700
|
+
* @public
|
|
5116
5701
|
* <p>A comma-separated list of the paths of folders to refresh in the cache. The default is
|
|
5117
5702
|
* [<code>"/"</code>]. The default refreshes objects and folders at the root of the Amazon S3 bucket. If <code>Recursive</code> is set to <code>true</code>, the entire S3
|
|
5118
5703
|
* bucket that the file share has access to is refreshed.</p>
|
|
5119
5704
|
*/
|
|
5120
5705
|
FolderList?: string[];
|
|
5121
5706
|
/**
|
|
5707
|
+
* @public
|
|
5122
5708
|
* <p>A value that specifies whether to recursively refresh folders in the cache. The refresh
|
|
5123
5709
|
* includes folders that were in the cache the last time the gateway listed the folder's
|
|
5124
5710
|
* contents. If this value set to <code>true</code>, each folder that is listed in
|
|
@@ -5138,10 +5724,12 @@ export interface RefreshCacheInput {
|
|
|
5138
5724
|
*/
|
|
5139
5725
|
export interface RefreshCacheOutput {
|
|
5140
5726
|
/**
|
|
5727
|
+
* @public
|
|
5141
5728
|
* <p>The Amazon Resource Name (ARN) of the file share.</p>
|
|
5142
5729
|
*/
|
|
5143
5730
|
FileShareARN?: string;
|
|
5144
5731
|
/**
|
|
5732
|
+
* @public
|
|
5145
5733
|
* <p>The randomly generated ID of the notification that was sent. This ID is in UUID
|
|
5146
5734
|
* format.</p>
|
|
5147
5735
|
*/
|
|
@@ -5153,10 +5741,12 @@ export interface RefreshCacheOutput {
|
|
|
5153
5741
|
*/
|
|
5154
5742
|
export interface RemoveTagsFromResourceInput {
|
|
5155
5743
|
/**
|
|
5744
|
+
* @public
|
|
5156
5745
|
* <p>The Amazon Resource Name (ARN) of the resource you want to remove the tags from.</p>
|
|
5157
5746
|
*/
|
|
5158
5747
|
ResourceARN: string | undefined;
|
|
5159
5748
|
/**
|
|
5749
|
+
* @public
|
|
5160
5750
|
* <p>The keys of the tags you want to remove from the specified resource. A tag is composed
|
|
5161
5751
|
* of a key-value pair.</p>
|
|
5162
5752
|
*/
|
|
@@ -5168,6 +5758,7 @@ export interface RemoveTagsFromResourceInput {
|
|
|
5168
5758
|
*/
|
|
5169
5759
|
export interface RemoveTagsFromResourceOutput {
|
|
5170
5760
|
/**
|
|
5761
|
+
* @public
|
|
5171
5762
|
* <p>The Amazon Resource Name (ARN) of the resource that the tags were removed from.</p>
|
|
5172
5763
|
*/
|
|
5173
5764
|
ResourceARN?: string;
|
|
@@ -5177,6 +5768,7 @@ export interface RemoveTagsFromResourceOutput {
|
|
|
5177
5768
|
*/
|
|
5178
5769
|
export interface ResetCacheInput {
|
|
5179
5770
|
/**
|
|
5771
|
+
* @public
|
|
5180
5772
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5181
5773
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5182
5774
|
*/
|
|
@@ -5187,6 +5779,7 @@ export interface ResetCacheInput {
|
|
|
5187
5779
|
*/
|
|
5188
5780
|
export interface ResetCacheOutput {
|
|
5189
5781
|
/**
|
|
5782
|
+
* @public
|
|
5190
5783
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5191
5784
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5192
5785
|
*/
|
|
@@ -5198,11 +5791,13 @@ export interface ResetCacheOutput {
|
|
|
5198
5791
|
*/
|
|
5199
5792
|
export interface RetrieveTapeArchiveInput {
|
|
5200
5793
|
/**
|
|
5794
|
+
* @public
|
|
5201
5795
|
* <p>The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual
|
|
5202
5796
|
* tape shelf (VTS).</p>
|
|
5203
5797
|
*/
|
|
5204
5798
|
TapeARN: string | undefined;
|
|
5205
5799
|
/**
|
|
5800
|
+
* @public
|
|
5206
5801
|
* <p>The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to.
|
|
5207
5802
|
* Use the <a>ListGateways</a> operation to return a list of gateways for your
|
|
5208
5803
|
* account and Amazon Web Services Region.</p>
|
|
@@ -5218,6 +5813,7 @@ export interface RetrieveTapeArchiveInput {
|
|
|
5218
5813
|
*/
|
|
5219
5814
|
export interface RetrieveTapeArchiveOutput {
|
|
5220
5815
|
/**
|
|
5816
|
+
* @public
|
|
5221
5817
|
* <p>The Amazon Resource Name (ARN) of the retrieved virtual tape.</p>
|
|
5222
5818
|
*/
|
|
5223
5819
|
TapeARN?: string;
|
|
@@ -5228,11 +5824,13 @@ export interface RetrieveTapeArchiveOutput {
|
|
|
5228
5824
|
*/
|
|
5229
5825
|
export interface RetrieveTapeRecoveryPointInput {
|
|
5230
5826
|
/**
|
|
5827
|
+
* @public
|
|
5231
5828
|
* <p>The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the
|
|
5232
5829
|
* recovery point.</p>
|
|
5233
5830
|
*/
|
|
5234
5831
|
TapeARN: string | undefined;
|
|
5235
5832
|
/**
|
|
5833
|
+
* @public
|
|
5236
5834
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5237
5835
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5238
5836
|
*/
|
|
@@ -5244,6 +5842,7 @@ export interface RetrieveTapeRecoveryPointInput {
|
|
|
5244
5842
|
*/
|
|
5245
5843
|
export interface RetrieveTapeRecoveryPointOutput {
|
|
5246
5844
|
/**
|
|
5845
|
+
* @public
|
|
5247
5846
|
* <p>The Amazon Resource Name (ARN) of the virtual tape for which the recovery point was
|
|
5248
5847
|
* retrieved.</p>
|
|
5249
5848
|
*/
|
|
@@ -5255,11 +5854,13 @@ export interface RetrieveTapeRecoveryPointOutput {
|
|
|
5255
5854
|
*/
|
|
5256
5855
|
export interface SetLocalConsolePasswordInput {
|
|
5257
5856
|
/**
|
|
5857
|
+
* @public
|
|
5258
5858
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5259
5859
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5260
5860
|
*/
|
|
5261
5861
|
GatewayARN: string | undefined;
|
|
5262
5862
|
/**
|
|
5863
|
+
* @public
|
|
5263
5864
|
* <p>The password you want to set for your VM local console.</p>
|
|
5264
5865
|
*/
|
|
5265
5866
|
LocalConsolePassword: string | undefined;
|
|
@@ -5269,6 +5870,7 @@ export interface SetLocalConsolePasswordInput {
|
|
|
5269
5870
|
*/
|
|
5270
5871
|
export interface SetLocalConsolePasswordOutput {
|
|
5271
5872
|
/**
|
|
5873
|
+
* @public
|
|
5272
5874
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5273
5875
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5274
5876
|
*/
|
|
@@ -5280,11 +5882,13 @@ export interface SetLocalConsolePasswordOutput {
|
|
|
5280
5882
|
*/
|
|
5281
5883
|
export interface SetSMBGuestPasswordInput {
|
|
5282
5884
|
/**
|
|
5885
|
+
* @public
|
|
5283
5886
|
* <p>The Amazon Resource Name (ARN) of the S3 File Gateway the SMB file share is associated
|
|
5284
5887
|
* with.</p>
|
|
5285
5888
|
*/
|
|
5286
5889
|
GatewayARN: string | undefined;
|
|
5287
5890
|
/**
|
|
5891
|
+
* @public
|
|
5288
5892
|
* <p>The password that you want to set for your SMB server.</p>
|
|
5289
5893
|
*/
|
|
5290
5894
|
Password: string | undefined;
|
|
@@ -5294,6 +5898,7 @@ export interface SetSMBGuestPasswordInput {
|
|
|
5294
5898
|
*/
|
|
5295
5899
|
export interface SetSMBGuestPasswordOutput {
|
|
5296
5900
|
/**
|
|
5901
|
+
* @public
|
|
5297
5902
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5298
5903
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5299
5904
|
*/
|
|
@@ -5306,6 +5911,7 @@ export interface SetSMBGuestPasswordOutput {
|
|
|
5306
5911
|
*/
|
|
5307
5912
|
export interface ShutdownGatewayInput {
|
|
5308
5913
|
/**
|
|
5914
|
+
* @public
|
|
5309
5915
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5310
5916
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5311
5917
|
*/
|
|
@@ -5318,6 +5924,7 @@ export interface ShutdownGatewayInput {
|
|
|
5318
5924
|
*/
|
|
5319
5925
|
export interface ShutdownGatewayOutput {
|
|
5320
5926
|
/**
|
|
5927
|
+
* @public
|
|
5321
5928
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5322
5929
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5323
5930
|
*/
|
|
@@ -5328,6 +5935,7 @@ export interface ShutdownGatewayOutput {
|
|
|
5328
5935
|
*/
|
|
5329
5936
|
export interface StartAvailabilityMonitorTestInput {
|
|
5330
5937
|
/**
|
|
5938
|
+
* @public
|
|
5331
5939
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5332
5940
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5333
5941
|
*/
|
|
@@ -5338,6 +5946,7 @@ export interface StartAvailabilityMonitorTestInput {
|
|
|
5338
5946
|
*/
|
|
5339
5947
|
export interface StartAvailabilityMonitorTestOutput {
|
|
5340
5948
|
/**
|
|
5949
|
+
* @public
|
|
5341
5950
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5342
5951
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5343
5952
|
*/
|
|
@@ -5349,6 +5958,7 @@ export interface StartAvailabilityMonitorTestOutput {
|
|
|
5349
5958
|
*/
|
|
5350
5959
|
export interface StartGatewayInput {
|
|
5351
5960
|
/**
|
|
5961
|
+
* @public
|
|
5352
5962
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5353
5963
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5354
5964
|
*/
|
|
@@ -5361,6 +5971,7 @@ export interface StartGatewayInput {
|
|
|
5361
5971
|
*/
|
|
5362
5972
|
export interface StartGatewayOutput {
|
|
5363
5973
|
/**
|
|
5974
|
+
* @public
|
|
5364
5975
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5365
5976
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5366
5977
|
*/
|
|
@@ -5371,11 +5982,13 @@ export interface StartGatewayOutput {
|
|
|
5371
5982
|
*/
|
|
5372
5983
|
export interface UpdateAutomaticTapeCreationPolicyInput {
|
|
5373
5984
|
/**
|
|
5985
|
+
* @public
|
|
5374
5986
|
* <p>An automatic tape creation policy consists of a list of automatic tape creation rules.
|
|
5375
5987
|
* The rules determine when and how to automatically create new tapes.</p>
|
|
5376
5988
|
*/
|
|
5377
5989
|
AutomaticTapeCreationRules: AutomaticTapeCreationRule[] | undefined;
|
|
5378
5990
|
/**
|
|
5991
|
+
* @public
|
|
5379
5992
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5380
5993
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5381
5994
|
*/
|
|
@@ -5386,6 +5999,7 @@ export interface UpdateAutomaticTapeCreationPolicyInput {
|
|
|
5386
5999
|
*/
|
|
5387
6000
|
export interface UpdateAutomaticTapeCreationPolicyOutput {
|
|
5388
6001
|
/**
|
|
6002
|
+
* @public
|
|
5389
6003
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5390
6004
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5391
6005
|
*/
|
|
@@ -5410,15 +6024,18 @@ export interface UpdateAutomaticTapeCreationPolicyOutput {
|
|
|
5410
6024
|
*/
|
|
5411
6025
|
export interface UpdateBandwidthRateLimitInput {
|
|
5412
6026
|
/**
|
|
6027
|
+
* @public
|
|
5413
6028
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5414
6029
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5415
6030
|
*/
|
|
5416
6031
|
GatewayARN: string | undefined;
|
|
5417
6032
|
/**
|
|
6033
|
+
* @public
|
|
5418
6034
|
* <p>The average upload bandwidth rate limit in bits per second.</p>
|
|
5419
6035
|
*/
|
|
5420
6036
|
AverageUploadRateLimitInBitsPerSec?: number;
|
|
5421
6037
|
/**
|
|
6038
|
+
* @public
|
|
5422
6039
|
* <p>The average download bandwidth rate limit in bits per second.</p>
|
|
5423
6040
|
*/
|
|
5424
6041
|
AverageDownloadRateLimitInBitsPerSec?: number;
|
|
@@ -5430,6 +6047,7 @@ export interface UpdateBandwidthRateLimitInput {
|
|
|
5430
6047
|
*/
|
|
5431
6048
|
export interface UpdateBandwidthRateLimitOutput {
|
|
5432
6049
|
/**
|
|
6050
|
+
* @public
|
|
5433
6051
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5434
6052
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5435
6053
|
*/
|
|
@@ -5440,11 +6058,13 @@ export interface UpdateBandwidthRateLimitOutput {
|
|
|
5440
6058
|
*/
|
|
5441
6059
|
export interface UpdateBandwidthRateLimitScheduleInput {
|
|
5442
6060
|
/**
|
|
6061
|
+
* @public
|
|
5443
6062
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5444
6063
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5445
6064
|
*/
|
|
5446
6065
|
GatewayARN: string | undefined;
|
|
5447
6066
|
/**
|
|
6067
|
+
* @public
|
|
5448
6068
|
* <p> An array containing bandwidth rate limit schedule intervals for a gateway. When no
|
|
5449
6069
|
* bandwidth rate limit intervals have been scheduled, the array is empty. </p>
|
|
5450
6070
|
*/
|
|
@@ -5455,6 +6075,7 @@ export interface UpdateBandwidthRateLimitScheduleInput {
|
|
|
5455
6075
|
*/
|
|
5456
6076
|
export interface UpdateBandwidthRateLimitScheduleOutput {
|
|
5457
6077
|
/**
|
|
6078
|
+
* @public
|
|
5458
6079
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5459
6080
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5460
6081
|
*/
|
|
@@ -5490,11 +6111,13 @@ export interface UpdateBandwidthRateLimitScheduleOutput {
|
|
|
5490
6111
|
*/
|
|
5491
6112
|
export interface UpdateChapCredentialsInput {
|
|
5492
6113
|
/**
|
|
6114
|
+
* @public
|
|
5493
6115
|
* <p>The Amazon Resource Name (ARN) of the iSCSI volume target. Use the <a>DescribeStorediSCSIVolumes</a> operation to return the TargetARN for specified
|
|
5494
6116
|
* VolumeARN.</p>
|
|
5495
6117
|
*/
|
|
5496
6118
|
TargetARN: string | undefined;
|
|
5497
6119
|
/**
|
|
6120
|
+
* @public
|
|
5498
6121
|
* <p>The secret key that the initiator (for example, the Windows client) must provide to
|
|
5499
6122
|
* participate in mutual CHAP with the target.</p>
|
|
5500
6123
|
*
|
|
@@ -5504,10 +6127,12 @@ export interface UpdateChapCredentialsInput {
|
|
|
5504
6127
|
*/
|
|
5505
6128
|
SecretToAuthenticateInitiator: string | undefined;
|
|
5506
6129
|
/**
|
|
6130
|
+
* @public
|
|
5507
6131
|
* <p>The iSCSI initiator that connects to the target.</p>
|
|
5508
6132
|
*/
|
|
5509
6133
|
InitiatorName: string | undefined;
|
|
5510
6134
|
/**
|
|
6135
|
+
* @public
|
|
5511
6136
|
* <p>The secret key that the target must provide to participate in mutual CHAP with the
|
|
5512
6137
|
* initiator (e.g. Windows client).</p>
|
|
5513
6138
|
*
|
|
@@ -5525,11 +6150,13 @@ export interface UpdateChapCredentialsInput {
|
|
|
5525
6150
|
*/
|
|
5526
6151
|
export interface UpdateChapCredentialsOutput {
|
|
5527
6152
|
/**
|
|
6153
|
+
* @public
|
|
5528
6154
|
* <p>The Amazon Resource Name (ARN) of the target. This is the same target specified in the
|
|
5529
6155
|
* request.</p>
|
|
5530
6156
|
*/
|
|
5531
6157
|
TargetARN?: string;
|
|
5532
6158
|
/**
|
|
6159
|
+
* @public
|
|
5533
6160
|
* <p>The iSCSI initiator that connects to the target. This is the same initiator name
|
|
5534
6161
|
* specified in the request.</p>
|
|
5535
6162
|
*/
|
|
@@ -5540,25 +6167,30 @@ export interface UpdateChapCredentialsOutput {
|
|
|
5540
6167
|
*/
|
|
5541
6168
|
export interface UpdateFileSystemAssociationInput {
|
|
5542
6169
|
/**
|
|
6170
|
+
* @public
|
|
5543
6171
|
* <p>The Amazon Resource Name (ARN) of the file system association that you want to
|
|
5544
6172
|
* update.</p>
|
|
5545
6173
|
*/
|
|
5546
6174
|
FileSystemAssociationARN: string | undefined;
|
|
5547
6175
|
/**
|
|
6176
|
+
* @public
|
|
5548
6177
|
* <p>The user name of the user credential that has permission to access the root share D$ of
|
|
5549
6178
|
* the Amazon FSx file system. The user account must belong to the Amazon FSx
|
|
5550
6179
|
* delegated admin user group.</p>
|
|
5551
6180
|
*/
|
|
5552
6181
|
UserName?: string;
|
|
5553
6182
|
/**
|
|
6183
|
+
* @public
|
|
5554
6184
|
* <p>The password of the user credential.</p>
|
|
5555
6185
|
*/
|
|
5556
6186
|
Password?: string;
|
|
5557
6187
|
/**
|
|
6188
|
+
* @public
|
|
5558
6189
|
* <p>The Amazon Resource Name (ARN) of the storage used for the audit logs.</p>
|
|
5559
6190
|
*/
|
|
5560
6191
|
AuditDestinationARN?: string;
|
|
5561
6192
|
/**
|
|
6193
|
+
* @public
|
|
5562
6194
|
* <p>The refresh cache information for the file share or FSx file systems.</p>
|
|
5563
6195
|
*/
|
|
5564
6196
|
CacheAttributes?: CacheAttributes;
|
|
@@ -5568,6 +6200,7 @@ export interface UpdateFileSystemAssociationInput {
|
|
|
5568
6200
|
*/
|
|
5569
6201
|
export interface UpdateFileSystemAssociationOutput {
|
|
5570
6202
|
/**
|
|
6203
|
+
* @public
|
|
5571
6204
|
* <p>The ARN of the updated file system association.</p>
|
|
5572
6205
|
*/
|
|
5573
6206
|
FileSystemAssociationARN?: string;
|
|
@@ -5577,19 +6210,23 @@ export interface UpdateFileSystemAssociationOutput {
|
|
|
5577
6210
|
*/
|
|
5578
6211
|
export interface UpdateGatewayInformationInput {
|
|
5579
6212
|
/**
|
|
6213
|
+
* @public
|
|
5580
6214
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5581
6215
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5582
6216
|
*/
|
|
5583
6217
|
GatewayARN: string | undefined;
|
|
5584
6218
|
/**
|
|
6219
|
+
* @public
|
|
5585
6220
|
* <p>The name you configured for your gateway.</p>
|
|
5586
6221
|
*/
|
|
5587
6222
|
GatewayName?: string;
|
|
5588
6223
|
/**
|
|
6224
|
+
* @public
|
|
5589
6225
|
* <p>A value that indicates the time zone of the gateway.</p>
|
|
5590
6226
|
*/
|
|
5591
6227
|
GatewayTimezone?: string;
|
|
5592
6228
|
/**
|
|
6229
|
+
* @public
|
|
5593
6230
|
* <p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want to use
|
|
5594
6231
|
* to monitor and log events in the gateway.</p>
|
|
5595
6232
|
*
|
|
@@ -5599,6 +6236,7 @@ export interface UpdateGatewayInformationInput {
|
|
|
5599
6236
|
*/
|
|
5600
6237
|
CloudWatchLogGroupARN?: string;
|
|
5601
6238
|
/**
|
|
6239
|
+
* @public
|
|
5602
6240
|
* <p>Specifies the size of the gateway's metadata cache.</p>
|
|
5603
6241
|
*/
|
|
5604
6242
|
GatewayCapacity?: GatewayCapacity | string;
|
|
@@ -5610,11 +6248,13 @@ export interface UpdateGatewayInformationInput {
|
|
|
5610
6248
|
*/
|
|
5611
6249
|
export interface UpdateGatewayInformationOutput {
|
|
5612
6250
|
/**
|
|
6251
|
+
* @public
|
|
5613
6252
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5614
6253
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5615
6254
|
*/
|
|
5616
6255
|
GatewayARN?: string;
|
|
5617
6256
|
/**
|
|
6257
|
+
* @public
|
|
5618
6258
|
* <p>The name you configured for your gateway.</p>
|
|
5619
6259
|
*/
|
|
5620
6260
|
GatewayName?: string;
|
|
@@ -5625,6 +6265,7 @@ export interface UpdateGatewayInformationOutput {
|
|
|
5625
6265
|
*/
|
|
5626
6266
|
export interface UpdateGatewaySoftwareNowInput {
|
|
5627
6267
|
/**
|
|
6268
|
+
* @public
|
|
5628
6269
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5629
6270
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5630
6271
|
*/
|
|
@@ -5637,6 +6278,7 @@ export interface UpdateGatewaySoftwareNowInput {
|
|
|
5637
6278
|
*/
|
|
5638
6279
|
export interface UpdateGatewaySoftwareNowOutput {
|
|
5639
6280
|
/**
|
|
6281
|
+
* @public
|
|
5640
6282
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5641
6283
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5642
6284
|
*/
|
|
@@ -5671,28 +6313,33 @@ export interface UpdateGatewaySoftwareNowOutput {
|
|
|
5671
6313
|
*/
|
|
5672
6314
|
export interface UpdateMaintenanceStartTimeInput {
|
|
5673
6315
|
/**
|
|
6316
|
+
* @public
|
|
5674
6317
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5675
6318
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5676
6319
|
*/
|
|
5677
6320
|
GatewayARN: string | undefined;
|
|
5678
6321
|
/**
|
|
6322
|
+
* @public
|
|
5679
6323
|
* <p>The hour component of the maintenance start time represented as <i>hh</i>,
|
|
5680
6324
|
* where <i>hh</i> is the hour (00 to 23). The hour of the day is in the time
|
|
5681
6325
|
* zone of the gateway.</p>
|
|
5682
6326
|
*/
|
|
5683
6327
|
HourOfDay: number | undefined;
|
|
5684
6328
|
/**
|
|
6329
|
+
* @public
|
|
5685
6330
|
* <p>The minute component of the maintenance start time represented as
|
|
5686
6331
|
* <i>mm</i>, where <i>mm</i> is the minute (00 to 59). The
|
|
5687
6332
|
* minute of the hour is in the time zone of the gateway.</p>
|
|
5688
6333
|
*/
|
|
5689
6334
|
MinuteOfHour: number | undefined;
|
|
5690
6335
|
/**
|
|
6336
|
+
* @public
|
|
5691
6337
|
* <p>The day of the week component of the maintenance start time week represented as an
|
|
5692
6338
|
* ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday.</p>
|
|
5693
6339
|
*/
|
|
5694
6340
|
DayOfWeek?: number;
|
|
5695
6341
|
/**
|
|
6342
|
+
* @public
|
|
5696
6343
|
* <p>The day of the month component of the maintenance start time represented as an ordinal
|
|
5697
6344
|
* number from 1 to 28, where 1 represents the first day of the month and 28 represents the
|
|
5698
6345
|
* last day of the month.</p>
|
|
@@ -5706,6 +6353,7 @@ export interface UpdateMaintenanceStartTimeInput {
|
|
|
5706
6353
|
*/
|
|
5707
6354
|
export interface UpdateMaintenanceStartTimeOutput {
|
|
5708
6355
|
/**
|
|
6356
|
+
* @public
|
|
5709
6357
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
5710
6358
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
5711
6359
|
*/
|
|
@@ -5717,10 +6365,12 @@ export interface UpdateMaintenanceStartTimeOutput {
|
|
|
5717
6365
|
*/
|
|
5718
6366
|
export interface UpdateNFSFileShareInput {
|
|
5719
6367
|
/**
|
|
6368
|
+
* @public
|
|
5720
6369
|
* <p>The Amazon Resource Name (ARN) of the file share to be updated.</p>
|
|
5721
6370
|
*/
|
|
5722
6371
|
FileShareARN: string | undefined;
|
|
5723
6372
|
/**
|
|
6373
|
+
* @public
|
|
5724
6374
|
* <p>Set to <code>true</code> to use Amazon S3 server-side encryption with your own
|
|
5725
6375
|
* KMS key, or <code>false</code> to use a key managed by Amazon S3.
|
|
5726
6376
|
* Optional.</p>
|
|
@@ -5730,15 +6380,18 @@ export interface UpdateNFSFileShareInput {
|
|
|
5730
6380
|
*/
|
|
5731
6381
|
KMSEncrypted?: boolean;
|
|
5732
6382
|
/**
|
|
6383
|
+
* @public
|
|
5733
6384
|
* <p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
|
|
5734
6385
|
* value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>
|
|
5735
6386
|
*/
|
|
5736
6387
|
KMSKey?: string;
|
|
5737
6388
|
/**
|
|
6389
|
+
* @public
|
|
5738
6390
|
* <p>The default values for the file share. Optional.</p>
|
|
5739
6391
|
*/
|
|
5740
6392
|
NFSFileShareDefaults?: NFSFileShareDefaults;
|
|
5741
6393
|
/**
|
|
6394
|
+
* @public
|
|
5742
6395
|
* <p>The default storage class for objects put into an Amazon S3 bucket by the S3
|
|
5743
6396
|
* File Gateway. The default value is <code>S3_STANDARD</code>. Optional.</p>
|
|
5744
6397
|
*
|
|
@@ -5748,16 +6401,19 @@ export interface UpdateNFSFileShareInput {
|
|
|
5748
6401
|
*/
|
|
5749
6402
|
DefaultStorageClass?: string;
|
|
5750
6403
|
/**
|
|
6404
|
+
* @public
|
|
5751
6405
|
* <p>A value that sets the access control list (ACL) permission for objects in the S3 bucket
|
|
5752
6406
|
* that a S3 File Gateway puts objects into. The default value is <code>private</code>.</p>
|
|
5753
6407
|
*/
|
|
5754
6408
|
ObjectACL?: ObjectACL | string;
|
|
5755
6409
|
/**
|
|
6410
|
+
* @public
|
|
5756
6411
|
* <p>The list of clients that are allowed to access the S3 File Gateway. The list must
|
|
5757
6412
|
* contain either valid IP addresses or valid CIDR blocks.</p>
|
|
5758
6413
|
*/
|
|
5759
6414
|
ClientList?: string[];
|
|
5760
6415
|
/**
|
|
6416
|
+
* @public
|
|
5761
6417
|
* <p>The user mapped to anonymous user.</p>
|
|
5762
6418
|
*
|
|
5763
6419
|
* <p>Valid values are the following:</p>
|
|
@@ -5779,6 +6435,7 @@ export interface UpdateNFSFileShareInput {
|
|
|
5779
6435
|
*/
|
|
5780
6436
|
Squash?: string;
|
|
5781
6437
|
/**
|
|
6438
|
+
* @public
|
|
5782
6439
|
* <p>A value that sets the write status of a file share. Set this value to <code>true</code>
|
|
5783
6440
|
* to set the write status to read-only, otherwise set to <code>false</code>.</p>
|
|
5784
6441
|
*
|
|
@@ -5787,6 +6444,7 @@ export interface UpdateNFSFileShareInput {
|
|
|
5787
6444
|
*/
|
|
5788
6445
|
ReadOnly?: boolean;
|
|
5789
6446
|
/**
|
|
6447
|
+
* @public
|
|
5790
6448
|
* <p>A value that enables guessing of the MIME type for uploaded objects based on file
|
|
5791
6449
|
* extensions. Set this value to <code>true</code> to enable MIME type guessing, otherwise set
|
|
5792
6450
|
* to <code>false</code>. The default value is <code>true</code>.</p>
|
|
@@ -5796,6 +6454,7 @@ export interface UpdateNFSFileShareInput {
|
|
|
5796
6454
|
*/
|
|
5797
6455
|
GuessMIMETypeEnabled?: boolean;
|
|
5798
6456
|
/**
|
|
6457
|
+
* @public
|
|
5799
6458
|
* <p>A value that sets who pays the cost of the request and the cost associated with data
|
|
5800
6459
|
* download from the S3 bucket. If this value is set to <code>true</code>, the requester pays
|
|
5801
6460
|
* the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays
|
|
@@ -5813,6 +6472,7 @@ export interface UpdateNFSFileShareInput {
|
|
|
5813
6472
|
*/
|
|
5814
6473
|
RequesterPays?: boolean;
|
|
5815
6474
|
/**
|
|
6475
|
+
* @public
|
|
5816
6476
|
* <p>The name of the file share. Optional.</p>
|
|
5817
6477
|
*
|
|
5818
6478
|
* <note>
|
|
@@ -5823,10 +6483,12 @@ export interface UpdateNFSFileShareInput {
|
|
|
5823
6483
|
*/
|
|
5824
6484
|
FileShareName?: string;
|
|
5825
6485
|
/**
|
|
6486
|
+
* @public
|
|
5826
6487
|
* <p>Specifies refresh cache information for the file share.</p>
|
|
5827
6488
|
*/
|
|
5828
6489
|
CacheAttributes?: CacheAttributes;
|
|
5829
6490
|
/**
|
|
6491
|
+
* @public
|
|
5830
6492
|
* <p>The notification policy of the file share. <code>SettlingTimeInSeconds</code> controls
|
|
5831
6493
|
* the number of seconds to wait after the last point in time a client wrote to a file before
|
|
5832
6494
|
* generating an <code>ObjectUploaded</code> notification. Because clients can make many small
|
|
@@ -5854,6 +6516,7 @@ export interface UpdateNFSFileShareInput {
|
|
|
5854
6516
|
*/
|
|
5855
6517
|
NotificationPolicy?: string;
|
|
5856
6518
|
/**
|
|
6519
|
+
* @public
|
|
5857
6520
|
* <p>The Amazon Resource Name (ARN) of the storage used for audit logs.</p>
|
|
5858
6521
|
*/
|
|
5859
6522
|
AuditDestinationARN?: string;
|
|
@@ -5864,6 +6527,7 @@ export interface UpdateNFSFileShareInput {
|
|
|
5864
6527
|
*/
|
|
5865
6528
|
export interface UpdateNFSFileShareOutput {
|
|
5866
6529
|
/**
|
|
6530
|
+
* @public
|
|
5867
6531
|
* <p>The Amazon Resource Name (ARN) of the updated file share.</p>
|
|
5868
6532
|
*/
|
|
5869
6533
|
FileShareARN?: string;
|
|
@@ -5874,10 +6538,12 @@ export interface UpdateNFSFileShareOutput {
|
|
|
5874
6538
|
*/
|
|
5875
6539
|
export interface UpdateSMBFileShareInput {
|
|
5876
6540
|
/**
|
|
6541
|
+
* @public
|
|
5877
6542
|
* <p>The Amazon Resource Name (ARN) of the SMB file share that you want to update.</p>
|
|
5878
6543
|
*/
|
|
5879
6544
|
FileShareARN: string | undefined;
|
|
5880
6545
|
/**
|
|
6546
|
+
* @public
|
|
5881
6547
|
* <p>Set to <code>true</code> to use Amazon S3 server-side encryption with your own
|
|
5882
6548
|
* KMS key, or <code>false</code> to use a key managed by Amazon S3.
|
|
5883
6549
|
* Optional.</p>
|
|
@@ -5887,11 +6553,13 @@ export interface UpdateSMBFileShareInput {
|
|
|
5887
6553
|
*/
|
|
5888
6554
|
KMSEncrypted?: boolean;
|
|
5889
6555
|
/**
|
|
6556
|
+
* @public
|
|
5890
6557
|
* <p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This
|
|
5891
6558
|
* value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>
|
|
5892
6559
|
*/
|
|
5893
6560
|
KMSKey?: string;
|
|
5894
6561
|
/**
|
|
6562
|
+
* @public
|
|
5895
6563
|
* <p>The default storage class for objects put into an Amazon S3 bucket by the S3
|
|
5896
6564
|
* File Gateway. The default value is <code>S3_STANDARD</code>. Optional.</p>
|
|
5897
6565
|
*
|
|
@@ -5901,11 +6569,13 @@ export interface UpdateSMBFileShareInput {
|
|
|
5901
6569
|
*/
|
|
5902
6570
|
DefaultStorageClass?: string;
|
|
5903
6571
|
/**
|
|
6572
|
+
* @public
|
|
5904
6573
|
* <p>A value that sets the access control list (ACL) permission for objects in the S3 bucket
|
|
5905
6574
|
* that a S3 File Gateway puts objects into. The default value is <code>private</code>.</p>
|
|
5906
6575
|
*/
|
|
5907
6576
|
ObjectACL?: ObjectACL | string;
|
|
5908
6577
|
/**
|
|
6578
|
+
* @public
|
|
5909
6579
|
* <p>A value that sets the write status of a file share. Set this value to <code>true</code>
|
|
5910
6580
|
* to set write status to read-only, otherwise set to <code>false</code>.</p>
|
|
5911
6581
|
*
|
|
@@ -5914,6 +6584,7 @@ export interface UpdateSMBFileShareInput {
|
|
|
5914
6584
|
*/
|
|
5915
6585
|
ReadOnly?: boolean;
|
|
5916
6586
|
/**
|
|
6587
|
+
* @public
|
|
5917
6588
|
* <p>A value that enables guessing of the MIME type for uploaded objects based on file
|
|
5918
6589
|
* extensions. Set this value to <code>true</code> to enable MIME type guessing, otherwise set
|
|
5919
6590
|
* to <code>false</code>. The default value is <code>true</code>.</p>
|
|
@@ -5923,6 +6594,7 @@ export interface UpdateSMBFileShareInput {
|
|
|
5923
6594
|
*/
|
|
5924
6595
|
GuessMIMETypeEnabled?: boolean;
|
|
5925
6596
|
/**
|
|
6597
|
+
* @public
|
|
5926
6598
|
* <p>A value that sets who pays the cost of the request and the cost associated with data
|
|
5927
6599
|
* download from the S3 bucket. If this value is set to <code>true</code>, the requester pays
|
|
5928
6600
|
* the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays
|
|
@@ -5940,6 +6612,7 @@ export interface UpdateSMBFileShareInput {
|
|
|
5940
6612
|
*/
|
|
5941
6613
|
RequesterPays?: boolean;
|
|
5942
6614
|
/**
|
|
6615
|
+
* @public
|
|
5943
6616
|
* <p>Set this value to <code>true</code> to enable access control list (ACL) on the SMB file
|
|
5944
6617
|
* share. Set it to <code>false</code> to map file and directory permissions to the POSIX
|
|
5945
6618
|
* permissions.</p>
|
|
@@ -5955,11 +6628,13 @@ export interface UpdateSMBFileShareInput {
|
|
|
5955
6628
|
*/
|
|
5956
6629
|
SMBACLEnabled?: boolean;
|
|
5957
6630
|
/**
|
|
6631
|
+
* @public
|
|
5958
6632
|
* <p>The files and folders on this share will only be visible to users with read
|
|
5959
6633
|
* access.</p>
|
|
5960
6634
|
*/
|
|
5961
6635
|
AccessBasedEnumeration?: boolean;
|
|
5962
6636
|
/**
|
|
6637
|
+
* @public
|
|
5963
6638
|
* <p>A list of users or groups in the Active Directory that have administrator rights to the
|
|
5964
6639
|
* file share. A group must be prefixed with the @ character. Acceptable formats include:
|
|
5965
6640
|
* <code>DOMAIN\User1</code>, <code>user1</code>, <code>@group1</code>, and
|
|
@@ -5968,6 +6643,7 @@ export interface UpdateSMBFileShareInput {
|
|
|
5968
6643
|
*/
|
|
5969
6644
|
AdminUserList?: string[];
|
|
5970
6645
|
/**
|
|
6646
|
+
* @public
|
|
5971
6647
|
* <p>A list of users or groups in the Active Directory that are allowed to access the file
|
|
5972
6648
|
* share. A group must be prefixed with the @ character. Acceptable formats include:
|
|
5973
6649
|
* <code>DOMAIN\User1</code>, <code>user1</code>, <code>@group1</code>, and
|
|
@@ -5976,6 +6652,7 @@ export interface UpdateSMBFileShareInput {
|
|
|
5976
6652
|
*/
|
|
5977
6653
|
ValidUserList?: string[];
|
|
5978
6654
|
/**
|
|
6655
|
+
* @public
|
|
5979
6656
|
* <p>A list of users or groups in the Active Directory that are not allowed to access the
|
|
5980
6657
|
* file share. A group must be prefixed with the @ character. Acceptable formats include:
|
|
5981
6658
|
* <code>DOMAIN\User1</code>, <code>user1</code>, <code>@group1</code>, and
|
|
@@ -5984,10 +6661,12 @@ export interface UpdateSMBFileShareInput {
|
|
|
5984
6661
|
*/
|
|
5985
6662
|
InvalidUserList?: string[];
|
|
5986
6663
|
/**
|
|
6664
|
+
* @public
|
|
5987
6665
|
* <p>The Amazon Resource Name (ARN) of the storage used for audit logs.</p>
|
|
5988
6666
|
*/
|
|
5989
6667
|
AuditDestinationARN?: string;
|
|
5990
6668
|
/**
|
|
6669
|
+
* @public
|
|
5991
6670
|
* <p>The case of an object name in an Amazon S3 bucket. For
|
|
5992
6671
|
* <code>ClientSpecified</code>, the client determines the case sensitivity. For
|
|
5993
6672
|
* <code>CaseSensitive</code>, the gateway determines the case sensitivity. The default
|
|
@@ -5995,6 +6674,7 @@ export interface UpdateSMBFileShareInput {
|
|
|
5995
6674
|
*/
|
|
5996
6675
|
CaseSensitivity?: CaseSensitivity | string;
|
|
5997
6676
|
/**
|
|
6677
|
+
* @public
|
|
5998
6678
|
* <p>The name of the file share. Optional.</p>
|
|
5999
6679
|
*
|
|
6000
6680
|
* <note>
|
|
@@ -6005,10 +6685,12 @@ export interface UpdateSMBFileShareInput {
|
|
|
6005
6685
|
*/
|
|
6006
6686
|
FileShareName?: string;
|
|
6007
6687
|
/**
|
|
6688
|
+
* @public
|
|
6008
6689
|
* <p>Specifies refresh cache information for the file share.</p>
|
|
6009
6690
|
*/
|
|
6010
6691
|
CacheAttributes?: CacheAttributes;
|
|
6011
6692
|
/**
|
|
6693
|
+
* @public
|
|
6012
6694
|
* <p>The notification policy of the file share. <code>SettlingTimeInSeconds</code> controls
|
|
6013
6695
|
* the number of seconds to wait after the last point in time a client wrote to a file before
|
|
6014
6696
|
* generating an <code>ObjectUploaded</code> notification. Because clients can make many small
|
|
@@ -6036,6 +6718,7 @@ export interface UpdateSMBFileShareInput {
|
|
|
6036
6718
|
*/
|
|
6037
6719
|
NotificationPolicy?: string;
|
|
6038
6720
|
/**
|
|
6721
|
+
* @public
|
|
6039
6722
|
* <p>Specifies whether opportunistic locking is enabled for the SMB file share.</p>
|
|
6040
6723
|
* <note>
|
|
6041
6724
|
* <p>Enabling opportunistic locking on case-sensitive shares is not recommended for
|
|
@@ -6052,6 +6735,7 @@ export interface UpdateSMBFileShareInput {
|
|
|
6052
6735
|
*/
|
|
6053
6736
|
export interface UpdateSMBFileShareOutput {
|
|
6054
6737
|
/**
|
|
6738
|
+
* @public
|
|
6055
6739
|
* <p>The Amazon Resource Name (ARN) of the updated SMB file share.</p>
|
|
6056
6740
|
*/
|
|
6057
6741
|
FileShareARN?: string;
|
|
@@ -6061,11 +6745,13 @@ export interface UpdateSMBFileShareOutput {
|
|
|
6061
6745
|
*/
|
|
6062
6746
|
export interface UpdateSMBFileShareVisibilityInput {
|
|
6063
6747
|
/**
|
|
6748
|
+
* @public
|
|
6064
6749
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
6065
6750
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
6066
6751
|
*/
|
|
6067
6752
|
GatewayARN: string | undefined;
|
|
6068
6753
|
/**
|
|
6754
|
+
* @public
|
|
6069
6755
|
* <p>The shares on this gateway appear when listing shares.</p>
|
|
6070
6756
|
*/
|
|
6071
6757
|
FileSharesVisible: boolean | undefined;
|
|
@@ -6075,6 +6761,7 @@ export interface UpdateSMBFileShareVisibilityInput {
|
|
|
6075
6761
|
*/
|
|
6076
6762
|
export interface UpdateSMBFileShareVisibilityOutput {
|
|
6077
6763
|
/**
|
|
6764
|
+
* @public
|
|
6078
6765
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
6079
6766
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
6080
6767
|
*/
|
|
@@ -6085,11 +6772,13 @@ export interface UpdateSMBFileShareVisibilityOutput {
|
|
|
6085
6772
|
*/
|
|
6086
6773
|
export interface UpdateSMBLocalGroupsInput {
|
|
6087
6774
|
/**
|
|
6775
|
+
* @public
|
|
6088
6776
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
6089
6777
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
6090
6778
|
*/
|
|
6091
6779
|
GatewayARN: string | undefined;
|
|
6092
6780
|
/**
|
|
6781
|
+
* @public
|
|
6093
6782
|
* <p>A list of Active Directory users and groups that you want to grant special permissions
|
|
6094
6783
|
* for SMB file shares on the gateway.</p>
|
|
6095
6784
|
*/
|
|
@@ -6100,6 +6789,7 @@ export interface UpdateSMBLocalGroupsInput {
|
|
|
6100
6789
|
*/
|
|
6101
6790
|
export interface UpdateSMBLocalGroupsOutput {
|
|
6102
6791
|
/**
|
|
6792
|
+
* @public
|
|
6103
6793
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
6104
6794
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
6105
6795
|
*/
|
|
@@ -6110,11 +6800,13 @@ export interface UpdateSMBLocalGroupsOutput {
|
|
|
6110
6800
|
*/
|
|
6111
6801
|
export interface UpdateSMBSecurityStrategyInput {
|
|
6112
6802
|
/**
|
|
6803
|
+
* @public
|
|
6113
6804
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
6114
6805
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
6115
6806
|
*/
|
|
6116
6807
|
GatewayARN: string | undefined;
|
|
6117
6808
|
/**
|
|
6809
|
+
* @public
|
|
6118
6810
|
* <p>Specifies the type of security strategy.</p>
|
|
6119
6811
|
*
|
|
6120
6812
|
* <p>ClientSpecified: if you use this option, requests are established based on what is
|
|
@@ -6138,6 +6830,7 @@ export interface UpdateSMBSecurityStrategyInput {
|
|
|
6138
6830
|
*/
|
|
6139
6831
|
export interface UpdateSMBSecurityStrategyOutput {
|
|
6140
6832
|
/**
|
|
6833
|
+
* @public
|
|
6141
6834
|
* <p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a>
|
|
6142
6835
|
* operation to return a list of gateways for your account and Amazon Web Services Region.</p>
|
|
6143
6836
|
*/
|
|
@@ -6172,25 +6865,30 @@ export interface UpdateSMBSecurityStrategyOutput {
|
|
|
6172
6865
|
*/
|
|
6173
6866
|
export interface UpdateSnapshotScheduleInput {
|
|
6174
6867
|
/**
|
|
6868
|
+
* @public
|
|
6175
6869
|
* <p>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a>
|
|
6176
6870
|
* operation to return a list of gateway volumes.</p>
|
|
6177
6871
|
*/
|
|
6178
6872
|
VolumeARN: string | undefined;
|
|
6179
6873
|
/**
|
|
6874
|
+
* @public
|
|
6180
6875
|
* <p>The hour of the day at which the snapshot schedule begins represented as
|
|
6181
6876
|
* <i>hh</i>, where <i>hh</i> is the hour (0 to 23). The hour
|
|
6182
6877
|
* of the day is in the time zone of the gateway.</p>
|
|
6183
6878
|
*/
|
|
6184
6879
|
StartAt: number | undefined;
|
|
6185
6880
|
/**
|
|
6881
|
+
* @public
|
|
6186
6882
|
* <p>Frequency of snapshots. Specify the number of hours between snapshots.</p>
|
|
6187
6883
|
*/
|
|
6188
6884
|
RecurrenceInHours: number | undefined;
|
|
6189
6885
|
/**
|
|
6886
|
+
* @public
|
|
6190
6887
|
* <p>Optional description of the snapshot that overwrites the existing description.</p>
|
|
6191
6888
|
*/
|
|
6192
6889
|
Description?: string;
|
|
6193
6890
|
/**
|
|
6891
|
+
* @public
|
|
6194
6892
|
* <p>A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value
|
|
6195
6893
|
* pair.</p>
|
|
6196
6894
|
*
|
|
@@ -6210,6 +6908,7 @@ export interface UpdateSnapshotScheduleInput {
|
|
|
6210
6908
|
*/
|
|
6211
6909
|
export interface UpdateSnapshotScheduleOutput {
|
|
6212
6910
|
/**
|
|
6911
|
+
* @public
|
|
6213
6912
|
* <p>The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a>
|
|
6214
6913
|
* operation to return a list of gateway volumes.</p>
|
|
6215
6914
|
*/
|
|
@@ -6220,10 +6919,12 @@ export interface UpdateSnapshotScheduleOutput {
|
|
|
6220
6919
|
*/
|
|
6221
6920
|
export interface UpdateVTLDeviceTypeInput {
|
|
6222
6921
|
/**
|
|
6922
|
+
* @public
|
|
6223
6923
|
* <p>The Amazon Resource Name (ARN) of the medium changer you want to select.</p>
|
|
6224
6924
|
*/
|
|
6225
6925
|
VTLDeviceARN: string | undefined;
|
|
6226
6926
|
/**
|
|
6927
|
+
* @public
|
|
6227
6928
|
* <p>The type of medium changer you want to select.</p>
|
|
6228
6929
|
*
|
|
6229
6930
|
* <p>Valid Values: <code>STK-L700</code> | <code>AWS-Gateway-VTL</code> |
|
|
@@ -6238,6 +6939,7 @@ export interface UpdateVTLDeviceTypeInput {
|
|
|
6238
6939
|
*/
|
|
6239
6940
|
export interface UpdateVTLDeviceTypeOutput {
|
|
6240
6941
|
/**
|
|
6942
|
+
* @public
|
|
6241
6943
|
* <p>The Amazon Resource Name (ARN) of the medium changer you have selected.</p>
|
|
6242
6944
|
*/
|
|
6243
6945
|
VTLDeviceARN?: string;
|