UNPKG

27.5 kBJSONView Raw
1{
2 "version": "1.0",
3 "examples": {
4 "AbortMultipartUpload": [
5 {
6 "input": {
7 "accountId": "-",
8 "uploadId": "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ",
9 "vaultName": "my-vault"
10 },
11 "comments": {
12 "input": {
13 },
14 "output": {
15 }
16 },
17 "description": "The example deletes an in-progress multipart upload to a vault named my-vault:",
18 "id": "f3d907f6-e71c-420c-8f71-502346a2c48a",
19 "title": "To abort a multipart upload identified by the upload ID"
20 }
21 ],
22 "AbortVaultLock": [
23 {
24 "input": {
25 "accountId": "-",
26 "vaultName": "examplevault"
27 },
28 "comments": {
29 "input": {
30 },
31 "output": {
32 }
33 },
34 "description": "The example aborts the vault locking process if the vault lock is not in the Locked state for the vault named examplevault.",
35 "id": "to-abort-a-vault-lock-1481839357947",
36 "title": "To abort a vault lock"
37 }
38 ],
39 "AddTagsToVault": [
40 {
41 "input": {
42 "Tags": {
43 "examplekey1": "examplevalue1",
44 "examplekey2": "examplevalue2"
45 },
46 "accountId": "-",
47 "vaultName": "my-vault"
48 },
49 "comments": {
50 "input": {
51 },
52 "output": {
53 }
54 },
55 "description": "The example adds two tags to a my-vault.",
56 "id": "add-tags-to-vault-post-tags-add-1481663457694",
57 "title": "To add tags to a vault"
58 }
59 ],
60 "CompleteMultipartUpload": [
61 {
62 "input": {
63 "accountId": "-",
64 "archiveSize": "3145728",
65 "checksum": "9628195fcdbcbbe76cdde456d4646fa7de5f219fb39823836d81f0cc0e18aa67",
66 "uploadId": "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ",
67 "vaultName": "my-vault"
68 },
69 "output": {
70 "archiveId": "NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId",
71 "checksum": "9628195fcdbcbbe76cdde456d4646fa7de5f219fb39823836d81f0cc0e18aa67",
72 "location": "/111122223333/vaults/my-vault/archives/NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId"
73 },
74 "comments": {
75 "input": {
76 },
77 "output": {
78 }
79 },
80 "description": "The example completes a multipart upload for a 3 MiB archive.",
81 "id": "272aa0b8-e44c-4a64-add2-ad905a37984d",
82 "title": "To complete a multipart upload"
83 }
84 ],
85 "CompleteVaultLock": [
86 {
87 "input": {
88 "accountId": "-",
89 "lockId": "AE863rKkWZU53SLW5be4DUcW",
90 "vaultName": "example-vault"
91 },
92 "comments": {
93 "input": {
94 },
95 "output": {
96 }
97 },
98 "description": "The example completes the vault locking process by transitioning the vault lock from the InProgress state to the Locked state.",
99 "id": "to-complete-a-vault-lock-1481839721312",
100 "title": "To complete a vault lock"
101 }
102 ],
103 "CreateVault": [
104 {
105 "input": {
106 "accountId": "-",
107 "vaultName": "my-vault"
108 },
109 "output": {
110 "location": "/111122223333/vaults/my-vault"
111 },
112 "comments": {
113 "input": {
114 },
115 "output": {
116 }
117 },
118 "description": "The following example creates a new vault named my-vault.",
119 "id": "1dc0313d-ace1-4e6c-9d13-1ec7813b14b7",
120 "title": "To create a new vault"
121 }
122 ],
123 "DeleteArchive": [
124 {
125 "input": {
126 "accountId": "-",
127 "archiveId": "NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId",
128 "vaultName": "examplevault"
129 },
130 "comments": {
131 "input": {
132 },
133 "output": {
134 }
135 },
136 "description": "The example deletes the archive specified by the archive ID.",
137 "id": "delete-archive-1481667809463",
138 "title": "To delete an archive"
139 }
140 ],
141 "DeleteVault": [
142 {
143 "input": {
144 "accountId": "-",
145 "vaultName": "my-vault"
146 },
147 "comments": {
148 "input": {
149 },
150 "output": {
151 }
152 },
153 "description": "The example deletes a vault named my-vault:",
154 "id": "7f7f000b-4bdb-40d2-91e6-7c902f60f60f",
155 "title": "To delete a vault"
156 }
157 ],
158 "DeleteVaultAccessPolicy": [
159 {
160 "input": {
161 "accountId": "-",
162 "vaultName": "examplevault"
163 },
164 "comments": {
165 "input": {
166 },
167 "output": {
168 }
169 },
170 "description": "The example deletes the access policy associated with the vault named examplevault.",
171 "id": "to-delete-the-vault-access-policy-1481840424677",
172 "title": "To delete the vault access policy"
173 }
174 ],
175 "DeleteVaultNotifications": [
176 {
177 "input": {
178 "accountId": "-",
179 "vaultName": "examplevault"
180 },
181 "comments": {
182 "input": {
183 },
184 "output": {
185 }
186 },
187 "description": "The example deletes the notification configuration set for the vault named examplevault.",
188 "id": "to-delete-the-notification-configuration-set-for-a-vault-1481840646090",
189 "title": "To delete the notification configuration set for a vault"
190 }
191 ],
192 "DescribeJob": [
193 {
194 "input": {
195 "accountId": "-",
196 "jobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4Cn",
197 "vaultName": "my-vault"
198 },
199 "output": {
200 "Action": "InventoryRetrieval",
201 "Completed": false,
202 "CreationDate": "2015-07-17T20:23:41.616Z",
203 "InventoryRetrievalParameters": {
204 "Format": "JSON"
205 },
206 "JobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW",
207 "StatusCode": "InProgress",
208 "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault"
209 },
210 "comments": {
211 "input": {
212 },
213 "output": {
214 }
215 },
216 "description": "The example returns information about the previously initiated job specified by the job ID.",
217 "id": "to-get-information-about-a-job-you-previously-initiated-1481840928592",
218 "title": "To get information about a previously initiated job"
219 }
220 ],
221 "DescribeVault": [
222 {
223 "input": {
224 "accountId": "-",
225 "vaultName": "my-vault"
226 },
227 "output": {
228 "CreationDate": "2016-09-23T19:27:18.665Z",
229 "NumberOfArchives": 0,
230 "SizeInBytes": 0,
231 "VaultARN": "arn:aws:glacier:us-west-2:111122223333:vaults/my-vault",
232 "VaultName": "my-vault"
233 },
234 "comments": {
235 "input": {
236 },
237 "output": {
238 }
239 },
240 "description": "The example retrieves data about a vault named my-vault.",
241 "id": "3c1c6e9d-f5a2-427a-aa6a-f439eacfc05f",
242 "title": "To retrieve information about a vault"
243 }
244 ],
245 "GetDataRetrievalPolicy": [
246 {
247 "input": {
248 "accountId": "-"
249 },
250 "output": {
251 "Policy": {
252 "Rules": [
253 {
254 "BytesPerHour": 10737418240,
255 "Strategy": "BytesPerHour"
256 }
257 ]
258 }
259 },
260 "comments": {
261 "input": {
262 },
263 "output": {
264 }
265 },
266 "description": "The example returns the current data retrieval policy for the account.",
267 "id": "to-get-the-current-data-retrieval-policy-for-the-account-1481851580439",
268 "title": "To get the current data retrieval policy for an account"
269 }
270 ],
271 "GetJobOutput": [
272 {
273 "input": {
274 "accountId": "-",
275 "jobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW",
276 "range": "",
277 "vaultName": "my-vaul"
278 },
279 "output": {
280 "acceptRanges": "bytes",
281 "body": "inventory-data",
282 "contentType": "application/json",
283 "status": 200
284 },
285 "comments": {
286 "input": {
287 },
288 "output": {
289 }
290 },
291 "description": "The example downloads the output of a previously initiated inventory retrieval job that is identified by the job ID.",
292 "id": "to-get-the-output-of-a-previously-initiated-job-1481848550859",
293 "title": "To get the output of a previously initiated job"
294 }
295 ],
296 "GetVaultAccessPolicy": [
297 {
298 "input": {
299 "accountId": "-",
300 "vaultName": "example-vault"
301 },
302 "output": {
303 "policy": {
304 "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-owner-access-rights\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\"}]}"
305 }
306 },
307 "comments": {
308 "input": {
309 },
310 "output": {
311 }
312 },
313 "description": "The example retrieves the access-policy set on the vault named example-vault.",
314 "id": "to--get-the-access-policy-set-on-the-vault-1481936004590",
315 "title": "To get the access-policy set on the vault"
316 }
317 ],
318 "GetVaultLock": [
319 {
320 "input": {
321 "accountId": "-",
322 "vaultName": "examplevault"
323 },
324 "output": {
325 "CreationDate": "exampledate",
326 "ExpirationDate": "exampledate",
327 "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-vault-lock\",\"Effect\":\"Deny\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\",\"Condition\":{\"NumericLessThanEquals\":{\"glacier:ArchiveAgeinDays\":\"365\"}}}]}",
328 "State": "InProgress"
329 },
330 "comments": {
331 "input": {
332 },
333 "output": {
334 }
335 },
336 "description": "The example retrieves the attributes from the lock-policy subresource set on the vault named examplevault.",
337 "id": "to-retrieve-vault-lock-policy-related-attributes-that-are-set-on-a-vault-1481851363097",
338 "title": "To retrieve vault lock-policy related attributes that are set on a vault"
339 }
340 ],
341 "GetVaultNotifications": [
342 {
343 "input": {
344 "accountId": "-",
345 "vaultName": "my-vault"
346 },
347 "output": {
348 "vaultNotificationConfig": {
349 "Events": [
350 "InventoryRetrievalCompleted",
351 "ArchiveRetrievalCompleted"
352 ],
353 "SNSTopic": "arn:aws:sns:us-west-2:0123456789012:my-vault"
354 }
355 },
356 "comments": {
357 "input": {
358 },
359 "output": {
360 }
361 },
362 "description": "The example retrieves the notification-configuration for the vault named my-vault.",
363 "id": "to-get-the-notification-configuration-for-the-specified-vault-1481918746677",
364 "title": "To get the notification-configuration for the specified vault"
365 }
366 ],
367 "InitiateJob": [
368 {
369 "input": {
370 "accountId": "-",
371 "jobParameters": {
372 "Description": "My inventory job",
373 "Format": "CSV",
374 "SNSTopic": "arn:aws:sns:us-west-2:111111111111:Glacier-InventoryRetrieval-topic-Example",
375 "Type": "inventory-retrieval"
376 },
377 "vaultName": "examplevault"
378 },
379 "output": {
380 "jobId": " HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID",
381 "location": "/111122223333/vaults/examplevault/jobs/HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID"
382 },
383 "comments": {
384 "input": {
385 },
386 "output": {
387 }
388 },
389 "description": "The example initiates an inventory-retrieval job for the vault named examplevault.",
390 "id": "to-initiate-an-inventory-retrieval-job-1482186883826",
391 "title": "To initiate an inventory-retrieval job"
392 }
393 ],
394 "InitiateMultipartUpload": [
395 {
396 "input": {
397 "accountId": "-",
398 "partSize": "1048576",
399 "vaultName": "my-vault"
400 },
401 "output": {
402 "location": "/111122223333/vaults/my-vault/multipart-uploads/19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ",
403 "uploadId": "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ"
404 },
405 "comments": {
406 "input": {
407 },
408 "output": {
409 }
410 },
411 "description": "The example initiates a multipart upload to a vault named my-vault with a part size of 1 MiB (1024 x 1024 bytes) per file.",
412 "id": "72f2db19-3d93-4c74-b2ed-38703baacf49",
413 "title": "To initiate a multipart upload"
414 }
415 ],
416 "InitiateVaultLock": [
417 {
418 "input": {
419 "accountId": "-",
420 "policy": {
421 "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-vault-lock\",\"Effect\":\"Deny\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\",\"Condition\":{\"NumericLessThanEquals\":{\"glacier:ArchiveAgeinDays\":\"365\"}}}]}"
422 },
423 "vaultName": "my-vault"
424 },
425 "output": {
426 "lockId": "AE863rKkWZU53SLW5be4DUcW"
427 },
428 "comments": {
429 "input": {
430 },
431 "output": {
432 }
433 },
434 "description": "The example initiates the vault locking process for the vault named my-vault.",
435 "id": "to-initiate-the-vault-locking-process-1481919693394",
436 "title": "To initiate the vault locking process"
437 }
438 ],
439 "ListJobs": [
440 {
441 "input": {
442 "accountId": "-",
443 "vaultName": "my-vault"
444 },
445 "output": {
446 "JobList": [
447 {
448 "Action": "ArchiveRetrieval",
449 "ArchiveId": "kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw",
450 "ArchiveSHA256TreeHash": "9628195fcdbcbbe76cdde932d4646fa7de5f219fb39823836d81f0cc0e18aa67",
451 "ArchiveSizeInBytes": 3145728,
452 "Completed": false,
453 "CreationDate": "2015-07-17T21:16:13.840Z",
454 "JobDescription": "Retrieve archive on 2015-07-17",
455 "JobId": "l7IL5-EkXyEY9Ws95fClzIbk2O5uLYaFdAYOi-azsX_Z8V6NH4yERHzars8wTKYQMX6nBDI9cMNHzyZJO59-8N9aHWav",
456 "RetrievalByteRange": "0-3145727",
457 "SHA256TreeHash": "9628195fcdbcbbe76cdde932d4646fa7de5f219fb39823836d81f0cc0e18aa67",
458 "SNSTopic": "arn:aws:sns:us-west-2:0123456789012:my-vault",
459 "StatusCode": "InProgress",
460 "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault"
461 },
462 {
463 "Action": "InventoryRetrieval",
464 "Completed": false,
465 "CreationDate": "2015-07-17T20:23:41.616Z",
466 "InventoryRetrievalParameters": {
467 "Format": "JSON"
468 },
469 "JobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW",
470 "StatusCode": "InProgress",
471 "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault"
472 }
473 ]
474 },
475 "comments": {
476 "input": {
477 },
478 "output": {
479 }
480 },
481 "description": "The example lists jobs for the vault named my-vault.",
482 "id": "to-list-jobs-for-a-vault-1481920530537",
483 "title": "To list jobs for a vault"
484 }
485 ],
486 "ListMultipartUploads": [
487 {
488 "input": {
489 "accountId": "-",
490 "vaultName": "examplevault"
491 },
492 "output": {
493 "Marker": "null",
494 "UploadsList": [
495 {
496 "ArchiveDescription": "archive 1",
497 "CreationDate": "2012-03-19T23:20:59.130Z",
498 "MultipartUploadId": "xsQdFIRsfJr20CW2AbZBKpRZAFTZSJIMtL2hYf8mvp8dM0m4RUzlaqoEye6g3h3ecqB_zqwB7zLDMeSWhwo65re4C4Ev",
499 "PartSizeInBytes": 4194304,
500 "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
501 },
502 {
503 "ArchiveDescription": "archive 2",
504 "CreationDate": "2012-04-01T15:00:00.000Z",
505 "MultipartUploadId": "nPyGOnyFcx67qqX7E-0tSGiRi88hHMOwOxR-_jNyM6RjVMFfV29lFqZ3rNsSaWBugg6OP92pRtufeHdQH7ClIpSF6uJc",
506 "PartSizeInBytes": 4194304,
507 "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
508 },
509 {
510 "ArchiveDescription": "archive 3",
511 "CreationDate": "2012-03-20T17:03:43.221Z",
512 "MultipartUploadId": "qt-RBst_7yO8gVIonIBsAxr2t-db0pE4s8MNeGjKjGdNpuU-cdSAcqG62guwV9r5jh5mLyFPzFEitTpNE7iQfHiu1XoV",
513 "PartSizeInBytes": 4194304,
514 "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
515 }
516 ]
517 },
518 "comments": {
519 "input": {
520 },
521 "output": {
522 }
523 },
524 "description": "The example lists all the in-progress multipart uploads for the vault named examplevault.",
525 "id": "to-list-all-the-in-progress-multipart-uploads-for-a-vault-1481935250590",
526 "title": "To list all the in-progress multipart uploads for a vault"
527 }
528 ],
529 "ListParts": [
530 {
531 "input": {
532 "accountId": "-",
533 "uploadId": "OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE",
534 "vaultName": "examplevault"
535 },
536 "output": {
537 "ArchiveDescription": "archive description",
538 "CreationDate": "2012-03-20T17:03:43.221Z",
539 "Marker": "null",
540 "MultipartUploadId": "OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE",
541 "PartSizeInBytes": 4194304,
542 "Parts": [
543 {
544 "RangeInBytes": "0-4194303",
545 "SHA256TreeHash": "01d34dabf7be316472c93b1ef80721f5d4"
546 },
547 {
548 "RangeInBytes": "4194304-8388607",
549 "SHA256TreeHash": "0195875365afda349fc21c84c099987164"
550 }
551 ],
552 "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/demo1-vault"
553 },
554 "comments": {
555 "input": {
556 },
557 "output": {
558 }
559 },
560 "description": "The example lists all the parts of a multipart upload.",
561 "id": "to-list-the-parts-of-an-archive-that-have-been-uploaded-in-a-multipart-upload-1481921767590",
562 "title": "To list the parts of an archive that have been uploaded in a multipart upload"
563 }
564 ],
565 "ListProvisionedCapacity": [
566 {
567 "input": {
568 "accountId": "-"
569 },
570 "output": {
571 "ProvisionedCapacityList": [
572 {
573 "CapacityId": "zSaq7NzHFQDANTfQkDen4V7z",
574 "ExpirationDate": "2016-12-12T00:00:00.000Z",
575 "StartDate": "2016-11-11T20:11:51.095Z"
576 },
577 {
578 "CapacityId": "yXaq7NzHFQNADTfQkDen4V7z",
579 "ExpirationDate": "2017-01-15T00:00:00.000Z",
580 "StartDate": "2016-12-13T20:11:51.095Z"
581 }
582 ]
583 },
584 "comments": {
585 "input": {
586 },
587 "output": {
588 }
589 },
590 "description": "The example lists the provisioned capacity units for an account.",
591 "id": "to-list-the-provisioned-capacity-units-for-an-account-1481923656130",
592 "title": "To list the provisioned capacity units for an account"
593 }
594 ],
595 "ListTagsForVault": [
596 {
597 "input": {
598 "accountId": "-",
599 "vaultName": "examplevault"
600 },
601 "output": {
602 "Tags": {
603 "date": "july2015",
604 "id": "1234"
605 }
606 },
607 "comments": {
608 "input": {
609 },
610 "output": {
611 }
612 },
613 "description": "The example lists all the tags attached to the vault examplevault.",
614 "id": "list-tags-for-vault-1481755839720",
615 "title": "To list the tags for a vault"
616 }
617 ],
618 "ListVaults": [
619 {
620 "input": {
621 "accountId": "-",
622 "limit": "",
623 "marker": ""
624 },
625 "output": {
626 "VaultList": [
627 {
628 "CreationDate": "2015-04-06T21:23:45.708Z",
629 "LastInventoryDate": "2015-04-07T00:26:19.028Z",
630 "NumberOfArchives": 1,
631 "SizeInBytes": 3178496,
632 "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault",
633 "VaultName": "my-vault"
634 }
635 ]
636 },
637 "comments": {
638 "input": {
639 },
640 "output": {
641 }
642 },
643 "description": "The example lists all vaults owned by the specified AWS account.",
644 "id": "list-vaults-1481753006990",
645 "title": "To list all vaults owned by the calling user's account"
646 }
647 ],
648 "PurchaseProvisionedCapacity": [
649 {
650 "input": {
651 "accountId": "-"
652 },
653 "output": {
654 "capacityId": "zSaq7NzHFQDANTfQkDen4V7z"
655 },
656 "comments": {
657 "input": {
658 },
659 "output": {
660 }
661 },
662 "description": "The example purchases provisioned capacity unit for an AWS account.",
663 "id": "to-purchases-a-provisioned-capacity-unit-for-an-aws-account-1481927446662",
664 "title": "To purchases a provisioned capacity unit for an AWS account"
665 }
666 ],
667 "RemoveTagsFromVault": [
668 {
669 "input": {
670 "TagKeys": [
671 "examplekey1",
672 "examplekey2"
673 ],
674 "accountId": "-",
675 "vaultName": "examplevault"
676 },
677 "comments": {
678 "input": {
679 },
680 "output": {
681 }
682 },
683 "description": "The example removes two tags from the vault named examplevault.",
684 "id": "remove-tags-from-vault-1481754998801",
685 "title": "To remove tags from a vault"
686 }
687 ],
688 "SetDataRetrievalPolicy": [
689 {
690 "input": {
691 "Policy": {
692 "Rules": [
693 {
694 "BytesPerHour": 10737418240,
695 "Strategy": "BytesPerHour"
696 }
697 ]
698 },
699 "accountId": "-"
700 },
701 "comments": {
702 "input": {
703 },
704 "output": {
705 }
706 },
707 "description": "The example sets and then enacts a data retrieval policy.",
708 "id": "to-set-and-then-enact-a-data-retrieval-policy--1481928352408",
709 "title": "To set and then enact a data retrieval policy "
710 }
711 ],
712 "SetVaultAccessPolicy": [
713 {
714 "input": {
715 "accountId": "-",
716 "policy": {
717 "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-owner-access-rights\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\"}]}"
718 },
719 "vaultName": "examplevault"
720 },
721 "comments": {
722 "input": {
723 },
724 "output": {
725 }
726 },
727 "description": "The example configures an access policy for the vault named examplevault.",
728 "id": "to--set-the-access-policy-on-a-vault-1482185872517",
729 "title": "To set the access-policy on a vault"
730 }
731 ],
732 "SetVaultNotifications": [
733 {
734 "input": {
735 "accountId": "-",
736 "vaultName": "examplevault",
737 "vaultNotificationConfig": {
738 "Events": [
739 "ArchiveRetrievalCompleted",
740 "InventoryRetrievalCompleted"
741 ],
742 "SNSTopic": "arn:aws:sns:us-west-2:012345678901:mytopic"
743 }
744 },
745 "comments": {
746 "input": {
747 },
748 "output": {
749 }
750 },
751 "description": "The example sets the examplevault notification configuration.",
752 "id": "to-configure-a-vault-to-post-a-message-to-an-amazon-simple-notification-service-amazon-sns-topic-when-jobs-complete-1482186397475",
753 "title": "To configure a vault to post a message to an Amazon SNS topic when jobs complete"
754 }
755 ],
756 "UploadArchive": [
757 {
758 "input": {
759 "accountId": "-",
760 "archiveDescription": "",
761 "body": "example-data-to-upload",
762 "checksum": "",
763 "vaultName": "my-vault"
764 },
765 "output": {
766 "archiveId": "kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw",
767 "checksum": "969fb39823836d81f0cc028195fcdbcbbe76cdde932d4646fa7de5f21e18aa67",
768 "location": "/0123456789012/vaults/my-vault/archives/kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw"
769 },
770 "comments": {
771 "input": {
772 },
773 "output": {
774 }
775 },
776 "description": "The example adds an archive to a vault.",
777 "id": "upload-archive-1481668510494",
778 "title": "To upload an archive"
779 }
780 ],
781 "UploadMultipartPart": [
782 {
783 "input": {
784 "accountId": "-",
785 "body": "part1",
786 "checksum": "c06f7cd4baacb087002a99a5f48bf953",
787 "range": "bytes 0-1048575/*",
788 "uploadId": "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ",
789 "vaultName": "examplevault"
790 },
791 "output": {
792 "checksum": "c06f7cd4baacb087002a99a5f48bf953"
793 },
794 "comments": {
795 "input": {
796 },
797 "output": {
798 }
799 },
800 "description": "The example uploads the first 1 MiB (1024 x 1024 bytes) part of an archive.",
801 "id": "to-upload-the-first-part-of-an-archive-1481835899519",
802 "title": "To upload the first part of an archive"
803 }
804 ]
805 }
806}