forked from aws/aws-sdk-js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathstoragegateway-2013-06-30.normal.json
3463 lines (3463 loc) · 154 KB
/
storagegateway-2013-06-30.normal.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version":"2.0",
"metadata":{
"apiVersion":"2013-06-30",
"endpointPrefix":"storagegateway",
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"AWS Storage Gateway",
"signatureVersion":"v4",
"targetPrefix":"StorageGateway_20130630",
"uid":"storagegateway-2013-06-30"
},
"operations":{
"ActivateGateway":{
"name":"ActivateGateway",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ActivateGatewayInput"},
"output":{"shape":"ActivateGatewayOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Activates the gateway you previously deployed on your host. For more information, see <a href=\"http://docs.aws.amazon.com/storagegateway/latest/userguide/GettingStartedActivateGateway-common.html\"> Activate the AWS Storage Gateway</a>. In the activation process, you specify information such as the you want to use for storing snapshots, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account; for more information, see <a>UpdateGatewayInformation</a>.</p> <note> <p>You must turn on the gateway VM before you can activate your gateway.</p> </note>"
},
"AddCache":{
"name":"AddCache",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AddCacheInput"},
"output":{"shape":"AddCacheOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Configures one or more gateway local disks as cache for a cached-volume gateway. This operation is supported only for the gateway-cached volume architecture (see <a href=\"http://docs.aws.amazon.com/storagegateway/latest/userguide/StorageGatewayConcepts.html\">Storage Gateway Concepts</a>).</p> <p>In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.</p>"
},
"AddTagsToResource":{
"name":"AddTagsToResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AddTagsToResourceInput"},
"output":{"shape":"AddTagsToResourceOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following AWS Storage Gateway resources:</p> <ul> <li> <p>Storage gateways of all types</p> </li> </ul> <ul> <li> <p>Storage Volumes</p> </li> </ul> <ul> <li> <p>Virtual Tapes</p> </li> </ul> <p>You can create a maximum of 10 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags.</p>"
},
"AddUploadBuffer":{
"name":"AddUploadBuffer",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AddUploadBufferInput"},
"output":{"shape":"AddUploadBufferOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.</p> <p>In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer.</p>"
},
"AddWorkingStorage":{
"name":"AddWorkingStorage",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AddWorkingStorageInput"},
"output":{"shape":"AddWorkingStorageOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Configures one or more gateway local disks as working storage for a gateway. This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version 20120630. Use <a>AddUploadBuffer</a> instead.</p> <note> <p>Working storage is also referred to as upload buffer. You can also use the <a>AddUploadBuffer</a> operation to add upload buffer to a stored-volume gateway.</p> </note> <p>In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage.</p>"
},
"CancelArchival":{
"name":"CancelArchival",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CancelArchivalInput"},
"output":{"shape":"CancelArchivalOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.</p>"
},
"CancelRetrieval":{
"name":"CancelRetrieval",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CancelRetrievalInput"},
"output":{"shape":"CancelRetrievalOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS.</p>"
},
"CreateCachediSCSIVolume":{
"name":"CreateCachediSCSIVolume",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateCachediSCSIVolumeInput"},
"output":{"shape":"CreateCachediSCSIVolumeOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Creates a cached volume on a specified cached gateway. This operation is supported only for the gateway-cached volume architecture.</p> <note> <p>Cache storage must be allocated to the gateway before you can create a cached volume. Use the <a>AddCache</a> operation to add cache storage to a gateway. </p> </note> <p>In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, AWS Storage Gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.</p> <p>Optionally, you can provide the ARN for an existing volume as the <code>SourceVolumeARN</code> for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The <code>VolumeSizeInBytes</code> value must be equal to or larger than the size of the copied volume, in bytes.</p>"
},
"CreateNFSFileShare":{
"name":"CreateNFSFileShare",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateNFSFileShareInput"},
"output":{"shape":"CreateNFSFileShareOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Creates a file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using a Network File System (NFS) interface.</p>"
},
"CreateSnapshot":{
"name":"CreateSnapshot",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateSnapshotInput"},
"output":{"shape":"CreateSnapshotOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableError"}
],
"documentation":"<p>Initiates a snapshot of a volume.</p> <p>AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad-hoc basis. This API enables you to take ad-hoc snapshot. For more information, see <a href=\"http://docs.aws.amazon.com/storagegateway/latest/userguide/WorkingWithSnapshots.html\">Working With Snapshots in the AWS Storage Gateway Console</a>.</p> <p>In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.</p> <note> <p>To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Operations.html\">EC2 API reference</a>.</p> </note> <important> <p>Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the <a href=\"http://docs.aws.amazon.com/storagegateway/latest/APIReference/Welcome.html\">Welcome</a> page.</p> </important>"
},
"CreateSnapshotFromVolumeRecoveryPoint":{
"name":"CreateSnapshotFromVolumeRecoveryPoint",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateSnapshotFromVolumeRecoveryPointInput"},
"output":{"shape":"CreateSnapshotFromVolumeRecoveryPointOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableError"}
],
"documentation":"<p>Initiates a snapshot of a gateway from a volume recovery point. This operation is supported only for the gateway-cached volume architecture.</p> <p>A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for gateway-cached volumes, use <a>ListVolumeRecoveryPoints</a>.</p> <p>In the <code>CreateSnapshotFromVolumeRecoveryPoint</code> request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When AWS Storage Gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.</p> <note> <p>To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in <i>Amazon Elastic Compute Cloud API Reference</i>.</p> </note>"
},
"CreateStorediSCSIVolume":{
"name":"CreateStorediSCSIVolume",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateStorediSCSIVolumeInput"},
"output":{"shape":"CreateStorediSCSIVolumeOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Creates a volume on a specified gateway. This operation is supported only for the gateway-stored volume architecture.</p> <p>The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased.</p> <p>In the request you must specify the gateway and the disk information on which you are creating the volume. In response, AWS Storage Gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.</p>"
},
"CreateTapeWithBarcode":{
"name":"CreateTapeWithBarcode",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateTapeWithBarcodeInput"},
"output":{"shape":"CreateTapeWithBarcodeOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape.</p> <note> <p>Cache storage must be allocated to the gateway before you can create a virtual tape. Use the <a>AddCache</a> operation to add cache storage to a gateway.</p> </note>"
},
"CreateTapes":{
"name":"CreateTapes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateTapesInput"},
"output":{"shape":"CreateTapesOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes.</p> <note> <p>Cache storage must be allocated to the gateway before you can create virtual tapes. Use the <a>AddCache</a> operation to add cache storage to a gateway. </p> </note>"
},
"DeleteBandwidthRateLimit":{
"name":"DeleteBandwidthRateLimit",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteBandwidthRateLimitInput"},
"output":{"shape":"DeleteBandwidthRateLimitOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request.</p>"
},
"DeleteChapCredentials":{
"name":"DeleteChapCredentials",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteChapCredentialsInput"},
"output":{"shape":"DeleteChapCredentialsOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.</p>"
},
"DeleteFileShare":{
"name":"DeleteFileShare",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteFileShareInput"},
"output":{"shape":"DeleteFileShareOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Deletes a file share from a file gateway.</p>"
},
"DeleteGateway":{
"name":"DeleteGateway",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteGatewayInput"},
"output":{"shape":"DeleteGatewayOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer.</p> <p>After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment.</p> <important> <p>You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription. If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the <a href=\"http://aws.amazon.com/storagegateway\"> AWS Storage Gateway Detail Page</a>. </p> </important>"
},
"DeleteSnapshotSchedule":{
"name":"DeleteSnapshotSchedule",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteSnapshotScheduleInput"},
"output":{"shape":"DeleteSnapshotScheduleOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Deletes a snapshot of a volume.</p> <p>You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see <a href=\"http://docs.aws.amazon.com/storagegateway/latest/userguide/WorkingWithSnapshots.html\">Working with Snapshots</a>. In the <code>DeleteSnapshotSchedule</code> request, you identify the volume by providing its Amazon Resource Name (ARN). </p> <note> <p>To list or delete a snapshot, you must use the Amazon EC2 API. in <i>Amazon Elastic Compute Cloud API Reference</i>.</p> </note>"
},
"DeleteTape":{
"name":"DeleteTape",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteTapeInput"},
"output":{"shape":"DeleteTapeOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Deletes the specified virtual tape.</p>"
},
"DeleteTapeArchive":{
"name":"DeleteTapeArchive",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteTapeArchiveInput"},
"output":{"shape":"DeleteTapeArchiveOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Deletes the specified virtual tape from the virtual tape shelf (VTS).</p>"
},
"DeleteVolume":{
"name":"DeleteVolume",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteVolumeInput"},
"output":{"shape":"DeleteVolumeOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Deletes the specified gateway volume that you previously created using the <a>CreateCachediSCSIVolume</a> or <a>CreateStorediSCSIVolume</a> API. For gateway-stored volumes, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume. </p> <p>Before you delete a gateway volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html\">DescribeSnapshots</a> in the <i>Amazon Elastic Compute Cloud API Reference</i>.</p> <p>In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.</p>"
},
"DescribeBandwidthRateLimit":{
"name":"DescribeBandwidthRateLimit",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeBandwidthRateLimitInput"},
"output":{"shape":"DescribeBandwidthRateLimitOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect.</p> <p>This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.</p>"
},
"DescribeCache":{
"name":"DescribeCache",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeCacheInput"},
"output":{"shape":"DescribeCacheOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Returns information about the cache of a gateway. This operation is supported only for the gateway-cached volume architecture.</p> <p>The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.</p>"
},
"DescribeCachediSCSIVolumes":{
"name":"DescribeCachediSCSIVolumes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeCachediSCSIVolumesInput"},
"output":{"shape":"DescribeCachediSCSIVolumesOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Returns a description of the gateway volumes specified in the request. This operation is supported only for the gateway-cached volume architecture.</p> <p>The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).</p>"
},
"DescribeChapCredentials":{
"name":"DescribeChapCredentials",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeChapCredentialsInput"},
"output":{"shape":"DescribeChapCredentialsOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.</p>"
},
"DescribeGatewayInformation":{
"name":"DescribeGatewayInformation",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeGatewayInformationInput"},
"output":{"shape":"DescribeGatewayInformationOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.</p>"
},
"DescribeMaintenanceStartTime":{
"name":"DescribeMaintenanceStartTime",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeMaintenanceStartTimeInput"},
"output":{"shape":"DescribeMaintenanceStartTimeOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone.</p>"
},
"DescribeNFSFileShares":{
"name":"DescribeNFSFileShares",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeNFSFileSharesInput"},
"output":{"shape":"DescribeNFSFileSharesOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Gets a description for one or more file shares from a file gateway.</p>"
},
"DescribeSnapshotSchedule":{
"name":"DescribeSnapshotSchedule",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeSnapshotScheduleInput"},
"output":{"shape":"DescribeSnapshotScheduleOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume.</p>"
},
"DescribeStorediSCSIVolumes":{
"name":"DescribeStorediSCSIVolumes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeStorediSCSIVolumesInput"},
"output":{"shape":"DescribeStorediSCSIVolumesOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs.</p>"
},
"DescribeTapeArchives":{
"name":"DescribeTapeArchives",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeTapeArchivesInput"},
"output":{"shape":"DescribeTapeArchivesOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Returns a description of specified virtual tapes in the virtual tape shelf (VTS).</p> <p>If a specific <code>TapeARN</code> is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.</p>"
},
"DescribeTapeRecoveryPoints":{
"name":"DescribeTapeRecoveryPoints",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeTapeRecoveryPointsInput"},
"output":{"shape":"DescribeTapeRecoveryPointsOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Returns a list of virtual tape recovery points that are available for the specified gateway-VTL.</p> <p>A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.</p>"
},
"DescribeTapes":{
"name":"DescribeTapes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeTapesInput"},
"output":{"shape":"DescribeTapesOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a <code>TapeARN</code> is not specified, returns a description of all virtual tapes associated with the specified gateway.</p>"
},
"DescribeUploadBuffer":{
"name":"DescribeUploadBuffer",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeUploadBufferInput"},
"output":{"shape":"DescribeUploadBufferOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Returns information about the upload buffer of a gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.</p> <p>The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.</p>"
},
"DescribeVTLDevices":{
"name":"DescribeVTLDevices",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeVTLDevicesInput"},
"output":{"shape":"DescribeVTLDevicesOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Returns a description of virtual tape library (VTL) devices for the specified gateway. In the response, AWS Storage Gateway returns VTL device information.</p> <p>The list of VTL devices must be from one gateway.</p>"
},
"DescribeWorkingStorage":{
"name":"DescribeWorkingStorage",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeWorkingStorageInput"},
"output":{"shape":"DescribeWorkingStorageOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Returns information about the working storage of a gateway. This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead.</p> <note> <p>Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored-volume gateway.</p> </note> <p>The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.</p>"
},
"DisableGateway":{
"name":"DisableGateway",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisableGatewayInput"},
"output":{"shape":"DisableGatewayOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Disables a gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.</p> <p>Use this operation for a gateway-VTL that is not reachable or not functioning.</p> <important> <p>Once a gateway is disabled it cannot be enabled.</p> </important>"
},
"ListFileShares":{
"name":"ListFileShares",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListFileSharesInput"},
"output":{"shape":"ListFileSharesOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling user account. </p>"
},
"ListGateways":{
"name":"ListGateways",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListGatewaysInput"},
"output":{"shape":"ListGatewaysOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).</p> <p>By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.</p> <p>If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.</p>"
},
"ListLocalDisks":{
"name":"ListLocalDisks",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListLocalDisksInput"},
"output":{"shape":"ListLocalDisksOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request.</p> <p>The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a <code>DiskStatus</code> field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted). </p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTagsForResourceInput"},
"output":{"shape":"ListTagsForResourceOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Lists the tags that have been added to the specified resource.</p>"
},
"ListTapes":{
"name":"ListTapes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTapesInput"},
"output":{"shape":"ListTapesOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS.</p> <p>This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the <code>Limit</code> parameter in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a <code>Marker</code> element that you can use in your subsequent request to retrieve the next set of tapes.</p>"
},
"ListVolumeInitiators":{
"name":"ListVolumeInitiators",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListVolumeInitiatorsInput"},
"output":{"shape":"ListVolumeInitiatorsOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not.</p>"
},
"ListVolumeRecoveryPoints":{
"name":"ListVolumeRecoveryPoints",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListVolumeRecoveryPointsInput"},
"output":{"shape":"ListVolumeRecoveryPointsOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Lists the recovery points for a specified gateway. This operation is supported only for the gateway-cached volume architecture.</p> <p>Each gateway-cached volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To create a snapshot from a volume recovery point use the <a>CreateSnapshotFromVolumeRecoveryPoint</a> operation.</p>"
},
"ListVolumes":{
"name":"ListVolumes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListVolumesInput"},
"output":{"shape":"ListVolumesOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the <a>DescribeStorediSCSIVolumes</a> or the <a>DescribeCachediSCSIVolumes</a> API.</p> <p>The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the <code>Limit</code> field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes.</p>"
},
"RemoveTagsFromResource":{
"name":"RemoveTagsFromResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RemoveTagsFromResourceInput"},
"output":{"shape":"RemoveTagsFromResourceOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Removes one or more tags from the specified resource.</p>"
},
"ResetCache":{
"name":"ResetCache",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ResetCacheInput"},
"output":{"shape":"ResetCacheOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks.</p> <important> <p>If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.</p> </important>"
},
"RetrieveTapeArchive":{
"name":"RetrieveTapeArchive",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RetrieveTapeArchiveInput"},
"output":{"shape":"RetrieveTapeArchiveOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS.</p> <p>Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway.</p>"
},
"RetrieveTapeRecoveryPoint":{
"name":"RetrieveTapeRecoveryPoint",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RetrieveTapeRecoveryPointInput"},
"output":{"shape":"RetrieveTapeRecoveryPointOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Retrieves the recovery point for the specified virtual tape.</p> <p>A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.</p> <note> <p>The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a gateway-VTL. There is no charge for retrieving recovery points.</p> </note>"
},
"SetLocalConsolePassword":{
"name":"SetLocalConsolePassword",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SetLocalConsolePasswordInput"},
"output":{"shape":"SetLocalConsolePasswordOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Sets the password for your VM local console. When you log in to the local console for the first time, you log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know the default password to set a new password.</p>"
},
"ShutdownGateway":{
"name":"ShutdownGateway",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ShutdownGatewayInput"},
"output":{"shape":"ShutdownGatewayOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.</p> <p>The operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the VM.</p> <note> <p>If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.</p> </note> <p>After the gateway is shutdown, you cannot call any other API except <a>StartGateway</a>, <a>DescribeGatewayInformation</a>, and <a>ListGateways</a>. For more information, see <a>ActivateGateway</a>. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.</p> <note> <p>When you make a shutdown request, you will get a <code>200 OK</code> success response immediately. However, it might take some time for the gateway to shut down. You can call the <a>DescribeGatewayInformation</a> API to check the status. For more information, see <a>ActivateGateway</a>.</p> </note> <p>If do not intend to use the gateway again, you must delete the gateway (using <a>DeleteGateway</a>) to no longer pay software charges associated with the gateway.</p>"
},
"StartGateway":{
"name":"StartGateway",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartGatewayInput"},
"output":{"shape":"StartGatewayOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Starts a gateway that you previously shut down (see <a>ShutdownGateway</a>). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups.</p> <note> <p>When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call <a>DescribeGatewayInformation</a> and check the status before making any additional API calls. For more information, see <a>ActivateGateway</a>.</p> </note> <p>To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.</p>"
},
"UpdateBandwidthRateLimit":{
"name":"UpdateBandwidthRateLimit",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateBandwidthRateLimitInput"},
"output":{"shape":"UpdateBandwidthRateLimitOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains.</p> <p>By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.</p> <p>To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.</p>"
},
"UpdateChapCredentials":{
"name":"UpdateChapCredentials",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateChapCredentialsInput"},
"output":{"shape":"UpdateChapCredentialsOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it.</p> <important> <p>When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.</p> </important>"
},
"UpdateGatewayInformation":{
"name":"UpdateGatewayInformation",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateGatewayInformationInput"},
"output":{"shape":"UpdateGatewayInformationOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.</p> <note> <p>For Gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN.</p> </note>"
},
"UpdateGatewaySoftwareNow":{
"name":"UpdateGatewaySoftwareNow",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateGatewaySoftwareNowInput"},
"output":{"shape":"UpdateGatewaySoftwareNowOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.</p> <note> <p>When you make this request, you get a <code>200 OK</code> success response immediately. However, it might take some time for the update to complete. You can call <a>DescribeGatewayInformation</a> to verify the gateway is in the <code>STATE_RUNNING</code> state.</p> </note> <important> <p>A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see <a href=\"http://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorWindowsClient.html#CustomizeWindowsiSCSISettings\">Customizing Your Windows iSCSI Settings</a> and <a href=\"http://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorRedHatClient.html#CustomizeLinuxiSCSISettings\">Customizing Your Linux iSCSI Settings</a>, respectively.</p> </important>"
},
"UpdateMaintenanceStartTime":{
"name":"UpdateMaintenanceStartTime",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateMaintenanceStartTimeInput"},
"output":{"shape":"UpdateMaintenanceStartTimeOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone.</p>"
},
"UpdateNFSFileShare":{
"name":"UpdateNFSFileShare",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateNFSFileShareInput"},
"output":{"shape":"UpdateNFSFileShareOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Updates a file share. </p> <note> <p>To leave a file share field unchanged, set the corresponding input field to null.</p> </note>"
},
"UpdateSnapshotSchedule":{
"name":"UpdateSnapshotSchedule",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateSnapshotScheduleInput"},
"output":{"shape":"UpdateSnapshotScheduleOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Updates a snapshot schedule configured for a gateway volume.</p> <p>The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume.</p> <p>In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.</p>"
},
"UpdateVTLDeviceType":{
"name":"UpdateVTLDeviceType",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateVTLDeviceTypeInput"},
"output":{"shape":"UpdateVTLDeviceTypeOutput"},
"errors":[
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Updates the type of medium changer in a gateway-VTL. When you activate a gateway-VTL, you select a medium changer type for the gateway-VTL. This operation enables you to select a different type of medium changer after a gateway-VTL is activated.</p>"
}
},
"shapes":{
"ActivateGatewayInput":{
"type":"structure",
"required":[
"ActivationKey",
"GatewayName",
"GatewayTimezone",
"GatewayRegion"
],
"members":{
"ActivationKey":{
"shape":"ActivationKey",
"documentation":"<p>Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter <code>activationKey</code>. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the <code>ActivateGateway</code> API call determine the actual configuration of your gateway.</p>"
},
"GatewayName":{
"shape":"GatewayName",
"documentation":"<p>The name you configured for your gateway.</p>"
},
"GatewayTimezone":{
"shape":"GatewayTimezone",
"documentation":"<p>A value that indicates the time zone you want to set for the gateway. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.</p>"
},
"GatewayRegion":{
"shape":"RegionId",
"documentation":"<p>A value that indicates the region where you want to store the snapshot backups. The gateway region specified must be the same region as the region in your <code>Host</code> header in the request. For more information about available regions and endpoints for AWS Storage Gateway, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#sg_region\">Regions and Endpoints</a> in the <i>Amazon Web Services Glossary</i>.</p> <p> Valid Values: \"us-east-1\", \"us-west-1\", \"us-west-2\", \"eu-west-1\", \"eu-central-1\", \"ap-northeast-1\", \"ap-northeast-2\", \"ap-southeast-1\", \"ap-southeast-2\", \"sa-east-1\"</p>"
},
"GatewayType":{
"shape":"GatewayType",
"documentation":"<p>A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is <code>STORED</code>. </p>"
},
"TapeDriveType":{
"shape":"TapeDriveType",
"documentation":"<p>The value that indicates the type of tape drive to use for gateway-VTL. This field is optional.</p> <p> Valid Values: \"IBM-ULT3580-TD5\" </p>"
},
"MediumChangerType":{
"shape":"MediumChangerType",
"documentation":"<p>The value that indicates the type of medium changer to use for gateway-VTL. This field is optional.</p> <p> Valid Values: \"STK-L700\", \"AWS-Gateway-VTL\"</p>"
}
},
"documentation":"<p>A JSON object containing one or more of the following fields:</p> <ul> <li> <p> <a>ActivateGatewayInput$ActivationKey</a> </p> </li> <li> <p> <a>ActivateGatewayInput$GatewayName</a> </p> </li> <li> <p> <a>ActivateGatewayInput$GatewayRegion</a> </p> </li> <li> <p> <a>ActivateGatewayInput$GatewayTimezone</a> </p> </li> <li> <p> <a>ActivateGatewayInput$GatewayType</a> </p> </li> <li> <p> <a>ActivateGatewayInput$TapeDriveType</a> </p> </li> <li> <p> <a>ActivateGatewayInput$MediumChangerType</a> </p> </li> </ul>"
},
"ActivateGatewayOutput":{
"type":"structure",
"members":{
"GatewayARN":{"shape":"GatewayARN"}
},
"documentation":"<p>AWS Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It is a string made of information such as your account, gateway name, and region. This ARN is used to reference the gateway in other API operations as well as resource-based authorization.</p> <note> <p>For gateways activated prior to September 02, 2015 the gateway ARN contains the gateway name rather than the gateway id. Changing the name of the gateway has no effect on the gateway ARN.</p> </note>"
},
"ActivationKey":{
"type":"string",
"max":50,
"min":1
},
"AddCacheInput":{
"type":"structure",
"required":[
"GatewayARN",
"DiskIds"
],
"members":{
"GatewayARN":{"shape":"GatewayARN"},
"DiskIds":{"shape":"DiskIds"}
}
},
"AddCacheOutput":{
"type":"structure",
"members":{
"GatewayARN":{"shape":"GatewayARN"}
}
},
"AddTagsToResourceInput":{
"type":"structure",
"required":[
"ResourceARN",
"Tags"
],
"members":{
"ResourceARN":{
"shape":"ResourceARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource you want to add tags to.</p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>The key-value pair that represents the tag you want to add to the resource. The value can be an empty string.</p> <note> <p>Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @.</p> </note>"
}
},
"documentation":"<p>AddTagsToResourceInput</p>"
},
"AddTagsToResourceOutput":{
"type":"structure",
"members":{
"ResourceARN":{
"shape":"ResourceARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource you want to add tags to.</p>"
}
},
"documentation":"<p>AddTagsToResourceOutput</p>"
},
"AddUploadBufferInput":{
"type":"structure",
"required":[
"GatewayARN",
"DiskIds"
],
"members":{
"GatewayARN":{"shape":"GatewayARN"},
"DiskIds":{"shape":"DiskIds"}
}
},
"AddUploadBufferOutput":{
"type":"structure",
"members":{
"GatewayARN":{"shape":"GatewayARN"}
}
},
"AddWorkingStorageInput":{
"type":"structure",
"required":[
"GatewayARN",
"DiskIds"
],
"members":{
"GatewayARN":{"shape":"GatewayARN"},
"DiskIds":{
"shape":"DiskIds",
"documentation":"<p>An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the <a>ListLocalDisks</a> API.</p>"
}
},
"documentation":"<p>A JSON object containing one or more of the following fields:</p> <ul> <li> <p> <a>AddWorkingStorageInput$DiskIds</a> </p> </li> </ul>"
},