forked from aws/aws-sdk-js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathglacier-2012-06-01.normal.json
2274 lines (2274 loc) · 149 KB
/
glacier-2012-06-01.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":"2012-06-01",
"checksumFormat":"sha256",
"endpointPrefix":"glacier",
"protocol":"rest-json",
"serviceFullName":"Amazon Glacier",
"signatureVersion":"v4",
"uid":"glacier-2012-06-01"
},
"operations":{
"AbortMultipartUpload":{
"name":"AbortMultipartUpload",
"http":{
"method":"DELETE",
"requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}",
"responseCode":204
},
"input":{"shape":"AbortMultipartUploadInput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation aborts a multipart upload identified by the upload ID.</p> <p>After the Abort Multipart Upload request succeeds, you cannot upload any more parts to the multipart upload or complete the multipart upload. Aborting a completed upload fails. However, aborting an already-aborted upload will succeed, for a short time. For more information about uploading a part and completing a multipart upload, see <a>UploadMultipartPart</a> and <a>CompleteMultipartUpload</a>.</p> <p>This operation is idempotent.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p> For conceptual information and underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html\">Working with Archives in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-abort-upload.html\">Abort Multipart Upload</a> in the <i>Amazon Glacier Developer Guide</i>. </p>"
},
"AbortVaultLock":{
"name":"AbortVaultLock",
"http":{
"method":"DELETE",
"requestUri":"/{accountId}/vaults/{vaultName}/lock-policy",
"responseCode":204
},
"input":{"shape":"AbortVaultLockInput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation aborts the vault locking process if the vault lock is not in the <code>Locked</code> state. If the vault lock is in the <code>Locked</code> state when this operation is requested, the operation returns an <code>AccessDeniedException</code> error. Aborting the vault locking process removes the vault lock policy from the specified vault. </p> <p>A vault lock is put into the <code>InProgress</code> state by calling <a>InitiateVaultLock</a>. A vault lock is put into the <code>Locked</code> state by calling <a>CompleteVaultLock</a>. You can get the state of a vault lock by calling <a>GetVaultLock</a>. For more information about the vault locking process, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html\">Amazon Glacier Vault Lock</a>. For more information about vault lock policies, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock-policy.html\">Amazon Glacier Access Control with Vault Lock Policies</a>. </p> <p>This operation is idempotent. You can successfully invoke this operation multiple times, if the vault lock is in the <code>InProgress</code> state or if there is no policy associated with the vault.</p>"
},
"AddTagsToVault":{
"name":"AddTagsToVault",
"http":{
"method":"POST",
"requestUri":"/{accountId}/vaults/{vaultName}/tags?operation=add",
"responseCode":204
},
"input":{"shape":"AddTagsToVaultInput"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation adds the specified tags to a vault. Each tag is composed of a key and a value. Each vault can have up to 10 tags. If your request would cause the tag limit for the vault to be exceeded, the operation throws the <code>LimitExceededException</code> error. If a tag already exists on the vault under a specified key, the existing key value will be overwritten. For more information about tags, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html\">Tagging Amazon Glacier Resources</a>. </p>"
},
"CompleteMultipartUpload":{
"name":"CompleteMultipartUpload",
"http":{
"method":"POST",
"requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}",
"responseCode":201
},
"input":{"shape":"CompleteMultipartUploadInput"},
"output":{"shape":"ArchiveCreationOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>You call this operation to inform Amazon Glacier that all the archive parts have been uploaded and that Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive resource. Using the URI path, you can then access the archive. After you upload an archive, you should save the archive ID returned to retrieve the archive at a later point. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see <a>InitiateJob</a>.</p> <p>In the request, you must include the computed SHA256 tree hash of the entire archive you have uploaded. For information about computing a SHA256 tree hash, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html\">Computing Checksums</a>. On the server side, Amazon Glacier also constructs the SHA256 tree hash of the assembled archive. If the values match, Amazon Glacier saves the archive to the vault; otherwise, it returns an error, and the operation fails. The <a>ListParts</a> operation returns a list of parts uploaded for a specific multipart upload. It includes checksum information for each uploaded part that can be used to debug a bad checksum issue.</p> <p>Additionally, Amazon Glacier also checks for any missing content ranges when assembling the archive, if missing content ranges are found, Amazon Glacier returns an error and the operation fails.</p> <p>Complete Multipart Upload is an idempotent operation. After your first successful complete multipart upload, if you call the operation again within a short period, the operation will succeed and return the same archive ID. This is useful in the event you experience a network issue that causes an aborted connection or receive a 500 server error, in which case you can repeat your Complete Multipart Upload request and get the same archive ID without creating duplicate archives. Note, however, that after the multipart upload completes, you cannot call the List Parts operation and the multipart upload will not appear in List Multipart Uploads response, even if idempotent complete is possible.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p> For conceptual information and underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html\">Uploading Large Archives in Parts (Multipart Upload)</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-complete-upload.html\">Complete Multipart Upload</a> in the <i>Amazon Glacier Developer Guide</i>. </p>"
},
"CompleteVaultLock":{
"name":"CompleteVaultLock",
"http":{
"method":"POST",
"requestUri":"/{accountId}/vaults/{vaultName}/lock-policy/{lockId}",
"responseCode":204
},
"input":{"shape":"CompleteVaultLockInput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation completes the vault locking process by transitioning the vault lock from the <code>InProgress</code> state to the <code>Locked</code> state, which causes the vault lock policy to become unchangeable. A vault lock is put into the <code>InProgress</code> state by calling <a>InitiateVaultLock</a>. You can obtain the state of the vault lock by calling <a>GetVaultLock</a>. For more information about the vault locking process, <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html\">Amazon Glacier Vault Lock</a>. </p> <p>This operation is idempotent. This request is always successful if the vault lock is in the <code>Locked</code> state and the provided lock ID matches the lock ID originally used to lock the vault.</p> <p>If an invalid lock ID is passed in the request when the vault lock is in the <code>Locked</code> state, the operation returns an <code>AccessDeniedException</code> error. If an invalid lock ID is passed in the request when the vault lock is in the <code>InProgress</code> state, the operation throws an <code>InvalidParameter</code> error.</p>"
},
"CreateVault":{
"name":"CreateVault",
"http":{
"method":"PUT",
"requestUri":"/{accountId}/vaults/{vaultName}",
"responseCode":201
},
"input":{"shape":"CreateVaultInput"},
"output":{"shape":"CreateVaultOutput"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>This operation creates a new vault with the specified name. The name of the vault must be unique within a region for an AWS account. You can create up to 1,000 vaults per account. If you need to create more vaults, contact Amazon Glacier.</p> <p>You must use the following guidelines when naming a vault.</p> <ul> <li> <p>Names can be between 1 and 255 characters long.</p> </li> <li> <p>Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period).</p> </li> </ul> <p>This operation is idempotent.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p> For conceptual information and underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/creating-vaults.html\">Creating a Vault in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-put.html\">Create Vault </a> in the <i>Amazon Glacier Developer Guide</i>. </p>"
},
"DeleteArchive":{
"name":"DeleteArchive",
"http":{
"method":"DELETE",
"requestUri":"/{accountId}/vaults/{vaultName}/archives/{archiveId}",
"responseCode":204
},
"input":{"shape":"DeleteArchiveInput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation deletes an archive from a vault. Subsequent requests to initiate a retrieval of this archive will fail. Archive retrievals that are in progress for this archive ID may or may not succeed according to the following scenarios:</p> <ul> <li> <p>If the archive retrieval job is actively preparing the data for download when Amazon Glacier receives the delete archive request, the archival retrieval operation might fail.</p> </li> <li> <p>If the archive retrieval job has successfully prepared the archive for download when Amazon Glacier receives the delete archive request, you will be able to download the output.</p> </li> </ul> <p>This operation is idempotent. Attempting to delete an already-deleted archive does not result in an error.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p> For conceptual information and underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/deleting-an-archive.html\">Deleting an Archive in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-delete.html\">Delete Archive</a> in the <i>Amazon Glacier Developer Guide</i>. </p>"
},
"DeleteVault":{
"name":"DeleteVault",
"http":{
"method":"DELETE",
"requestUri":"/{accountId}/vaults/{vaultName}",
"responseCode":204
},
"input":{"shape":"DeleteVaultInput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation deletes a vault. Amazon Glacier will delete a vault only if there are no archives in the vault as of the last inventory and there have been no writes to the vault since the last inventory. If either of these conditions is not satisfied, the vault deletion fails (that is, the vault is not removed) and Amazon Glacier returns an error. You can use <a>DescribeVault</a> to return the number of archives in a vault, and you can use <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html\">Initiate a Job (POST jobs)</a> to initiate a new inventory retrieval for a vault. The inventory contains the archive IDs you use to delete archives using <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-delete.html\">Delete Archive (DELETE archive)</a>.</p> <p>This operation is idempotent.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p> For conceptual information and underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/deleting-vaults.html\">Deleting a Vault in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-delete.html\">Delete Vault </a> in the <i>Amazon Glacier Developer Guide</i>. </p>"
},
"DeleteVaultAccessPolicy":{
"name":"DeleteVaultAccessPolicy",
"http":{
"method":"DELETE",
"requestUri":"/{accountId}/vaults/{vaultName}/access-policy",
"responseCode":204
},
"input":{"shape":"DeleteVaultAccessPolicyInput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation deletes the access policy associated with the specified vault. The operation is eventually consistent; that is, it might take some time for Amazon Glacier to completely remove the access policy, and you might still see the effect of the policy for a short time after you send the delete request.</p> <p>This operation is idempotent. You can invoke delete multiple times, even if there is no policy associated with the vault. For more information about vault access policies, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html\">Amazon Glacier Access Control with Vault Access Policies</a>. </p>"
},
"DeleteVaultNotifications":{
"name":"DeleteVaultNotifications",
"http":{
"method":"DELETE",
"requestUri":"/{accountId}/vaults/{vaultName}/notification-configuration",
"responseCode":204
},
"input":{"shape":"DeleteVaultNotificationsInput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation deletes the notification configuration set for a vault. The operation is eventually consistent; that is, it might take some time for Amazon Glacier to completely disable the notifications and you might still receive some notifications for a short time after you send the delete request.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p> For conceptual information and underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html\">Configuring Vault Notifications in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-delete.html\">Delete Vault Notification Configuration </a> in the Amazon Glacier Developer Guide. </p>"
},
"DescribeJob":{
"name":"DescribeJob",
"http":{
"method":"GET",
"requestUri":"/{accountId}/vaults/{vaultName}/jobs/{jobId}"
},
"input":{"shape":"DescribeJobInput"},
"output":{"shape":"GlacierJobDescription"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation returns information about a job you previously initiated, including the job initiation date, the user who initiated the job, the job status code/message and the Amazon SNS topic to notify after Amazon Glacier completes the job. For more information about initiating a job, see <a>InitiateJob</a>. </p> <note> <p>This operation enables you to check the status of your job. However, it is strongly recommended that you set up an Amazon SNS topic and specify it in your initiate job request so that Amazon Glacier can notify the topic after it completes the job.</p> </note> <p>A job ID will not expire for at least 24 hours after Amazon Glacier completes the job.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p> For information about the underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-describe-job-get.html\">Working with Archives in Amazon Glacier</a> in the <i>Amazon Glacier Developer Guide</i>. </p>"
},
"DescribeVault":{
"name":"DescribeVault",
"http":{
"method":"GET",
"requestUri":"/{accountId}/vaults/{vaultName}"
},
"input":{"shape":"DescribeVaultInput"},
"output":{"shape":"DescribeVaultOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation returns information about a vault, including the vault's Amazon Resource Name (ARN), the date the vault was created, the number of archives it contains, and the total size of all the archives in the vault. The number of archives and their total size are as of the last inventory generation. This means that if you add or remove an archive from a vault, and then immediately use Describe Vault, the change in contents will not be immediately reflected. If you want to retrieve the latest inventory of the vault, use <a>InitiateJob</a>. Amazon Glacier generates vault inventories approximately daily. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html\">Downloading a Vault Inventory in Amazon Glacier</a>. </p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For conceptual information and underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html\">Retrieving Vault Metadata in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-get.html\">Describe Vault </a> in the <i>Amazon Glacier Developer Guide</i>. </p>"
},
"GetDataRetrievalPolicy":{
"name":"GetDataRetrievalPolicy",
"http":{
"method":"GET",
"requestUri":"/{accountId}/policies/data-retrieval"
},
"input":{"shape":"GetDataRetrievalPolicyInput"},
"output":{"shape":"GetDataRetrievalPolicyOutput"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation returns the current data retrieval policy for the account and region specified in the GET request. For more information about data retrieval policies, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/data-retrieval-policy.html\">Amazon Glacier Data Retrieval Policies</a>.</p>"
},
"GetJobOutput":{
"name":"GetJobOutput",
"http":{
"method":"GET",
"requestUri":"/{accountId}/vaults/{vaultName}/jobs/{jobId}/output"
},
"input":{"shape":"GetJobOutputInput"},
"output":{"shape":"GetJobOutputOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation downloads the output of the job you initiated using <a>InitiateJob</a>. Depending on the job type you specified when you initiated the job, the output will be either the content of an archive or a vault inventory.</p> <p>You can download all the job output or download a portion of the output by specifying a byte range. In the case of an archive retrieval job, depending on the byte range you specify, Amazon Glacier returns the checksum for the portion of the data. You can compute the checksum on the client and verify that the values match to ensure the portion you downloaded is the correct data.</p> <p>A job ID will not expire for at least 24 hours after Amazon Glacier completes the job. That a byte range. For both archive and inventory retrieval jobs, you should verify the downloaded size against the size returned in the headers from the <b>Get Job Output</b> response.</p> <p>For archive retrieval jobs, you should also verify that the size is what you expected. If you download a portion of the output, the expected size is based on the range of bytes you specified. For example, if you specify a range of <code>bytes=0-1048575</code>, you should verify your download size is 1,048,576 bytes. If you download an entire archive, the expected size is the size of the archive when you uploaded it to Amazon Glacier The expected size is also returned in the headers from the <b>Get Job Output</b> response.</p> <p>In the case of an archive retrieval job, depending on the byte range you specify, Amazon Glacier returns the checksum for the portion of the data. To ensure the portion you downloaded is the correct data, compute the checksum on the client, verify that the values match, and verify that the size is what you expected.</p> <p>A job ID does not expire for at least 24 hours after Amazon Glacier completes the job. That is, you can download the job output within the 24 hours period after Amazon Glacier completes the job.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For conceptual information and the underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html\">Downloading a Vault Inventory</a>, <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/downloading-an-archive.html\">Downloading an Archive</a>, and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-job-output-get.html\">Get Job Output </a> </p>"
},
"GetVaultAccessPolicy":{
"name":"GetVaultAccessPolicy",
"http":{
"method":"GET",
"requestUri":"/{accountId}/vaults/{vaultName}/access-policy"
},
"input":{"shape":"GetVaultAccessPolicyInput"},
"output":{"shape":"GetVaultAccessPolicyOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation retrieves the <code>access-policy</code> subresource set on the vault; for more information on setting this subresource, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-SetVaultAccessPolicy.html\">Set Vault Access Policy (PUT access-policy)</a>. If there is no access policy set on the vault, the operation returns a <code>404 Not found</code> error. For more information about vault access policies, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html\">Amazon Glacier Access Control with Vault Access Policies</a>.</p>"
},
"GetVaultLock":{
"name":"GetVaultLock",
"http":{
"method":"GET",
"requestUri":"/{accountId}/vaults/{vaultName}/lock-policy"
},
"input":{"shape":"GetVaultLockInput"},
"output":{"shape":"GetVaultLockOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation retrieves the following attributes from the <code>lock-policy</code> subresource set on the specified vault: </p> <ul> <li> <p>The vault lock policy set on the vault.</p> </li> <li> <p>The state of the vault lock, which is either <code>InProgess</code> or <code>Locked</code>.</p> </li> <li> <p>When the lock ID expires. The lock ID is used to complete the vault locking process.</p> </li> <li> <p>When the vault lock was initiated and put into the <code>InProgress</code> state.</p> </li> </ul> <p>A vault lock is put into the <code>InProgress</code> state by calling <a>InitiateVaultLock</a>. A vault lock is put into the <code>Locked</code> state by calling <a>CompleteVaultLock</a>. You can abort the vault locking process by calling <a>AbortVaultLock</a>. For more information about the vault locking process, <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html\">Amazon Glacier Vault Lock</a>. </p> <p>If there is no vault lock policy set on the vault, the operation returns a <code>404 Not found</code> error. For more information about vault lock policies, <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock-policy.html\">Amazon Glacier Access Control with Vault Lock Policies</a>. </p>"
},
"GetVaultNotifications":{
"name":"GetVaultNotifications",
"http":{
"method":"GET",
"requestUri":"/{accountId}/vaults/{vaultName}/notification-configuration"
},
"input":{"shape":"GetVaultNotificationsInput"},
"output":{"shape":"GetVaultNotificationsOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation retrieves the <code>notification-configuration</code> subresource of the specified vault.</p> <p>For information about setting a notification configuration on a vault, see <a>SetVaultNotifications</a>. If a notification configuration for a vault is not set, the operation returns a <code>404 Not Found</code> error. For more information about vault notifications, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html\">Configuring Vault Notifications in Amazon Glacier</a>. </p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For conceptual information and underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html\">Configuring Vault Notifications in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-get.html\">Get Vault Notification Configuration </a> in the <i>Amazon Glacier Developer Guide</i>. </p>"
},
"InitiateJob":{
"name":"InitiateJob",
"http":{
"method":"POST",
"requestUri":"/{accountId}/vaults/{vaultName}/jobs",
"responseCode":202
},
"input":{"shape":"InitiateJobInput"},
"output":{"shape":"InitiateJobOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"PolicyEnforcedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"InsufficientCapacityException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation initiates a job of the specified type. In this release, you can initiate a job to retrieve either an archive or a vault inventory (a list of archives in a vault).</p> <p>Retrieving data from Amazon Glacier is a two-step process:</p> <ol> <li> <p>Initiate a retrieval job.</p> <note> <p>A data retrieval policy can cause your initiate retrieval job request to fail with a PolicyEnforcedException exception. For more information about data retrieval policies, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/data-retrieval-policy.html\">Amazon Glacier Data Retrieval Policies</a>. For more information about the PolicyEnforcedException exception, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-error-responses.html\">Error Responses</a>.</p> </note> </li> <li> <p>After the job completes, download the bytes.</p> </li> </ol> <p>The retrieval request is executed asynchronously. When you initiate a retrieval job, Amazon Glacier creates a job and returns a job ID in the response. When Amazon Glacier completes the job, you can get the job output (archive or inventory data). For information about getting job output, see <a>GetJobOutput</a> operation. </p> <p>The job must complete before you can get its output. To determine when a job is complete, you have the following options:</p> <ul> <li> <p> <b>Use Amazon SNS Notification</b> You can specify an Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Glacier can post a notification after the job is completed. You can specify an SNS topic per job request. The notification is sent only after Amazon Glacier completes the job. In addition to specifying an SNS topic per job request, you can configure vault notifications for a vault so that job notifications are always sent. For more information, see <a>SetVaultNotifications</a>.</p> </li> <li> <p> <b>Get job details</b> You can make a <a>DescribeJob</a> request to obtain job status information while a job is in progress. However, it is more efficient to use an Amazon SNS notification to determine when a job is complete.</p> </li> </ul> <note> <p>The information you get via notification is same that you get by calling <a>DescribeJob</a>.</p> </note> <p>If for a specific event, you add both the notification configuration on the vault and also specify an SNS topic in your initiate job request, Amazon Glacier sends both notifications. For more information, see <a>SetVaultNotifications</a>.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p> <b>About the Vault Inventory</b> </p> <p>Amazon Glacier prepares an inventory for each vault periodically, every 24 hours. When you initiate a job for a vault inventory, Amazon Glacier returns the last inventory for the vault. The inventory data you get might be up to a day or two days old. Also, the initiate inventory job might take some time to complete before you can download the vault inventory. So you do not want to retrieve a vault inventory for each vault operation. However, in some scenarios, you might find the vault inventory useful. For example, when you upload an archive, you can provide an archive description but not an archive name. Amazon Glacier provides you a unique archive ID, an opaque string of characters. So, you might maintain your own database that maps archive names to their corresponding Amazon Glacier assigned archive IDs. You might find the vault inventory useful in the event you need to reconcile information in your database with the actual vault inventory.</p> <p> <b>Range Inventory Retrieval</b> </p> <p>You can limit the number of inventory items retrieved by filtering on the archive creation date or by setting a limit.</p> <p> <i>Filtering by Archive Creation Date</i> </p> <p>You can retrieve inventory items for archives created between <code>StartDate</code> and <code>EndDate</code> by specifying values for these parameters in the <b>InitiateJob</b> request. Archives created on or after the <code>StartDate</code> and before the <code>EndDate</code> will be returned. If you only provide the <code>StartDate</code> without the <code>EndDate</code>, you will retrieve the inventory for all archives created on or after the <code>StartDate</code>. If you only provide the <code>EndDate</code> without the <code>StartDate</code>, you will get back the inventory for all archives created before the <code>EndDate</code>.</p> <p> <i>Limiting Inventory Items per Retrieval</i> </p> <p>You can limit the number of inventory items returned by setting the <code>Limit</code> parameter in the <b>InitiateJob</b> request. The inventory job output will contain inventory items up to the specified <code>Limit</code>. If there are more inventory items available, the result is paginated. After a job is complete you can use the <a>DescribeJob</a> operation to get a marker that you use in a subsequent <b>InitiateJob</b> request. The marker will indicate the starting point to retrieve the next set of inventory items. You can page through your entire inventory by repeatedly making <b>InitiateJob</b> requests with the marker from the previous <b>DescribeJob</b> output, until you get a marker from <b>DescribeJob</b> that returns null, indicating that there are no more inventory items available.</p> <p>You can use the <code>Limit</code> parameter together with the date range parameters.</p> <p> <b>About Ranged Archive Retrieval</b> </p> <p>You can initiate an archive retrieval for the whole archive or a range of the archive. In the case of ranged archive retrieval, you specify a byte range to return or the whole archive. The range specified must be megabyte (MB) aligned, that is the range start value must be divisible by 1 MB and range end value plus 1 must be divisible by 1 MB or equal the end of the archive. If the ranged archive retrieval is not megabyte aligned, this operation returns a 400 response. Furthermore, to ensure you get checksum values for data you download using Get Job Output API, the range must be tree hash aligned.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For conceptual information and the underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html\">Initiate a Job</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html\">Downloading a Vault Inventory</a> </p> <p> <b>Expedited and Bulk Archive Retrievals</b> </p> <p>When retrieving an archive, you can specify one of the following options in the <code>Tier</code> field of the request body: </p> <ul> <li> <p> <b>Standard</b> The default type of retrieval, which allows access to any of your archives within several hours. Standard retrievals typically complete within 3–5 hours.</p> </li> <li> <p> <b>Bulk</b> Amazon Glacier’s lowest-cost retrieval option, which enables you to retrieve large amounts of data inexpensively in a day. Bulk retrieval requests typically complete within 5–12 hours. </p> </li> <li> <p> <b>Expedited</b> Amazon Glacier’s option for the fastest retrievals. Archives requested using the expedited retrievals typically become accessible within 1–5 minutes. </p> </li> </ul> <p>For more information about expedited and bulk retrievals, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/downloading-an-archive-two-steps.html\">Retrieving Amazon Glacier Archives</a>.</p>"
},
"InitiateMultipartUpload":{
"name":"InitiateMultipartUpload",
"http":{
"method":"POST",
"requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads",
"responseCode":201
},
"input":{"shape":"InitiateMultipartUploadInput"},
"output":{"shape":"InitiateMultipartUploadOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation initiates a multipart upload. Amazon Glacier creates a multipart upload resource and returns its ID in the response. The multipart upload ID is used in subsequent requests to upload parts of an archive (see <a>UploadMultipartPart</a>).</p> <p>When you initiate a multipart upload, you specify the part size in number of bytes. The part size must be a megabyte (1024 KB) multiplied by a power of 2-for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB.</p> <p>Every part you upload to this resource (see <a>UploadMultipartPart</a>), except the last one, must have the same size. The last one can be the same size or smaller. For example, suppose you want to upload a 16.2 MB file. If you initiate the multipart upload with a part size of 4 MB, you will upload four parts of 4 MB each and one part of 0.2 MB. </p> <note> <p>You don't need to know the size of the archive when you start a multipart upload because Amazon Glacier does not require you to specify the overall archive size.</p> </note> <p>After you complete the multipart upload, Amazon Glacier removes the multipart upload resource referenced by the ID. Amazon Glacier also removes the multipart upload resource if you cancel the multipart upload or it may be removed if there is no activity for a period of 24 hours.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For conceptual information and underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html\">Uploading Large Archives in Parts (Multipart Upload)</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-initiate-upload.html\">Initiate Multipart Upload</a> in the <i>Amazon Glacier Developer Guide</i>.</p>"
},
"InitiateVaultLock":{
"name":"InitiateVaultLock",
"http":{
"method":"POST",
"requestUri":"/{accountId}/vaults/{vaultName}/lock-policy",
"responseCode":201
},
"input":{"shape":"InitiateVaultLockInput"},
"output":{"shape":"InitiateVaultLockOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation initiates the vault locking process by doing the following:</p> <ul> <li> <p>Installing a vault lock policy on the specified vault.</p> </li> <li> <p>Setting the lock state of vault lock to <code>InProgress</code>.</p> </li> <li> <p>Returning a lock ID, which is used to complete the vault locking process.</p> </li> </ul> <p>You can set one vault lock policy for each vault and this policy can be up to 20 KB in size. For more information about vault lock policies, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock-policy.html\">Amazon Glacier Access Control with Vault Lock Policies</a>. </p> <p>You must complete the vault locking process within 24 hours after the vault lock enters the <code>InProgress</code> state. After the 24 hour window ends, the lock ID expires, the vault automatically exits the <code>InProgress</code> state, and the vault lock policy is removed from the vault. You call <a>CompleteVaultLock</a> to complete the vault locking process by setting the state of the vault lock to <code>Locked</code>. </p> <p>After a vault lock is in the <code>Locked</code> state, you cannot initiate a new vault lock for the vault.</p> <p>You can abort the vault locking process by calling <a>AbortVaultLock</a>. You can get the state of the vault lock by calling <a>GetVaultLock</a>. For more information about the vault locking process, <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html\">Amazon Glacier Vault Lock</a>.</p> <p>If this operation is called when the vault lock is in the <code>InProgress</code> state, the operation returns an <code>AccessDeniedException</code> error. When the vault lock is in the <code>InProgress</code> state you must call <a>AbortVaultLock</a> before you can initiate a new vault lock policy. </p>"
},
"ListJobs":{
"name":"ListJobs",
"http":{
"method":"GET",
"requestUri":"/{accountId}/vaults/{vaultName}/jobs"
},
"input":{"shape":"ListJobsInput"},
"output":{"shape":"ListJobsOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished.</p> <note> <p>Amazon Glacier retains recently completed jobs for a period before deleting them; however, it eventually removes completed jobs. The output of completed jobs can be retrieved. Retaining completed jobs for a period of time after they have completed enables you to get a job output in the event you miss the job completion notification or your first attempt to download it fails. For example, suppose you start an archive retrieval job to download an archive. After the job completes, you start to download the archive but encounter a network error. In this scenario, you can retry and download the archive while the job exists.</p> </note> <p>To retrieve an archive or retrieve a vault inventory from Amazon Glacier, you first initiate a job, and after the job completes, you download the data. For an archive retrieval, the output is the archive data. For an inventory retrieval, it is the inventory list. The List Job operation returns a list of these jobs sorted by job initiation time.</p> <p>The List Jobs operation supports pagination. You should always check the response <code>Marker</code> field. If there are no more jobs to list, the <code>Marker</code> field is set to <code>null</code>. If there are more jobs to list, the <code>Marker</code> field is set to a non-null value, which you can use to continue the pagination of the list. To return a list of jobs that begins at a specific job, set the marker request parameter to the <code>Marker</code> value for that job that you obtained from a previous List Jobs request.</p> <p>You can set a maximum limit for the number of jobs returned in the response by specifying the <code>limit</code> parameter in the request. The default limit is 1000. The number of jobs returned might be fewer than the limit, but the number of returned jobs never exceeds the limit.</p> <p>Additionally, you can filter the jobs list returned by specifying the optional <code>statuscode</code> parameter or <code>completed</code> parameter, or both. Using the <code>statuscode</code> parameter, you can specify to return only jobs that match either the <code>InProgress</code>, <code>Succeeded</code>, or <code>Failed</code> status. Using the <code>completed</code> parameter, you can specify to return only jobs that were completed (<code>true</code>) or jobs that were not completed (<code>false</code>).</p> <p>For the underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-jobs-get.html\">List Jobs</a>. </p>"
},
"ListMultipartUploads":{
"name":"ListMultipartUploads",
"http":{
"method":"GET",
"requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads"
},
"input":{"shape":"ListMultipartUploadsInput"},
"output":{"shape":"ListMultipartUploadsOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation lists in-progress multipart uploads for the specified vault. An in-progress multipart upload is a multipart upload that has been initiated by an <a>InitiateMultipartUpload</a> request, but has not yet been completed or aborted. The list returned in the List Multipart Upload response has no guaranteed order. </p> <p>The List Multipart Uploads operation supports pagination. By default, this operation returns up to 1,000 multipart uploads in the response. You should always check the response for a <code>marker</code> at which to continue the list; if there are no more items the <code>marker</code> is <code>null</code>. To return a list of multipart uploads that begins at a specific upload, set the <code>marker</code> request parameter to the value you obtained from a previous List Multipart Upload request. You can also limit the number of uploads returned in the response by specifying the <code>limit</code> parameter in the request.</p> <p>Note the difference between this operation and listing parts (<a>ListParts</a>). The List Multipart Uploads operation lists all multipart uploads for a vault and does not require a multipart upload ID. The List Parts operation requires a multipart upload ID since parts are associated with a single upload.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For conceptual information and the underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html\">Working with Archives in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-uploads.html\">List Multipart Uploads </a> in the <i>Amazon Glacier Developer Guide</i>.</p>"
},
"ListParts":{
"name":"ListParts",
"http":{
"method":"GET",
"requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}"
},
"input":{"shape":"ListPartsInput"},
"output":{"shape":"ListPartsOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation lists the parts of an archive that have been uploaded in a specific multipart upload. You can make this request at any time during an in-progress multipart upload before you complete the upload (see <a>CompleteMultipartUpload</a>. List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range. </p> <p>The List Parts operation supports pagination. By default, this operation returns up to 1,000 uploaded parts in the response. You should always check the response for a <code>marker</code> at which to continue the list; if there are no more items the <code>marker</code> is <code>null</code>. To return a list of parts that begins at a specific part, set the <code>marker</code> request parameter to the value you obtained from a previous List Parts request. You can also limit the number of parts returned in the response by specifying the <code>limit</code> parameter in the request. </p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For conceptual information and the underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html\">Working with Archives in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-parts.html\">List Parts</a> in the <i>Amazon Glacier Developer Guide</i>.</p>"
},
"ListProvisionedCapacity":{
"name":"ListProvisionedCapacity",
"http":{
"method":"GET",
"requestUri":"/{accountId}/provisioned-capacity"
},
"input":{"shape":"ListProvisionedCapacityInput"},
"output":{"shape":"ListProvisionedCapacityOutput"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation lists the provisioned capacity for the specified AWS account.</p>"
},
"ListTagsForVault":{
"name":"ListTagsForVault",
"http":{
"method":"GET",
"requestUri":"/{accountId}/vaults/{vaultName}/tags"
},
"input":{"shape":"ListTagsForVaultInput"},
"output":{"shape":"ListTagsForVaultOutput"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation lists all the tags attached to a vault. The operation returns an empty map if there are no tags. For more information about tags, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html\">Tagging Amazon Glacier Resources</a>.</p>"
},
"ListVaults":{
"name":"ListVaults",
"http":{
"method":"GET",
"requestUri":"/{accountId}/vaults"
},
"input":{"shape":"ListVaultsInput"},
"output":{"shape":"ListVaultsOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name.</p> <p>By default, this operation returns up to 1,000 items. If there are more vaults to list, the response <code>marker</code> field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the <code>marker</code> field is <code>null</code>. To return a list of vaults that begins at a specific vault, set the <code>marker</code> request parameter to the vault ARN you obtained from a previous List Vaults request. You can also limit the number of vaults returned in the response by specifying the <code>limit</code> parameter in the request. </p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For conceptual information and underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html\">Retrieving Vault Metadata in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vaults-get.html\">List Vaults </a> in the <i>Amazon Glacier Developer Guide</i>. </p>"
},
"PurchaseProvisionedCapacity":{
"name":"PurchaseProvisionedCapacity",
"http":{
"method":"POST",
"requestUri":"/{accountId}/provisioned-capacity",
"responseCode":201
},
"input":{"shape":"PurchaseProvisionedCapacityInput"},
"output":{"shape":"PurchaseProvisionedCapacityOutput"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"LimitExceededException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation purchases a provisioned capacity unit for an AWS account.</p>"
},
"RemoveTagsFromVault":{
"name":"RemoveTagsFromVault",
"http":{
"method":"POST",
"requestUri":"/{accountId}/vaults/{vaultName}/tags?operation=remove",
"responseCode":204
},
"input":{"shape":"RemoveTagsFromVaultInput"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation removes one or more tags from the set of tags attached to a vault. For more information about tags, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html\">Tagging Amazon Glacier Resources</a>. This operation is idempotent. The operation will be successful, even if there are no tags attached to the vault. </p>"
},
"SetDataRetrievalPolicy":{
"name":"SetDataRetrievalPolicy",
"http":{
"method":"PUT",
"requestUri":"/{accountId}/policies/data-retrieval",
"responseCode":204
},
"input":{"shape":"SetDataRetrievalPolicyInput"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation sets and then enacts a data retrieval policy in the region specified in the PUT request. You can set one policy per region for an AWS account. The policy is enacted within a few minutes of a successful PUT operation.</p> <p>The set policy operation does not affect retrieval jobs that were in progress before the policy was enacted. For more information about data retrieval policies, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/data-retrieval-policy.html\">Amazon Glacier Data Retrieval Policies</a>. </p>"
},
"SetVaultAccessPolicy":{
"name":"SetVaultAccessPolicy",
"http":{
"method":"PUT",
"requestUri":"/{accountId}/vaults/{vaultName}/access-policy",
"responseCode":204
},
"input":{"shape":"SetVaultAccessPolicyInput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation configures an access policy for a vault and will overwrite an existing policy. To configure a vault access policy, send a PUT request to the <code>access-policy</code> subresource of the vault. An access policy is specific to a vault and is also called a vault subresource. You can set one access policy per vault and the policy can be up to 20 KB in size. For more information about vault access policies, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html\">Amazon Glacier Access Control with Vault Access Policies</a>. </p>"
},
"SetVaultNotifications":{
"name":"SetVaultNotifications",
"http":{
"method":"PUT",
"requestUri":"/{accountId}/vaults/{vaultName}/notification-configuration",
"responseCode":204
},
"input":{"shape":"SetVaultNotificationsInput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation configures notifications that will be sent when specific events happen to a vault. By default, you don't get any notifications.</p> <p>To configure vault notifications, send a PUT request to the <code>notification-configuration</code> subresource of the vault. The request should include a JSON document that provides an Amazon SNS topic and specific events for which you want Amazon Glacier to send notifications to the topic.</p> <p>Amazon SNS topics must grant permission to the vault to be allowed to publish notifications to the topic. You can configure a vault to publish a notification for the following vault events:</p> <ul> <li> <p> <b>ArchiveRetrievalCompleted</b> This event occurs when a job that was initiated for an archive retrieval is completed (<a>InitiateJob</a>). The status of the completed job can be \"Succeeded\" or \"Failed\". The notification sent to the SNS topic is the same output as returned from <a>DescribeJob</a>. </p> </li> <li> <p> <b>InventoryRetrievalCompleted</b> This event occurs when a job that was initiated for an inventory retrieval is completed (<a>InitiateJob</a>). The status of the completed job can be \"Succeeded\" or \"Failed\". The notification sent to the SNS topic is the same output as returned from <a>DescribeJob</a>. </p> </li> </ul> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For conceptual information and underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html\">Configuring Vault Notifications in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-put.html\">Set Vault Notification Configuration </a> in the <i>Amazon Glacier Developer Guide</i>. </p>"
},
"UploadArchive":{
"name":"UploadArchive",
"http":{
"method":"POST",
"requestUri":"/{accountId}/vaults/{vaultName}/archives",
"responseCode":201
},
"input":{"shape":"UploadArchiveInput"},
"output":{"shape":"ArchiveCreationOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"RequestTimeoutException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation adds an archive to a vault. This is a synchronous operation, and for a successful upload, your data is durably persisted. Amazon Glacier returns the archive ID in the <code>x-amz-archive-id</code> header of the response. </p> <p>You must use the archive ID to access your data in Amazon Glacier. After you upload an archive, you should save the archive ID returned so that you can retrieve or delete the archive later. Besides saving the archive ID, you can also index it and give it a friendly name to allow for better searching. You can also use the optional archive description field to specify how the archive is referred to in an external index of archives, such as you might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see <a>InitiateJob</a>. </p> <p>You must provide a SHA256 tree hash of the data you are uploading. For information about computing a SHA256 tree hash, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html\">Computing Checksums</a>. </p> <p>You can optionally specify an archive description of up to 1,024 printable ASCII characters. You can get the archive description when you either retrieve the archive or get the vault inventory. For more information, see <a>InitiateJob</a>. Amazon Glacier does not interpret the description in any way. An archive description does not need to be unique. You cannot use the description to retrieve or sort the archive list. </p> <p>Archives are immutable. After you upload an archive, you cannot edit the archive or its description.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p> For conceptual information and underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-an-archive.html\">Uploading an Archive in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html\">Upload Archive</a> in the <i>Amazon Glacier Developer Guide</i>. </p>"
},
"UploadMultipartPart":{
"name":"UploadMultipartPart",
"http":{
"method":"PUT",
"requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}",
"responseCode":204
},
"input":{"shape":"UploadMultipartPartInput"},
"output":{"shape":"UploadMultipartPartOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"RequestTimeoutException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation uploads a part of an archive. You can upload archive parts in any order. You can also upload them in parallel. You can upload up to 10,000 parts for a multipart upload.</p> <p>Amazon Glacier rejects your upload part request if any of the following conditions is true:</p> <ul> <li> <p> <b>SHA256 tree hash does not match</b>To ensure that part data is not corrupted in transmission, you compute a SHA256 tree hash of the part and include it in your request. Upon receiving the part data, Amazon Glacier also computes a SHA256 tree hash. If these hash values don't match, the operation fails. For information about computing a SHA256 tree hash, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html\">Computing Checksums</a>.</p> </li> <li> <p> <b>Part size does not match</b>The size of each part except the last must match the size specified in the corresponding <a>InitiateMultipartUpload</a> request. The size of the last part must be the same size as, or smaller than, the specified size.</p> <note> <p>If you upload a part whose size is smaller than the part size you specified in your initiate multipart upload request and that part is not the last part, then the upload part request will succeed. However, the subsequent Complete Multipart Upload request will fail.</p> </note> </li> <li> <p> <b>Range does not align</b>The byte range value in the request does not align with the part size specified in the corresponding initiate request. For example, if you specify a part size of 4194304 bytes (4 MB), then 0 to 4194303 bytes (4 MB - 1) and 4194304 (4 MB) to 8388607 (8 MB - 1) are valid part ranges. However, if you set a range value of 2 MB to 6 MB, the range does not align with the part size and the upload will fail. </p> </li> </ul> <p>This operation is idempotent. If you upload the same part multiple times, the data included in the most recent request overwrites the previously uploaded data.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p> For conceptual information and underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html\">Uploading Large Archives in Parts (Multipart Upload)</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-upload-part.html\">Upload Part </a> in the <i>Amazon Glacier Developer Guide</i>.</p>"
}
},
"shapes":{
"AbortMultipartUploadInput":{
"type":"structure",
"required":[
"accountId",
"vaultName",
"uploadId"
],
"members":{
"accountId":{
"shape":"string",
"documentation":"<p>The <code>AccountId</code> value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '<code>-</code>' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.</p>",
"location":"uri",
"locationName":"accountId"
},
"vaultName":{
"shape":"string",
"documentation":"<p>The name of the vault.</p>",
"location":"uri",
"locationName":"vaultName"
},
"uploadId":{
"shape":"string",
"documentation":"<p>The upload ID of the multipart upload to delete.</p>",
"location":"uri",
"locationName":"uploadId"
}
},
"documentation":"<p>Provides options to abort a multipart upload identified by the upload ID.</p> <p>For information about the underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-abort-upload.html\">Abort Multipart Upload</a>. For conceptual information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html\">Working with Archives in Amazon Glacier</a>.</p>"
},
"AbortVaultLockInput":{
"type":"structure",
"required":[
"accountId",
"vaultName"
],
"members":{
"accountId":{
"shape":"string",
"documentation":"<p>The <code>AccountId</code> value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '<code>-</code>' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.</p>",
"location":"uri",
"locationName":"accountId"
},
"vaultName":{
"shape":"string",
"documentation":"<p>The name of the vault.</p>",
"location":"uri",
"locationName":"vaultName"
}
},
"documentation":"<p>The input values for <code>AbortVaultLock</code>.</p>"
},
"ActionCode":{
"type":"string",
"enum":[
"ArchiveRetrieval",
"InventoryRetrieval"
]
},
"AddTagsToVaultInput":{
"type":"structure",
"required":[
"accountId",
"vaultName"
],
"members":{
"accountId":{
"shape":"string",
"documentation":"<p>The <code>AccountId</code> value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '<code>-</code>' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.</p>",
"location":"uri",
"locationName":"accountId"
},
"vaultName":{
"shape":"string",
"documentation":"<p>The name of the vault.</p>",
"location":"uri",
"locationName":"vaultName"
},
"Tags":{
"shape":"TagMap",
"documentation":"<p>The tags to add to the vault. Each tag is composed of a key and a value. The value can be an empty string.</p>"
}
},
"documentation":"<p>The input values for <code>AddTagsToVault</code>.</p>"
},
"ArchiveCreationOutput":{
"type":"structure",
"members":{
"location":{
"shape":"string",
"documentation":"<p>The relative URI path of the newly added archive resource.</p>",
"location":"header",
"locationName":"Location"
},
"checksum":{
"shape":"string",
"documentation":"<p>The checksum of the archive computed by Amazon Glacier.</p>",
"location":"header",
"locationName":"x-amz-sha256-tree-hash"
},
"archiveId":{
"shape":"string",
"documentation":"<p>The ID of the archive. This value is also included as part of the location.</p>",
"location":"header",
"locationName":"x-amz-archive-id"
}
},
"documentation":"<p>Contains the Amazon Glacier response to your request.</p> <p>For information about the underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html\">Upload Archive</a>. For conceptual information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html\">Working with Archives in Amazon Glacier</a>.</p>"
},
"CompleteMultipartUploadInput":{
"type":"structure",
"required":[
"accountId",
"vaultName",
"uploadId"
],
"members":{
"accountId":{
"shape":"string",
"documentation":"<p>The <code>AccountId</code> value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '<code>-</code>' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.</p>",
"location":"uri",
"locationName":"accountId"
},
"vaultName":{
"shape":"string",
"documentation":"<p>The name of the vault.</p>",
"location":"uri",
"locationName":"vaultName"
},
"uploadId":{
"shape":"string",
"documentation":"<p>The upload ID of the multipart upload.</p>",
"location":"uri",
"locationName":"uploadId"
},
"archiveSize":{
"shape":"string",
"documentation":"<p>The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded.</p>",
"location":"header",
"locationName":"x-amz-archive-size"
},
"checksum":{
"shape":"string",
"documentation":"<p>The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon Glacier, Amazon Glacier returns an error and the request fails.</p>",
"location":"header",
"locationName":"x-amz-sha256-tree-hash"
}
},
"documentation":"<p>Provides options to complete a multipart upload operation. This informs Amazon Glacier that all the archive parts have been uploaded and Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive resource.</p>"
},
"CompleteVaultLockInput":{
"type":"structure",
"required":[
"accountId",
"vaultName",
"lockId"
],
"members":{
"accountId":{
"shape":"string",
"documentation":"<p>The <code>AccountId</code> value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '<code>-</code>' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.</p>",
"location":"uri",
"locationName":"accountId"
},
"vaultName":{
"shape":"string",
"documentation":"<p>The name of the vault.</p>",
"location":"uri",
"locationName":"vaultName"
},
"lockId":{
"shape":"string",
"documentation":"<p>The <code>lockId</code> value is the lock ID obtained from a <a>InitiateVaultLock</a> request.</p>",
"location":"uri",
"locationName":"lockId"
}
},
"documentation":"<p>The input values for <code>CompleteVaultLock</code>.</p>"
},
"CreateVaultInput":{
"type":"structure",
"required":[
"accountId",
"vaultName"
],
"members":{
"accountId":{
"shape":"string",
"documentation":"<p>The <code>AccountId</code> value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '<code>-</code>' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.</p>",
"location":"uri",
"locationName":"accountId"
},
"vaultName":{
"shape":"string",
"documentation":"<p>The name of the vault.</p>",
"location":"uri",
"locationName":"vaultName"
}
},
"documentation":"<p>Provides options to create a vault.</p>"
},
"CreateVaultOutput":{
"type":"structure",
"members":{
"location":{
"shape":"string",
"documentation":"<p>The URI of the vault that was created.</p>",
"location":"header",
"locationName":"Location"
}
},
"documentation":"<p>Contains the Amazon Glacier response to your request.</p>"
},
"DataRetrievalPolicy":{
"type":"structure",
"members":{
"Rules":{
"shape":"DataRetrievalRulesList",
"documentation":"<p>The policy rule. Although this is a list type, currently there must be only one rule, which contains a Strategy field and optionally a BytesPerHour field.</p>"
}
},
"documentation":"<p>Data retrieval policy.</p>"
},
"DataRetrievalRule":{
"type":"structure",
"members":{
"Strategy":{
"shape":"string",
"documentation":"<p>The type of data retrieval policy to set.</p> <p>Valid values: BytesPerHour|FreeTier|None</p>"
},
"BytesPerHour":{
"shape":"NullableLong",
"documentation":"<p>The maximum number of bytes that can be retrieved in an hour.</p> <p>This field is required only if the value of the Strategy field is <code>BytesPerHour</code>. Your PUT operation will be rejected if the Strategy field is not set to <code>BytesPerHour</code> and you set this field.</p>"
}
},
"documentation":"<p>Data retrieval policy rule.</p>"
},
"DataRetrievalRulesList":{
"type":"list",
"member":{"shape":"DataRetrievalRule"}
},
"DateTime":{"type":"string"},
"DeleteArchiveInput":{
"type":"structure",
"required":[
"accountId",
"vaultName",
"archiveId"
],
"members":{
"accountId":{
"shape":"string",
"documentation":"<p>The <code>AccountId</code> value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '<code>-</code>' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.</p>",
"location":"uri",
"locationName":"accountId"
},
"vaultName":{
"shape":"string",
"documentation":"<p>The name of the vault.</p>",
"location":"uri",
"locationName":"vaultName"
},
"archiveId":{
"shape":"string",
"documentation":"<p>The ID of the archive to delete.</p>",
"location":"uri",
"locationName":"archiveId"
}
},
"documentation":"<p>Provides options for deleting an archive from an Amazon Glacier vault.</p>"
},
"DeleteVaultAccessPolicyInput":{
"type":"structure",
"required":[
"accountId",
"vaultName"
],
"members":{
"accountId":{
"shape":"string",
"documentation":"<p>The <code>AccountId</code> value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '<code>-</code>' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. </p>",
"location":"uri",
"locationName":"accountId"
},
"vaultName":{
"shape":"string",
"documentation":"<p>The name of the vault.</p>",
"location":"uri",
"locationName":"vaultName"
}
},
"documentation":"<p>DeleteVaultAccessPolicy input.</p>"
},
"DeleteVaultInput":{
"type":"structure",
"required":[
"accountId",
"vaultName"
],
"members":{
"accountId":{
"shape":"string",
"documentation":"<p>The <code>AccountId</code> value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '<code>-</code>' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.</p>",
"location":"uri",
"locationName":"accountId"
},
"vaultName":{
"shape":"string",
"documentation":"<p>The name of the vault.</p>",
"location":"uri",
"locationName":"vaultName"
}
},
"documentation":"<p>Provides options for deleting a vault from Amazon Glacier.</p>"
},
"DeleteVaultNotificationsInput":{
"type":"structure",
"required":[
"accountId",
"vaultName"
],
"members":{
"accountId":{
"shape":"string",
"documentation":"<p>The <code>AccountId</code> value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '<code>-</code>' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. </p>",
"location":"uri",
"locationName":"accountId"
},
"vaultName":{
"shape":"string",
"documentation":"<p>The name of the vault.</p>",
"location":"uri",
"locationName":"vaultName"
}
},
"documentation":"<p>Provides options for deleting a vault notification configuration from an Amazon Glacier vault.</p>"
},
"DescribeJobInput":{
"type":"structure",
"required":[
"accountId",
"vaultName",
"jobId"
],
"members":{
"accountId":{
"shape":"string",
"documentation":"<p>The <code>AccountId</code> value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '<code>-</code>' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. </p>",
"location":"uri",
"locationName":"accountId"
},
"vaultName":{
"shape":"string",
"documentation":"<p>The name of the vault.</p>",
"location":"uri",
"locationName":"vaultName"
},
"jobId":{
"shape":"string",
"documentation":"<p>The ID of the job to describe.</p>",
"location":"uri",
"locationName":"jobId"
}
},
"documentation":"<p>Provides options for retrieving a job description.</p>"
},
"DescribeVaultInput":{
"type":"structure",
"required":[
"accountId",
"vaultName"
],
"members":{
"accountId":{
"shape":"string",
"documentation":"<p>The <code>AccountId</code> value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '<code>-</code>' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. </p>",
"location":"uri",
"locationName":"accountId"
},
"vaultName":{
"shape":"string",
"documentation":"<p>The name of the vault.</p>",
"location":"uri",
"locationName":"vaultName"
}
},
"documentation":"<p>Provides options for retrieving metadata for a specific vault in Amazon Glacier.</p>"
},
"DescribeVaultOutput":{
"type":"structure",
"members":{
"VaultARN":{
"shape":"string",
"documentation":"<p>The Amazon Resource Name (ARN) of the vault.</p>"
},
"VaultName":{
"shape":"string",
"documentation":"<p>The name of the vault.</p>"
},
"CreationDate":{
"shape":"string",
"documentation":"<p>The Universal Coordinated Time (UTC) date when the vault was created. This value should be a string in the ISO 8601 date format, for example <code>2012-03-20T17:03:43.221Z</code>.</p>"
},
"LastInventoryDate":{
"shape":"string",
"documentation":"<p>The Universal Coordinated Time (UTC) date when Amazon Glacier completed the last vault inventory. This value should be a string in the ISO 8601 date format, for example <code>2012-03-20T17:03:43.221Z</code>.</p>"
},
"NumberOfArchives":{
"shape":"long",
"documentation":"<p>The number of archives in the vault as of the last inventory date. This field will return <code>null</code> if an inventory has not yet run on the vault, for example if you just created the vault.</p>"
},
"SizeInBytes":{
"shape":"long",
"documentation":"<p>Total size, in bytes, of the archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example if you just created the vault.</p>"
}
},
"documentation":"<p>Contains the Amazon Glacier response to your request.</p>"
},
"GetDataRetrievalPolicyInput":{
"type":"structure",
"required":["accountId"],
"members":{
"accountId":{
"shape":"string",
"documentation":"<p>The <code>AccountId</code> value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '<code>-</code>' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID. </p>",
"location":"uri",
"locationName":"accountId"
}
},
"documentation":"<p>Input for GetDataRetrievalPolicy.</p>"
},
"GetDataRetrievalPolicyOutput":{
"type":"structure",
"members":{
"Policy":{
"shape":"DataRetrievalPolicy",
"documentation":"<p>Contains the returned data retrieval policy in JSON format.</p>"
}
},
"documentation":"<p>Contains the Amazon Glacier response to the <code>GetDataRetrievalPolicy</code> request.</p>"
},
"GetJobOutputInput":{
"type":"structure",
"required":[
"accountId",
"vaultName",
"jobId"
],
"members":{