aws-sdk-glacier 1.0.0.rc5 → 1.0.0.rc6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: fb94534c55d858f30316031ea936165a173d12e5
4
- data.tar.gz: 69c64d593b3e9051d5d49da9344f9bc078724c4a
3
+ metadata.gz: 03db12953ee64dbe4f06c9ae2437e20183352642
4
+ data.tar.gz: 9b356f6491f89d16a446bc2de2d8d5454d2b0a1b
5
5
  SHA512:
6
- metadata.gz: b8cc5c73b0ef5f0eb01208cf02dce8feeb148433b96355df6ce8f189e03e265ded45374936d73dc1a4c2bebf764a2c611dd29591b8af5148a1a12f2355eeb368
7
- data.tar.gz: 27f712b0aa924f4e1ebe0a70e8600daefa7b7b3ae4ca9ff49db1c17ff0042813aabb82727305822060b69234665ecc3997fe6a13c1ed859f2293206e78eac9c9
6
+ metadata.gz: 4c278fe0c8c21ca7e2fb703fcf5e018c1f1a9416f821e719991be0aa939448f48a34582e35757ffca6fbf70a91d978417a20c1d0fb203cd070fab8f6cddfd496
7
+ data.tar.gz: bce9e6c69a66d24f1efaf297ae9a3d27742722349fbcd32af51c2704c6e85f0ea7950da51ddc9e42de7bf855f149adc2e00edc3b85cb84f409f64570b337c375
@@ -49,6 +49,6 @@ require_relative 'aws-sdk-glacier/customizations'
49
49
  # @service
50
50
  module Aws::Glacier
51
51
 
52
- GEM_VERSION = '1.0.0.rc5'
52
+ GEM_VERSION = '1.0.0.rc6'
53
53
 
54
54
  end
@@ -199,6 +199,17 @@ module Aws::Glacier
199
199
  #
200
200
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
201
201
  #
202
+ #
203
+ # @example Example: To abort a multipart upload identified by the upload ID
204
+ #
205
+ # # The example deletes an in-progress multipart upload to a vault named my-vault:
206
+ #
207
+ # resp = client.abort_multipart_upload({
208
+ # account_id: "-",
209
+ # upload_id: "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ",
210
+ # vault_name: "my-vault",
211
+ # })
212
+ #
202
213
  # @example Request syntax with placeholder values
203
214
  #
204
215
  # resp = client.abort_multipart_upload({
@@ -251,6 +262,16 @@ module Aws::Glacier
251
262
  #
252
263
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
253
264
  #
265
+ #
266
+ # @example Example: To abort a vault lock
267
+ #
268
+ # # The example aborts the vault locking process if the vault lock is not in the Locked state for the vault named examplevault.
269
+ #
270
+ # resp = client.abort_vault_lock({
271
+ # account_id: "-",
272
+ # vault_name: "examplevault",
273
+ # })
274
+ #
254
275
  # @example Request syntax with placeholder values
255
276
  #
256
277
  # resp = client.abort_vault_lock({
@@ -294,6 +315,20 @@ module Aws::Glacier
294
315
  #
295
316
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
296
317
  #
318
+ #
319
+ # @example Example: To add tags to a vault
320
+ #
321
+ # # The example adds two tags to a my-vault.
322
+ #
323
+ # resp = client.add_tags_to_vault({
324
+ # tags: {
325
+ # "examplekey1" => "examplevalue1",
326
+ # "examplekey2" => "examplevalue2",
327
+ # },
328
+ # account_id: "-",
329
+ # vault_name: "my-vault",
330
+ # })
331
+ #
297
332
  # @example Request syntax with placeholder values
298
333
  #
299
334
  # resp = client.add_tags_to_vault({
@@ -395,6 +430,26 @@ module Aws::Glacier
395
430
  # * {Types::ArchiveCreationOutput#checksum #checksum} => String
396
431
  # * {Types::ArchiveCreationOutput#archive_id #archive_id} => String
397
432
  #
433
+ #
434
+ # @example Example: To complete a multipart upload
435
+ #
436
+ # # The example completes a multipart upload for a 3 MiB archive.
437
+ #
438
+ # resp = client.complete_multipart_upload({
439
+ # account_id: "-",
440
+ # archive_size: 3145728,
441
+ # checksum: "9628195fcdbcbbe76cdde456d4646fa7de5f219fb39823836d81f0cc0e18aa67",
442
+ # upload_id: "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ",
443
+ # vault_name: "my-vault",
444
+ # })
445
+ #
446
+ # resp.to_h outputs the following:
447
+ # {
448
+ # archive_id: "NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId",
449
+ # checksum: "9628195fcdbcbbe76cdde456d4646fa7de5f219fb39823836d81f0cc0e18aa67",
450
+ # location: "/111122223333/vaults/my-vault/archives/NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId",
451
+ # }
452
+ #
398
453
  # @example Request syntax with placeholder values
399
454
  #
400
455
  # resp = client.complete_multipart_upload({
@@ -458,6 +513,17 @@ module Aws::Glacier
458
513
  #
459
514
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
460
515
  #
516
+ #
517
+ # @example Example: To complete a vault lock
518
+ #
519
+ # # The example completes the vault locking process by transitioning the vault lock from the InProgress state to the Locked state.
520
+ #
521
+ # resp = client.complete_vault_lock({
522
+ # account_id: "-",
523
+ # lock_id: "AE863rKkWZU53SLW5be4DUcW",
524
+ # vault_name: "example-vault",
525
+ # })
526
+ #
461
527
  # @example Request syntax with placeholder values
462
528
  #
463
529
  # resp = client.complete_vault_lock({
@@ -519,6 +585,21 @@ module Aws::Glacier
519
585
  #
520
586
  # * {Types::CreateVaultOutput#location #location} => String
521
587
  #
588
+ #
589
+ # @example Example: To create a new vault
590
+ #
591
+ # # The following example creates a new vault named my-vault.
592
+ #
593
+ # resp = client.create_vault({
594
+ # account_id: "-",
595
+ # vault_name: "my-vault",
596
+ # })
597
+ #
598
+ # resp.to_h outputs the following:
599
+ # {
600
+ # location: "/111122223333/vaults/my-vault",
601
+ # }
602
+ #
522
603
  # @example Request syntax with placeholder values
523
604
  #
524
605
  # resp = client.create_vault({
@@ -585,6 +666,17 @@ module Aws::Glacier
585
666
  #
586
667
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
587
668
  #
669
+ #
670
+ # @example Example: To delete an archive
671
+ #
672
+ # # The example deletes the archive specified by the archive ID.
673
+ #
674
+ # resp = client.delete_archive({
675
+ # account_id: "-",
676
+ # archive_id: "NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId",
677
+ # vault_name: "examplevault",
678
+ # })
679
+ #
588
680
  # @example Request syntax with placeholder values
589
681
  #
590
682
  # resp = client.delete_archive({
@@ -644,6 +736,16 @@ module Aws::Glacier
644
736
  #
645
737
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
646
738
  #
739
+ #
740
+ # @example Example: To delete a vault
741
+ #
742
+ # # The example deletes a vault named my-vault:
743
+ #
744
+ # resp = client.delete_vault({
745
+ # account_id: "-",
746
+ # vault_name: "my-vault",
747
+ # })
748
+ #
647
749
  # @example Request syntax with placeholder values
648
750
  #
649
751
  # resp = client.delete_vault({
@@ -686,6 +788,16 @@ module Aws::Glacier
686
788
  #
687
789
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
688
790
  #
791
+ #
792
+ # @example Example: To delete the vault access policy
793
+ #
794
+ # # The example deletes the access policy associated with the vault named examplevault.
795
+ #
796
+ # resp = client.delete_vault_access_policy({
797
+ # account_id: "-",
798
+ # vault_name: "examplevault",
799
+ # })
800
+ #
689
801
  # @example Request syntax with placeholder values
690
802
  #
691
803
  # resp = client.delete_vault_access_policy({
@@ -735,6 +847,16 @@ module Aws::Glacier
735
847
  #
736
848
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
737
849
  #
850
+ #
851
+ # @example Example: To delete the notification configuration set for a vault
852
+ #
853
+ # # The example deletes the notification configuration set for the vault named examplevault.
854
+ #
855
+ # resp = client.delete_vault_notifications({
856
+ # account_id: "-",
857
+ # vault_name: "examplevault",
858
+ # })
859
+ #
738
860
  # @example Request syntax with placeholder values
739
861
  #
740
862
  # resp = client.delete_vault_notifications({
@@ -815,6 +937,30 @@ module Aws::Glacier
815
937
  # * {Types::GlacierJobDescription#tier #tier} => String
816
938
  # * {Types::GlacierJobDescription#inventory_retrieval_parameters #inventory_retrieval_parameters} => Types::InventoryRetrievalJobDescription
817
939
  #
940
+ #
941
+ # @example Example: To get information about a previously initiated job
942
+ #
943
+ # # The example returns information about the previously initiated job specified by the job ID.
944
+ #
945
+ # resp = client.describe_job({
946
+ # account_id: "-",
947
+ # job_id: "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4Cn",
948
+ # vault_name: "my-vault",
949
+ # })
950
+ #
951
+ # resp.to_h outputs the following:
952
+ # {
953
+ # action: "InventoryRetrieval",
954
+ # completed: false,
955
+ # creation_date: Time.parse("2015-07-17T20:23:41.616Z"),
956
+ # inventory_retrieval_parameters: {
957
+ # format: "JSON",
958
+ # },
959
+ # job_id: "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW",
960
+ # status_code: "InProgress",
961
+ # vault_arn: "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault",
962
+ # }
963
+ #
818
964
  # @example Request syntax with placeholder values
819
965
  #
820
966
  # resp = client.describe_job({
@@ -904,6 +1050,25 @@ module Aws::Glacier
904
1050
  # * {Types::DescribeVaultOutput#number_of_archives #number_of_archives} => Integer
905
1051
  # * {Types::DescribeVaultOutput#size_in_bytes #size_in_bytes} => Integer
906
1052
  #
1053
+ #
1054
+ # @example Example: To retrieve information about a vault
1055
+ #
1056
+ # # The example retrieves data about a vault named my-vault.
1057
+ #
1058
+ # resp = client.describe_vault({
1059
+ # account_id: "-",
1060
+ # vault_name: "my-vault",
1061
+ # })
1062
+ #
1063
+ # resp.to_h outputs the following:
1064
+ # {
1065
+ # creation_date: Time.parse("2016-09-23T19:27:18.665Z"),
1066
+ # number_of_archives: 0,
1067
+ # size_in_bytes: 0,
1068
+ # vault_arn: "arn:aws:glacier:us-west-2:111122223333:vaults/my-vault",
1069
+ # vault_name: "my-vault",
1070
+ # }
1071
+ #
907
1072
  # @example Request syntax with placeholder values
908
1073
  #
909
1074
  # resp = client.describe_vault({
@@ -949,6 +1114,27 @@ module Aws::Glacier
949
1114
  #
950
1115
  # * {Types::GetDataRetrievalPolicyOutput#policy #policy} => Types::DataRetrievalPolicy
951
1116
  #
1117
+ #
1118
+ # @example Example: To get the current data retrieval policy for an account
1119
+ #
1120
+ # # The example returns the current data retrieval policy for the account.
1121
+ #
1122
+ # resp = client.get_data_retrieval_policy({
1123
+ # account_id: "-",
1124
+ # })
1125
+ #
1126
+ # resp.to_h outputs the following:
1127
+ # {
1128
+ # policy: {
1129
+ # rules: [
1130
+ # {
1131
+ # bytes_per_hour: 10737418240,
1132
+ # strategy: "BytesPerHour",
1133
+ # },
1134
+ # ],
1135
+ # },
1136
+ # }
1137
+ #
952
1138
  # @example Request syntax with placeholder values
953
1139
  #
954
1140
  # resp = client.get_data_retrieval_policy({
@@ -1078,6 +1264,26 @@ module Aws::Glacier
1078
1264
  # * {Types::GetJobOutputOutput#content_type #content_type} => String
1079
1265
  # * {Types::GetJobOutputOutput#archive_description #archive_description} => String
1080
1266
  #
1267
+ #
1268
+ # @example Example: To get the output of a previously initiated job
1269
+ #
1270
+ # # The example downloads the output of a previously initiated inventory retrieval job that is identified by the job ID.
1271
+ #
1272
+ # resp = client.get_job_output({
1273
+ # account_id: "-",
1274
+ # job_id: "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW",
1275
+ # range: "",
1276
+ # vault_name: "my-vaul",
1277
+ # })
1278
+ #
1279
+ # resp.to_h outputs the following:
1280
+ # {
1281
+ # accept_ranges: "bytes",
1282
+ # body: "inventory-data",
1283
+ # content_type: "application/json",
1284
+ # status: 200,
1285
+ # }
1286
+ #
1081
1287
  # @example Request syntax with placeholder values
1082
1288
  #
1083
1289
  # resp = client.get_job_output({
@@ -1131,6 +1337,23 @@ module Aws::Glacier
1131
1337
  #
1132
1338
  # * {Types::GetVaultAccessPolicyOutput#policy #policy} => Types::VaultAccessPolicy
1133
1339
  #
1340
+ #
1341
+ # @example Example: To get the access-policy set on the vault
1342
+ #
1343
+ # # The example retrieves the access-policy set on the vault named example-vault.
1344
+ #
1345
+ # resp = client.get_vault_access_policy({
1346
+ # account_id: "-",
1347
+ # vault_name: "example-vault",
1348
+ # })
1349
+ #
1350
+ # resp.to_h outputs the following:
1351
+ # {
1352
+ # policy: {
1353
+ # 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\"}]}",
1354
+ # },
1355
+ # }
1356
+ #
1134
1357
  # @example Request syntax with placeholder values
1135
1358
  #
1136
1359
  # resp = client.get_vault_access_policy({
@@ -1196,6 +1419,24 @@ module Aws::Glacier
1196
1419
  # * {Types::GetVaultLockOutput#expiration_date #expiration_date} => Time
1197
1420
  # * {Types::GetVaultLockOutput#creation_date #creation_date} => Time
1198
1421
  #
1422
+ #
1423
+ # @example Example: To retrieve vault lock-policy related attributes that are set on a vault
1424
+ #
1425
+ # # The example retrieves the attributes from the lock-policy subresource set on the vault named examplevault.
1426
+ #
1427
+ # resp = client.get_vault_lock({
1428
+ # account_id: "-",
1429
+ # vault_name: "examplevault",
1430
+ # })
1431
+ #
1432
+ # resp.to_h outputs the following:
1433
+ # {
1434
+ # creation_date: Time.parse("exampledate"),
1435
+ # expiration_date: Time.parse("exampledate"),
1436
+ # 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\"}}}]}",
1437
+ # state: "InProgress",
1438
+ # }
1439
+ #
1199
1440
  # @example Request syntax with placeholder values
1200
1441
  #
1201
1442
  # resp = client.get_vault_lock({
@@ -1257,6 +1498,27 @@ module Aws::Glacier
1257
1498
  #
1258
1499
  # * {Types::GetVaultNotificationsOutput#vault_notification_config #vault_notification_config} => Types::VaultNotificationConfig
1259
1500
  #
1501
+ #
1502
+ # @example Example: To get the notification-configuration for the specified vault
1503
+ #
1504
+ # # The example retrieves the notification-configuration for the vault named my-vault.
1505
+ #
1506
+ # resp = client.get_vault_notifications({
1507
+ # account_id: "-",
1508
+ # vault_name: "my-vault",
1509
+ # })
1510
+ #
1511
+ # resp.to_h outputs the following:
1512
+ # {
1513
+ # vault_notification_config: {
1514
+ # events: [
1515
+ # "InventoryRetrievalCompleted",
1516
+ # "ArchiveRetrievalCompleted",
1517
+ # ],
1518
+ # sns_topic: "arn:aws:sns:us-west-2:0123456789012:my-vault",
1519
+ # },
1520
+ # }
1521
+ #
1260
1522
  # @example Request syntax with placeholder values
1261
1523
  #
1262
1524
  # resp = client.get_vault_notifications({
@@ -1455,6 +1717,28 @@ module Aws::Glacier
1455
1717
  # * {Types::InitiateJobOutput#location #location} => String
1456
1718
  # * {Types::InitiateJobOutput#job_id #job_id} => String
1457
1719
  #
1720
+ #
1721
+ # @example Example: To initiate an inventory-retrieval job
1722
+ #
1723
+ # # The example initiates an inventory-retrieval job for the vault named examplevault.
1724
+ #
1725
+ # resp = client.initiate_job({
1726
+ # account_id: "-",
1727
+ # job_parameters: {
1728
+ # description: "My inventory job",
1729
+ # format: "CSV",
1730
+ # sns_topic: "arn:aws:sns:us-west-2:111111111111:Glacier-InventoryRetrieval-topic-Example",
1731
+ # type: "inventory-retrieval",
1732
+ # },
1733
+ # vault_name: "examplevault",
1734
+ # })
1735
+ #
1736
+ # resp.to_h outputs the following:
1737
+ # {
1738
+ # job_id: " HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID",
1739
+ # location: "/111122223333/vaults/examplevault/jobs/HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID",
1740
+ # }
1741
+ #
1458
1742
  # @example Request syntax with placeholder values
1459
1743
  #
1460
1744
  # resp = client.initiate_job({
@@ -1562,6 +1846,23 @@ module Aws::Glacier
1562
1846
  # * {Types::InitiateMultipartUploadOutput#location #location} => String
1563
1847
  # * {Types::InitiateMultipartUploadOutput#upload_id #upload_id} => String
1564
1848
  #
1849
+ #
1850
+ # @example Example: To initiate a multipart upload
1851
+ #
1852
+ # # 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.
1853
+ #
1854
+ # resp = client.initiate_multipart_upload({
1855
+ # account_id: "-",
1856
+ # part_size: 1048576,
1857
+ # vault_name: "my-vault",
1858
+ # })
1859
+ #
1860
+ # resp.to_h outputs the following:
1861
+ # {
1862
+ # location: "/111122223333/vaults/my-vault/multipart-uploads/19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ",
1863
+ # upload_id: "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ",
1864
+ # }
1865
+ #
1565
1866
  # @example Request syntax with placeholder values
1566
1867
  #
1567
1868
  # resp = client.initiate_multipart_upload({
@@ -1643,6 +1944,24 @@ module Aws::Glacier
1643
1944
  #
1644
1945
  # * {Types::InitiateVaultLockOutput#lock_id #lock_id} => String
1645
1946
  #
1947
+ #
1948
+ # @example Example: To initiate the vault locking process
1949
+ #
1950
+ # # The example initiates the vault locking process for the vault named my-vault.
1951
+ #
1952
+ # resp = client.initiate_vault_lock({
1953
+ # account_id: "-",
1954
+ # policy: {
1955
+ # 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\"}}}]}",
1956
+ # },
1957
+ # vault_name: "my-vault",
1958
+ # })
1959
+ #
1960
+ # resp.to_h outputs the following:
1961
+ # {
1962
+ # lock_id: "AE863rKkWZU53SLW5be4DUcW",
1963
+ # }
1964
+ #
1646
1965
  # @example Request syntax with placeholder values
1647
1966
  #
1648
1967
  # resp = client.initiate_vault_lock({
@@ -1750,6 +2069,48 @@ module Aws::Glacier
1750
2069
  # * {Types::ListJobsOutput#job_list #job_list} => Array<Types::GlacierJobDescription>
1751
2070
  # * {Types::ListJobsOutput#marker #marker} => String
1752
2071
  #
2072
+ #
2073
+ # @example Example: To list jobs for a vault
2074
+ #
2075
+ # # The example lists jobs for the vault named my-vault.
2076
+ #
2077
+ # resp = client.list_jobs({
2078
+ # account_id: "-",
2079
+ # vault_name: "my-vault",
2080
+ # })
2081
+ #
2082
+ # resp.to_h outputs the following:
2083
+ # {
2084
+ # job_list: [
2085
+ # {
2086
+ # action: "ArchiveRetrieval",
2087
+ # archive_id: "kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw",
2088
+ # archive_sha256_tree_hash: "9628195fcdbcbbe76cdde932d4646fa7de5f219fb39823836d81f0cc0e18aa67",
2089
+ # archive_size_in_bytes: 3145728,
2090
+ # completed: false,
2091
+ # creation_date: Time.parse("2015-07-17T21:16:13.840Z"),
2092
+ # job_description: "Retrieve archive on 2015-07-17",
2093
+ # job_id: "l7IL5-EkXyEY9Ws95fClzIbk2O5uLYaFdAYOi-azsX_Z8V6NH4yERHzars8wTKYQMX6nBDI9cMNHzyZJO59-8N9aHWav",
2094
+ # retrieval_byte_range: "0-3145727",
2095
+ # sha256_tree_hash: "9628195fcdbcbbe76cdde932d4646fa7de5f219fb39823836d81f0cc0e18aa67",
2096
+ # sns_topic: "arn:aws:sns:us-west-2:0123456789012:my-vault",
2097
+ # status_code: "InProgress",
2098
+ # vault_arn: "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault",
2099
+ # },
2100
+ # {
2101
+ # action: "InventoryRetrieval",
2102
+ # completed: false,
2103
+ # creation_date: Time.parse("2015-07-17T20:23:41.616Z"),
2104
+ # inventory_retrieval_parameters: {
2105
+ # format: "JSON",
2106
+ # },
2107
+ # job_id: "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW",
2108
+ # status_code: "InProgress",
2109
+ # vault_arn: "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault",
2110
+ # },
2111
+ # ],
2112
+ # }
2113
+ #
1753
2114
  # @example Request syntax with placeholder values
1754
2115
  #
1755
2116
  # resp = client.list_jobs({
@@ -1861,6 +2222,44 @@ module Aws::Glacier
1861
2222
  # * {Types::ListMultipartUploadsOutput#uploads_list #uploads_list} => Array<Types::UploadListElement>
1862
2223
  # * {Types::ListMultipartUploadsOutput#marker #marker} => String
1863
2224
  #
2225
+ #
2226
+ # @example Example: To list all the in-progress multipart uploads for a vault
2227
+ #
2228
+ # # The example lists all the in-progress multipart uploads for the vault named examplevault.
2229
+ #
2230
+ # resp = client.list_multipart_uploads({
2231
+ # account_id: "-",
2232
+ # vault_name: "examplevault",
2233
+ # })
2234
+ #
2235
+ # resp.to_h outputs the following:
2236
+ # {
2237
+ # marker: "null",
2238
+ # uploads_list: [
2239
+ # {
2240
+ # archive_description: "archive 1",
2241
+ # creation_date: Time.parse("2012-03-19T23:20:59.130Z"),
2242
+ # multipart_upload_id: "xsQdFIRsfJr20CW2AbZBKpRZAFTZSJIMtL2hYf8mvp8dM0m4RUzlaqoEye6g3h3ecqB_zqwB7zLDMeSWhwo65re4C4Ev",
2243
+ # part_size_in_bytes: 4194304,
2244
+ # vault_arn: "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault",
2245
+ # },
2246
+ # {
2247
+ # archive_description: "archive 2",
2248
+ # creation_date: Time.parse("2012-04-01T15:00:00.000Z"),
2249
+ # multipart_upload_id: "nPyGOnyFcx67qqX7E-0tSGiRi88hHMOwOxR-_jNyM6RjVMFfV29lFqZ3rNsSaWBugg6OP92pRtufeHdQH7ClIpSF6uJc",
2250
+ # part_size_in_bytes: 4194304,
2251
+ # vault_arn: "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault",
2252
+ # },
2253
+ # {
2254
+ # archive_description: "archive 3",
2255
+ # creation_date: Time.parse("2012-03-20T17:03:43.221Z"),
2256
+ # multipart_upload_id: "qt-RBst_7yO8gVIonIBsAxr2t-db0pE4s8MNeGjKjGdNpuU-cdSAcqG62guwV9r5jh5mLyFPzFEitTpNE7iQfHiu1XoV",
2257
+ # part_size_in_bytes: 4194304,
2258
+ # vault_arn: "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault",
2259
+ # },
2260
+ # ],
2261
+ # }
2262
+ #
1864
2263
  # @example Request syntax with placeholder values
1865
2264
  #
1866
2265
  # resp = client.list_multipart_uploads({
@@ -1955,6 +2354,37 @@ module Aws::Glacier
1955
2354
  # * {Types::ListPartsOutput#parts #parts} => Array<Types::PartListElement>
1956
2355
  # * {Types::ListPartsOutput#marker #marker} => String
1957
2356
  #
2357
+ #
2358
+ # @example Example: To list the parts of an archive that have been uploaded in a multipart upload
2359
+ #
2360
+ # # The example lists all the parts of a multipart upload.
2361
+ #
2362
+ # resp = client.list_parts({
2363
+ # account_id: "-",
2364
+ # upload_id: "OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE",
2365
+ # vault_name: "examplevault",
2366
+ # })
2367
+ #
2368
+ # resp.to_h outputs the following:
2369
+ # {
2370
+ # archive_description: "archive description",
2371
+ # creation_date: Time.parse("2012-03-20T17:03:43.221Z"),
2372
+ # marker: "null",
2373
+ # multipart_upload_id: "OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE",
2374
+ # part_size_in_bytes: 4194304,
2375
+ # parts: [
2376
+ # {
2377
+ # range_in_bytes: "0-4194303",
2378
+ # sha256_tree_hash: "01d34dabf7be316472c93b1ef80721f5d4",
2379
+ # },
2380
+ # {
2381
+ # range_in_bytes: "4194304-8388607",
2382
+ # sha256_tree_hash: "0195875365afda349fc21c84c099987164",
2383
+ # },
2384
+ # ],
2385
+ # vault_arn: "arn:aws:glacier:us-west-2:012345678901:vaults/demo1-vault",
2386
+ # }
2387
+ #
1958
2388
  # @example Request syntax with placeholder values
1959
2389
  #
1960
2390
  # resp = client.list_parts({
@@ -1999,6 +2429,31 @@ module Aws::Glacier
1999
2429
  #
2000
2430
  # * {Types::ListProvisionedCapacityOutput#provisioned_capacity_list #provisioned_capacity_list} => Array<Types::ProvisionedCapacityDescription>
2001
2431
  #
2432
+ #
2433
+ # @example Example: To list the provisioned capacity units for an account
2434
+ #
2435
+ # # The example lists the provisioned capacity units for an account.
2436
+ #
2437
+ # resp = client.list_provisioned_capacity({
2438
+ # account_id: "-",
2439
+ # })
2440
+ #
2441
+ # resp.to_h outputs the following:
2442
+ # {
2443
+ # provisioned_capacity_list: [
2444
+ # {
2445
+ # capacity_id: "zSaq7NzHFQDANTfQkDen4V7z",
2446
+ # expiration_date: Time.parse("2016-12-12T00:00:00.000Z"),
2447
+ # start_date: Time.parse("2016-11-11T20:11:51.095Z"),
2448
+ # },
2449
+ # {
2450
+ # capacity_id: "yXaq7NzHFQNADTfQkDen4V7z",
2451
+ # expiration_date: Time.parse("2017-01-15T00:00:00.000Z"),
2452
+ # start_date: Time.parse("2016-12-13T20:11:51.095Z"),
2453
+ # },
2454
+ # ],
2455
+ # }
2456
+ #
2002
2457
  # @example Request syntax with placeholder values
2003
2458
  #
2004
2459
  # resp = client.list_provisioned_capacity({
@@ -2042,6 +2497,24 @@ module Aws::Glacier
2042
2497
  #
2043
2498
  # * {Types::ListTagsForVaultOutput#tags #tags} => Hash<String,String>
2044
2499
  #
2500
+ #
2501
+ # @example Example: To list the tags for a vault
2502
+ #
2503
+ # # The example lists all the tags attached to the vault examplevault.
2504
+ #
2505
+ # resp = client.list_tags_for_vault({
2506
+ # account_id: "-",
2507
+ # vault_name: "examplevault",
2508
+ # })
2509
+ #
2510
+ # resp.to_h outputs the following:
2511
+ # {
2512
+ # tags: {
2513
+ # "date" => "july2015",
2514
+ # "id" => "1234",
2515
+ # },
2516
+ # }
2517
+ #
2045
2518
  # @example Request syntax with placeholder values
2046
2519
  #
2047
2520
  # resp = client.list_tags_for_vault({
@@ -2113,6 +2586,31 @@ module Aws::Glacier
2113
2586
  # * {Types::ListVaultsOutput#vault_list #vault_list} => Array<Types::DescribeVaultOutput>
2114
2587
  # * {Types::ListVaultsOutput#marker #marker} => String
2115
2588
  #
2589
+ #
2590
+ # @example Example: To list all vaults owned by the calling user's account
2591
+ #
2592
+ # # The example lists all vaults owned by the specified AWS account.
2593
+ #
2594
+ # resp = client.list_vaults({
2595
+ # account_id: "-",
2596
+ # limit: ,
2597
+ # marker: "",
2598
+ # })
2599
+ #
2600
+ # resp.to_h outputs the following:
2601
+ # {
2602
+ # vault_list: [
2603
+ # {
2604
+ # creation_date: Time.parse("2015-04-06T21:23:45.708Z"),
2605
+ # last_inventory_date: Time.parse("2015-04-07T00:26:19.028Z"),
2606
+ # number_of_archives: 1,
2607
+ # size_in_bytes: 3178496,
2608
+ # vault_arn: "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault",
2609
+ # vault_name: "my-vault",
2610
+ # },
2611
+ # ],
2612
+ # }
2613
+ #
2116
2614
  # @example Request syntax with placeholder values
2117
2615
  #
2118
2616
  # resp = client.list_vaults({
@@ -2153,6 +2651,20 @@ module Aws::Glacier
2153
2651
  #
2154
2652
  # * {Types::PurchaseProvisionedCapacityOutput#capacity_id #capacity_id} => String
2155
2653
  #
2654
+ #
2655
+ # @example Example: To purchases a provisioned capacity unit for an AWS account
2656
+ #
2657
+ # # The example purchases provisioned capacity unit for an AWS account.
2658
+ #
2659
+ # resp = client.purchase_provisioned_capacity({
2660
+ # account_id: "-",
2661
+ # })
2662
+ #
2663
+ # resp.to_h outputs the following:
2664
+ # {
2665
+ # capacity_id: "zSaq7NzHFQDANTfQkDen4V7z",
2666
+ # }
2667
+ #
2156
2668
  # @example Request syntax with placeholder values
2157
2669
  #
2158
2670
  # resp = client.purchase_provisioned_capacity({
@@ -2195,6 +2707,20 @@ module Aws::Glacier
2195
2707
  #
2196
2708
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2197
2709
  #
2710
+ #
2711
+ # @example Example: To remove tags from a vault
2712
+ #
2713
+ # # The example removes two tags from the vault named examplevault.
2714
+ #
2715
+ # resp = client.remove_tags_from_vault({
2716
+ # tag_keys: [
2717
+ # "examplekey1",
2718
+ # "examplekey2",
2719
+ # ],
2720
+ # account_id: "-",
2721
+ # vault_name: "examplevault",
2722
+ # })
2723
+ #
2198
2724
  # @example Request syntax with placeholder values
2199
2725
  #
2200
2726
  # resp = client.remove_tags_from_vault({
@@ -2238,6 +2764,23 @@ module Aws::Glacier
2238
2764
  #
2239
2765
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2240
2766
  #
2767
+ #
2768
+ # @example Example: To set and then enact a data retrieval policy
2769
+ #
2770
+ # # The example sets and then enacts a data retrieval policy.
2771
+ #
2772
+ # resp = client.set_data_retrieval_policy({
2773
+ # policy: {
2774
+ # rules: [
2775
+ # {
2776
+ # bytes_per_hour: 10737418240,
2777
+ # strategy: "BytesPerHour",
2778
+ # },
2779
+ # ],
2780
+ # },
2781
+ # account_id: "-",
2782
+ # })
2783
+ #
2241
2784
  # @example Request syntax with placeholder values
2242
2785
  #
2243
2786
  # resp = client.set_data_retrieval_policy({
@@ -2288,6 +2831,19 @@ module Aws::Glacier
2288
2831
  #
2289
2832
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2290
2833
  #
2834
+ #
2835
+ # @example Example: To set the access-policy on a vault
2836
+ #
2837
+ # # The example configures an access policy for the vault named examplevault.
2838
+ #
2839
+ # resp = client.set_vault_access_policy({
2840
+ # account_id: "-",
2841
+ # policy: {
2842
+ # 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\"}]}",
2843
+ # },
2844
+ # vault_name: "examplevault",
2845
+ # })
2846
+ #
2291
2847
  # @example Request syntax with placeholder values
2292
2848
  #
2293
2849
  # resp = client.set_vault_access_policy({
@@ -2363,6 +2919,23 @@ module Aws::Glacier
2363
2919
  #
2364
2920
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2365
2921
  #
2922
+ #
2923
+ # @example Example: To configure a vault to post a message to an Amazon SNS topic when jobs complete
2924
+ #
2925
+ # # The example sets the examplevault notification configuration.
2926
+ #
2927
+ # resp = client.set_vault_notifications({
2928
+ # account_id: "-",
2929
+ # vault_name: "examplevault",
2930
+ # vault_notification_config: {
2931
+ # events: [
2932
+ # "ArchiveRetrievalCompleted",
2933
+ # "InventoryRetrievalCompleted",
2934
+ # ],
2935
+ # sns_topic: "arn:aws:sns:us-west-2:012345678901:mytopic",
2936
+ # },
2937
+ # })
2938
+ #
2366
2939
  # @example Request syntax with placeholder values
2367
2940
  #
2368
2941
  # resp = client.set_vault_notifications({
@@ -2454,6 +3027,26 @@ module Aws::Glacier
2454
3027
  # * {Types::ArchiveCreationOutput#checksum #checksum} => String
2455
3028
  # * {Types::ArchiveCreationOutput#archive_id #archive_id} => String
2456
3029
  #
3030
+ #
3031
+ # @example Example: To upload an archive
3032
+ #
3033
+ # # The example adds an archive to a vault.
3034
+ #
3035
+ # resp = client.upload_archive({
3036
+ # account_id: "-",
3037
+ # archive_description: "",
3038
+ # body: "example-data-to-upload",
3039
+ # checksum: "",
3040
+ # vault_name: "my-vault",
3041
+ # })
3042
+ #
3043
+ # resp.to_h outputs the following:
3044
+ # {
3045
+ # archive_id: "kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw",
3046
+ # checksum: "969fb39823836d81f0cc028195fcdbcbbe76cdde932d4646fa7de5f21e18aa67",
3047
+ # location: "/0123456789012/vaults/my-vault/archives/kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw",
3048
+ # }
3049
+ #
2457
3050
  # @example Request syntax with placeholder values
2458
3051
  #
2459
3052
  # resp = client.upload_archive({
@@ -2563,6 +3156,25 @@ module Aws::Glacier
2563
3156
  #
2564
3157
  # * {Types::UploadMultipartPartOutput#checksum #checksum} => String
2565
3158
  #
3159
+ #
3160
+ # @example Example: To upload the first part of an archive
3161
+ #
3162
+ # # The example uploads the first 1 MiB (1024 x 1024 bytes) part of an archive.
3163
+ #
3164
+ # resp = client.upload_multipart_part({
3165
+ # account_id: "-",
3166
+ # body: "part1",
3167
+ # checksum: "c06f7cd4baacb087002a99a5f48bf953",
3168
+ # range: "bytes 0-1048575/*",
3169
+ # upload_id: "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ",
3170
+ # vault_name: "examplevault",
3171
+ # })
3172
+ #
3173
+ # resp.to_h outputs the following:
3174
+ # {
3175
+ # checksum: "c06f7cd4baacb087002a99a5f48bf953",
3176
+ # }
3177
+ #
2566
3178
  # @example Request syntax with placeholder values
2567
3179
  #
2568
3180
  # resp = client.upload_multipart_part({
@@ -2598,7 +3210,7 @@ module Aws::Glacier
2598
3210
  params: params,
2599
3211
  config: config)
2600
3212
  context[:gem_name] = 'aws-sdk-glacier'
2601
- context[:gem_version] = '1.0.0.rc5'
3213
+ context[:gem_version] = '1.0.0.rc6'
2602
3214
  Seahorse::Client::Request.new(handlers, context)
2603
3215
  end
2604
3216
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-glacier
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0.rc5
4
+ version: 1.0.0.rc6
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2017-05-23 00:00:00.000000000 Z
11
+ date: 2017-06-29 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -16,14 +16,14 @@ dependencies:
16
16
  requirements:
17
17
  - - "~>"
18
18
  - !ruby/object:Gem::Version
19
- version: 3.0.0.rc12
19
+ version: 3.0.0.rc14
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
- version: 3.0.0.rc12
26
+ version: 3.0.0.rc14
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: aws-sigv4
29
29
  requirement: !ruby/object:Gem::Requirement