aws-sdk-s3 1.0.0.rc9 → 1.0.0.rc10
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-s3.rb +1 -1
- data/lib/aws-sdk-s3/client.rb +1499 -1
- metadata +6 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9941d7a77941656ac28b295b635c88764738d627
|
4
|
+
data.tar.gz: 89ab8918779f593a41059cf81ac4b28b0bd06c28
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ac3d2334fa35831ebb7b8eeb83bf93a35ee7b396142736ee3af7939bc7b6c09e6692163afb861e17798a46d10145b8e3bc47517b01a7906e5bdd674abaea8ada
|
7
|
+
data.tar.gz: 8ebafa71ce04d89702baa25ac2b72f1cdb9b337d7427c7d1897c39c541390b1014a28961d10f7e94b077c428900b4b30b65dd89889f67c097286edec3790ba8c
|
data/lib/aws-sdk-s3.rb
CHANGED
data/lib/aws-sdk-s3/client.rb
CHANGED
@@ -222,6 +222,21 @@ module Aws::S3
|
|
222
222
|
#
|
223
223
|
# * {Types::AbortMultipartUploadOutput#request_charged #request_charged} => String
|
224
224
|
#
|
225
|
+
#
|
226
|
+
# @example Example: To abort a multipart upload
|
227
|
+
#
|
228
|
+
# # The following example aborts a multipart upload.
|
229
|
+
#
|
230
|
+
# resp = client.abort_multipart_upload({
|
231
|
+
# bucket: "examplebucket",
|
232
|
+
# key: "bigobject",
|
233
|
+
# upload_id: "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--",
|
234
|
+
# })
|
235
|
+
#
|
236
|
+
# resp.to_h outputs the following:
|
237
|
+
# {
|
238
|
+
# }
|
239
|
+
#
|
225
240
|
# @example Request syntax with placeholder values
|
226
241
|
#
|
227
242
|
# resp = client.abort_multipart_upload({
|
@@ -273,6 +288,37 @@ module Aws::S3
|
|
273
288
|
# * {Types::CompleteMultipartUploadOutput#ssekms_key_id #ssekms_key_id} => String
|
274
289
|
# * {Types::CompleteMultipartUploadOutput#request_charged #request_charged} => String
|
275
290
|
#
|
291
|
+
#
|
292
|
+
# @example Example: To complete multipart upload
|
293
|
+
#
|
294
|
+
# # The following example completes a multipart upload.
|
295
|
+
#
|
296
|
+
# resp = client.complete_multipart_upload({
|
297
|
+
# bucket: "examplebucket",
|
298
|
+
# key: "bigobject",
|
299
|
+
# multipart_upload: {
|
300
|
+
# parts: [
|
301
|
+
# {
|
302
|
+
# etag: "\"d8c2eafd90c266e19ab9dcacc479f8af\"",
|
303
|
+
# part_number: 1,
|
304
|
+
# },
|
305
|
+
# {
|
306
|
+
# etag: "\"d8c2eafd90c266e19ab9dcacc479f8af\"",
|
307
|
+
# part_number: 2,
|
308
|
+
# },
|
309
|
+
# ],
|
310
|
+
# },
|
311
|
+
# upload_id: "7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--",
|
312
|
+
# })
|
313
|
+
#
|
314
|
+
# resp.to_h outputs the following:
|
315
|
+
# {
|
316
|
+
# bucket: "acexamplebucket",
|
317
|
+
# etag: "\"4d9031c7644d8081c2829f4ea23c55f7-2\"",
|
318
|
+
# key: "bigobject",
|
319
|
+
# location: "https://examplebucket.s3.amazonaws.com/bigobject",
|
320
|
+
# }
|
321
|
+
#
|
276
322
|
# @example Request syntax with placeholder values
|
277
323
|
#
|
278
324
|
# resp = client.complete_multipart_upload({
|
@@ -455,6 +501,25 @@ module Aws::S3
|
|
455
501
|
# * {Types::CopyObjectOutput#ssekms_key_id #ssekms_key_id} => String
|
456
502
|
# * {Types::CopyObjectOutput#request_charged #request_charged} => String
|
457
503
|
#
|
504
|
+
#
|
505
|
+
# @example Example: To copy an object
|
506
|
+
#
|
507
|
+
# # The following example copies an object from one bucket to another.
|
508
|
+
#
|
509
|
+
# resp = client.copy_object({
|
510
|
+
# bucket: "destinationbucket",
|
511
|
+
# copy_source: "/sourcebucket/HappyFacejpg",
|
512
|
+
# key: "HappyFaceCopyjpg",
|
513
|
+
# })
|
514
|
+
#
|
515
|
+
# resp.to_h outputs the following:
|
516
|
+
# {
|
517
|
+
# copy_object_result: {
|
518
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
519
|
+
# last_modified: Time.parse("2016-12-15T17:38:53.000Z"),
|
520
|
+
# },
|
521
|
+
# }
|
522
|
+
#
|
458
523
|
# @example Request syntax with placeholder values
|
459
524
|
#
|
460
525
|
# resp = client.copy_object({
|
@@ -547,6 +612,36 @@ module Aws::S3
|
|
547
612
|
#
|
548
613
|
# * {Types::CreateBucketOutput#location #location} => String
|
549
614
|
#
|
615
|
+
#
|
616
|
+
# @example Example: To create a bucket in a specific region
|
617
|
+
#
|
618
|
+
# # The following example creates a bucket. The request specifies an AWS region where to create the bucket.
|
619
|
+
#
|
620
|
+
# resp = client.create_bucket({
|
621
|
+
# bucket: "examplebucket",
|
622
|
+
# create_bucket_configuration: {
|
623
|
+
# location_constraint: "eu-west-1",
|
624
|
+
# },
|
625
|
+
# })
|
626
|
+
#
|
627
|
+
# resp.to_h outputs the following:
|
628
|
+
# {
|
629
|
+
# location: "http://examplebucket.s3.amazonaws.com/",
|
630
|
+
# }
|
631
|
+
#
|
632
|
+
# @example Example: To create a bucket
|
633
|
+
#
|
634
|
+
# # The following example creates a bucket.
|
635
|
+
#
|
636
|
+
# resp = client.create_bucket({
|
637
|
+
# bucket: "examplebucket",
|
638
|
+
# })
|
639
|
+
#
|
640
|
+
# resp.to_h outputs the following:
|
641
|
+
# {
|
642
|
+
# location: "/examplebucket",
|
643
|
+
# }
|
644
|
+
#
|
550
645
|
# @example Request syntax with placeholder values
|
551
646
|
#
|
552
647
|
# resp = client.create_bucket({
|
@@ -681,6 +776,23 @@ module Aws::S3
|
|
681
776
|
# * {Types::CreateMultipartUploadOutput#ssekms_key_id #ssekms_key_id} => String
|
682
777
|
# * {Types::CreateMultipartUploadOutput#request_charged #request_charged} => String
|
683
778
|
#
|
779
|
+
#
|
780
|
+
# @example Example: To initiate a multipart upload
|
781
|
+
#
|
782
|
+
# # The following example initiates a multipart upload.
|
783
|
+
#
|
784
|
+
# resp = client.create_multipart_upload({
|
785
|
+
# bucket: "examplebucket",
|
786
|
+
# key: "largeobject",
|
787
|
+
# })
|
788
|
+
#
|
789
|
+
# resp.to_h outputs the following:
|
790
|
+
# {
|
791
|
+
# bucket: "examplebucket",
|
792
|
+
# key: "largeobject",
|
793
|
+
# upload_id: "ibZBv_75gd9r8lH_gqXatLdxMVpAlj6ZQjEs.OwyF3953YdwbcQnMA2BLGn8Lx12fQNICtMw5KyteFeHw.Sjng--",
|
794
|
+
# }
|
795
|
+
#
|
684
796
|
# @example Request syntax with placeholder values
|
685
797
|
#
|
686
798
|
# resp = client.create_multipart_upload({
|
@@ -740,6 +852,15 @@ module Aws::S3
|
|
740
852
|
#
|
741
853
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
742
854
|
#
|
855
|
+
#
|
856
|
+
# @example Example: To delete a bucket
|
857
|
+
#
|
858
|
+
# # The following example deletes the specified bucket.
|
859
|
+
#
|
860
|
+
# resp = client.delete_bucket({
|
861
|
+
# bucket: "forrandall2",
|
862
|
+
# })
|
863
|
+
#
|
743
864
|
# @example Request syntax with placeholder values
|
744
865
|
#
|
745
866
|
# resp = client.delete_bucket({
|
@@ -789,6 +910,15 @@ module Aws::S3
|
|
789
910
|
#
|
790
911
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
791
912
|
#
|
913
|
+
#
|
914
|
+
# @example Example: To delete cors configuration on a bucket.
|
915
|
+
#
|
916
|
+
# # The following example deletes CORS configuration on a bucket.
|
917
|
+
#
|
918
|
+
# resp = client.delete_bucket_cors({
|
919
|
+
# bucket: "examplebucket",
|
920
|
+
# })
|
921
|
+
#
|
792
922
|
# @example Request syntax with placeholder values
|
793
923
|
#
|
794
924
|
# resp = client.delete_bucket_cors({
|
@@ -838,6 +968,15 @@ module Aws::S3
|
|
838
968
|
#
|
839
969
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
840
970
|
#
|
971
|
+
#
|
972
|
+
# @example Example: To delete lifecycle configuration on a bucket.
|
973
|
+
#
|
974
|
+
# # The following example deletes lifecycle configuration on a bucket.
|
975
|
+
#
|
976
|
+
# resp = client.delete_bucket_lifecycle({
|
977
|
+
# bucket: "examplebucket",
|
978
|
+
# })
|
979
|
+
#
|
841
980
|
# @example Request syntax with placeholder values
|
842
981
|
#
|
843
982
|
# resp = client.delete_bucket_lifecycle({
|
@@ -886,6 +1025,15 @@ module Aws::S3
|
|
886
1025
|
#
|
887
1026
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
888
1027
|
#
|
1028
|
+
#
|
1029
|
+
# @example Example: To delete bucket policy
|
1030
|
+
#
|
1031
|
+
# # The following example deletes bucket policy on the specified bucket.
|
1032
|
+
#
|
1033
|
+
# resp = client.delete_bucket_policy({
|
1034
|
+
# bucket: "examplebucket",
|
1035
|
+
# })
|
1036
|
+
#
|
889
1037
|
# @example Request syntax with placeholder values
|
890
1038
|
#
|
891
1039
|
# resp = client.delete_bucket_policy({
|
@@ -907,6 +1055,15 @@ module Aws::S3
|
|
907
1055
|
#
|
908
1056
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
909
1057
|
#
|
1058
|
+
#
|
1059
|
+
# @example Example: To delete bucket replication configuration
|
1060
|
+
#
|
1061
|
+
# # The following example deletes replication configuration set on bucket.
|
1062
|
+
#
|
1063
|
+
# resp = client.delete_bucket_replication({
|
1064
|
+
# bucket: "example",
|
1065
|
+
# })
|
1066
|
+
#
|
910
1067
|
# @example Request syntax with placeholder values
|
911
1068
|
#
|
912
1069
|
# resp = client.delete_bucket_replication({
|
@@ -928,6 +1085,15 @@ module Aws::S3
|
|
928
1085
|
#
|
929
1086
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
930
1087
|
#
|
1088
|
+
#
|
1089
|
+
# @example Example: To delete bucket tags
|
1090
|
+
#
|
1091
|
+
# # The following example deletes bucket tags.
|
1092
|
+
#
|
1093
|
+
# resp = client.delete_bucket_tagging({
|
1094
|
+
# bucket: "examplebucket",
|
1095
|
+
# })
|
1096
|
+
#
|
931
1097
|
# @example Request syntax with placeholder values
|
932
1098
|
#
|
933
1099
|
# resp = client.delete_bucket_tagging({
|
@@ -949,6 +1115,15 @@ module Aws::S3
|
|
949
1115
|
#
|
950
1116
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
951
1117
|
#
|
1118
|
+
#
|
1119
|
+
# @example Example: To delete bucket website configuration
|
1120
|
+
#
|
1121
|
+
# # The following example deletes bucket website configuration.
|
1122
|
+
#
|
1123
|
+
# resp = client.delete_bucket_website({
|
1124
|
+
# bucket: "examplebucket",
|
1125
|
+
# })
|
1126
|
+
#
|
952
1127
|
# @example Request syntax with placeholder values
|
953
1128
|
#
|
954
1129
|
# resp = client.delete_bucket_website({
|
@@ -992,6 +1167,29 @@ module Aws::S3
|
|
992
1167
|
# * {Types::DeleteObjectOutput#version_id #version_id} => String
|
993
1168
|
# * {Types::DeleteObjectOutput#request_charged #request_charged} => String
|
994
1169
|
#
|
1170
|
+
#
|
1171
|
+
# @example Example: To delete an object (from a non-versioned bucket)
|
1172
|
+
#
|
1173
|
+
# # The following example deletes an object from a non-versioned bucket.
|
1174
|
+
#
|
1175
|
+
# resp = client.delete_object({
|
1176
|
+
# bucket: "ExampleBucket",
|
1177
|
+
# key: "HappyFace.jpg",
|
1178
|
+
# })
|
1179
|
+
#
|
1180
|
+
# @example Example: To delete an object
|
1181
|
+
#
|
1182
|
+
# # The following example deletes an object from an S3 bucket.
|
1183
|
+
#
|
1184
|
+
# resp = client.delete_object({
|
1185
|
+
# bucket: "examplebucket",
|
1186
|
+
# key: "objectkey.jpg",
|
1187
|
+
# })
|
1188
|
+
#
|
1189
|
+
# resp.to_h outputs the following:
|
1190
|
+
# {
|
1191
|
+
# }
|
1192
|
+
#
|
995
1193
|
# @example Request syntax with placeholder values
|
996
1194
|
#
|
997
1195
|
# resp = client.delete_object({
|
@@ -1030,6 +1228,36 @@ module Aws::S3
|
|
1030
1228
|
#
|
1031
1229
|
# * {Types::DeleteObjectTaggingOutput#version_id #version_id} => String
|
1032
1230
|
#
|
1231
|
+
#
|
1232
|
+
# @example Example: To remove tag set from an object version
|
1233
|
+
#
|
1234
|
+
# # The following example removes tag set associated with the specified object version. The request specifies both the object key and object version.
|
1235
|
+
#
|
1236
|
+
# resp = client.delete_object_tagging({
|
1237
|
+
# bucket: "examplebucket",
|
1238
|
+
# key: "HappyFace.jpg",
|
1239
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
1240
|
+
# })
|
1241
|
+
#
|
1242
|
+
# resp.to_h outputs the following:
|
1243
|
+
# {
|
1244
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
1245
|
+
# }
|
1246
|
+
#
|
1247
|
+
# @example Example: To remove tag set from an object
|
1248
|
+
#
|
1249
|
+
# # The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the operation removes tag set from the latest object version.
|
1250
|
+
#
|
1251
|
+
# resp = client.delete_object_tagging({
|
1252
|
+
# bucket: "examplebucket",
|
1253
|
+
# key: "HappyFace.jpg",
|
1254
|
+
# })
|
1255
|
+
#
|
1256
|
+
# resp.to_h outputs the following:
|
1257
|
+
# {
|
1258
|
+
# version_id: "null",
|
1259
|
+
# }
|
1260
|
+
#
|
1033
1261
|
# @example Request syntax with placeholder values
|
1034
1262
|
#
|
1035
1263
|
# resp = client.delete_object_tagging({
|
@@ -1075,6 +1303,77 @@ module Aws::S3
|
|
1075
1303
|
# * {Types::DeleteObjectsOutput#request_charged #request_charged} => String
|
1076
1304
|
# * {Types::DeleteObjectsOutput#errors #errors} => Array<Types::Error>
|
1077
1305
|
#
|
1306
|
+
#
|
1307
|
+
# @example Example: To delete multiple object versions from a versioned bucket
|
1308
|
+
#
|
1309
|
+
# # The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object versions and returns the key and versions of deleted objects in the response.
|
1310
|
+
#
|
1311
|
+
# resp = client.delete_objects({
|
1312
|
+
# bucket: "examplebucket",
|
1313
|
+
# delete: {
|
1314
|
+
# objects: [
|
1315
|
+
# {
|
1316
|
+
# key: "HappyFace.jpg",
|
1317
|
+
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
1318
|
+
# },
|
1319
|
+
# {
|
1320
|
+
# key: "HappyFace.jpg",
|
1321
|
+
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
1322
|
+
# },
|
1323
|
+
# ],
|
1324
|
+
# quiet: false,
|
1325
|
+
# },
|
1326
|
+
# })
|
1327
|
+
#
|
1328
|
+
# resp.to_h outputs the following:
|
1329
|
+
# {
|
1330
|
+
# deleted: [
|
1331
|
+
# {
|
1332
|
+
# key: "HappyFace.jpg",
|
1333
|
+
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
1334
|
+
# },
|
1335
|
+
# {
|
1336
|
+
# key: "HappyFace.jpg",
|
1337
|
+
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
1338
|
+
# },
|
1339
|
+
# ],
|
1340
|
+
# }
|
1341
|
+
#
|
1342
|
+
# @example Example: To delete multiple objects from a versioned bucket
|
1343
|
+
#
|
1344
|
+
# # The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.
|
1345
|
+
#
|
1346
|
+
# resp = client.delete_objects({
|
1347
|
+
# bucket: "examplebucket",
|
1348
|
+
# delete: {
|
1349
|
+
# objects: [
|
1350
|
+
# {
|
1351
|
+
# key: "objectkey1",
|
1352
|
+
# },
|
1353
|
+
# {
|
1354
|
+
# key: "objectkey2",
|
1355
|
+
# },
|
1356
|
+
# ],
|
1357
|
+
# quiet: false,
|
1358
|
+
# },
|
1359
|
+
# })
|
1360
|
+
#
|
1361
|
+
# resp.to_h outputs the following:
|
1362
|
+
# {
|
1363
|
+
# deleted: [
|
1364
|
+
# {
|
1365
|
+
# delete_marker: true,
|
1366
|
+
# delete_marker_version_id: "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
|
1367
|
+
# key: "objectkey1",
|
1368
|
+
# },
|
1369
|
+
# {
|
1370
|
+
# delete_marker: true,
|
1371
|
+
# delete_marker_version_id: "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
|
1372
|
+
# key: "objectkey2",
|
1373
|
+
# },
|
1374
|
+
# ],
|
1375
|
+
# }
|
1376
|
+
#
|
1078
1377
|
# @example Request syntax with placeholder values
|
1079
1378
|
#
|
1080
1379
|
# resp = client.delete_objects({
|
@@ -1234,6 +1533,33 @@ module Aws::S3
|
|
1234
1533
|
#
|
1235
1534
|
# * {Types::GetBucketCorsOutput#cors_rules #cors_rules} => Array<Types::CORSRule>
|
1236
1535
|
#
|
1536
|
+
#
|
1537
|
+
# @example Example: To get cors configuration set on a bucket
|
1538
|
+
#
|
1539
|
+
# # The following example returns cross-origin resource sharing (CORS) configuration set on a bucket.
|
1540
|
+
#
|
1541
|
+
# resp = client.get_bucket_cors({
|
1542
|
+
# bucket: "examplebucket",
|
1543
|
+
# })
|
1544
|
+
#
|
1545
|
+
# resp.to_h outputs the following:
|
1546
|
+
# {
|
1547
|
+
# cors_rules: [
|
1548
|
+
# {
|
1549
|
+
# allowed_headers: [
|
1550
|
+
# "Authorization",
|
1551
|
+
# ],
|
1552
|
+
# allowed_methods: [
|
1553
|
+
# "GET",
|
1554
|
+
# ],
|
1555
|
+
# allowed_origins: [
|
1556
|
+
# "*",
|
1557
|
+
# ],
|
1558
|
+
# max_age_seconds: 3000,
|
1559
|
+
# },
|
1560
|
+
# ],
|
1561
|
+
# }
|
1562
|
+
#
|
1237
1563
|
# @example Request syntax with placeholder values
|
1238
1564
|
#
|
1239
1565
|
# resp = client.get_bucket_cors({
|
@@ -1314,6 +1640,29 @@ module Aws::S3
|
|
1314
1640
|
#
|
1315
1641
|
# * {Types::GetBucketLifecycleOutput#rules #rules} => Array<Types::Rule>
|
1316
1642
|
#
|
1643
|
+
#
|
1644
|
+
# @example Example: To get a bucket acl
|
1645
|
+
#
|
1646
|
+
# # The following example gets ACL on the specified bucket.
|
1647
|
+
#
|
1648
|
+
# resp = client.get_bucket_lifecycle({
|
1649
|
+
# bucket: "acl1",
|
1650
|
+
# })
|
1651
|
+
#
|
1652
|
+
# resp.to_h outputs the following:
|
1653
|
+
# {
|
1654
|
+
# rules: [
|
1655
|
+
# {
|
1656
|
+
# expiration: {
|
1657
|
+
# days: 1,
|
1658
|
+
# },
|
1659
|
+
# id: "delete logs",
|
1660
|
+
# prefix: "123/",
|
1661
|
+
# status: "Enabled",
|
1662
|
+
# },
|
1663
|
+
# ],
|
1664
|
+
# }
|
1665
|
+
#
|
1317
1666
|
# @example Request syntax with placeholder values
|
1318
1667
|
#
|
1319
1668
|
# resp = client.get_bucket_lifecycle({
|
@@ -1354,6 +1703,32 @@ module Aws::S3
|
|
1354
1703
|
#
|
1355
1704
|
# * {Types::GetBucketLifecycleConfigurationOutput#rules #rules} => Array<Types::LifecycleRule>
|
1356
1705
|
#
|
1706
|
+
#
|
1707
|
+
# @example Example: To get lifecycle configuration on a bucket
|
1708
|
+
#
|
1709
|
+
# # The following example retrieves lifecycle configuration on set on a bucket.
|
1710
|
+
#
|
1711
|
+
# resp = client.get_bucket_lifecycle_configuration({
|
1712
|
+
# bucket: "examplebucket",
|
1713
|
+
# })
|
1714
|
+
#
|
1715
|
+
# resp.to_h outputs the following:
|
1716
|
+
# {
|
1717
|
+
# rules: [
|
1718
|
+
# {
|
1719
|
+
# id: "Rule for TaxDocs/",
|
1720
|
+
# prefix: "TaxDocs",
|
1721
|
+
# status: "Enabled",
|
1722
|
+
# transitions: [
|
1723
|
+
# {
|
1724
|
+
# days: 365,
|
1725
|
+
# storage_class: "STANDARD_IA",
|
1726
|
+
# },
|
1727
|
+
# ],
|
1728
|
+
# },
|
1729
|
+
# ],
|
1730
|
+
# }
|
1731
|
+
#
|
1357
1732
|
# @example Request syntax with placeholder values
|
1358
1733
|
#
|
1359
1734
|
# resp = client.get_bucket_lifecycle_configuration({
|
@@ -1403,6 +1778,20 @@ module Aws::S3
|
|
1403
1778
|
#
|
1404
1779
|
# * {Types::GetBucketLocationOutput#location_constraint #location_constraint} => String
|
1405
1780
|
#
|
1781
|
+
#
|
1782
|
+
# @example Example: To get bucket location
|
1783
|
+
#
|
1784
|
+
# # The following example returns bucket location.
|
1785
|
+
#
|
1786
|
+
# resp = client.get_bucket_location({
|
1787
|
+
# bucket: "examplebucket",
|
1788
|
+
# })
|
1789
|
+
#
|
1790
|
+
# resp.to_h outputs the following:
|
1791
|
+
# {
|
1792
|
+
# location_constraint: "us-west-2",
|
1793
|
+
# }
|
1794
|
+
#
|
1406
1795
|
# @example Request syntax with placeholder values
|
1407
1796
|
#
|
1408
1797
|
# resp = client.get_bucket_location({
|
@@ -1511,6 +1900,63 @@ module Aws::S3
|
|
1511
1900
|
# * {Types::NotificationConfigurationDeprecated#queue_configuration #queue_configuration} => Types::QueueConfigurationDeprecated
|
1512
1901
|
# * {Types::NotificationConfigurationDeprecated#cloud_function_configuration #cloud_function_configuration} => Types::CloudFunctionConfiguration
|
1513
1902
|
#
|
1903
|
+
#
|
1904
|
+
# @example Example: To get notification configuration set on a bucket
|
1905
|
+
#
|
1906
|
+
# # The following example returns notification configuration set on a bucket.
|
1907
|
+
#
|
1908
|
+
# resp = client.get_bucket_notification({
|
1909
|
+
# bucket: "examplebucket",
|
1910
|
+
# })
|
1911
|
+
#
|
1912
|
+
# resp.to_h outputs the following:
|
1913
|
+
# {
|
1914
|
+
# queue_configuration: {
|
1915
|
+
# event: "s3:ObjectCreated:Put",
|
1916
|
+
# events: [
|
1917
|
+
# "s3:ObjectCreated:Put",
|
1918
|
+
# ],
|
1919
|
+
# id: "MDQ2OGQ4NDEtOTBmNi00YTM4LTk0NzYtZDIwN2I3NWQ1NjIx",
|
1920
|
+
# queue: "arn:aws:sqs:us-east-1:acct-id:S3ObjectCreatedEventQueue",
|
1921
|
+
# },
|
1922
|
+
# topic_configuration: {
|
1923
|
+
# event: "s3:ObjectCreated:Copy",
|
1924
|
+
# events: [
|
1925
|
+
# "s3:ObjectCreated:Copy",
|
1926
|
+
# ],
|
1927
|
+
# id: "YTVkMWEzZGUtNTY1NS00ZmE2LWJjYjktMmRlY2QwODFkNTJi",
|
1928
|
+
# topic: "arn:aws:sns:us-east-1:acct-id:S3ObjectCreatedEventTopic",
|
1929
|
+
# },
|
1930
|
+
# }
|
1931
|
+
#
|
1932
|
+
# @example Example: To get notification configuration set on a bucket
|
1933
|
+
#
|
1934
|
+
# # The following example returns notification configuration set on a bucket.
|
1935
|
+
#
|
1936
|
+
# resp = client.get_bucket_notification({
|
1937
|
+
# bucket: "examplebucket",
|
1938
|
+
# })
|
1939
|
+
#
|
1940
|
+
# resp.to_h outputs the following:
|
1941
|
+
# {
|
1942
|
+
# queue_configuration: {
|
1943
|
+
# event: "s3:ObjectCreated:Put",
|
1944
|
+
# events: [
|
1945
|
+
# "s3:ObjectCreated:Put",
|
1946
|
+
# ],
|
1947
|
+
# id: "MDQ2OGQ4NDEtOTBmNi00YTM4LTk0NzYtZDIwN2I3NWQ1NjIx",
|
1948
|
+
# queue: "arn:aws:sqs:us-east-1:acct-id:S3ObjectCreatedEventQueue",
|
1949
|
+
# },
|
1950
|
+
# topic_configuration: {
|
1951
|
+
# event: "s3:ObjectCreated:Copy",
|
1952
|
+
# events: [
|
1953
|
+
# "s3:ObjectCreated:Copy",
|
1954
|
+
# ],
|
1955
|
+
# id: "YTVkMWEzZGUtNTY1NS00ZmE2LWJjYjktMmRlY2QwODFkNTJi",
|
1956
|
+
# topic: "arn:aws:sns:us-east-1:acct-id:S3ObjectCreatedEventTopic",
|
1957
|
+
# },
|
1958
|
+
# }
|
1959
|
+
#
|
1514
1960
|
# @example Request syntax with placeholder values
|
1515
1961
|
#
|
1516
1962
|
# resp = client.get_bucket_notification({
|
@@ -1606,6 +2052,20 @@ module Aws::S3
|
|
1606
2052
|
#
|
1607
2053
|
# * {Types::GetBucketPolicyOutput#policy #policy} => IO
|
1608
2054
|
#
|
2055
|
+
#
|
2056
|
+
# @example Example: To get bucket policy
|
2057
|
+
#
|
2058
|
+
# # The following example returns bucket policy associated with a bucket.
|
2059
|
+
#
|
2060
|
+
# resp = client.get_bucket_policy({
|
2061
|
+
# bucket: "examplebucket",
|
2062
|
+
# })
|
2063
|
+
#
|
2064
|
+
# resp.to_h outputs the following:
|
2065
|
+
# {
|
2066
|
+
# policy: "{\"Version\":\"2008-10-17\",\"Id\":\"LogPolicy\",\"Statement\":[{\"Sid\":\"Enables the log delivery group to publish logs to your bucket \",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"111122223333\"},\"Action\":[\"s3:GetBucketAcl\",\"s3:GetObjectAcl\",\"s3:PutObject\"],\"Resource\":[\"arn:aws:s3:::policytest1/*\",\"arn:aws:s3:::policytest1\"]}]}",
|
2067
|
+
# }
|
2068
|
+
#
|
1609
2069
|
# @example Request syntax with placeholder values
|
1610
2070
|
#
|
1611
2071
|
# resp = client.get_bucket_policy({
|
@@ -1633,6 +2093,32 @@ module Aws::S3
|
|
1633
2093
|
#
|
1634
2094
|
# * {Types::GetBucketReplicationOutput#replication_configuration #replication_configuration} => Types::ReplicationConfiguration
|
1635
2095
|
#
|
2096
|
+
#
|
2097
|
+
# @example Example: To get replication configuration set on a bucket
|
2098
|
+
#
|
2099
|
+
# # The following example returns replication configuration set on a bucket.
|
2100
|
+
#
|
2101
|
+
# resp = client.get_bucket_replication({
|
2102
|
+
# bucket: "examplebucket",
|
2103
|
+
# })
|
2104
|
+
#
|
2105
|
+
# resp.to_h outputs the following:
|
2106
|
+
# {
|
2107
|
+
# replication_configuration: {
|
2108
|
+
# role: "arn:aws:iam::acct-id:role/example-role",
|
2109
|
+
# rules: [
|
2110
|
+
# {
|
2111
|
+
# destination: {
|
2112
|
+
# bucket: "arn:aws:s3:::destination-bucket",
|
2113
|
+
# },
|
2114
|
+
# id: "MWIwNTkwZmItMTE3MS00ZTc3LWJkZDEtNzRmODQwYzc1OTQy",
|
2115
|
+
# prefix: "Tax",
|
2116
|
+
# status: "Enabled",
|
2117
|
+
# },
|
2118
|
+
# ],
|
2119
|
+
# },
|
2120
|
+
# }
|
2121
|
+
#
|
1636
2122
|
# @example Request syntax with placeholder values
|
1637
2123
|
#
|
1638
2124
|
# resp = client.get_bucket_replication({
|
@@ -1666,6 +2152,20 @@ module Aws::S3
|
|
1666
2152
|
#
|
1667
2153
|
# * {Types::GetBucketRequestPaymentOutput#payer #payer} => String
|
1668
2154
|
#
|
2155
|
+
#
|
2156
|
+
# @example Example: To get bucket versioning configuration
|
2157
|
+
#
|
2158
|
+
# # The following example retrieves bucket versioning configuration.
|
2159
|
+
#
|
2160
|
+
# resp = client.get_bucket_request_payment({
|
2161
|
+
# bucket: "examplebucket",
|
2162
|
+
# })
|
2163
|
+
#
|
2164
|
+
# resp.to_h outputs the following:
|
2165
|
+
# {
|
2166
|
+
# payer: "BucketOwner",
|
2167
|
+
# }
|
2168
|
+
#
|
1669
2169
|
# @example Request syntax with placeholder values
|
1670
2170
|
#
|
1671
2171
|
# resp = client.get_bucket_request_payment({
|
@@ -1693,6 +2193,29 @@ module Aws::S3
|
|
1693
2193
|
#
|
1694
2194
|
# * {Types::GetBucketTaggingOutput#tag_set #tag_set} => Array<Types::Tag>
|
1695
2195
|
#
|
2196
|
+
#
|
2197
|
+
# @example Example: To get tag set associated with a bucket
|
2198
|
+
#
|
2199
|
+
# # The following example returns tag set associated with a bucket
|
2200
|
+
#
|
2201
|
+
# resp = client.get_bucket_tagging({
|
2202
|
+
# bucket: "examplebucket",
|
2203
|
+
# })
|
2204
|
+
#
|
2205
|
+
# resp.to_h outputs the following:
|
2206
|
+
# {
|
2207
|
+
# tag_set: [
|
2208
|
+
# {
|
2209
|
+
# key: "key1",
|
2210
|
+
# value: "value1",
|
2211
|
+
# },
|
2212
|
+
# {
|
2213
|
+
# key: "key2",
|
2214
|
+
# value: "value2",
|
2215
|
+
# },
|
2216
|
+
# ],
|
2217
|
+
# }
|
2218
|
+
#
|
1696
2219
|
# @example Request syntax with placeholder values
|
1697
2220
|
#
|
1698
2221
|
# resp = client.get_bucket_tagging({
|
@@ -1723,6 +2246,21 @@ module Aws::S3
|
|
1723
2246
|
# * {Types::GetBucketVersioningOutput#status #status} => String
|
1724
2247
|
# * {Types::GetBucketVersioningOutput#mfa_delete #mfa_delete} => String
|
1725
2248
|
#
|
2249
|
+
#
|
2250
|
+
# @example Example: To get bucket versioning configuration
|
2251
|
+
#
|
2252
|
+
# # The following example retrieves bucket versioning configuration.
|
2253
|
+
#
|
2254
|
+
# resp = client.get_bucket_versioning({
|
2255
|
+
# bucket: "examplebucket",
|
2256
|
+
# })
|
2257
|
+
#
|
2258
|
+
# resp.to_h outputs the following:
|
2259
|
+
# {
|
2260
|
+
# mfa_delete: "Disabled",
|
2261
|
+
# status: "Enabled",
|
2262
|
+
# }
|
2263
|
+
#
|
1726
2264
|
# @example Request syntax with placeholder values
|
1727
2265
|
#
|
1728
2266
|
# resp = client.get_bucket_versioning({
|
@@ -1754,6 +2292,25 @@ module Aws::S3
|
|
1754
2292
|
# * {Types::GetBucketWebsiteOutput#error_document #error_document} => Types::ErrorDocument
|
1755
2293
|
# * {Types::GetBucketWebsiteOutput#routing_rules #routing_rules} => Array<Types::RoutingRule>
|
1756
2294
|
#
|
2295
|
+
#
|
2296
|
+
# @example Example: To get bucket website configuration
|
2297
|
+
#
|
2298
|
+
# # The following example retrieves website configuration of a bucket.
|
2299
|
+
#
|
2300
|
+
# resp = client.get_bucket_website({
|
2301
|
+
# bucket: "examplebucket",
|
2302
|
+
# })
|
2303
|
+
#
|
2304
|
+
# resp.to_h outputs the following:
|
2305
|
+
# {
|
2306
|
+
# error_document: {
|
2307
|
+
# key: "error.html",
|
2308
|
+
# },
|
2309
|
+
# index_document: {
|
2310
|
+
# suffix: "index.html",
|
2311
|
+
# },
|
2312
|
+
# }
|
2313
|
+
#
|
1757
2314
|
# @example Request syntax with placeholder values
|
1758
2315
|
#
|
1759
2316
|
# resp = client.get_bucket_website({
|
@@ -1896,6 +2453,52 @@ module Aws::S3
|
|
1896
2453
|
# * {Types::GetObjectOutput#parts_count #parts_count} => Integer
|
1897
2454
|
# * {Types::GetObjectOutput#tag_count #tag_count} => Integer
|
1898
2455
|
#
|
2456
|
+
#
|
2457
|
+
# @example Example: To retrieve an object
|
2458
|
+
#
|
2459
|
+
# # The following example retrieves an object for an S3 bucket.
|
2460
|
+
#
|
2461
|
+
# resp = client.get_object({
|
2462
|
+
# bucket: "examplebucket",
|
2463
|
+
# key: "HappyFace.jpg",
|
2464
|
+
# })
|
2465
|
+
#
|
2466
|
+
# resp.to_h outputs the following:
|
2467
|
+
# {
|
2468
|
+
# accept_ranges: "bytes",
|
2469
|
+
# content_length: 3191,
|
2470
|
+
# content_type: "image/jpeg",
|
2471
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
2472
|
+
# last_modified: Time.parse("Thu, 15 Dec 2016 01:19:41 GMT"),
|
2473
|
+
# metadata: {
|
2474
|
+
# },
|
2475
|
+
# tag_count: 2,
|
2476
|
+
# version_id: "null",
|
2477
|
+
# }
|
2478
|
+
#
|
2479
|
+
# @example Example: To retrieve a byte range of an object
|
2480
|
+
#
|
2481
|
+
# # The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.
|
2482
|
+
#
|
2483
|
+
# resp = client.get_object({
|
2484
|
+
# bucket: "examplebucket",
|
2485
|
+
# key: "SampleFile.txt",
|
2486
|
+
# range: "bytes=0-9",
|
2487
|
+
# })
|
2488
|
+
#
|
2489
|
+
# resp.to_h outputs the following:
|
2490
|
+
# {
|
2491
|
+
# accept_ranges: "bytes",
|
2492
|
+
# content_length: 10,
|
2493
|
+
# content_range: "bytes 0-9/43",
|
2494
|
+
# content_type: "text/plain",
|
2495
|
+
# etag: "\"0d94420ffd0bc68cd3d152506b97a9cc\"",
|
2496
|
+
# last_modified: Time.parse("Thu, 09 Oct 2014 22:57:28 GMT"),
|
2497
|
+
# metadata: {
|
2498
|
+
# },
|
2499
|
+
# version_id: "null",
|
2500
|
+
# }
|
2501
|
+
#
|
1899
2502
|
# @example Download an object to disk
|
1900
2503
|
# # stream object directly to disk
|
1901
2504
|
# resp = s3.get_object(
|
@@ -2011,6 +2614,58 @@ module Aws::S3
|
|
2011
2614
|
# * {Types::GetObjectAclOutput#grants #grants} => Array<Types::Grant>
|
2012
2615
|
# * {Types::GetObjectAclOutput#request_charged #request_charged} => String
|
2013
2616
|
#
|
2617
|
+
#
|
2618
|
+
# @example Example: To retrieve object ACL
|
2619
|
+
#
|
2620
|
+
# # The following example retrieves access control list (ACL) of an object.
|
2621
|
+
#
|
2622
|
+
# resp = client.get_object_acl({
|
2623
|
+
# bucket: "examplebucket",
|
2624
|
+
# key: "HappyFace.jpg",
|
2625
|
+
# })
|
2626
|
+
#
|
2627
|
+
# resp.to_h outputs the following:
|
2628
|
+
# {
|
2629
|
+
# grants: [
|
2630
|
+
# {
|
2631
|
+
# grantee: {
|
2632
|
+
# display_name: "owner-display-name",
|
2633
|
+
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
2634
|
+
# type: "CanonicalUser",
|
2635
|
+
# },
|
2636
|
+
# permission: "WRITE",
|
2637
|
+
# },
|
2638
|
+
# {
|
2639
|
+
# grantee: {
|
2640
|
+
# display_name: "owner-display-name",
|
2641
|
+
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
2642
|
+
# type: "CanonicalUser",
|
2643
|
+
# },
|
2644
|
+
# permission: "WRITE_ACP",
|
2645
|
+
# },
|
2646
|
+
# {
|
2647
|
+
# grantee: {
|
2648
|
+
# display_name: "owner-display-name",
|
2649
|
+
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
2650
|
+
# type: "CanonicalUser",
|
2651
|
+
# },
|
2652
|
+
# permission: "READ",
|
2653
|
+
# },
|
2654
|
+
# {
|
2655
|
+
# grantee: {
|
2656
|
+
# display_name: "owner-display-name",
|
2657
|
+
# id: "852b113eexamplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
2658
|
+
# type: "CanonicalUser",
|
2659
|
+
# },
|
2660
|
+
# permission: "READ_ACP",
|
2661
|
+
# },
|
2662
|
+
# ],
|
2663
|
+
# owner: {
|
2664
|
+
# display_name: "owner-display-name",
|
2665
|
+
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
2666
|
+
# },
|
2667
|
+
# }
|
2668
|
+
#
|
2014
2669
|
# @example Request syntax with placeholder values
|
2015
2670
|
#
|
2016
2671
|
# resp = client.get_object_acl({
|
@@ -2055,6 +2710,52 @@ module Aws::S3
|
|
2055
2710
|
# * {Types::GetObjectTaggingOutput#version_id #version_id} => String
|
2056
2711
|
# * {Types::GetObjectTaggingOutput#tag_set #tag_set} => Array<Types::Tag>
|
2057
2712
|
#
|
2713
|
+
#
|
2714
|
+
# @example Example: To retrieve tag set of an object
|
2715
|
+
#
|
2716
|
+
# # The following example retrieves tag set of an object.
|
2717
|
+
#
|
2718
|
+
# resp = client.get_object_tagging({
|
2719
|
+
# bucket: "examplebucket",
|
2720
|
+
# key: "HappyFace.jpg",
|
2721
|
+
# })
|
2722
|
+
#
|
2723
|
+
# resp.to_h outputs the following:
|
2724
|
+
# {
|
2725
|
+
# tag_set: [
|
2726
|
+
# {
|
2727
|
+
# key: "Key4",
|
2728
|
+
# value: "Value4",
|
2729
|
+
# },
|
2730
|
+
# {
|
2731
|
+
# key: "Key3",
|
2732
|
+
# value: "Value3",
|
2733
|
+
# },
|
2734
|
+
# ],
|
2735
|
+
# version_id: "null",
|
2736
|
+
# }
|
2737
|
+
#
|
2738
|
+
# @example Example: To retrieve tag set of a specific object version
|
2739
|
+
#
|
2740
|
+
# # The following example retrieves tag set of an object. The request specifies object version.
|
2741
|
+
#
|
2742
|
+
# resp = client.get_object_tagging({
|
2743
|
+
# bucket: "examplebucket",
|
2744
|
+
# key: "exampleobject",
|
2745
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
2746
|
+
# })
|
2747
|
+
#
|
2748
|
+
# resp.to_h outputs the following:
|
2749
|
+
# {
|
2750
|
+
# tag_set: [
|
2751
|
+
# {
|
2752
|
+
# key: "Key1",
|
2753
|
+
# value: "Value1",
|
2754
|
+
# },
|
2755
|
+
# ],
|
2756
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
2757
|
+
# }
|
2758
|
+
#
|
2058
2759
|
# @example Request syntax with placeholder values
|
2059
2760
|
#
|
2060
2761
|
# resp = client.get_object_tagging({
|
@@ -2100,6 +2801,20 @@ module Aws::S3
|
|
2100
2801
|
# * {Types::GetObjectTorrentOutput#body #body} => IO
|
2101
2802
|
# * {Types::GetObjectTorrentOutput#request_charged #request_charged} => String
|
2102
2803
|
#
|
2804
|
+
#
|
2805
|
+
# @example Example: To retrieve torrent files for an object
|
2806
|
+
#
|
2807
|
+
# # The following example retrieves torrent files of an object.
|
2808
|
+
#
|
2809
|
+
# resp = client.get_object_torrent({
|
2810
|
+
# bucket: "examplebucket",
|
2811
|
+
# key: "HappyFace.jpg",
|
2812
|
+
# })
|
2813
|
+
#
|
2814
|
+
# resp.to_h outputs the following:
|
2815
|
+
# {
|
2816
|
+
# }
|
2817
|
+
#
|
2103
2818
|
# @example Request syntax with placeholder values
|
2104
2819
|
#
|
2105
2820
|
# resp = client.get_object_torrent({
|
@@ -2129,6 +2844,15 @@ module Aws::S3
|
|
2129
2844
|
#
|
2130
2845
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2131
2846
|
#
|
2847
|
+
#
|
2848
|
+
# @example Example: To determine if bucket exists
|
2849
|
+
#
|
2850
|
+
# # This operation checks to see if a bucket exists.
|
2851
|
+
#
|
2852
|
+
# resp = client.head_bucket({
|
2853
|
+
# bucket: "acl1",
|
2854
|
+
# })
|
2855
|
+
#
|
2132
2856
|
# @example Request syntax with placeholder values
|
2133
2857
|
#
|
2134
2858
|
# resp = client.head_bucket({
|
@@ -2235,6 +2959,28 @@ module Aws::S3
|
|
2235
2959
|
# * {Types::HeadObjectOutput#replication_status #replication_status} => String
|
2236
2960
|
# * {Types::HeadObjectOutput#parts_count #parts_count} => Integer
|
2237
2961
|
#
|
2962
|
+
#
|
2963
|
+
# @example Example: To retrieve metadata of an object without returning the object itself
|
2964
|
+
#
|
2965
|
+
# # The following example retrieves an object metadata.
|
2966
|
+
#
|
2967
|
+
# resp = client.head_object({
|
2968
|
+
# bucket: "examplebucket",
|
2969
|
+
# key: "HappyFace.jpg",
|
2970
|
+
# })
|
2971
|
+
#
|
2972
|
+
# resp.to_h outputs the following:
|
2973
|
+
# {
|
2974
|
+
# accept_ranges: "bytes",
|
2975
|
+
# content_length: 3191,
|
2976
|
+
# content_type: "image/jpeg",
|
2977
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
2978
|
+
# last_modified: Time.parse("Thu, 15 Dec 2016 01:19:41 GMT"),
|
2979
|
+
# metadata: {
|
2980
|
+
# },
|
2981
|
+
# version_id: "null",
|
2982
|
+
# }
|
2983
|
+
#
|
2238
2984
|
# @example Request syntax with placeholder values
|
2239
2985
|
#
|
2240
2986
|
# resp = client.head_object({
|
@@ -2456,6 +3202,36 @@ module Aws::S3
|
|
2456
3202
|
# * {Types::ListBucketsOutput#buckets #buckets} => Array<Types::Bucket>
|
2457
3203
|
# * {Types::ListBucketsOutput#owner #owner} => Types::Owner
|
2458
3204
|
#
|
3205
|
+
#
|
3206
|
+
# @example Example: To list object versions
|
3207
|
+
#
|
3208
|
+
# # The following example return versions of an object with specific key name prefix. The request limits the number of items returned to two. If there are are more than two object version, S3 returns NextToken in the response. You can specify this token value in your next request to fetch next set of object versions.
|
3209
|
+
#
|
3210
|
+
# resp = client.list_buckets({
|
3211
|
+
# })
|
3212
|
+
#
|
3213
|
+
# resp.to_h outputs the following:
|
3214
|
+
# {
|
3215
|
+
# buckets: [
|
3216
|
+
# {
|
3217
|
+
# creation_date: Time.parse("2012-02-15T21: 03: 02.000Z"),
|
3218
|
+
# name: "examplebucket",
|
3219
|
+
# },
|
3220
|
+
# {
|
3221
|
+
# creation_date: Time.parse("2011-07-24T19: 33: 50.000Z"),
|
3222
|
+
# name: "examplebucket2",
|
3223
|
+
# },
|
3224
|
+
# {
|
3225
|
+
# creation_date: Time.parse("2010-12-17T00: 56: 49.000Z"),
|
3226
|
+
# name: "examplebucket3",
|
3227
|
+
# },
|
3228
|
+
# ],
|
3229
|
+
# owner: {
|
3230
|
+
# display_name: "own-display-name",
|
3231
|
+
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31",
|
3232
|
+
# },
|
3233
|
+
# }
|
3234
|
+
#
|
2459
3235
|
# @example Response structure
|
2460
3236
|
#
|
2461
3237
|
# resp.buckets #=> Array
|
@@ -2521,6 +3297,101 @@ module Aws::S3
|
|
2521
3297
|
# * {Types::ListMultipartUploadsOutput#common_prefixes #common_prefixes} => Array<Types::CommonPrefix>
|
2522
3298
|
# * {Types::ListMultipartUploadsOutput#encoding_type #encoding_type} => String
|
2523
3299
|
#
|
3300
|
+
#
|
3301
|
+
# @example Example: To list in-progress multipart uploads on a bucket
|
3302
|
+
#
|
3303
|
+
# # The following example lists in-progress multipart uploads on a specific bucket.
|
3304
|
+
#
|
3305
|
+
# resp = client.list_multipart_uploads({
|
3306
|
+
# bucket: "examplebucket",
|
3307
|
+
# })
|
3308
|
+
#
|
3309
|
+
# resp.to_h outputs the following:
|
3310
|
+
# {
|
3311
|
+
# uploads: [
|
3312
|
+
# {
|
3313
|
+
# initiated: Time.parse("2014-05-01T05:40:58.000Z"),
|
3314
|
+
# initiator: {
|
3315
|
+
# display_name: "display-name",
|
3316
|
+
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
3317
|
+
# },
|
3318
|
+
# key: "JavaFile",
|
3319
|
+
# owner: {
|
3320
|
+
# display_name: "display-name",
|
3321
|
+
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
3322
|
+
# },
|
3323
|
+
# storage_class: "STANDARD",
|
3324
|
+
# upload_id: "examplelUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--",
|
3325
|
+
# },
|
3326
|
+
# {
|
3327
|
+
# initiated: Time.parse("2014-05-01T05:41:27.000Z"),
|
3328
|
+
# initiator: {
|
3329
|
+
# display_name: "display-name",
|
3330
|
+
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
3331
|
+
# },
|
3332
|
+
# key: "JavaFile",
|
3333
|
+
# owner: {
|
3334
|
+
# display_name: "display-name",
|
3335
|
+
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
3336
|
+
# },
|
3337
|
+
# storage_class: "STANDARD",
|
3338
|
+
# upload_id: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
3339
|
+
# },
|
3340
|
+
# ],
|
3341
|
+
# }
|
3342
|
+
#
|
3343
|
+
# @example Example: List next set of multipart uploads when previous result is truncated
|
3344
|
+
#
|
3345
|
+
# # The following example specifies the upload-id-marker and key-marker from previous truncated response to retrieve next setup of multipart uploads.
|
3346
|
+
#
|
3347
|
+
# resp = client.list_multipart_uploads({
|
3348
|
+
# bucket: "examplebucket",
|
3349
|
+
# key_marker: "nextkeyfrompreviousresponse",
|
3350
|
+
# max_uploads: 2,
|
3351
|
+
# upload_id_marker: "valuefrompreviousresponse",
|
3352
|
+
# })
|
3353
|
+
#
|
3354
|
+
# resp.to_h outputs the following:
|
3355
|
+
# {
|
3356
|
+
# bucket: "acl1",
|
3357
|
+
# is_truncated: true,
|
3358
|
+
# key_marker: "",
|
3359
|
+
# max_uploads: 2,
|
3360
|
+
# next_key_marker: "someobjectkey",
|
3361
|
+
# next_upload_id_marker: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
3362
|
+
# upload_id_marker: "",
|
3363
|
+
# uploads: [
|
3364
|
+
# {
|
3365
|
+
# initiated: Time.parse("2014-05-01T05:40:58.000Z"),
|
3366
|
+
# initiator: {
|
3367
|
+
# display_name: "ownder-display-name",
|
3368
|
+
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
3369
|
+
# },
|
3370
|
+
# key: "JavaFile",
|
3371
|
+
# owner: {
|
3372
|
+
# display_name: "mohanataws",
|
3373
|
+
# id: "852b113e7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
3374
|
+
# },
|
3375
|
+
# storage_class: "STANDARD",
|
3376
|
+
# upload_id: "gZ30jIqlUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--",
|
3377
|
+
# },
|
3378
|
+
# {
|
3379
|
+
# initiated: Time.parse("2014-05-01T05:41:27.000Z"),
|
3380
|
+
# initiator: {
|
3381
|
+
# display_name: "ownder-display-name",
|
3382
|
+
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
3383
|
+
# },
|
3384
|
+
# key: "JavaFile",
|
3385
|
+
# owner: {
|
3386
|
+
# display_name: "ownder-display-name",
|
3387
|
+
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
3388
|
+
# },
|
3389
|
+
# storage_class: "STANDARD",
|
3390
|
+
# upload_id: "b7tZSqIlo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
3391
|
+
# },
|
3392
|
+
# ],
|
3393
|
+
# }
|
3394
|
+
#
|
2524
3395
|
# @example Request syntax with placeholder values
|
2525
3396
|
#
|
2526
3397
|
# resp = client.list_multipart_uploads({
|
@@ -2610,6 +3481,48 @@ module Aws::S3
|
|
2610
3481
|
# * {Types::ListObjectVersionsOutput#common_prefixes #common_prefixes} => Array<Types::CommonPrefix>
|
2611
3482
|
# * {Types::ListObjectVersionsOutput#encoding_type #encoding_type} => String
|
2612
3483
|
#
|
3484
|
+
#
|
3485
|
+
# @example Example: To list object versions
|
3486
|
+
#
|
3487
|
+
# # The following example return versions of an object with specific key name prefix. The request limits the number of items returned to two. If there are are more than two object version, S3 returns NextToken in the response. You can specify this token value in your next request to fetch next set of object versions.
|
3488
|
+
#
|
3489
|
+
# resp = client.list_object_versions({
|
3490
|
+
# bucket: "examplebucket",
|
3491
|
+
# prefix: "HappyFace.jpg",
|
3492
|
+
# })
|
3493
|
+
#
|
3494
|
+
# resp.to_h outputs the following:
|
3495
|
+
# {
|
3496
|
+
# versions: [
|
3497
|
+
# {
|
3498
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
3499
|
+
# is_latest: true,
|
3500
|
+
# key: "HappyFace.jpg",
|
3501
|
+
# last_modified: Time.parse("2016-12-15T01:19:41.000Z"),
|
3502
|
+
# owner: {
|
3503
|
+
# display_name: "owner-display-name",
|
3504
|
+
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
3505
|
+
# },
|
3506
|
+
# size: 3191,
|
3507
|
+
# storage_class: "STANDARD",
|
3508
|
+
# version_id: "null",
|
3509
|
+
# },
|
3510
|
+
# {
|
3511
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
3512
|
+
# is_latest: false,
|
3513
|
+
# key: "HappyFace.jpg",
|
3514
|
+
# last_modified: Time.parse("2016-12-13T00:58:26.000Z"),
|
3515
|
+
# owner: {
|
3516
|
+
# display_name: "owner-display-name",
|
3517
|
+
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
3518
|
+
# },
|
3519
|
+
# size: 3191,
|
3520
|
+
# storage_class: "STANDARD",
|
3521
|
+
# version_id: "PHtexPGjH2y.zBgT8LmB7wwLI2mpbz.k",
|
3522
|
+
# },
|
3523
|
+
# ],
|
3524
|
+
# }
|
3525
|
+
#
|
2613
3526
|
# @example Request syntax with placeholder values
|
2614
3527
|
#
|
2615
3528
|
# resp = client.list_object_versions({
|
@@ -2708,6 +3621,45 @@ module Aws::S3
|
|
2708
3621
|
# * {Types::ListObjectsOutput#common_prefixes #common_prefixes} => Array<Types::CommonPrefix>
|
2709
3622
|
# * {Types::ListObjectsOutput#encoding_type #encoding_type} => String
|
2710
3623
|
#
|
3624
|
+
#
|
3625
|
+
# @example Example: To list objects in a bucket
|
3626
|
+
#
|
3627
|
+
# # The following example list two objects in a bucket.
|
3628
|
+
#
|
3629
|
+
# resp = client.list_objects({
|
3630
|
+
# bucket: "examplebucket",
|
3631
|
+
# max_keys: 2,
|
3632
|
+
# })
|
3633
|
+
#
|
3634
|
+
# resp.to_h outputs the following:
|
3635
|
+
# {
|
3636
|
+
# contents: [
|
3637
|
+
# {
|
3638
|
+
# etag: "\"70ee1738b6b21e2c8a43f3a5ab0eee71\"",
|
3639
|
+
# key: "example1.jpg",
|
3640
|
+
# last_modified: Time.parse("2014-11-21T19:40:05.000Z"),
|
3641
|
+
# owner: {
|
3642
|
+
# display_name: "myname",
|
3643
|
+
# id: "12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
3644
|
+
# },
|
3645
|
+
# size: 11,
|
3646
|
+
# storage_class: "STANDARD",
|
3647
|
+
# },
|
3648
|
+
# {
|
3649
|
+
# etag: "\"9c8af9a76df052144598c115ef33e511\"",
|
3650
|
+
# key: "example2.jpg",
|
3651
|
+
# last_modified: Time.parse("2013-11-15T01:10:49.000Z"),
|
3652
|
+
# owner: {
|
3653
|
+
# display_name: "myname",
|
3654
|
+
# id: "12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
3655
|
+
# },
|
3656
|
+
# size: 713193,
|
3657
|
+
# storage_class: "STANDARD",
|
3658
|
+
# },
|
3659
|
+
# ],
|
3660
|
+
# next_marker: "eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==",
|
3661
|
+
# }
|
3662
|
+
#
|
2711
3663
|
# @example Request syntax with placeholder values
|
2712
3664
|
#
|
2713
3665
|
# resp = client.list_objects({
|
@@ -2807,6 +3759,42 @@ module Aws::S3
|
|
2807
3759
|
# * {Types::ListObjectsV2Output#next_continuation_token #next_continuation_token} => String
|
2808
3760
|
# * {Types::ListObjectsV2Output#start_after #start_after} => String
|
2809
3761
|
#
|
3762
|
+
#
|
3763
|
+
# @example Example: To get object list
|
3764
|
+
#
|
3765
|
+
# # The following example retrieves object list. The request specifies max keys to limit response to include only 2 object keys.
|
3766
|
+
#
|
3767
|
+
# resp = client.list_objects_v2({
|
3768
|
+
# bucket: "examplebucket",
|
3769
|
+
# max_keys: 2,
|
3770
|
+
# })
|
3771
|
+
#
|
3772
|
+
# resp.to_h outputs the following:
|
3773
|
+
# {
|
3774
|
+
# contents: [
|
3775
|
+
# {
|
3776
|
+
# etag: "\"70ee1738b6b21e2c8a43f3a5ab0eee71\"",
|
3777
|
+
# key: "happyface.jpg",
|
3778
|
+
# last_modified: Time.parse("2014-11-21T19:40:05.000Z"),
|
3779
|
+
# size: 11,
|
3780
|
+
# storage_class: "STANDARD",
|
3781
|
+
# },
|
3782
|
+
# {
|
3783
|
+
# etag: "\"becf17f89c30367a9a44495d62ed521a-1\"",
|
3784
|
+
# key: "test.jpg",
|
3785
|
+
# last_modified: Time.parse("2014-05-02T04:51:50.000Z"),
|
3786
|
+
# size: 4192256,
|
3787
|
+
# storage_class: "STANDARD",
|
3788
|
+
# },
|
3789
|
+
# ],
|
3790
|
+
# is_truncated: true,
|
3791
|
+
# key_count: 2,
|
3792
|
+
# max_keys: 2,
|
3793
|
+
# name: "examplebucket",
|
3794
|
+
# next_continuation_token: "1w41l63U0xa8q7smH50vCxyTQqdxo69O3EmK28Bi5PcROI4wI/EyIJg==",
|
3795
|
+
# prefix: "",
|
3796
|
+
# }
|
3797
|
+
#
|
2810
3798
|
# @example Request syntax with placeholder values
|
2811
3799
|
#
|
2812
3800
|
# resp = client.list_objects_v2({
|
@@ -2895,6 +3883,44 @@ module Aws::S3
|
|
2895
3883
|
# * {Types::ListPartsOutput#storage_class #storage_class} => String
|
2896
3884
|
# * {Types::ListPartsOutput#request_charged #request_charged} => String
|
2897
3885
|
#
|
3886
|
+
#
|
3887
|
+
# @example Example: To list parts of a multipart upload.
|
3888
|
+
#
|
3889
|
+
# # The following example lists parts uploaded for a specific multipart upload.
|
3890
|
+
#
|
3891
|
+
# resp = client.list_parts({
|
3892
|
+
# bucket: "examplebucket",
|
3893
|
+
# key: "bigobject",
|
3894
|
+
# upload_id: "example7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--",
|
3895
|
+
# })
|
3896
|
+
#
|
3897
|
+
# resp.to_h outputs the following:
|
3898
|
+
# {
|
3899
|
+
# initiator: {
|
3900
|
+
# display_name: "owner-display-name",
|
3901
|
+
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
3902
|
+
# },
|
3903
|
+
# owner: {
|
3904
|
+
# display_name: "owner-display-name",
|
3905
|
+
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
3906
|
+
# },
|
3907
|
+
# parts: [
|
3908
|
+
# {
|
3909
|
+
# etag: "\"d8c2eafd90c266e19ab9dcacc479f8af\"",
|
3910
|
+
# last_modified: Time.parse("2016-12-16T00:11:42.000Z"),
|
3911
|
+
# part_number: 1,
|
3912
|
+
# size: 26246026,
|
3913
|
+
# },
|
3914
|
+
# {
|
3915
|
+
# etag: "\"d8c2eafd90c266e19ab9dcacc479f8af\"",
|
3916
|
+
# last_modified: Time.parse("2016-12-16T00:15:01.000Z"),
|
3917
|
+
# part_number: 2,
|
3918
|
+
# size: 26246026,
|
3919
|
+
# },
|
3920
|
+
# ],
|
3921
|
+
# storage_class: "STANDARD",
|
3922
|
+
# }
|
3923
|
+
#
|
2898
3924
|
# @example Request syntax with placeholder values
|
2899
3925
|
#
|
2900
3926
|
# resp = client.list_parts({
|
@@ -2996,6 +4022,17 @@ module Aws::S3
|
|
2996
4022
|
#
|
2997
4023
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2998
4024
|
#
|
4025
|
+
#
|
4026
|
+
# @example Example: Put bucket acl
|
4027
|
+
#
|
4028
|
+
# # The following example replaces existing ACL on a bucket. The ACL grants the bucket owner (specified using the owner ID) and write permission to the LogDelivery group. Because this is a replace operation, you must specify all the grants in your request. To incrementally add or remove ACL grants, you might use the console.
|
4029
|
+
#
|
4030
|
+
# resp = client.put_bucket_acl({
|
4031
|
+
# bucket: "examplebucket",
|
4032
|
+
# grant_full_control: "id=examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484",
|
4033
|
+
# grant_write: "uri=http://acs.amazonaws.com/groups/s3/LogDelivery",
|
4034
|
+
# })
|
4035
|
+
#
|
2999
4036
|
# @example Request syntax with placeholder values
|
3000
4037
|
#
|
3001
4038
|
# resp = client.put_bucket_acl({
|
@@ -3108,6 +4145,49 @@ module Aws::S3
|
|
3108
4145
|
#
|
3109
4146
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3110
4147
|
#
|
4148
|
+
#
|
4149
|
+
# @example Example: To set cors configuration on a bucket.
|
4150
|
+
#
|
4151
|
+
# # The following example enables PUT, POST, and DELETE requests from www.example.com, and enables GET requests from any domain.
|
4152
|
+
#
|
4153
|
+
# resp = client.put_bucket_cors({
|
4154
|
+
# bucket: "",
|
4155
|
+
# cors_configuration: {
|
4156
|
+
# cors_rules: [
|
4157
|
+
# {
|
4158
|
+
# allowed_headers: [
|
4159
|
+
# "*",
|
4160
|
+
# ],
|
4161
|
+
# allowed_methods: [
|
4162
|
+
# "PUT",
|
4163
|
+
# "POST",
|
4164
|
+
# "DELETE",
|
4165
|
+
# ],
|
4166
|
+
# allowed_origins: [
|
4167
|
+
# "http://www.example.com",
|
4168
|
+
# ],
|
4169
|
+
# expose_headers: [
|
4170
|
+
# "x-amz-server-side-encryption",
|
4171
|
+
# ],
|
4172
|
+
# max_age_seconds: 3000,
|
4173
|
+
# },
|
4174
|
+
# {
|
4175
|
+
# allowed_headers: [
|
4176
|
+
# "Authorization",
|
4177
|
+
# ],
|
4178
|
+
# allowed_methods: [
|
4179
|
+
# "GET",
|
4180
|
+
# ],
|
4181
|
+
# allowed_origins: [
|
4182
|
+
# "*",
|
4183
|
+
# ],
|
4184
|
+
# max_age_seconds: 3000,
|
4185
|
+
# },
|
4186
|
+
# ],
|
4187
|
+
# },
|
4188
|
+
# content_md5: "",
|
4189
|
+
# })
|
4190
|
+
#
|
3111
4191
|
# @example Request syntax with placeholder values
|
3112
4192
|
#
|
3113
4193
|
# resp = client.put_bucket_cors({
|
@@ -3250,6 +4330,35 @@ module Aws::S3
|
|
3250
4330
|
#
|
3251
4331
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3252
4332
|
#
|
4333
|
+
#
|
4334
|
+
# @example Example: Put bucket lifecycle
|
4335
|
+
#
|
4336
|
+
# # The following example replaces existing lifecycle configuration, if any, on the specified bucket.
|
4337
|
+
#
|
4338
|
+
# resp = client.put_bucket_lifecycle_configuration({
|
4339
|
+
# bucket: "examplebucket",
|
4340
|
+
# lifecycle_configuration: {
|
4341
|
+
# rules: [
|
4342
|
+
# {
|
4343
|
+
# expiration: {
|
4344
|
+
# days: 3650,
|
4345
|
+
# },
|
4346
|
+
# filter: {
|
4347
|
+
# prefix: "documents/",
|
4348
|
+
# },
|
4349
|
+
# id: "TestOnly",
|
4350
|
+
# status: "Enabled",
|
4351
|
+
# transitions: [
|
4352
|
+
# {
|
4353
|
+
# days: 365,
|
4354
|
+
# storage_class: "GLACIER",
|
4355
|
+
# },
|
4356
|
+
# ],
|
4357
|
+
# },
|
4358
|
+
# ],
|
4359
|
+
# },
|
4360
|
+
# })
|
4361
|
+
#
|
3253
4362
|
# @example Request syntax with placeholder values
|
3254
4363
|
#
|
3255
4364
|
# resp = client.put_bucket_lifecycle_configuration({
|
@@ -3326,6 +4435,30 @@ module Aws::S3
|
|
3326
4435
|
#
|
3327
4436
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3328
4437
|
#
|
4438
|
+
#
|
4439
|
+
# @example Example: Set logging configuration for a bucket
|
4440
|
+
#
|
4441
|
+
# # The following example sets logging policy on a bucket. For the Log Delivery group to deliver logs to the destination bucket, it needs permission for the READ_ACP action which the policy grants.
|
4442
|
+
#
|
4443
|
+
# resp = client.put_bucket_logging({
|
4444
|
+
# bucket: "sourcebucket",
|
4445
|
+
# bucket_logging_status: {
|
4446
|
+
# logging_enabled: {
|
4447
|
+
# target_bucket: "targetbucket",
|
4448
|
+
# target_grants: [
|
4449
|
+
# {
|
4450
|
+
# grantee: {
|
4451
|
+
# type: "Group",
|
4452
|
+
# uri: "http://acs.amazonaws.com/groups/global/AllUsers",
|
4453
|
+
# },
|
4454
|
+
# permission: "READ",
|
4455
|
+
# },
|
4456
|
+
# ],
|
4457
|
+
# target_prefix: "MyBucketLogs/",
|
4458
|
+
# },
|
4459
|
+
# },
|
4460
|
+
# })
|
4461
|
+
#
|
3329
4462
|
# @example Request syntax with placeholder values
|
3330
4463
|
#
|
3331
4464
|
# resp = client.put_bucket_logging({
|
@@ -3466,6 +4599,25 @@ module Aws::S3
|
|
3466
4599
|
#
|
3467
4600
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3468
4601
|
#
|
4602
|
+
#
|
4603
|
+
# @example Example: Set notification configuration for a bucket
|
4604
|
+
#
|
4605
|
+
# # The following example sets notification configuration on a bucket to publish the object created events to an SNS topic.
|
4606
|
+
#
|
4607
|
+
# resp = client.put_bucket_notification_configuration({
|
4608
|
+
# bucket: "examplebucket",
|
4609
|
+
# notification_configuration: {
|
4610
|
+
# topic_configurations: [
|
4611
|
+
# {
|
4612
|
+
# events: [
|
4613
|
+
# "s3:ObjectCreated:*",
|
4614
|
+
# ],
|
4615
|
+
# topic_arn: "arn:aws:sns:us-west-2:123456789012:s3-notification-topic",
|
4616
|
+
# },
|
4617
|
+
# ],
|
4618
|
+
# },
|
4619
|
+
# })
|
4620
|
+
#
|
3469
4621
|
# @example Request syntax with placeholder values
|
3470
4622
|
#
|
3471
4623
|
# resp = client.put_bucket_notification_configuration({
|
@@ -3546,6 +4698,16 @@ module Aws::S3
|
|
3546
4698
|
#
|
3547
4699
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3548
4700
|
#
|
4701
|
+
#
|
4702
|
+
# @example Example: Set bucket policy
|
4703
|
+
#
|
4704
|
+
# # The following example sets a permission policy on a bucket.
|
4705
|
+
#
|
4706
|
+
# resp = client.put_bucket_policy({
|
4707
|
+
# bucket: "examplebucket",
|
4708
|
+
# policy: "{\"Version\": \"2012-10-17\", \"Statement\": [{ \"Sid\": \"id-1\",\"Effect\": \"Allow\",\"Principal\": {\"AWS\": \"arn:aws:iam::123456789012:root\"}, \"Action\": [ \"s3:PutObject\",\"s3:PutObjectAcl\"], \"Resource\": [\"arn:aws:s3:::acl3/*\" ] } ]}",
|
4709
|
+
# })
|
4710
|
+
#
|
3549
4711
|
# @example Request syntax with placeholder values
|
3550
4712
|
#
|
3551
4713
|
# resp = client.put_bucket_policy({
|
@@ -3576,6 +4738,28 @@ module Aws::S3
|
|
3576
4738
|
#
|
3577
4739
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3578
4740
|
#
|
4741
|
+
#
|
4742
|
+
# @example Example: Set replication configuration on a bucket
|
4743
|
+
#
|
4744
|
+
# # The following example sets replication configuration on a bucket.
|
4745
|
+
#
|
4746
|
+
# resp = client.put_bucket_replication({
|
4747
|
+
# bucket: "examplebucket",
|
4748
|
+
# replication_configuration: {
|
4749
|
+
# role: "arn:aws:iam::123456789012:role/examplerole",
|
4750
|
+
# rules: [
|
4751
|
+
# {
|
4752
|
+
# destination: {
|
4753
|
+
# bucket: "arn:aws:s3:::destinationbucket",
|
4754
|
+
# storage_class: "STANDARD",
|
4755
|
+
# },
|
4756
|
+
# prefix: "",
|
4757
|
+
# status: "Enabled",
|
4758
|
+
# },
|
4759
|
+
# ],
|
4760
|
+
# },
|
4761
|
+
# })
|
4762
|
+
#
|
3579
4763
|
# @example Request syntax with placeholder values
|
3580
4764
|
#
|
3581
4765
|
# resp = client.put_bucket_replication({
|
@@ -3621,6 +4805,18 @@ module Aws::S3
|
|
3621
4805
|
#
|
3622
4806
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3623
4807
|
#
|
4808
|
+
#
|
4809
|
+
# @example Example: Set request payment configuration on a bucket.
|
4810
|
+
#
|
4811
|
+
# # The following example sets request payment configuration on a bucket so that person requesting the download is charged.
|
4812
|
+
#
|
4813
|
+
# resp = client.put_bucket_request_payment({
|
4814
|
+
# bucket: "examplebucket",
|
4815
|
+
# request_payment_configuration: {
|
4816
|
+
# payer: "Requester",
|
4817
|
+
# },
|
4818
|
+
# })
|
4819
|
+
#
|
3624
4820
|
# @example Request syntax with placeholder values
|
3625
4821
|
#
|
3626
4822
|
# resp = client.put_bucket_request_payment({
|
@@ -3650,6 +4846,27 @@ module Aws::S3
|
|
3650
4846
|
#
|
3651
4847
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3652
4848
|
#
|
4849
|
+
#
|
4850
|
+
# @example Example: Set tags on a bucket
|
4851
|
+
#
|
4852
|
+
# # The following example sets tags on a bucket. Any existing tags are replaced.
|
4853
|
+
#
|
4854
|
+
# resp = client.put_bucket_tagging({
|
4855
|
+
# bucket: "examplebucket",
|
4856
|
+
# tagging: {
|
4857
|
+
# tag_set: [
|
4858
|
+
# {
|
4859
|
+
# key: "Key1",
|
4860
|
+
# value: "Value1",
|
4861
|
+
# },
|
4862
|
+
# {
|
4863
|
+
# key: "Key2",
|
4864
|
+
# value: "Value2",
|
4865
|
+
# },
|
4866
|
+
# ],
|
4867
|
+
# },
|
4868
|
+
# })
|
4869
|
+
#
|
3653
4870
|
# @example Request syntax with placeholder values
|
3654
4871
|
#
|
3655
4872
|
# resp = client.put_bucket_tagging({
|
@@ -3689,6 +4906,19 @@ module Aws::S3
|
|
3689
4906
|
#
|
3690
4907
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3691
4908
|
#
|
4909
|
+
#
|
4910
|
+
# @example Example: Set versioning configuration on a bucket
|
4911
|
+
#
|
4912
|
+
# # The following example sets versioning configuration on bucket. The configuration enables versioning on the bucket.
|
4913
|
+
#
|
4914
|
+
# resp = client.put_bucket_versioning({
|
4915
|
+
# bucket: "examplebucket",
|
4916
|
+
# versioning_configuration: {
|
4917
|
+
# mfa_delete: "Disabled",
|
4918
|
+
# status: "Enabled",
|
4919
|
+
# },
|
4920
|
+
# })
|
4921
|
+
#
|
3692
4922
|
# @example Request syntax with placeholder values
|
3693
4923
|
#
|
3694
4924
|
# resp = client.put_bucket_versioning({
|
@@ -3720,6 +4950,24 @@ module Aws::S3
|
|
3720
4950
|
#
|
3721
4951
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3722
4952
|
#
|
4953
|
+
#
|
4954
|
+
# @example Example: Set website configuration on a bucket
|
4955
|
+
#
|
4956
|
+
# # The following example adds website configuration to a bucket.
|
4957
|
+
#
|
4958
|
+
# resp = client.put_bucket_website({
|
4959
|
+
# bucket: "examplebucket",
|
4960
|
+
# content_md5: "",
|
4961
|
+
# website_configuration: {
|
4962
|
+
# error_document: {
|
4963
|
+
# key: "error.html",
|
4964
|
+
# },
|
4965
|
+
# index_document: {
|
4966
|
+
# suffix: "index.html",
|
4967
|
+
# },
|
4968
|
+
# },
|
4969
|
+
# })
|
4970
|
+
#
|
3723
4971
|
# @example Request syntax with placeholder values
|
3724
4972
|
#
|
3725
4973
|
# resp = client.put_bucket_website({
|
@@ -3877,6 +5125,131 @@ module Aws::S3
|
|
3877
5125
|
# * {Types::PutObjectOutput#ssekms_key_id #ssekms_key_id} => String
|
3878
5126
|
# * {Types::PutObjectOutput#request_charged #request_charged} => String
|
3879
5127
|
#
|
5128
|
+
#
|
5129
|
+
# @example Example: To upload an object and specify server-side encryption and object tags
|
5130
|
+
#
|
5131
|
+
# # The following example uploads and object. The request specifies the optional server-side encryption option. The request also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.
|
5132
|
+
#
|
5133
|
+
# resp = client.put_object({
|
5134
|
+
# body: "filetoupload",
|
5135
|
+
# bucket: "examplebucket",
|
5136
|
+
# key: "exampleobject",
|
5137
|
+
# server_side_encryption: "AES256",
|
5138
|
+
# tagging: "key1=value1&key2=value2",
|
5139
|
+
# })
|
5140
|
+
#
|
5141
|
+
# resp.to_h outputs the following:
|
5142
|
+
# {
|
5143
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
5144
|
+
# server_side_encryption: "AES256",
|
5145
|
+
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
5146
|
+
# }
|
5147
|
+
#
|
5148
|
+
# @example Example: To upload an object and specify canned ACL.
|
5149
|
+
#
|
5150
|
+
# # The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.
|
5151
|
+
#
|
5152
|
+
# resp = client.put_object({
|
5153
|
+
# acl: "authenticated-read",
|
5154
|
+
# body: "filetoupload",
|
5155
|
+
# bucket: "examplebucket",
|
5156
|
+
# key: "exampleobject",
|
5157
|
+
# })
|
5158
|
+
#
|
5159
|
+
# resp.to_h outputs the following:
|
5160
|
+
# {
|
5161
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
5162
|
+
# version_id: "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr",
|
5163
|
+
# }
|
5164
|
+
#
|
5165
|
+
# @example Example: To upload an object
|
5166
|
+
#
|
5167
|
+
# # The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file syntax. S3 returns VersionId of the newly created object.
|
5168
|
+
#
|
5169
|
+
# resp = client.put_object({
|
5170
|
+
# body: "HappyFace.jpg",
|
5171
|
+
# bucket: "examplebucket",
|
5172
|
+
# key: "HappyFace.jpg",
|
5173
|
+
# })
|
5174
|
+
#
|
5175
|
+
# resp.to_h outputs the following:
|
5176
|
+
# {
|
5177
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
5178
|
+
# version_id: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk",
|
5179
|
+
# }
|
5180
|
+
#
|
5181
|
+
# @example Example: To create an object.
|
5182
|
+
#
|
5183
|
+
# # The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
|
5184
|
+
#
|
5185
|
+
# resp = client.put_object({
|
5186
|
+
# body: "filetoupload",
|
5187
|
+
# bucket: "examplebucket",
|
5188
|
+
# key: "objectkey",
|
5189
|
+
# })
|
5190
|
+
#
|
5191
|
+
# resp.to_h outputs the following:
|
5192
|
+
# {
|
5193
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
5194
|
+
# version_id: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ",
|
5195
|
+
# }
|
5196
|
+
#
|
5197
|
+
# @example Example: To upload an object and specify optional tags
|
5198
|
+
#
|
5199
|
+
# # The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object.
|
5200
|
+
#
|
5201
|
+
# resp = client.put_object({
|
5202
|
+
# body: "c:\\HappyFace.jpg",
|
5203
|
+
# bucket: "examplebucket",
|
5204
|
+
# key: "HappyFace.jpg",
|
5205
|
+
# tagging: "key1=value1&key2=value2",
|
5206
|
+
# })
|
5207
|
+
#
|
5208
|
+
# resp.to_h outputs the following:
|
5209
|
+
# {
|
5210
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
5211
|
+
# version_id: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a",
|
5212
|
+
# }
|
5213
|
+
#
|
5214
|
+
# @example Example: To upload object and specify user-defined metadata
|
5215
|
+
#
|
5216
|
+
# # The following example creates an object. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response.
|
5217
|
+
#
|
5218
|
+
# resp = client.put_object({
|
5219
|
+
# body: "filetoupload",
|
5220
|
+
# bucket: "examplebucket",
|
5221
|
+
# key: "exampleobject",
|
5222
|
+
# metadata: {
|
5223
|
+
# "metadata1" => "value1",
|
5224
|
+
# "metadata2" => "value2",
|
5225
|
+
# },
|
5226
|
+
# })
|
5227
|
+
#
|
5228
|
+
# resp.to_h outputs the following:
|
5229
|
+
# {
|
5230
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
5231
|
+
# version_id: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0",
|
5232
|
+
# }
|
5233
|
+
#
|
5234
|
+
# @example Example: To upload an object (specify optional headers)
|
5235
|
+
#
|
5236
|
+
# # The following example uploads an object. The request specifies optional request headers to directs S3 to use specific storage class and use server-side encryption.
|
5237
|
+
#
|
5238
|
+
# resp = client.put_object({
|
5239
|
+
# body: "HappyFace.jpg",
|
5240
|
+
# bucket: "examplebucket",
|
5241
|
+
# key: "HappyFace.jpg",
|
5242
|
+
# server_side_encryption: "AES256",
|
5243
|
+
# storage_class: "STANDARD_IA",
|
5244
|
+
# })
|
5245
|
+
#
|
5246
|
+
# resp.to_h outputs the following:
|
5247
|
+
# {
|
5248
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
5249
|
+
# server_side_encryption: "AES256",
|
5250
|
+
# version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp",
|
5251
|
+
# }
|
5252
|
+
#
|
3880
5253
|
# @example Streaming a file from disk
|
3881
5254
|
# # upload file from disk in a single request, may not exceed 5GB
|
3882
5255
|
# File.open('/source/file/path', 'rb') do |file|
|
@@ -3981,6 +5354,24 @@ module Aws::S3
|
|
3981
5354
|
#
|
3982
5355
|
# * {Types::PutObjectAclOutput#request_charged #request_charged} => String
|
3983
5356
|
#
|
5357
|
+
#
|
5358
|
+
# @example Example: To grant permissions using object ACL
|
5359
|
+
#
|
5360
|
+
# # The following example adds grants to an object ACL. The first permission grants user1 and user2 FULL_CONTROL and the AllUsers group READ permission.
|
5361
|
+
#
|
5362
|
+
# resp = client.put_object_acl({
|
5363
|
+
# access_control_policy: {
|
5364
|
+
# },
|
5365
|
+
# bucket: "examplebucket",
|
5366
|
+
# grant_full_control: "emailaddress=user1@example.com,emailaddress=user2@example.com",
|
5367
|
+
# grant_read: "uri=http://acs.amazonaws.com/groups/global/AllUsers",
|
5368
|
+
# key: "HappyFace.jpg",
|
5369
|
+
# })
|
5370
|
+
#
|
5371
|
+
# resp.to_h outputs the following:
|
5372
|
+
# {
|
5373
|
+
# }
|
5374
|
+
#
|
3984
5375
|
# @example Request syntax with placeholder values
|
3985
5376
|
#
|
3986
5377
|
# resp = client.put_object_acl({
|
@@ -4044,6 +5435,33 @@ module Aws::S3
|
|
4044
5435
|
#
|
4045
5436
|
# * {Types::PutObjectTaggingOutput#version_id #version_id} => String
|
4046
5437
|
#
|
5438
|
+
#
|
5439
|
+
# @example Example: To add tags to an existing object
|
5440
|
+
#
|
5441
|
+
# # The following example adds tags to an existing object.
|
5442
|
+
#
|
5443
|
+
# resp = client.put_object_tagging({
|
5444
|
+
# bucket: "examplebucket",
|
5445
|
+
# key: "HappyFace.jpg",
|
5446
|
+
# tagging: {
|
5447
|
+
# tag_set: [
|
5448
|
+
# {
|
5449
|
+
# key: "Key3",
|
5450
|
+
# value: "Value3",
|
5451
|
+
# },
|
5452
|
+
# {
|
5453
|
+
# key: "Key4",
|
5454
|
+
# value: "Value4",
|
5455
|
+
# },
|
5456
|
+
# ],
|
5457
|
+
# },
|
5458
|
+
# })
|
5459
|
+
#
|
5460
|
+
# resp.to_h outputs the following:
|
5461
|
+
# {
|
5462
|
+
# version_id: "null",
|
5463
|
+
# }
|
5464
|
+
#
|
4047
5465
|
# @example Request syntax with placeholder values
|
4048
5466
|
#
|
4049
5467
|
# resp = client.put_object_tagging({
|
@@ -4095,6 +5513,26 @@ module Aws::S3
|
|
4095
5513
|
#
|
4096
5514
|
# * {Types::RestoreObjectOutput#request_charged #request_charged} => String
|
4097
5515
|
#
|
5516
|
+
#
|
5517
|
+
# @example Example: To restore an archived object
|
5518
|
+
#
|
5519
|
+
# # The following example restores for one day an archived copy of an object back into Amazon S3 bucket.
|
5520
|
+
#
|
5521
|
+
# resp = client.restore_object({
|
5522
|
+
# bucket: "examplebucket",
|
5523
|
+
# key: "archivedobjectkey",
|
5524
|
+
# restore_request: {
|
5525
|
+
# days: 1,
|
5526
|
+
# glacier_job_parameters: {
|
5527
|
+
# tier: "Expedited",
|
5528
|
+
# },
|
5529
|
+
# },
|
5530
|
+
# })
|
5531
|
+
#
|
5532
|
+
# resp.to_h outputs the following:
|
5533
|
+
# {
|
5534
|
+
# }
|
5535
|
+
#
|
4098
5536
|
# @example Request syntax with placeholder values
|
4099
5537
|
#
|
4100
5538
|
# resp = client.restore_object({
|
@@ -4189,6 +5627,24 @@ module Aws::S3
|
|
4189
5627
|
# * {Types::UploadPartOutput#ssekms_key_id #ssekms_key_id} => String
|
4190
5628
|
# * {Types::UploadPartOutput#request_charged #request_charged} => String
|
4191
5629
|
#
|
5630
|
+
#
|
5631
|
+
# @example Example: To upload a part
|
5632
|
+
#
|
5633
|
+
# # The following example uploads part 1 of a multipart upload. The example specifies a file name for the part data. The Upload ID is same that is returned by the initiate multipart upload.
|
5634
|
+
#
|
5635
|
+
# resp = client.upload_part({
|
5636
|
+
# body: "fileToUpload",
|
5637
|
+
# bucket: "examplebucket",
|
5638
|
+
# key: "examplelargeobject",
|
5639
|
+
# part_number: 1,
|
5640
|
+
# upload_id: "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--",
|
5641
|
+
# })
|
5642
|
+
#
|
5643
|
+
# resp.to_h outputs the following:
|
5644
|
+
# {
|
5645
|
+
# etag: "\"d8c2eafd90c266e19ab9dcacc479f8af\"",
|
5646
|
+
# }
|
5647
|
+
#
|
4192
5648
|
# @example Request syntax with placeholder values
|
4193
5649
|
#
|
4194
5650
|
# resp = client.upload_part({
|
@@ -4310,6 +5766,48 @@ module Aws::S3
|
|
4310
5766
|
# * {Types::UploadPartCopyOutput#ssekms_key_id #ssekms_key_id} => String
|
4311
5767
|
# * {Types::UploadPartCopyOutput#request_charged #request_charged} => String
|
4312
5768
|
#
|
5769
|
+
#
|
5770
|
+
# @example Example: To upload a part by copying byte range from an existing object as data source
|
5771
|
+
#
|
5772
|
+
# # The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as data source.
|
5773
|
+
#
|
5774
|
+
# resp = client.upload_part_copy({
|
5775
|
+
# bucket: "examplebucket",
|
5776
|
+
# copy_source: "/bucketname/sourceobjectkey",
|
5777
|
+
# copy_source_range: "bytes=1-100000",
|
5778
|
+
# key: "examplelargeobject",
|
5779
|
+
# part_number: 2,
|
5780
|
+
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
5781
|
+
# })
|
5782
|
+
#
|
5783
|
+
# resp.to_h outputs the following:
|
5784
|
+
# {
|
5785
|
+
# copy_part_result: {
|
5786
|
+
# etag: "\"65d16d19e65a7508a51f043180edcc36\"",
|
5787
|
+
# last_modified: Time.parse("2016-12-29T21:44:28.000Z"),
|
5788
|
+
# },
|
5789
|
+
# }
|
5790
|
+
#
|
5791
|
+
# @example Example: To upload a part by copying data from an existing object as data source
|
5792
|
+
#
|
5793
|
+
# # The following example uploads a part of a multipart upload by copying data from an existing object as data source.
|
5794
|
+
#
|
5795
|
+
# resp = client.upload_part_copy({
|
5796
|
+
# bucket: "examplebucket",
|
5797
|
+
# copy_source: "bucketname/sourceobjectkey",
|
5798
|
+
# key: "examplelargeobject",
|
5799
|
+
# part_number: 1,
|
5800
|
+
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
5801
|
+
# })
|
5802
|
+
#
|
5803
|
+
# resp.to_h outputs the following:
|
5804
|
+
# {
|
5805
|
+
# copy_part_result: {
|
5806
|
+
# etag: "\"b0c6f0e7e054ab8fa2536a2677f8734d\"",
|
5807
|
+
# last_modified: Time.parse("2016-12-29T21:24:43.000Z"),
|
5808
|
+
# },
|
5809
|
+
# }
|
5810
|
+
#
|
4313
5811
|
# @example Request syntax with placeholder values
|
4314
5812
|
#
|
4315
5813
|
# resp = client.upload_part_copy({
|
@@ -4365,7 +5863,7 @@ module Aws::S3
|
|
4365
5863
|
params: params,
|
4366
5864
|
config: config)
|
4367
5865
|
context[:gem_name] = 'aws-sdk-s3'
|
4368
|
-
context[:gem_version] = '1.0.0.
|
5866
|
+
context[:gem_version] = '1.0.0.rc10'
|
4369
5867
|
Seahorse::Client::Request.new(handlers, context)
|
4370
5868
|
end
|
4371
5869
|
|