aws-sdk-s3 1.72.0 → 1.77.0
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 +4 -4
- data/lib/aws-sdk-s3.rb +1 -1
- data/lib/aws-sdk-s3/bucket.rb +2 -2
- data/lib/aws-sdk-s3/client.rb +795 -507
- data/lib/aws-sdk-s3/customizations/object.rb +12 -1
- data/lib/aws-sdk-s3/encryption.rb +2 -0
- data/lib/aws-sdk-s3/encryption/client.rb +11 -0
- data/lib/aws-sdk-s3/encryption/decrypt_handler.rb +64 -29
- data/lib/aws-sdk-s3/encryption/default_cipher_provider.rb +41 -5
- data/lib/aws-sdk-s3/encryption/encrypt_handler.rb +5 -5
- data/lib/aws-sdk-s3/encryption/io_decrypter.rb +7 -6
- data/lib/aws-sdk-s3/encryption/kms_cipher_provider.rb +32 -3
- data/lib/aws-sdk-s3/encryption/utils.rb +23 -0
- data/lib/aws-sdk-s3/encryptionV2/client.rb +201 -23
- data/lib/aws-sdk-s3/encryptionV2/decrypt_handler.rb +40 -12
- data/lib/aws-sdk-s3/encryptionV2/default_cipher_provider.rb +77 -10
- data/lib/aws-sdk-s3/encryptionV2/default_key_provider.rb +2 -0
- data/lib/aws-sdk-s3/encryptionV2/encrypt_handler.rb +7 -4
- data/lib/aws-sdk-s3/encryptionV2/errors.rb +24 -0
- data/lib/aws-sdk-s3/encryptionV2/io_auth_decrypter.rb +2 -0
- data/lib/aws-sdk-s3/encryptionV2/io_decrypter.rb +2 -0
- data/lib/aws-sdk-s3/encryptionV2/io_encrypter.rb +2 -0
- data/lib/aws-sdk-s3/encryptionV2/key_provider.rb +2 -0
- data/lib/aws-sdk-s3/encryptionV2/kms_cipher_provider.rb +90 -20
- data/lib/aws-sdk-s3/encryptionV2/materials.rb +2 -0
- data/lib/aws-sdk-s3/encryptionV2/utils.rb +2 -15
- data/lib/aws-sdk-s3/encryption_v2.rb +4 -1
- data/lib/aws-sdk-s3/file_uploader.rb +11 -0
- data/lib/aws-sdk-s3/multipart_file_uploader.rb +37 -2
- data/lib/aws-sdk-s3/multipart_upload_part.rb +5 -5
- data/lib/aws-sdk-s3/object.rb +10 -9
- data/lib/aws-sdk-s3/object_summary.rb +23 -7
- data/lib/aws-sdk-s3/object_version.rb +2 -2
- data/lib/aws-sdk-s3/plugins/accelerate.rb +27 -38
- data/lib/aws-sdk-s3/plugins/dualstack.rb +3 -1
- data/lib/aws-sdk-s3/plugins/sse_cpk.rb +1 -1
- data/lib/aws-sdk-s3/presigned_post.rb +61 -28
- data/lib/aws-sdk-s3/presigner.rb +2 -2
- data/lib/aws-sdk-s3/types.rb +63 -26
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 422b6a3ada8260b63191be267db716f2f368ea6beddf79715211383f1e43a694
|
4
|
+
data.tar.gz: 2fa30458ca058fc7594fdf92b26c46491cf44b9d5f724f279c72a8c3ee32557e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a3937af88ca256e605d8f83d34d34577c7c49c8357526fe27c8af61c6d58fe0fe54e630259b8a97848c9fc80bb8f72abf509c39c341ba137582bb3feac0b499d
|
7
|
+
data.tar.gz: 5b0dfeccd6803d948ec8db2282628e9647e4ce5efe08e09a4c32e7a40b9371103f3eef8b9e8c5210700a7e612bc5197bb23e291c9f4e7b117a20e22ff35260d6
|
data/lib/aws-sdk-s3.rb
CHANGED
data/lib/aws-sdk-s3/bucket.rb
CHANGED
@@ -357,7 +357,7 @@ module Aws::S3
|
|
357
357
|
#
|
358
358
|
#
|
359
359
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
|
360
|
-
# @option options [String,
|
360
|
+
# @option options [String, StringIO, File] :body
|
361
361
|
# Object data.
|
362
362
|
# @option options [String] :cache_control
|
363
363
|
# Can be used to specify caching behavior along the request/reply chain.
|
@@ -474,7 +474,7 @@ module Aws::S3
|
|
474
474
|
# encrypting data. This value is used to store the object and then it is
|
475
475
|
# discarded; Amazon S3 does not store the encryption key. The key must
|
476
476
|
# be appropriate for use with the algorithm specified in the
|
477
|
-
# `x-amz-server-side
|
477
|
+
# `x-amz-server-side-encryption-customer-algorithm` header.
|
478
478
|
# @option options [String] :sse_customer_key_md5
|
479
479
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
480
480
|
# RFC 1321. Amazon S3 uses this header for a message integrity check to
|
data/lib/aws-sdk-s3/client.rb
CHANGED
@@ -335,7 +335,7 @@ module Aws::S3
|
|
335
335
|
# @option options [Boolean] :use_accelerate_endpoint (false)
|
336
336
|
# When set to `true`, accelerated bucket endpoints will be used
|
337
337
|
# for all object operations. You must first enable accelerate for
|
338
|
-
# each bucket.
|
338
|
+
# each bucket. [Go here for more information](http://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html).
|
339
339
|
#
|
340
340
|
# @option options [Boolean] :use_dualstack_endpoint (false)
|
341
341
|
# When set to `true`, IPv6-compatible bucket endpoints will be used
|
@@ -402,27 +402,32 @@ module Aws::S3
|
|
402
402
|
# completely free all storage consumed by all parts.
|
403
403
|
#
|
404
404
|
# To verify that all parts have been removed, so you don't get charged
|
405
|
-
# for the part storage, you should call the ListParts operation and
|
405
|
+
# for the part storage, you should call the [ListParts][1] operation and
|
406
406
|
# ensure that the parts list is empty.
|
407
407
|
#
|
408
408
|
# For information about permissions required to use the multipart upload
|
409
|
-
# API, see [Multipart Upload API and Permissions][
|
409
|
+
# API, see [Multipart Upload API and Permissions][2].
|
410
410
|
#
|
411
411
|
# The following operations are related to `AbortMultipartUpload`\:
|
412
412
|
#
|
413
|
-
# * CreateMultipartUpload
|
413
|
+
# * [CreateMultipartUpload][3]
|
414
414
|
#
|
415
|
-
# * UploadPart
|
415
|
+
# * [UploadPart][4]
|
416
416
|
#
|
417
|
-
# * CompleteMultipartUpload
|
417
|
+
# * [CompleteMultipartUpload][5]
|
418
418
|
#
|
419
|
-
# * ListParts
|
419
|
+
# * [ListParts][1]
|
420
420
|
#
|
421
|
-
# * ListMultipartUploads
|
421
|
+
# * [ListMultipartUploads][6]
|
422
422
|
#
|
423
423
|
#
|
424
424
|
#
|
425
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
425
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
|
426
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
|
427
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html
|
428
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html
|
429
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html
|
430
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
|
426
431
|
#
|
427
432
|
# @option params [required, String] :bucket
|
428
433
|
# The bucket name to which the upload was taking place.
|
@@ -500,7 +505,7 @@ module Aws::S3
|
|
500
505
|
# Completes a multipart upload by assembling previously uploaded parts.
|
501
506
|
#
|
502
507
|
# You first initiate the multipart upload and then upload all parts
|
503
|
-
# using the UploadPart operation. After successfully uploading all
|
508
|
+
# using the [UploadPart][1] operation. After successfully uploading all
|
504
509
|
# relevant parts of an upload, you call this operation to complete the
|
505
510
|
# upload. Upon receiving this request, Amazon S3 concatenates all the
|
506
511
|
# parts in ascending order by part number to create a new object. In the
|
@@ -521,15 +526,15 @@ module Aws::S3
|
|
521
526
|
#
|
522
527
|
# Note that if `CompleteMultipartUpload` fails, applications should be
|
523
528
|
# prepared to retry the failed requests. For more information, see
|
524
|
-
# [Amazon S3 Error Best Practices][
|
529
|
+
# [Amazon S3 Error Best Practices][2].
|
525
530
|
#
|
526
531
|
# For more information about multipart uploads, see [Uploading Objects
|
527
|
-
# Using Multipart Upload][
|
532
|
+
# Using Multipart Upload][3].
|
528
533
|
#
|
529
534
|
# For information about permissions required to use the multipart upload
|
530
|
-
# API, see [Multipart Upload API and Permissions][
|
535
|
+
# API, see [Multipart Upload API and Permissions][4].
|
531
536
|
#
|
532
|
-
# `
|
537
|
+
# `CompleteMultipartUpload` has the following special errors:
|
533
538
|
#
|
534
539
|
# * Error code: `EntityTooSmall`
|
535
540
|
#
|
@@ -564,21 +569,26 @@ module Aws::S3
|
|
564
569
|
#
|
565
570
|
# The following operations are related to `CompleteMultipartUpload`\:
|
566
571
|
#
|
567
|
-
# * CreateMultipartUpload
|
572
|
+
# * [CreateMultipartUpload][5]
|
568
573
|
#
|
569
|
-
# * UploadPart
|
574
|
+
# * [UploadPart][1]
|
570
575
|
#
|
571
|
-
# * AbortMultipartUpload
|
576
|
+
# * [AbortMultipartUpload][6]
|
572
577
|
#
|
573
|
-
# * ListParts
|
578
|
+
# * [ListParts][7]
|
574
579
|
#
|
575
|
-
# * ListMultipartUploads
|
580
|
+
# * [ListMultipartUploads][8]
|
576
581
|
#
|
577
582
|
#
|
578
583
|
#
|
579
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
580
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
581
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
584
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html
|
585
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html
|
586
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html
|
587
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
|
588
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html
|
589
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
|
590
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
|
591
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
|
582
592
|
#
|
583
593
|
# @option params [required, String] :bucket
|
584
594
|
# Name of the bucket to which the multipart upload was initiated.
|
@@ -835,15 +845,15 @@ module Aws::S3
|
|
835
845
|
#
|
836
846
|
# If the source object's storage class is GLACIER, you must restore a
|
837
847
|
# copy of this object before you can use it as a source object for the
|
838
|
-
# copy operation. For more information, see .
|
848
|
+
# copy operation. For more information, see [RestoreObject][12].
|
839
849
|
#
|
840
850
|
# The following operations are related to `CopyObject`\:
|
841
851
|
#
|
842
|
-
# * PutObject
|
852
|
+
# * [PutObject][13]
|
843
853
|
#
|
844
|
-
# * GetObject
|
854
|
+
# * [GetObject][14]
|
845
855
|
#
|
846
|
-
# For more information, see [Copying Objects][
|
856
|
+
# For more information, see [Copying Objects][15].
|
847
857
|
#
|
848
858
|
#
|
849
859
|
#
|
@@ -858,7 +868,10 @@ module Aws::S3
|
|
858
868
|
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
859
869
|
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html
|
860
870
|
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html
|
861
|
-
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/
|
871
|
+
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html
|
872
|
+
# [13]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
873
|
+
# [14]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
874
|
+
# [15]: https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html
|
862
875
|
#
|
863
876
|
# @option params [String] :acl
|
864
877
|
# The canned ACL to apply to the object.
|
@@ -952,7 +965,7 @@ module Aws::S3
|
|
952
965
|
# encrypting data. This value is used to store the object and then it is
|
953
966
|
# discarded; Amazon S3 does not store the encryption key. The key must
|
954
967
|
# be appropriate for use with the algorithm specified in the
|
955
|
-
# `x-amz-server-side
|
968
|
+
# `x-amz-server-side-encryption-customer-algorithm` header.
|
956
969
|
#
|
957
970
|
# @option params [String] :sse_customer_key_md5
|
958
971
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
@@ -1207,9 +1220,9 @@ module Aws::S3
|
|
1207
1220
|
#
|
1208
1221
|
# The following operations are related to `CreateBucket`\:
|
1209
1222
|
#
|
1210
|
-
# * PutObject
|
1223
|
+
# * [PutObject][7]
|
1211
1224
|
#
|
1212
|
-
# * DeleteBucket
|
1225
|
+
# * [DeleteBucket][8]
|
1213
1226
|
#
|
1214
1227
|
#
|
1215
1228
|
#
|
@@ -1219,6 +1232,8 @@ module Aws::S3
|
|
1219
1232
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
|
1220
1233
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
1221
1234
|
# [6]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
|
1235
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
1236
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html
|
1222
1237
|
#
|
1223
1238
|
# @option params [String] :acl
|
1224
1239
|
# The canned ACL to apply to the bucket.
|
@@ -1316,29 +1331,29 @@ module Aws::S3
|
|
1316
1331
|
# This operation initiates a multipart upload and returns an upload ID.
|
1317
1332
|
# This upload ID is used to associate all of the parts in the specific
|
1318
1333
|
# multipart upload. You specify this upload ID in each of your
|
1319
|
-
# subsequent upload part requests (see UploadPart). You also
|
1320
|
-
# this upload ID in the final request to either complete or
|
1321
|
-
# multipart upload request.
|
1334
|
+
# subsequent upload part requests (see [UploadPart][1]). You also
|
1335
|
+
# include this upload ID in the final request to either complete or
|
1336
|
+
# abort the multipart upload request.
|
1322
1337
|
#
|
1323
1338
|
# For more information about multipart uploads, see [Multipart Upload
|
1324
|
-
# Overview][
|
1339
|
+
# Overview][2].
|
1325
1340
|
#
|
1326
1341
|
# If you have configured a lifecycle rule to abort incomplete multipart
|
1327
1342
|
# uploads, the upload must complete within the number of days specified
|
1328
1343
|
# in the bucket lifecycle configuration. Otherwise, the incomplete
|
1329
1344
|
# multipart upload becomes eligible for an abort operation and Amazon S3
|
1330
1345
|
# aborts the multipart upload. For more information, see [Aborting
|
1331
|
-
# Incomplete Multipart Uploads Using a Bucket Lifecycle Policy][
|
1346
|
+
# Incomplete Multipart Uploads Using a Bucket Lifecycle Policy][3].
|
1332
1347
|
#
|
1333
1348
|
# For information about the permissions required to use the multipart
|
1334
|
-
# upload API, see [Multipart Upload API and Permissions][
|
1349
|
+
# upload API, see [Multipart Upload API and Permissions][4].
|
1335
1350
|
#
|
1336
1351
|
# For request signing, multipart upload is just a series of regular
|
1337
1352
|
# requests. You initiate a multipart upload, send one or more requests
|
1338
1353
|
# to upload parts, and then complete the multipart upload process. You
|
1339
1354
|
# sign each request individually. There is nothing special about signing
|
1340
1355
|
# multipart upload requests. For more information about signing, see
|
1341
|
-
# [Authenticating Requests (AWS Signature Version 4)][
|
1356
|
+
# [Authenticating Requests (AWS Signature Version 4)][5].
|
1342
1357
|
#
|
1343
1358
|
# <note markdown="1"> After you initiate a multipart upload and upload one or more parts, to
|
1344
1359
|
# stop being charged for storing the uploaded parts, you must either
|
@@ -1354,9 +1369,9 @@ module Aws::S3
|
|
1354
1369
|
# your own encryption key, or use AWS Key Management Service (AWS KMS)
|
1355
1370
|
# customer master keys (CMKs) or Amazon S3-managed encryption keys. If
|
1356
1371
|
# you choose to provide your own encryption key, the request headers you
|
1357
|
-
# provide in UploadPart) and
|
1358
|
-
#
|
1359
|
-
# `CreateMultipartUpload`.
|
1372
|
+
# provide in [UploadPart](AmazonS3/latest/API/API_UploadPart.html) and
|
1373
|
+
# [UploadPartCopy][6] requests must match the headers you used in the
|
1374
|
+
# request to initiate the upload by using `CreateMultipartUpload`.
|
1360
1375
|
#
|
1361
1376
|
# To perform a multipart upload with encryption using an AWS KMS CMK,
|
1362
1377
|
# the requester must have permission to the `kms:Encrypt`,
|
@@ -1372,7 +1387,7 @@ module Aws::S3
|
|
1372
1387
|
# both the key policy and your IAM user or role.
|
1373
1388
|
#
|
1374
1389
|
# For more information, see [Protecting Data Using Server-Side
|
1375
|
-
# Encryption][
|
1390
|
+
# Encryption][7].
|
1376
1391
|
#
|
1377
1392
|
# Access Permissions
|
1378
1393
|
#
|
@@ -1382,13 +1397,13 @@ module Aws::S3
|
|
1382
1397
|
# request headers:
|
1383
1398
|
#
|
1384
1399
|
# * Specify a canned ACL with the `x-amz-acl` request header. For more
|
1385
|
-
# information, see [Canned ACL][
|
1400
|
+
# information, see [Canned ACL][8].
|
1386
1401
|
#
|
1387
1402
|
# * Specify access permissions explicitly with the `x-amz-grant-read`,
|
1388
1403
|
# `x-amz-grant-read-acp`, `x-amz-grant-write-acp`, and
|
1389
1404
|
# `x-amz-grant-full-control` headers. These parameters map to the
|
1390
1405
|
# set of permissions that Amazon S3 supports in an ACL. For more
|
1391
|
-
# information, see [Access Control List (ACL) Overview][
|
1406
|
+
# information, see [Access Control List (ACL) Overview][9].
|
1392
1407
|
#
|
1393
1408
|
# You can use either a canned ACL or specify access permissions
|
1394
1409
|
# explicitly. You cannot do both.
|
@@ -1407,7 +1422,7 @@ module Aws::S3
|
|
1407
1422
|
# want AWS to manage the keys used to encrypt data, specify the
|
1408
1423
|
# following headers in the request.
|
1409
1424
|
#
|
1410
|
-
# * x-amz-server-side
|
1425
|
+
# * x-amz-server-side-encryption
|
1411
1426
|
#
|
1412
1427
|
# * x-amz-server-side-encryption-aws-kms-key-id
|
1413
1428
|
#
|
@@ -1424,21 +1439,21 @@ module Aws::S3
|
|
1424
1439
|
#
|
1425
1440
|
# For more information about server-side encryption with CMKs stored
|
1426
1441
|
# in AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
|
1427
|
-
# Encryption with CMKs stored in AWS KMS][
|
1442
|
+
# Encryption with CMKs stored in AWS KMS][10].
|
1428
1443
|
#
|
1429
1444
|
# * Use customer-provided encryption keys – If you want to manage your
|
1430
1445
|
# own encryption keys, provide all the following headers in the
|
1431
1446
|
# request.
|
1432
1447
|
#
|
1433
|
-
# * x-amz-server-side
|
1448
|
+
# * x-amz-server-side-encryption-customer-algorithm
|
1434
1449
|
#
|
1435
|
-
# * x-amz-server-side
|
1450
|
+
# * x-amz-server-side-encryption-customer-key
|
1436
1451
|
#
|
1437
|
-
# * x-amz-server-side
|
1452
|
+
# * x-amz-server-side-encryption-customer-key-MD5
|
1438
1453
|
#
|
1439
1454
|
# For more information about server-side encryption with CMKs stored
|
1440
1455
|
# in AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
|
1441
|
-
# Encryption with CMKs stored in AWS KMS][
|
1456
|
+
# Encryption with CMKs stored in AWS KMS][10].
|
1442
1457
|
#
|
1443
1458
|
# Access-Control-List (ACL)-Specific Request Headers
|
1444
1459
|
#
|
@@ -1448,19 +1463,19 @@ module Aws::S3
|
|
1448
1463
|
# permissions to individual AWS accounts or to predefined groups
|
1449
1464
|
# defined by Amazon S3. These permissions are then added to the access
|
1450
1465
|
# control list (ACL) on the object. For more information, see [Using
|
1451
|
-
# ACLs][
|
1466
|
+
# ACLs][11]. With this operation, you can grant access permissions
|
1452
1467
|
# using one of the following two methods:
|
1453
1468
|
#
|
1454
1469
|
# * Specify a canned ACL (`x-amz-acl`) — Amazon S3 supports a set of
|
1455
1470
|
# predefined ACLs, known as *canned ACLs*. Each canned ACL has a
|
1456
1471
|
# predefined set of grantees and permissions. For more information,
|
1457
|
-
# see [Canned ACL][
|
1472
|
+
# see [Canned ACL][8].
|
1458
1473
|
#
|
1459
1474
|
# * Specify access permissions explicitly — To explicitly grant access
|
1460
1475
|
# permissions to specific AWS accounts or groups, use the following
|
1461
1476
|
# headers. Each header maps to specific permissions that Amazon S3
|
1462
1477
|
# supports in an ACL. For more information, see [Access Control List
|
1463
|
-
# (ACL) Overview][
|
1478
|
+
# (ACL) Overview][9]. In the header, you specify a list of grantees
|
1464
1479
|
# who get the specific permission. To grant permissions explicitly,
|
1465
1480
|
# use:
|
1466
1481
|
#
|
@@ -1505,7 +1520,7 @@ module Aws::S3
|
|
1505
1520
|
# * South America (São Paulo)
|
1506
1521
|
#
|
1507
1522
|
# For a list of all the Amazon S3 supported Regions and endpoints,
|
1508
|
-
# see [Regions and Endpoints][
|
1523
|
+
# see [Regions and Endpoints][12] in the AWS General Reference.
|
1509
1524
|
#
|
1510
1525
|
# </note>
|
1511
1526
|
#
|
@@ -1517,28 +1532,34 @@ module Aws::S3
|
|
1517
1532
|
#
|
1518
1533
|
# The following operations are related to `CreateMultipartUpload`\:
|
1519
1534
|
#
|
1520
|
-
# * UploadPart
|
1535
|
+
# * [UploadPart][1]
|
1521
1536
|
#
|
1522
|
-
# * CompleteMultipartUpload
|
1537
|
+
# * [CompleteMultipartUpload][13]
|
1523
1538
|
#
|
1524
|
-
# * AbortMultipartUpload
|
1539
|
+
# * [AbortMultipartUpload][14]
|
1525
1540
|
#
|
1526
|
-
# * ListParts
|
1541
|
+
# * [ListParts][15]
|
1527
1542
|
#
|
1528
|
-
# * ListMultipartUploads
|
1543
|
+
# * [ListMultipartUploads][16]
|
1529
1544
|
#
|
1530
1545
|
#
|
1531
1546
|
#
|
1532
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1533
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html
|
1534
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
1535
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1536
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1537
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1538
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
1539
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
1540
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
1541
|
-
# [10]: https://docs.aws.amazon.com/
|
1547
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html
|
1548
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html
|
1549
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config
|
1550
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
|
1551
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
|
1552
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html
|
1553
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html
|
1554
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
|
1555
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
1556
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html
|
1557
|
+
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
|
1558
|
+
# [12]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
|
1559
|
+
# [13]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html
|
1560
|
+
# [14]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
|
1561
|
+
# [15]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
|
1562
|
+
# [16]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
|
1542
1563
|
#
|
1543
1564
|
# @option params [String] :acl
|
1544
1565
|
# The canned ACL to apply to the object.
|
@@ -1606,7 +1627,7 @@ module Aws::S3
|
|
1606
1627
|
# encrypting data. This value is used to store the object and then it is
|
1607
1628
|
# discarded; Amazon S3 does not store the encryption key. The key must
|
1608
1629
|
# be appropriate for use with the algorithm specified in the
|
1609
|
-
# `x-amz-server-side
|
1630
|
+
# `x-amz-server-side-encryption-customer-algorithm` header.
|
1610
1631
|
#
|
1611
1632
|
# @option params [String] :sse_customer_key_md5
|
1612
1633
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
@@ -1750,8 +1771,14 @@ module Aws::S3
|
|
1750
1771
|
#
|
1751
1772
|
# **Related Resources**
|
1752
1773
|
#
|
1753
|
-
# *
|
1754
|
-
#
|
1774
|
+
# * [CreateBucket][1]
|
1775
|
+
#
|
1776
|
+
# * [DeleteObject][2]
|
1777
|
+
#
|
1778
|
+
#
|
1779
|
+
#
|
1780
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
1781
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html
|
1755
1782
|
#
|
1756
1783
|
# @option params [required, String] :bucket
|
1757
1784
|
# Specifies the bucket being deleted.
|
@@ -1798,15 +1825,20 @@ module Aws::S3
|
|
1798
1825
|
# The following operations are related to
|
1799
1826
|
# `DeleteBucketAnalyticsConfiguration`\:
|
1800
1827
|
#
|
1801
|
-
# *
|
1802
|
-
#
|
1803
|
-
# *
|
1828
|
+
# * [GetBucketAnalyticsConfiguration][4]
|
1829
|
+
#
|
1830
|
+
# * [ListBucketAnalyticsConfigurations][5]
|
1831
|
+
#
|
1832
|
+
# * [PutBucketAnalyticsConfiguration][6]
|
1804
1833
|
#
|
1805
1834
|
#
|
1806
1835
|
#
|
1807
1836
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
1808
1837
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
1809
1838
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
|
1839
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html
|
1840
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html
|
1841
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html
|
1810
1842
|
#
|
1811
1843
|
# @option params [required, String] :bucket
|
1812
1844
|
# The name of the bucket from which an analytics configuration is
|
@@ -1844,12 +1876,15 @@ module Aws::S3
|
|
1844
1876
|
#
|
1845
1877
|
# **Related Resources:**
|
1846
1878
|
#
|
1847
|
-
# *
|
1848
|
-
#
|
1879
|
+
# * [PutBucketCors][2]
|
1880
|
+
#
|
1881
|
+
# * [RESTOPTIONSobject][3]
|
1849
1882
|
#
|
1850
1883
|
#
|
1851
1884
|
#
|
1852
1885
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html
|
1886
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html
|
1887
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html
|
1853
1888
|
#
|
1854
1889
|
# @option params [required, String] :bucket
|
1855
1890
|
# Specifies the bucket whose `cors` configuration is being deleted.
|
@@ -1895,15 +1930,17 @@ module Aws::S3
|
|
1895
1930
|
#
|
1896
1931
|
# **Related Resources**
|
1897
1932
|
#
|
1898
|
-
# * PutBucketEncryption
|
1933
|
+
# * [PutBucketEncryption][4]
|
1899
1934
|
#
|
1900
|
-
# * GetBucketEncryption
|
1935
|
+
# * [GetBucketEncryption][5]
|
1901
1936
|
#
|
1902
1937
|
#
|
1903
1938
|
#
|
1904
1939
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
|
1905
1940
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
1906
1941
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
1942
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html
|
1943
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html
|
1907
1944
|
#
|
1908
1945
|
# @option params [required, String] :bucket
|
1909
1946
|
# The name of the bucket containing the server-side encryption
|
@@ -1941,17 +1978,20 @@ module Aws::S3
|
|
1941
1978
|
#
|
1942
1979
|
# Operations related to `DeleteBucketInventoryConfiguration` include:
|
1943
1980
|
#
|
1944
|
-
# * GetBucketInventoryConfiguration
|
1981
|
+
# * [GetBucketInventoryConfiguration][4]
|
1945
1982
|
#
|
1946
|
-
# * PutBucketInventoryConfiguration
|
1983
|
+
# * [PutBucketInventoryConfiguration][5]
|
1947
1984
|
#
|
1948
|
-
# * ListBucketInventoryConfigurations
|
1985
|
+
# * [ListBucketInventoryConfigurations][6]
|
1949
1986
|
#
|
1950
1987
|
#
|
1951
1988
|
#
|
1952
1989
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
1953
1990
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
1954
1991
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
|
1992
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html
|
1993
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html
|
1994
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html
|
1955
1995
|
#
|
1956
1996
|
# @option params [required, String] :bucket
|
1957
1997
|
# The name of the bucket containing the inventory configuration to
|
@@ -1997,13 +2037,15 @@ module Aws::S3
|
|
1997
2037
|
#
|
1998
2038
|
# Related actions include:
|
1999
2039
|
#
|
2000
|
-
# * PutBucketLifecycleConfiguration
|
2040
|
+
# * [PutBucketLifecycleConfiguration][2]
|
2001
2041
|
#
|
2002
|
-
# * GetBucketLifecycleConfiguration
|
2042
|
+
# * [GetBucketLifecycleConfiguration][3]
|
2003
2043
|
#
|
2004
2044
|
#
|
2005
2045
|
#
|
2006
2046
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions
|
2047
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html
|
2048
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html
|
2007
2049
|
#
|
2008
2050
|
# @option params [required, String] :bucket
|
2009
2051
|
# The bucket name of the lifecycle to delete.
|
@@ -2051,11 +2093,11 @@ module Aws::S3
|
|
2051
2093
|
# The following operations are related to
|
2052
2094
|
# `DeleteBucketMetricsConfiguration`\:
|
2053
2095
|
#
|
2054
|
-
# * GetBucketMetricsConfiguration
|
2096
|
+
# * [GetBucketMetricsConfiguration][4]
|
2055
2097
|
#
|
2056
|
-
# * PutBucketMetricsConfiguration
|
2098
|
+
# * [PutBucketMetricsConfiguration][5]
|
2057
2099
|
#
|
2058
|
-
# * ListBucketMetricsConfigurations
|
2100
|
+
# * [ListBucketMetricsConfigurations][6]
|
2059
2101
|
#
|
2060
2102
|
# * [Monitoring Metrics with Amazon CloudWatch][3]
|
2061
2103
|
#
|
@@ -2064,6 +2106,9 @@ module Aws::S3
|
|
2064
2106
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
2065
2107
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
2066
2108
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
|
2109
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html
|
2110
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html
|
2111
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html
|
2067
2112
|
#
|
2068
2113
|
# @option params [required, String] :bucket
|
2069
2114
|
# The name of the bucket containing the metrics configuration to delete.
|
@@ -2111,9 +2156,14 @@ module Aws::S3
|
|
2111
2156
|
#
|
2112
2157
|
# The following operations are related to `DeleteBucketPolicy`
|
2113
2158
|
#
|
2114
|
-
# * CreateBucket
|
2159
|
+
# * [CreateBucket][1]
|
2115
2160
|
#
|
2116
|
-
# * DeleteObject
|
2161
|
+
# * [DeleteObject][2]
|
2162
|
+
#
|
2163
|
+
#
|
2164
|
+
#
|
2165
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
2166
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html
|
2117
2167
|
#
|
2118
2168
|
# @option params [required, String] :bucket
|
2119
2169
|
# The bucket name.
|
@@ -2164,14 +2214,16 @@ module Aws::S3
|
|
2164
2214
|
#
|
2165
2215
|
# The following operations are related to `DeleteBucketReplication`\:
|
2166
2216
|
#
|
2167
|
-
# * PutBucketReplication
|
2217
|
+
# * [PutBucketReplication][3]
|
2168
2218
|
#
|
2169
|
-
# * GetBucketReplication
|
2219
|
+
# * [GetBucketReplication][4]
|
2170
2220
|
#
|
2171
2221
|
#
|
2172
2222
|
#
|
2173
2223
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
2174
2224
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
2225
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html
|
2226
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html
|
2175
2227
|
#
|
2176
2228
|
# @option params [required, String] :bucket
|
2177
2229
|
# The bucket name.
|
@@ -2210,9 +2262,14 @@ module Aws::S3
|
|
2210
2262
|
#
|
2211
2263
|
# The following operations are related to `DeleteBucketTagging`\:
|
2212
2264
|
#
|
2213
|
-
# * GetBucketTagging
|
2265
|
+
# * [GetBucketTagging][1]
|
2266
|
+
#
|
2267
|
+
# * [PutBucketTagging][2]
|
2214
2268
|
#
|
2215
|
-
#
|
2269
|
+
#
|
2270
|
+
#
|
2271
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html
|
2272
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html
|
2216
2273
|
#
|
2217
2274
|
# @option params [required, String] :bucket
|
2218
2275
|
# The bucket that has the tag set to be removed.
|
@@ -2261,13 +2318,15 @@ module Aws::S3
|
|
2261
2318
|
#
|
2262
2319
|
# The following operations are related to `DeleteBucketWebsite`\:
|
2263
2320
|
#
|
2264
|
-
# * GetBucketWebsite
|
2321
|
+
# * [GetBucketWebsite][2]
|
2265
2322
|
#
|
2266
|
-
# * PutBucketWebsite
|
2323
|
+
# * [PutBucketWebsite][3]
|
2267
2324
|
#
|
2268
2325
|
#
|
2269
2326
|
#
|
2270
2327
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html
|
2328
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketWebsite.html
|
2329
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html
|
2271
2330
|
#
|
2272
2331
|
# @option params [required, String] :bucket
|
2273
2332
|
# The bucket name for which you want to remove the website
|
@@ -2318,15 +2377,15 @@ module Aws::S3
|
|
2318
2377
|
# see sample requests that use versioning, see [Sample Request][2].
|
2319
2378
|
#
|
2320
2379
|
# You can delete objects by explicitly calling the DELETE Object API or
|
2321
|
-
# configure its lifecycle (PutBucketLifecycle) to enable Amazon S3
|
2322
|
-
# remove them for you. If you want to block users or accounts from
|
2380
|
+
# configure its lifecycle ([PutBucketLifecycle][3]) to enable Amazon S3
|
2381
|
+
# to remove them for you. If you want to block users or accounts from
|
2323
2382
|
# removing or deleting objects from your bucket, you must deny them the
|
2324
2383
|
# `s3:DeleteObject`, `s3:DeleteObjectVersion`, and
|
2325
2384
|
# `s3:PutLifeCycleConfiguration` actions.
|
2326
2385
|
#
|
2327
2386
|
# The following operation is related to `DeleteObject`\:
|
2328
2387
|
#
|
2329
|
-
# * PutObject
|
2388
|
+
# * [PutObject][4]
|
2330
2389
|
#
|
2331
2390
|
# ^
|
2332
2391
|
#
|
@@ -2334,6 +2393,8 @@ module Aws::S3
|
|
2334
2393
|
#
|
2335
2394
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html
|
2336
2395
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete
|
2396
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html
|
2397
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
2337
2398
|
#
|
2338
2399
|
# @option params [required, String] :bucket
|
2339
2400
|
# The bucket name of the bucket containing the object.
|
@@ -2445,13 +2506,15 @@ module Aws::S3
|
|
2445
2506
|
# The following operations are related to
|
2446
2507
|
# `DeleteBucketMetricsConfiguration`\:
|
2447
2508
|
#
|
2448
|
-
# * PutObjectTagging
|
2509
|
+
# * [PutObjectTagging][2]
|
2449
2510
|
#
|
2450
|
-
# * GetObjectTagging
|
2511
|
+
# * [GetObjectTagging][3]
|
2451
2512
|
#
|
2452
2513
|
#
|
2453
2514
|
#
|
2454
2515
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html
|
2516
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html
|
2517
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html
|
2455
2518
|
#
|
2456
2519
|
# @option params [required, String] :bucket
|
2457
2520
|
# The bucket name containing the objects from which to remove the tags.
|
@@ -2469,7 +2532,7 @@ module Aws::S3
|
|
2469
2532
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
2470
2533
|
#
|
2471
2534
|
# @option params [required, String] :key
|
2472
|
-
# Name of the
|
2535
|
+
# Name of the object key.
|
2473
2536
|
#
|
2474
2537
|
# @option params [String] :version_id
|
2475
2538
|
# The versionId of the object that the tag-set will be removed from.
|
@@ -2479,35 +2542,35 @@ module Aws::S3
|
|
2479
2542
|
# * {Types::DeleteObjectTaggingOutput#version_id #version_id} => String
|
2480
2543
|
#
|
2481
2544
|
#
|
2482
|
-
# @example Example: To remove tag set from an object
|
2545
|
+
# @example Example: To remove tag set from an object
|
2483
2546
|
#
|
2484
|
-
# # The following example removes tag set associated with the specified object
|
2485
|
-
# #
|
2547
|
+
# # The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the
|
2548
|
+
# # operation removes tag set from the latest object version.
|
2486
2549
|
#
|
2487
2550
|
# resp = client.delete_object_tagging({
|
2488
2551
|
# bucket: "examplebucket",
|
2489
2552
|
# key: "HappyFace.jpg",
|
2490
|
-
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
2491
2553
|
# })
|
2492
2554
|
#
|
2493
2555
|
# resp.to_h outputs the following:
|
2494
2556
|
# {
|
2495
|
-
# version_id: "
|
2557
|
+
# version_id: "null",
|
2496
2558
|
# }
|
2497
2559
|
#
|
2498
|
-
# @example Example: To remove tag set from an object
|
2560
|
+
# @example Example: To remove tag set from an object version
|
2499
2561
|
#
|
2500
|
-
# # The following example removes tag set associated with the specified object.
|
2501
|
-
# #
|
2562
|
+
# # The following example removes tag set associated with the specified object version. The request specifies both the
|
2563
|
+
# # object key and object version.
|
2502
2564
|
#
|
2503
2565
|
# resp = client.delete_object_tagging({
|
2504
2566
|
# bucket: "examplebucket",
|
2505
2567
|
# key: "HappyFace.jpg",
|
2568
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
2506
2569
|
# })
|
2507
2570
|
#
|
2508
2571
|
# resp.to_h outputs the following:
|
2509
2572
|
# {
|
2510
|
-
# version_id: "
|
2573
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
2511
2574
|
# }
|
2512
2575
|
#
|
2513
2576
|
# @example Request syntax with placeholder values
|
@@ -2565,19 +2628,24 @@ module Aws::S3
|
|
2565
2628
|
#
|
2566
2629
|
# The following operations are related to `DeleteObjects`\:
|
2567
2630
|
#
|
2568
|
-
# * CreateMultipartUpload
|
2631
|
+
# * [CreateMultipartUpload][2]
|
2569
2632
|
#
|
2570
|
-
# * UploadPart
|
2633
|
+
# * [UploadPart][3]
|
2571
2634
|
#
|
2572
|
-
# * CompleteMultipartUpload
|
2635
|
+
# * [CompleteMultipartUpload][4]
|
2573
2636
|
#
|
2574
|
-
# * ListParts
|
2637
|
+
# * [ListParts][5]
|
2575
2638
|
#
|
2576
|
-
# * AbortMultipartUpload
|
2639
|
+
# * [AbortMultipartUpload][6]
|
2577
2640
|
#
|
2578
2641
|
#
|
2579
2642
|
#
|
2580
2643
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete
|
2644
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html
|
2645
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html
|
2646
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html
|
2647
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
|
2648
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
|
2581
2649
|
#
|
2582
2650
|
# @option params [required, String] :bucket
|
2583
2651
|
# The bucket name containing the objects to delete.
|
@@ -2750,17 +2818,20 @@ module Aws::S3
|
|
2750
2818
|
#
|
2751
2819
|
# * [Using Amazon S3 Block Public Access][3]
|
2752
2820
|
#
|
2753
|
-
# * GetPublicAccessBlock
|
2821
|
+
# * [GetPublicAccessBlock][4]
|
2754
2822
|
#
|
2755
|
-
# * PutPublicAccessBlock
|
2823
|
+
# * [PutPublicAccessBlock][5]
|
2756
2824
|
#
|
2757
|
-
# * GetBucketPolicyStatus
|
2825
|
+
# * [GetBucketPolicyStatus][6]
|
2758
2826
|
#
|
2759
2827
|
#
|
2760
2828
|
#
|
2761
2829
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
2762
2830
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
2763
2831
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html
|
2832
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html
|
2833
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html
|
2834
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html
|
2764
2835
|
#
|
2765
2836
|
# @option params [required, String] :bucket
|
2766
2837
|
# The Amazon S3 bucket whose `PublicAccessBlock` configuration you want
|
@@ -2798,19 +2869,19 @@ module Aws::S3
|
|
2798
2869
|
# Storage Service Developer Guide*.
|
2799
2870
|
#
|
2800
2871
|
# You set the Transfer Acceleration state of an existing bucket to
|
2801
|
-
# `Enabled` or `Suspended` by using the
|
2802
|
-
# operation.
|
2872
|
+
# `Enabled` or `Suspended` by using the
|
2873
|
+
# [PutBucketAccelerateConfiguration][3] operation.
|
2803
2874
|
#
|
2804
2875
|
# A GET `accelerate` request does not return a state value for a bucket
|
2805
2876
|
# that has no transfer acceleration state. A bucket has no Transfer
|
2806
2877
|
# Acceleration state if a state has never been set on the bucket.
|
2807
2878
|
#
|
2808
2879
|
# For more information about transfer acceleration, see [Transfer
|
2809
|
-
# Acceleration][
|
2880
|
+
# Acceleration][4] in the Amazon Simple Storage Service Developer Guide.
|
2810
2881
|
#
|
2811
2882
|
# **Related Resources**
|
2812
2883
|
#
|
2813
|
-
# * PutBucketAccelerateConfiguration
|
2884
|
+
# * [PutBucketAccelerateConfiguration][3]
|
2814
2885
|
#
|
2815
2886
|
# ^
|
2816
2887
|
#
|
@@ -2818,7 +2889,8 @@ module Aws::S3
|
|
2818
2889
|
#
|
2819
2890
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
2820
2891
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
2821
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2892
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html
|
2893
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
|
2822
2894
|
#
|
2823
2895
|
# @option params [required, String] :bucket
|
2824
2896
|
# Name of the bucket for which the accelerate configuration is
|
@@ -2856,9 +2928,14 @@ module Aws::S3
|
|
2856
2928
|
#
|
2857
2929
|
# **Related Resources**
|
2858
2930
|
#
|
2859
|
-
# *
|
2931
|
+
# * [ListObjects][1]
|
2932
|
+
#
|
2860
2933
|
# ^
|
2861
2934
|
#
|
2935
|
+
#
|
2936
|
+
#
|
2937
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html
|
2938
|
+
#
|
2862
2939
|
# @option params [required, String] :bucket
|
2863
2940
|
# Specifies the S3 bucket whose ACL is being requested.
|
2864
2941
|
#
|
@@ -2912,15 +2989,20 @@ module Aws::S3
|
|
2912
2989
|
#
|
2913
2990
|
# **Related Resources**
|
2914
2991
|
#
|
2915
|
-
# *
|
2916
|
-
#
|
2917
|
-
# *
|
2992
|
+
# * [DeleteBucketAnalyticsConfiguration][4]
|
2993
|
+
#
|
2994
|
+
# * [ListBucketAnalyticsConfigurations][5]
|
2995
|
+
#
|
2996
|
+
# * [PutBucketAnalyticsConfiguration][6]
|
2918
2997
|
#
|
2919
2998
|
#
|
2920
2999
|
#
|
2921
3000
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
2922
3001
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
2923
3002
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
|
3003
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html
|
3004
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html
|
3005
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html
|
2924
3006
|
#
|
2925
3007
|
# @option params [required, String] :bucket
|
2926
3008
|
# The name of the bucket from which an analytics configuration is
|
@@ -2976,13 +3058,15 @@ module Aws::S3
|
|
2976
3058
|
#
|
2977
3059
|
# The following operations are related to `GetBucketCors`\:
|
2978
3060
|
#
|
2979
|
-
# * PutBucketCors
|
3061
|
+
# * [PutBucketCors][2]
|
2980
3062
|
#
|
2981
|
-
# * DeleteBucketCors
|
3063
|
+
# * [DeleteBucketCors][3]
|
2982
3064
|
#
|
2983
3065
|
#
|
2984
3066
|
#
|
2985
3067
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html
|
3068
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html
|
3069
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html
|
2986
3070
|
#
|
2987
3071
|
# @option params [required, String] :bucket
|
2988
3072
|
# The bucket name for which to get the cors configuration.
|
@@ -3059,15 +3143,17 @@ module Aws::S3
|
|
3059
3143
|
#
|
3060
3144
|
# The following operations are related to `GetBucketEncryption`\:
|
3061
3145
|
#
|
3062
|
-
# * PutBucketEncryption
|
3146
|
+
# * [PutBucketEncryption][4]
|
3063
3147
|
#
|
3064
|
-
# * DeleteBucketEncryption
|
3148
|
+
# * [DeleteBucketEncryption][5]
|
3065
3149
|
#
|
3066
3150
|
#
|
3067
3151
|
#
|
3068
3152
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
|
3069
3153
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3070
3154
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
3155
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html
|
3156
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html
|
3071
3157
|
#
|
3072
3158
|
# @option params [required, String] :bucket
|
3073
3159
|
# The name of the bucket from which the server-side encryption
|
@@ -3114,17 +3200,20 @@ module Aws::S3
|
|
3114
3200
|
# The following operations are related to
|
3115
3201
|
# `GetBucketInventoryConfiguration`\:
|
3116
3202
|
#
|
3117
|
-
# * DeleteBucketInventoryConfiguration
|
3203
|
+
# * [DeleteBucketInventoryConfiguration][4]
|
3118
3204
|
#
|
3119
|
-
# * ListBucketInventoryConfigurations
|
3205
|
+
# * [ListBucketInventoryConfigurations][5]
|
3120
3206
|
#
|
3121
|
-
# * PutBucketInventoryConfiguration
|
3207
|
+
# * [PutBucketInventoryConfiguration][6]
|
3122
3208
|
#
|
3123
3209
|
#
|
3124
3210
|
#
|
3125
3211
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3126
3212
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
3127
3213
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
|
3214
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html
|
3215
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html
|
3216
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html
|
3128
3217
|
#
|
3129
3218
|
# @option params [required, String] :bucket
|
3130
3219
|
# The name of the bucket containing the inventory configuration to
|
@@ -3169,20 +3258,21 @@ module Aws::S3
|
|
3169
3258
|
end
|
3170
3259
|
|
3171
3260
|
# For an updated version of this API, see
|
3172
|
-
# GetBucketLifecycleConfiguration. If you configured a bucket
|
3173
|
-
# using the `filter` element, you should see the updated
|
3174
|
-
# topic. This topic is provided for backward
|
3261
|
+
# [GetBucketLifecycleConfiguration][1]. If you configured a bucket
|
3262
|
+
# lifecycle using the `filter` element, you should see the updated
|
3263
|
+
# version of this topic. This topic is provided for backward
|
3264
|
+
# compatibility.
|
3175
3265
|
#
|
3176
3266
|
# Returns the lifecycle configuration information set on the bucket. For
|
3177
3267
|
# information about lifecycle configuration, see [Object Lifecycle
|
3178
|
-
# Management][
|
3268
|
+
# Management][2].
|
3179
3269
|
#
|
3180
3270
|
# To use this operation, you must have permission to perform the
|
3181
3271
|
# `s3:GetLifecycleConfiguration` action. The bucket owner has this
|
3182
3272
|
# permission by default. The bucket owner can grant this permission to
|
3183
3273
|
# others. For more information about permissions, see [Permissions
|
3184
|
-
# Related to Bucket Subresource Operations][
|
3185
|
-
# Permissions to Your Amazon S3 Resources][
|
3274
|
+
# Related to Bucket Subresource Operations][3] and [Managing Access
|
3275
|
+
# Permissions to Your Amazon S3 Resources][4].
|
3186
3276
|
#
|
3187
3277
|
# `GetBucketLifecycle` has the following special error:
|
3188
3278
|
#
|
@@ -3196,17 +3286,20 @@ module Aws::S3
|
|
3196
3286
|
#
|
3197
3287
|
# The following operations are related to `GetBucketLifecycle`\:
|
3198
3288
|
#
|
3199
|
-
# * GetBucketLifecycleConfiguration
|
3289
|
+
# * [GetBucketLifecycleConfiguration][1]
|
3200
3290
|
#
|
3201
|
-
# * PutBucketLifecycle
|
3291
|
+
# * [PutBucketLifecycle][5]
|
3202
3292
|
#
|
3203
|
-
# * DeleteBucketLifecycle
|
3293
|
+
# * [DeleteBucketLifecycle][6]
|
3204
3294
|
#
|
3205
3295
|
#
|
3206
3296
|
#
|
3207
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3208
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
3209
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-
|
3297
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html
|
3298
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
3299
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3300
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
3301
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html
|
3302
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html
|
3210
3303
|
#
|
3211
3304
|
# @option params [required, String] :bucket
|
3212
3305
|
# The name of the bucket for which to get the lifecycle information.
|
@@ -3277,20 +3370,20 @@ module Aws::S3
|
|
3277
3370
|
# specify a filter to select a subset of objects to which the rule
|
3278
3371
|
# applies. If you are still using previous version of the lifecycle
|
3279
3372
|
# configuration, it works. For the earlier API description, see
|
3280
|
-
# GetBucketLifecycle.
|
3373
|
+
# [GetBucketLifecycle][1].
|
3281
3374
|
#
|
3282
3375
|
# </note>
|
3283
3376
|
#
|
3284
3377
|
# Returns the lifecycle configuration information set on the bucket. For
|
3285
3378
|
# information about lifecycle configuration, see [Object Lifecycle
|
3286
|
-
# Management][
|
3379
|
+
# Management][2].
|
3287
3380
|
#
|
3288
3381
|
# To use this operation, you must have permission to perform the
|
3289
3382
|
# `s3:GetLifecycleConfiguration` action. The bucket owner has this
|
3290
3383
|
# permission, by default. The bucket owner can grant this permission to
|
3291
3384
|
# others. For more information about permissions, see [Permissions
|
3292
|
-
# Related to Bucket Subresource Operations][
|
3293
|
-
# Permissions to Your Amazon S3 Resources][
|
3385
|
+
# Related to Bucket Subresource Operations][3] and [Managing Access
|
3386
|
+
# Permissions to Your Amazon S3 Resources][4].
|
3294
3387
|
#
|
3295
3388
|
# `GetBucketLifecycleConfiguration` has the following special error:
|
3296
3389
|
#
|
@@ -3305,17 +3398,20 @@ module Aws::S3
|
|
3305
3398
|
# The following operations are related to
|
3306
3399
|
# `GetBucketLifecycleConfiguration`\:
|
3307
3400
|
#
|
3308
|
-
# * GetBucketLifecycle
|
3401
|
+
# * [GetBucketLifecycle][1]
|
3309
3402
|
#
|
3310
|
-
# * PutBucketLifecycle
|
3403
|
+
# * [PutBucketLifecycle][5]
|
3311
3404
|
#
|
3312
|
-
# * DeleteBucketLifecycle
|
3405
|
+
# * [DeleteBucketLifecycle][6]
|
3313
3406
|
#
|
3314
3407
|
#
|
3315
3408
|
#
|
3316
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3317
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
3318
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-
|
3409
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html
|
3410
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
3411
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3412
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
3413
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html
|
3414
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html
|
3319
3415
|
#
|
3320
3416
|
# @option params [required, String] :bucket
|
3321
3417
|
# The name of the bucket for which to get the lifecycle information.
|
@@ -3393,16 +3489,21 @@ module Aws::S3
|
|
3393
3489
|
|
3394
3490
|
# Returns the Region the bucket resides in. You set the bucket's Region
|
3395
3491
|
# using the `LocationConstraint` request parameter in a `CreateBucket`
|
3396
|
-
# request. For more information, see CreateBucket.
|
3492
|
+
# request. For more information, see [CreateBucket][1].
|
3397
3493
|
#
|
3398
3494
|
# To use this implementation of the operation, you must be the bucket
|
3399
3495
|
# owner.
|
3400
3496
|
#
|
3401
3497
|
# The following operations are related to `GetBucketLocation`\:
|
3402
3498
|
#
|
3403
|
-
# * GetObject
|
3499
|
+
# * [GetObject][2]
|
3404
3500
|
#
|
3405
|
-
# * CreateBucket
|
3501
|
+
# * [CreateBucket][1]
|
3502
|
+
#
|
3503
|
+
#
|
3504
|
+
#
|
3505
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
3506
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
3406
3507
|
#
|
3407
3508
|
# @option params [required, String] :bucket
|
3408
3509
|
# The name of the bucket for which to get the location.
|
@@ -3450,9 +3551,14 @@ module Aws::S3
|
|
3450
3551
|
#
|
3451
3552
|
# The following operations are related to `GetBucketLogging`\:
|
3452
3553
|
#
|
3453
|
-
# * CreateBucket
|
3554
|
+
# * [CreateBucket][1]
|
3555
|
+
#
|
3556
|
+
# * [PutBucketLogging][2]
|
3557
|
+
#
|
3454
3558
|
#
|
3455
|
-
#
|
3559
|
+
#
|
3560
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
3561
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLogging.html
|
3456
3562
|
#
|
3457
3563
|
# @option params [required, String] :bucket
|
3458
3564
|
# The bucket name for which to get the logging information.
|
@@ -3505,11 +3611,11 @@ module Aws::S3
|
|
3505
3611
|
# The following operations are related to
|
3506
3612
|
# `GetBucketMetricsConfiguration`\:
|
3507
3613
|
#
|
3508
|
-
# * PutBucketMetricsConfiguration
|
3614
|
+
# * [PutBucketMetricsConfiguration][4]
|
3509
3615
|
#
|
3510
|
-
# * DeleteBucketMetricsConfiguration
|
3616
|
+
# * [DeleteBucketMetricsConfiguration][5]
|
3511
3617
|
#
|
3512
|
-
# * ListBucketMetricsConfigurations
|
3618
|
+
# * [ListBucketMetricsConfigurations][6]
|
3513
3619
|
#
|
3514
3620
|
# * [Monitoring Metrics with Amazon CloudWatch][3]
|
3515
3621
|
#
|
@@ -3518,6 +3624,9 @@ module Aws::S3
|
|
3518
3624
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3519
3625
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
3520
3626
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
|
3627
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html
|
3628
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html
|
3629
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html
|
3521
3630
|
#
|
3522
3631
|
# @option params [required, String] :bucket
|
3523
3632
|
# The name of the bucket containing the metrics configuration to
|
@@ -3557,7 +3666,11 @@ module Aws::S3
|
|
3557
3666
|
req.send_request(options)
|
3558
3667
|
end
|
3559
3668
|
|
3560
|
-
# No longer used, see GetBucketNotificationConfiguration.
|
3669
|
+
# No longer used, see [GetBucketNotificationConfiguration][1].
|
3670
|
+
#
|
3671
|
+
#
|
3672
|
+
#
|
3673
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html
|
3561
3674
|
#
|
3562
3675
|
# @option params [required, String] :bucket
|
3563
3676
|
# Name of the bucket for which to get the notification configuration.
|
@@ -3676,7 +3789,7 @@ module Aws::S3
|
|
3676
3789
|
#
|
3677
3790
|
# The following operation is related to `GetBucketNotification`\:
|
3678
3791
|
#
|
3679
|
-
# * PutBucketNotification
|
3792
|
+
# * [PutBucketNotification][3]
|
3680
3793
|
#
|
3681
3794
|
# ^
|
3682
3795
|
#
|
@@ -3684,6 +3797,7 @@ module Aws::S3
|
|
3684
3797
|
#
|
3685
3798
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html
|
3686
3799
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html
|
3800
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotification.html
|
3687
3801
|
#
|
3688
3802
|
# @option params [required, String] :bucket
|
3689
3803
|
# Name of the bucket for which to get the notification configuration.
|
@@ -3756,13 +3870,14 @@ module Aws::S3
|
|
3756
3870
|
#
|
3757
3871
|
# The following operation is related to `GetBucketPolicy`\:
|
3758
3872
|
#
|
3759
|
-
# * GetObject
|
3873
|
+
# * [GetObject][2]
|
3760
3874
|
#
|
3761
3875
|
# ^
|
3762
3876
|
#
|
3763
3877
|
#
|
3764
3878
|
#
|
3765
3879
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html
|
3880
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
3766
3881
|
#
|
3767
3882
|
# @option params [required, String] :bucket
|
3768
3883
|
# The bucket name for which to get the bucket policy.
|
@@ -3817,17 +3932,20 @@ module Aws::S3
|
|
3817
3932
|
#
|
3818
3933
|
# * [Using Amazon S3 Block Public Access][3]
|
3819
3934
|
#
|
3820
|
-
# * GetPublicAccessBlock
|
3935
|
+
# * [GetPublicAccessBlock][4]
|
3821
3936
|
#
|
3822
|
-
# * PutPublicAccessBlock
|
3937
|
+
# * [PutPublicAccessBlock][5]
|
3823
3938
|
#
|
3824
|
-
# * DeletePublicAccessBlock
|
3939
|
+
# * [DeletePublicAccessBlock][6]
|
3825
3940
|
#
|
3826
3941
|
#
|
3827
3942
|
#
|
3828
3943
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
|
3829
3944
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status
|
3830
3945
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html
|
3946
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html
|
3947
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html
|
3948
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html
|
3831
3949
|
#
|
3832
3950
|
# @option params [required, String] :bucket
|
3833
3951
|
# The name of the Amazon S3 bucket whose policy status you want to
|
@@ -3875,19 +3993,22 @@ module Aws::S3
|
|
3875
3993
|
# you must also include the `DeleteMarkerReplication` and `Priority`
|
3876
3994
|
# elements. The response also returns those elements.
|
3877
3995
|
#
|
3878
|
-
# For information about `GetBucketReplication` errors, see
|
3879
|
-
#
|
3996
|
+
# For information about `GetBucketReplication` errors, see [List of
|
3997
|
+
# replication-related error codes][3]
|
3880
3998
|
#
|
3881
3999
|
# The following operations are related to `GetBucketReplication`\:
|
3882
4000
|
#
|
3883
|
-
# * PutBucketReplication
|
4001
|
+
# * [PutBucketReplication][4]
|
3884
4002
|
#
|
3885
|
-
# * DeleteBucketReplication
|
4003
|
+
# * [DeleteBucketReplication][5]
|
3886
4004
|
#
|
3887
4005
|
#
|
3888
4006
|
#
|
3889
4007
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html
|
3890
4008
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html
|
4009
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList
|
4010
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html
|
4011
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html
|
3891
4012
|
#
|
3892
4013
|
# @option params [required, String] :bucket
|
3893
4014
|
# The bucket name for which to get the replication information.
|
@@ -3971,13 +4092,14 @@ module Aws::S3
|
|
3971
4092
|
#
|
3972
4093
|
# The following operations are related to `GetBucketRequestPayment`\:
|
3973
4094
|
#
|
3974
|
-
# * ListObjects
|
4095
|
+
# * [ListObjects][2]
|
3975
4096
|
#
|
3976
4097
|
# ^
|
3977
4098
|
#
|
3978
4099
|
#
|
3979
4100
|
#
|
3980
4101
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html
|
4102
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html
|
3981
4103
|
#
|
3982
4104
|
# @option params [required, String] :bucket
|
3983
4105
|
# The name of the bucket for which to get the payment request
|
@@ -4036,9 +4158,14 @@ module Aws::S3
|
|
4036
4158
|
#
|
4037
4159
|
# The following operations are related to `GetBucketTagging`\:
|
4038
4160
|
#
|
4039
|
-
# * PutBucketTagging
|
4161
|
+
# * [PutBucketTagging][1]
|
4040
4162
|
#
|
4041
|
-
# * DeleteBucketTagging
|
4163
|
+
# * [DeleteBucketTagging][2]
|
4164
|
+
#
|
4165
|
+
#
|
4166
|
+
#
|
4167
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html
|
4168
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html
|
4042
4169
|
#
|
4043
4170
|
# @option params [required, String] :bucket
|
4044
4171
|
# The name of the bucket for which to get the tagging information.
|
@@ -4103,11 +4230,17 @@ module Aws::S3
|
|
4103
4230
|
#
|
4104
4231
|
# The following operations are related to `GetBucketVersioning`\:
|
4105
4232
|
#
|
4106
|
-
# * GetObject
|
4233
|
+
# * [GetObject][1]
|
4234
|
+
#
|
4235
|
+
# * [PutObject][2]
|
4236
|
+
#
|
4237
|
+
# * [DeleteObject][3]
|
4107
4238
|
#
|
4108
|
-
# * PutObject
|
4109
4239
|
#
|
4110
|
-
#
|
4240
|
+
#
|
4241
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
4242
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
4243
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html
|
4111
4244
|
#
|
4112
4245
|
# @option params [required, String] :bucket
|
4113
4246
|
# The name of the bucket for which to get the versioning information.
|
@@ -4165,13 +4298,15 @@ module Aws::S3
|
|
4165
4298
|
#
|
4166
4299
|
# The following operations are related to `DeleteBucketWebsite`\:
|
4167
4300
|
#
|
4168
|
-
# * DeleteBucketWebsite
|
4301
|
+
# * [DeleteBucketWebsite][2]
|
4169
4302
|
#
|
4170
|
-
# * PutBucketWebsite
|
4303
|
+
# * [PutBucketWebsite][3]
|
4171
4304
|
#
|
4172
4305
|
#
|
4173
4306
|
#
|
4174
4307
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html
|
4308
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketWebsite.html
|
4309
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html
|
4175
4310
|
#
|
4176
4311
|
# @option params [required, String] :bucket
|
4177
4312
|
# The bucket name for which to get the website configuration.
|
@@ -4255,13 +4390,13 @@ module Aws::S3
|
|
4255
4390
|
# To distribute large files to many people, you can save bandwidth costs
|
4256
4391
|
# by using BitTorrent. For more information, see [Amazon S3 Torrent][2].
|
4257
4392
|
# For more information about returning the ACL of an object, see
|
4258
|
-
# GetObjectAcl.
|
4393
|
+
# [GetObjectAcl][3].
|
4259
4394
|
#
|
4260
4395
|
# If the object you are retrieving is stored in the GLACIER or
|
4261
4396
|
# DEEP\_ARCHIVE storage classes, before you can retrieve the object you
|
4262
|
-
# must first restore a copy using . Otherwise, this
|
4263
|
-
# `InvalidObjectStateError` error. For information
|
4264
|
-
# archived objects, see [Restoring Archived Objects][
|
4397
|
+
# must first restore a copy using [RestoreObject][4]. Otherwise, this
|
4398
|
+
# operation returns an `InvalidObjectStateError` error. For information
|
4399
|
+
# about restoring archived objects, see [Restoring Archived Objects][5].
|
4265
4400
|
#
|
4266
4401
|
# Encryption request headers, like `x-amz-server-side-encryption`,
|
4267
4402
|
# should not be sent for GET requests if your object uses server-side
|
@@ -4275,25 +4410,25 @@ module Aws::S3
|
|
4275
4410
|
# Amazon S3, then when you GET the object, you must use the following
|
4276
4411
|
# headers:
|
4277
4412
|
#
|
4278
|
-
# * x-amz-server-side
|
4413
|
+
# * x-amz-server-side-encryption-customer-algorithm
|
4279
4414
|
#
|
4280
|
-
# * x-amz-server-side
|
4415
|
+
# * x-amz-server-side-encryption-customer-key
|
4281
4416
|
#
|
4282
|
-
# * x-amz-server-side
|
4417
|
+
# * x-amz-server-side-encryption-customer-key-MD5
|
4283
4418
|
#
|
4284
4419
|
# For more information about SSE-C, see [Server-Side Encryption (Using
|
4285
|
-
# Customer-Provided Encryption Keys)][
|
4420
|
+
# Customer-Provided Encryption Keys)][6].
|
4286
4421
|
#
|
4287
4422
|
# Assuming you have permission to read object tags (permission for the
|
4288
4423
|
# `s3:GetObjectVersionTagging` action), the response also returns the
|
4289
4424
|
# `x-amz-tagging-count` header that provides the count of number of tags
|
4290
|
-
# associated with the object. You can use GetObjectTagging to
|
4291
|
-
# the tag set associated with an object.
|
4425
|
+
# associated with the object. You can use [GetObjectTagging][7] to
|
4426
|
+
# retrieve the tag set associated with an object.
|
4292
4427
|
#
|
4293
4428
|
# **Permissions**
|
4294
4429
|
#
|
4295
4430
|
# You need the `s3:GetObject` permission for this operation. For more
|
4296
|
-
# information, see [Specifying Permissions in a Policy][
|
4431
|
+
# information, see [Specifying Permissions in a Policy][8]. If the
|
4297
4432
|
# object you request does not exist, the error Amazon S3 returns depends
|
4298
4433
|
# on whether you also have the `s3:ListBucket` permission.
|
4299
4434
|
#
|
@@ -4315,7 +4450,7 @@ module Aws::S3
|
|
4315
4450
|
#
|
4316
4451
|
# </note>
|
4317
4452
|
#
|
4318
|
-
# For more information about versioning, see PutBucketVersioning.
|
4453
|
+
# For more information about versioning, see [PutBucketVersioning][9].
|
4319
4454
|
#
|
4320
4455
|
# **Overriding Response Header Values**
|
4321
4456
|
#
|
@@ -4364,22 +4499,27 @@ module Aws::S3
|
|
4364
4499
|
# to `false`, and; `If-Modified-Since` condition evaluates to `true`;
|
4365
4500
|
# then, S3 returns 304 Not Modified response code.
|
4366
4501
|
#
|
4367
|
-
# For more information about conditional requests, see [RFC 7232][
|
4502
|
+
# For more information about conditional requests, see [RFC 7232][10].
|
4368
4503
|
#
|
4369
4504
|
# The following operations are related to `GetObject`\:
|
4370
4505
|
#
|
4371
|
-
# * ListBuckets
|
4506
|
+
# * [ListBuckets][11]
|
4372
4507
|
#
|
4373
|
-
# * GetObjectAcl
|
4508
|
+
# * [GetObjectAcl][3]
|
4374
4509
|
#
|
4375
4510
|
#
|
4376
4511
|
#
|
4377
4512
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket
|
4378
4513
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3Torrent.html
|
4379
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
4380
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
4381
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
4382
|
-
# [6]: https://
|
4514
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html
|
4515
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html
|
4516
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html
|
4517
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
|
4518
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html
|
4519
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
|
4520
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html
|
4521
|
+
# [10]: https://tools.ietf.org/html/rfc7232
|
4522
|
+
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html
|
4383
4523
|
#
|
4384
4524
|
# @option params [String, IO] :response_target
|
4385
4525
|
# Where to write response data, file path, or IO object.
|
@@ -4462,7 +4602,7 @@ module Aws::S3
|
|
4462
4602
|
# encrypting data. This value is used to store the object and then it is
|
4463
4603
|
# discarded; Amazon S3 does not store the encryption key. The key must
|
4464
4604
|
# be appropriate for use with the algorithm specified in the
|
4465
|
-
# `x-amz-server-side
|
4605
|
+
# `x-amz-server-side-encryption-customer-algorithm` header.
|
4466
4606
|
#
|
4467
4607
|
# @option params [String] :sse_customer_key_md5
|
4468
4608
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
@@ -4589,8 +4729,10 @@ module Aws::S3
|
|
4589
4729
|
#
|
4590
4730
|
# @example Streaming data to a block
|
4591
4731
|
# # WARNING: yielding data to a block disables retries of networking errors
|
4732
|
+
# # However truncation of the body will be retried automatically using a range request
|
4592
4733
|
# File.open('/path/to/file', 'wb') do |file|
|
4593
|
-
# s3.get_object(bucket: 'bucket-name', key: 'object-key') do |chunk|
|
4734
|
+
# s3.get_object(bucket: 'bucket-name', key: 'object-key') do |chunk, headers|
|
4735
|
+
# # headers['content-length']
|
4594
4736
|
# file.write(chunk)
|
4595
4737
|
# end
|
4596
4738
|
# end
|
@@ -4675,11 +4817,17 @@ module Aws::S3
|
|
4675
4817
|
#
|
4676
4818
|
# The following operations are related to `GetObjectAcl`\:
|
4677
4819
|
#
|
4678
|
-
# * GetObject
|
4820
|
+
# * [GetObject][1]
|
4821
|
+
#
|
4822
|
+
# * [DeleteObject][2]
|
4823
|
+
#
|
4824
|
+
# * [PutObject][3]
|
4679
4825
|
#
|
4680
|
-
# * DeleteObject
|
4681
4826
|
#
|
4682
|
-
#
|
4827
|
+
#
|
4828
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
4829
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html
|
4830
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
4683
4831
|
#
|
4684
4832
|
# @option params [required, String] :bucket
|
4685
4833
|
# The bucket name that contains the object for which to get the ACL
|
@@ -4996,13 +5144,14 @@ module Aws::S3
|
|
4996
5144
|
#
|
4997
5145
|
# The following operation is related to `GetObjectTagging`\:
|
4998
5146
|
#
|
4999
|
-
# * PutObjectTagging
|
5147
|
+
# * [PutObjectTagging][2]
|
5000
5148
|
#
|
5001
5149
|
# ^
|
5002
5150
|
#
|
5003
5151
|
#
|
5004
5152
|
#
|
5005
5153
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html
|
5154
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html
|
5006
5155
|
#
|
5007
5156
|
# @option params [required, String] :bucket
|
5008
5157
|
# The bucket name containing the object for which to get the tagging
|
@@ -5115,13 +5264,14 @@ module Aws::S3
|
|
5115
5264
|
#
|
5116
5265
|
# The following operation is related to `GetObjectTorrent`\:
|
5117
5266
|
#
|
5118
|
-
# * GetObject
|
5267
|
+
# * [GetObject][2]
|
5119
5268
|
#
|
5120
5269
|
# ^
|
5121
5270
|
#
|
5122
5271
|
#
|
5123
5272
|
#
|
5124
5273
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3Torrent.html
|
5274
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
5125
5275
|
#
|
5126
5276
|
# @option params [String, IO] :response_target
|
5127
5277
|
# Where to write response data, file path, or IO object.
|
@@ -5205,17 +5355,20 @@ module Aws::S3
|
|
5205
5355
|
#
|
5206
5356
|
# * [Using Amazon S3 Block Public Access][3]
|
5207
5357
|
#
|
5208
|
-
# * PutPublicAccessBlock
|
5358
|
+
# * [PutPublicAccessBlock][4]
|
5209
5359
|
#
|
5210
|
-
# * GetPublicAccessBlock
|
5360
|
+
# * [GetPublicAccessBlock][5]
|
5211
5361
|
#
|
5212
|
-
# * DeletePublicAccessBlock
|
5362
|
+
# * [DeletePublicAccessBlock][6]
|
5213
5363
|
#
|
5214
5364
|
#
|
5215
5365
|
#
|
5216
5366
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
|
5217
5367
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status
|
5218
5368
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html
|
5369
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html
|
5370
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html
|
5371
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html
|
5219
5372
|
#
|
5220
5373
|
# @option params [required, String] :bucket
|
5221
5374
|
# The name of the Amazon S3 bucket whose `PublicAccessBlock`
|
@@ -5314,11 +5467,11 @@ module Aws::S3
|
|
5314
5467
|
# Amazon S3, then when you retrieve the metadata from the object, you
|
5315
5468
|
# must use the following headers:
|
5316
5469
|
#
|
5317
|
-
# * x-amz-server-side
|
5470
|
+
# * x-amz-server-side-encryption-customer-algorithm
|
5318
5471
|
#
|
5319
|
-
# * x-amz-server-side
|
5472
|
+
# * x-amz-server-side-encryption-customer-key
|
5320
5473
|
#
|
5321
|
-
# * x-amz-server-side
|
5474
|
+
# * x-amz-server-side-encryption-customer-key-MD5
|
5322
5475
|
#
|
5323
5476
|
# For more information about SSE-C, see [Server-Side Encryption (Using
|
5324
5477
|
# Customer-Provided Encryption Keys)][1].
|
@@ -5372,7 +5525,7 @@ module Aws::S3
|
|
5372
5525
|
#
|
5373
5526
|
# The following operation is related to `HeadObject`\:
|
5374
5527
|
#
|
5375
|
-
# * GetObject
|
5528
|
+
# * [GetObject][5]
|
5376
5529
|
#
|
5377
5530
|
# ^
|
5378
5531
|
#
|
@@ -5382,6 +5535,7 @@ module Aws::S3
|
|
5382
5535
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html
|
5383
5536
|
# [3]: https://tools.ietf.org/html/rfc7232
|
5384
5537
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
|
5538
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
5385
5539
|
#
|
5386
5540
|
# @option params [required, String] :bucket
|
5387
5541
|
# The name of the bucket containing the object.
|
@@ -5427,7 +5581,7 @@ module Aws::S3
|
|
5427
5581
|
# encrypting data. This value is used to store the object and then it is
|
5428
5582
|
# discarded; Amazon S3 does not store the encryption key. The key must
|
5429
5583
|
# be appropriate for use with the algorithm specified in the
|
5430
|
-
# `x-amz-server-side
|
5584
|
+
# `x-amz-server-side-encryption-customer-algorithm` header.
|
5431
5585
|
#
|
5432
5586
|
# @option params [String] :sse_customer_key_md5
|
5433
5587
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
@@ -5597,17 +5751,20 @@ module Aws::S3
|
|
5597
5751
|
# The following operations are related to
|
5598
5752
|
# `ListBucketAnalyticsConfigurations`\:
|
5599
5753
|
#
|
5600
|
-
# * GetBucketAnalyticsConfiguration
|
5754
|
+
# * [GetBucketAnalyticsConfiguration][4]
|
5601
5755
|
#
|
5602
|
-
# * DeleteBucketAnalyticsConfiguration
|
5756
|
+
# * [DeleteBucketAnalyticsConfiguration][5]
|
5603
5757
|
#
|
5604
|
-
# * PutBucketAnalyticsConfiguration
|
5758
|
+
# * [PutBucketAnalyticsConfiguration][6]
|
5605
5759
|
#
|
5606
5760
|
#
|
5607
5761
|
#
|
5608
5762
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
5609
5763
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
5610
5764
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
|
5765
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html
|
5766
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html
|
5767
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html
|
5611
5768
|
#
|
5612
5769
|
# @option params [required, String] :bucket
|
5613
5770
|
# The name of the bucket from which analytics configurations are
|
@@ -5685,17 +5842,20 @@ module Aws::S3
|
|
5685
5842
|
# The following operations are related to
|
5686
5843
|
# `ListBucketInventoryConfigurations`\:
|
5687
5844
|
#
|
5688
|
-
# * GetBucketInventoryConfiguration
|
5845
|
+
# * [GetBucketInventoryConfiguration][4]
|
5689
5846
|
#
|
5690
|
-
# * DeleteBucketInventoryConfiguration
|
5847
|
+
# * [DeleteBucketInventoryConfiguration][5]
|
5691
5848
|
#
|
5692
|
-
# * PutBucketInventoryConfiguration
|
5849
|
+
# * [PutBucketInventoryConfiguration][6]
|
5693
5850
|
#
|
5694
5851
|
#
|
5695
5852
|
#
|
5696
5853
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
5697
5854
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
5698
5855
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
|
5856
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html
|
5857
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html
|
5858
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html
|
5699
5859
|
#
|
5700
5860
|
# @option params [required, String] :bucket
|
5701
5861
|
# The name of the bucket containing the inventory configurations to
|
@@ -5776,17 +5936,20 @@ module Aws::S3
|
|
5776
5936
|
# The following operations are related to
|
5777
5937
|
# `ListBucketMetricsConfigurations`\:
|
5778
5938
|
#
|
5779
|
-
# * PutBucketMetricsConfiguration
|
5939
|
+
# * [PutBucketMetricsConfiguration][4]
|
5780
5940
|
#
|
5781
|
-
# * GetBucketMetricsConfiguration
|
5941
|
+
# * [GetBucketMetricsConfiguration][5]
|
5782
5942
|
#
|
5783
|
-
# * DeleteBucketMetricsConfiguration
|
5943
|
+
# * [DeleteBucketMetricsConfiguration][6]
|
5784
5944
|
#
|
5785
5945
|
#
|
5786
5946
|
#
|
5787
5947
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
5788
5948
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
5789
5949
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
|
5950
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html
|
5951
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html
|
5952
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html
|
5790
5953
|
#
|
5791
5954
|
# @option params [required, String] :bucket
|
5792
5955
|
# The name of the bucket containing the metrics configurations to
|
@@ -5922,20 +6085,25 @@ module Aws::S3
|
|
5922
6085
|
#
|
5923
6086
|
# The following operations are related to `ListMultipartUploads`\:
|
5924
6087
|
#
|
5925
|
-
# * CreateMultipartUpload
|
6088
|
+
# * [CreateMultipartUpload][3]
|
5926
6089
|
#
|
5927
|
-
# * UploadPart
|
6090
|
+
# * [UploadPart][4]
|
5928
6091
|
#
|
5929
|
-
# * CompleteMultipartUpload
|
6092
|
+
# * [CompleteMultipartUpload][5]
|
5930
6093
|
#
|
5931
|
-
# * ListParts
|
6094
|
+
# * [ListParts][6]
|
5932
6095
|
#
|
5933
|
-
# * AbortMultipartUpload
|
6096
|
+
# * [AbortMultipartUpload][7]
|
5934
6097
|
#
|
5935
6098
|
#
|
5936
6099
|
#
|
5937
6100
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html
|
5938
6101
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
|
6102
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html
|
6103
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html
|
6104
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html
|
6105
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
|
6106
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
|
5939
6107
|
#
|
5940
6108
|
# @option params [required, String] :bucket
|
5941
6109
|
# Name of the bucket to which the multipart upload was initiated.
|
@@ -6020,97 +6188,97 @@ module Aws::S3
|
|
6020
6188
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6021
6189
|
#
|
6022
6190
|
#
|
6023
|
-
# @example Example:
|
6191
|
+
# @example Example: To list in-progress multipart uploads on a bucket
|
6024
6192
|
#
|
6025
|
-
# # The following example
|
6026
|
-
# # setup of multipart uploads.
|
6193
|
+
# # The following example lists in-progress multipart uploads on a specific bucket.
|
6027
6194
|
#
|
6028
6195
|
# resp = client.list_multipart_uploads({
|
6029
6196
|
# bucket: "examplebucket",
|
6030
|
-
# key_marker: "nextkeyfrompreviousresponse",
|
6031
|
-
# max_uploads: 2,
|
6032
|
-
# upload_id_marker: "valuefrompreviousresponse",
|
6033
6197
|
# })
|
6034
6198
|
#
|
6035
6199
|
# resp.to_h outputs the following:
|
6036
6200
|
# {
|
6037
|
-
# bucket: "acl1",
|
6038
|
-
# is_truncated: true,
|
6039
|
-
# key_marker: "",
|
6040
|
-
# max_uploads: 2,
|
6041
|
-
# next_key_marker: "someobjectkey",
|
6042
|
-
# next_upload_id_marker: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
6043
|
-
# upload_id_marker: "",
|
6044
6201
|
# uploads: [
|
6045
6202
|
# {
|
6046
6203
|
# initiated: Time.parse("2014-05-01T05:40:58.000Z"),
|
6047
6204
|
# initiator: {
|
6048
|
-
# display_name: "
|
6205
|
+
# display_name: "display-name",
|
6049
6206
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
6050
6207
|
# },
|
6051
6208
|
# key: "JavaFile",
|
6052
6209
|
# owner: {
|
6053
|
-
# display_name: "
|
6054
|
-
# id: "
|
6210
|
+
# display_name: "display-name",
|
6211
|
+
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
6055
6212
|
# },
|
6056
6213
|
# storage_class: "STANDARD",
|
6057
|
-
# upload_id: "
|
6214
|
+
# upload_id: "examplelUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--",
|
6058
6215
|
# },
|
6059
6216
|
# {
|
6060
6217
|
# initiated: Time.parse("2014-05-01T05:41:27.000Z"),
|
6061
6218
|
# initiator: {
|
6062
|
-
# display_name: "
|
6219
|
+
# display_name: "display-name",
|
6063
6220
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
6064
6221
|
# },
|
6065
6222
|
# key: "JavaFile",
|
6066
6223
|
# owner: {
|
6067
|
-
# display_name: "
|
6224
|
+
# display_name: "display-name",
|
6068
6225
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
6069
6226
|
# },
|
6070
6227
|
# storage_class: "STANDARD",
|
6071
|
-
# upload_id: "
|
6228
|
+
# upload_id: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
6072
6229
|
# },
|
6073
6230
|
# ],
|
6074
6231
|
# }
|
6075
6232
|
#
|
6076
|
-
# @example Example:
|
6233
|
+
# @example Example: List next set of multipart uploads when previous result is truncated
|
6077
6234
|
#
|
6078
|
-
# # The following example
|
6235
|
+
# # The following example specifies the upload-id-marker and key-marker from previous truncated response to retrieve next
|
6236
|
+
# # setup of multipart uploads.
|
6079
6237
|
#
|
6080
6238
|
# resp = client.list_multipart_uploads({
|
6081
6239
|
# bucket: "examplebucket",
|
6240
|
+
# key_marker: "nextkeyfrompreviousresponse",
|
6241
|
+
# max_uploads: 2,
|
6242
|
+
# upload_id_marker: "valuefrompreviousresponse",
|
6082
6243
|
# })
|
6083
6244
|
#
|
6084
6245
|
# resp.to_h outputs the following:
|
6085
6246
|
# {
|
6247
|
+
# bucket: "acl1",
|
6248
|
+
# is_truncated: true,
|
6249
|
+
# key_marker: "",
|
6250
|
+
# max_uploads: 2,
|
6251
|
+
# next_key_marker: "someobjectkey",
|
6252
|
+
# next_upload_id_marker: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
6253
|
+
# upload_id_marker: "",
|
6086
6254
|
# uploads: [
|
6087
6255
|
# {
|
6088
6256
|
# initiated: Time.parse("2014-05-01T05:40:58.000Z"),
|
6089
6257
|
# initiator: {
|
6090
|
-
# display_name: "display-name",
|
6258
|
+
# display_name: "ownder-display-name",
|
6091
6259
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
6092
6260
|
# },
|
6093
6261
|
# key: "JavaFile",
|
6094
6262
|
# owner: {
|
6095
|
-
# display_name: "
|
6096
|
-
# id: "
|
6263
|
+
# display_name: "mohanataws",
|
6264
|
+
# id: "852b113e7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
6097
6265
|
# },
|
6098
6266
|
# storage_class: "STANDARD",
|
6099
|
-
# upload_id: "
|
6267
|
+
# upload_id: "gZ30jIqlUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--",
|
6100
6268
|
# },
|
6101
6269
|
# {
|
6102
6270
|
# initiated: Time.parse("2014-05-01T05:41:27.000Z"),
|
6103
6271
|
# initiator: {
|
6104
|
-
# display_name: "display-name",
|
6272
|
+
# display_name: "ownder-display-name",
|
6105
6273
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
6106
6274
|
# },
|
6107
6275
|
# key: "JavaFile",
|
6108
6276
|
# owner: {
|
6109
|
-
# display_name: "display-name",
|
6277
|
+
# display_name: "ownder-display-name",
|
6110
6278
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
6111
6279
|
# },
|
6112
6280
|
# storage_class: "STANDARD",
|
6113
|
-
# upload_id: "
|
6281
|
+
# upload_id: "b7tZSqIlo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
6114
6282
|
# },
|
6115
6283
|
# ],
|
6116
6284
|
# }
|
@@ -6174,13 +6342,20 @@ module Aws::S3
|
|
6174
6342
|
#
|
6175
6343
|
# The following operations are related to `ListObjectVersions`\:
|
6176
6344
|
#
|
6177
|
-
# * ListObjectsV2
|
6345
|
+
# * [ListObjectsV2][1]
|
6346
|
+
#
|
6347
|
+
# * [GetObject][2]
|
6348
|
+
#
|
6349
|
+
# * [PutObject][3]
|
6350
|
+
#
|
6351
|
+
# * [DeleteObject][4]
|
6178
6352
|
#
|
6179
|
-
# * GetObject
|
6180
6353
|
#
|
6181
|
-
# * PutObject
|
6182
6354
|
#
|
6183
|
-
#
|
6355
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html
|
6356
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
6357
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
6358
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html
|
6184
6359
|
#
|
6185
6360
|
# @option params [required, String] :bucket
|
6186
6361
|
# The bucket name that contains the objects.
|
@@ -6357,20 +6532,28 @@ module Aws::S3
|
|
6357
6532
|
# of the response and handle it appropriately.
|
6358
6533
|
#
|
6359
6534
|
# This API has been revised. We recommend that you use the newer
|
6360
|
-
# version, ListObjectsV2, when developing applications. For
|
6361
|
-
# compatibility, Amazon S3 continues to support `ListObjects`.
|
6535
|
+
# version, [ListObjectsV2][1], when developing applications. For
|
6536
|
+
# backward compatibility, Amazon S3 continues to support `ListObjects`.
|
6362
6537
|
#
|
6363
6538
|
# The following operations are related to `ListObjects`\:
|
6364
6539
|
#
|
6365
|
-
# * ListObjectsV2
|
6540
|
+
# * [ListObjectsV2][1]
|
6366
6541
|
#
|
6367
|
-
# * GetObject
|
6542
|
+
# * [GetObject][2]
|
6368
6543
|
#
|
6369
|
-
# * PutObject
|
6544
|
+
# * [PutObject][3]
|
6370
6545
|
#
|
6371
|
-
# * CreateBucket
|
6546
|
+
# * [CreateBucket][4]
|
6372
6547
|
#
|
6373
|
-
# * ListBuckets
|
6548
|
+
# * [ListBuckets][5]
|
6549
|
+
#
|
6550
|
+
#
|
6551
|
+
#
|
6552
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html
|
6553
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
6554
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
6555
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
6556
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html
|
6374
6557
|
#
|
6375
6558
|
# @option params [required, String] :bucket
|
6376
6559
|
# The name of the bucket containing the objects.
|
@@ -6516,22 +6699,27 @@ module Aws::S3
|
|
6516
6699
|
# This section describes the latest revision of the API. We recommend
|
6517
6700
|
# that you use this revised API for application development. For
|
6518
6701
|
# backward compatibility, Amazon S3 continues to support the prior
|
6519
|
-
# version of this API, ListObjects.
|
6702
|
+
# version of this API, [ListObjects][3].
|
6520
6703
|
#
|
6521
|
-
# To get a list of your buckets, see ListBuckets.
|
6704
|
+
# To get a list of your buckets, see [ListBuckets][4].
|
6522
6705
|
#
|
6523
6706
|
# The following operations are related to `ListObjectsV2`\:
|
6524
6707
|
#
|
6525
|
-
# * GetObject
|
6708
|
+
# * [GetObject][5]
|
6526
6709
|
#
|
6527
|
-
# * PutObject
|
6710
|
+
# * [PutObject][6]
|
6528
6711
|
#
|
6529
|
-
# * CreateBucket
|
6712
|
+
# * [CreateBucket][7]
|
6530
6713
|
#
|
6531
6714
|
#
|
6532
6715
|
#
|
6533
6716
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
6534
6717
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
6718
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html
|
6719
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html
|
6720
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
6721
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
6722
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
6535
6723
|
#
|
6536
6724
|
# @option params [required, String] :bucket
|
6537
6725
|
# Bucket name to list.
|
@@ -6685,7 +6873,7 @@ module Aws::S3
|
|
6685
6873
|
# Lists the parts that have been uploaded for a specific multipart
|
6686
6874
|
# upload. This operation must include the upload ID, which you obtain by
|
6687
6875
|
# sending the initiate multipart upload request (see
|
6688
|
-
# CreateMultipartUpload). This request returns a maximum of 1,000
|
6876
|
+
# [CreateMultipartUpload][1]). This request returns a maximum of 1,000
|
6689
6877
|
# uploaded parts. The default number of parts returned is 1,000 parts.
|
6690
6878
|
# You can restrict the number of parts returned by specifying the
|
6691
6879
|
# `max-parts` request parameter. If your multipart upload consists of
|
@@ -6696,27 +6884,32 @@ module Aws::S3
|
|
6696
6884
|
# field value from the previous response.
|
6697
6885
|
#
|
6698
6886
|
# For more information on multipart uploads, see [Uploading Objects
|
6699
|
-
# Using Multipart Upload][
|
6887
|
+
# Using Multipart Upload][2].
|
6700
6888
|
#
|
6701
6889
|
# For information on permissions required to use the multipart upload
|
6702
|
-
# API, see [Multipart Upload API and Permissions][
|
6890
|
+
# API, see [Multipart Upload API and Permissions][3].
|
6703
6891
|
#
|
6704
6892
|
# The following operations are related to `ListParts`\:
|
6705
6893
|
#
|
6706
|
-
# * CreateMultipartUpload
|
6894
|
+
# * [CreateMultipartUpload][1]
|
6707
6895
|
#
|
6708
|
-
# * UploadPart
|
6896
|
+
# * [UploadPart][4]
|
6709
6897
|
#
|
6710
|
-
# * CompleteMultipartUpload
|
6898
|
+
# * [CompleteMultipartUpload][5]
|
6711
6899
|
#
|
6712
|
-
# * AbortMultipartUpload
|
6900
|
+
# * [AbortMultipartUpload][6]
|
6713
6901
|
#
|
6714
|
-
# * ListMultipartUploads
|
6902
|
+
# * [ListMultipartUploads][7]
|
6715
6903
|
#
|
6716
6904
|
#
|
6717
6905
|
#
|
6718
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6719
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
6906
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html
|
6907
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html
|
6908
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
|
6909
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html
|
6910
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html
|
6911
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
|
6912
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
|
6720
6913
|
#
|
6721
6914
|
# @option params [required, String] :bucket
|
6722
6915
|
# Name of the bucket to which the parts are being uploaded.
|
@@ -6876,8 +7069,8 @@ module Aws::S3
|
|
6876
7069
|
#
|
6877
7070
|
# * Suspended – Disables accelerated data transfers to the bucket.
|
6878
7071
|
#
|
6879
|
-
# The GetBucketAccelerateConfiguration operation returns the
|
6880
|
-
# acceleration state of a bucket.
|
7072
|
+
# The [GetBucketAccelerateConfiguration][3] operation returns the
|
7073
|
+
# transfer acceleration state of a bucket.
|
6881
7074
|
#
|
6882
7075
|
# After setting the Transfer Acceleration state of a bucket to Enabled,
|
6883
7076
|
# it might take up to thirty minutes before the data transfer rates to
|
@@ -6887,20 +7080,22 @@ module Aws::S3
|
|
6887
7080
|
# DNS-compliant and must not contain periods (".").
|
6888
7081
|
#
|
6889
7082
|
# For more information about transfer acceleration, see [Transfer
|
6890
|
-
# Acceleration][
|
7083
|
+
# Acceleration][4].
|
6891
7084
|
#
|
6892
7085
|
# The following operations are related to
|
6893
7086
|
# `PutBucketAccelerateConfiguration`\:
|
6894
7087
|
#
|
6895
|
-
# * GetBucketAccelerateConfiguration
|
7088
|
+
# * [GetBucketAccelerateConfiguration][3]
|
6896
7089
|
#
|
6897
|
-
# * CreateBucket
|
7090
|
+
# * [CreateBucket][5]
|
6898
7091
|
#
|
6899
7092
|
#
|
6900
7093
|
#
|
6901
7094
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
6902
7095
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
6903
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7096
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html
|
7097
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
|
7098
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
6904
7099
|
#
|
6905
7100
|
# @option params [required, String] :bucket
|
6906
7101
|
# Name of the bucket for which the accelerate configuration is set.
|
@@ -7069,11 +7264,11 @@ module Aws::S3
|
|
7069
7264
|
#
|
7070
7265
|
# **Related Resources**
|
7071
7266
|
#
|
7072
|
-
# * CreateBucket
|
7267
|
+
# * [CreateBucket][5]
|
7073
7268
|
#
|
7074
|
-
# * DeleteBucket
|
7269
|
+
# * [DeleteBucket][6]
|
7075
7270
|
#
|
7076
|
-
# * GetObjectAcl
|
7271
|
+
# * [GetObjectAcl][7]
|
7077
7272
|
#
|
7078
7273
|
#
|
7079
7274
|
#
|
@@ -7081,6 +7276,9 @@ module Aws::S3
|
|
7081
7276
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
|
7082
7277
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
7083
7278
|
# [4]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
|
7279
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
7280
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html
|
7281
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html
|
7084
7282
|
#
|
7085
7283
|
# @option params [String] :acl
|
7086
7284
|
# The canned ACL to apply to the bucket.
|
@@ -7225,9 +7423,11 @@ module Aws::S3
|
|
7225
7423
|
#
|
7226
7424
|
# **Related Resources**
|
7227
7425
|
#
|
7228
|
-
# *
|
7229
|
-
#
|
7230
|
-
# *
|
7426
|
+
# * [GetBucketAnalyticsConfiguration][5]
|
7427
|
+
#
|
7428
|
+
# * [DeleteBucketAnalyticsConfiguration][6]
|
7429
|
+
#
|
7430
|
+
# * [ListBucketAnalyticsConfigurations][7]
|
7231
7431
|
#
|
7232
7432
|
#
|
7233
7433
|
#
|
@@ -7235,6 +7435,9 @@ module Aws::S3
|
|
7235
7435
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9
|
7236
7436
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
7237
7437
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
7438
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html
|
7439
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html
|
7440
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html
|
7238
7441
|
#
|
7239
7442
|
# @option params [required, String] :bucket
|
7240
7443
|
# The name of the bucket to which an analytics configuration is stored.
|
@@ -7335,15 +7538,18 @@ module Aws::S3
|
|
7335
7538
|
#
|
7336
7539
|
# **Related Resources**
|
7337
7540
|
#
|
7338
|
-
# * GetBucketCors
|
7541
|
+
# * [GetBucketCors][2]
|
7339
7542
|
#
|
7340
|
-
# * DeleteBucketCors
|
7543
|
+
# * [DeleteBucketCors][3]
|
7341
7544
|
#
|
7342
|
-
# * RESTOPTIONSobject
|
7545
|
+
# * [RESTOPTIONSobject][4]
|
7343
7546
|
#
|
7344
7547
|
#
|
7345
7548
|
#
|
7346
7549
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html
|
7550
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketCors.html
|
7551
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html
|
7552
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html
|
7347
7553
|
#
|
7348
7554
|
# @option params [required, String] :bucket
|
7349
7555
|
# Specifies the bucket impacted by the `cors`configuration.
|
@@ -7463,15 +7669,17 @@ module Aws::S3
|
|
7463
7669
|
#
|
7464
7670
|
# **Related Resources**
|
7465
7671
|
#
|
7466
|
-
# * GetBucketEncryption
|
7672
|
+
# * [GetBucketEncryption][4]
|
7467
7673
|
#
|
7468
|
-
# * DeleteBucketEncryption
|
7674
|
+
# * [DeleteBucketEncryption][5]
|
7469
7675
|
#
|
7470
7676
|
#
|
7471
7677
|
#
|
7472
7678
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
|
7473
7679
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
7474
7680
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
7681
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html
|
7682
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html
|
7475
7683
|
#
|
7476
7684
|
# @option params [required, String] :bucket
|
7477
7685
|
# Specifies default encryption for a bucket using server-side encryption
|
@@ -7577,11 +7785,11 @@ module Aws::S3
|
|
7577
7785
|
#
|
7578
7786
|
# **Related Resources**
|
7579
7787
|
#
|
7580
|
-
# * GetBucketInventoryConfiguration
|
7788
|
+
# * [GetBucketInventoryConfiguration][5]
|
7581
7789
|
#
|
7582
|
-
# * DeleteBucketInventoryConfiguration
|
7790
|
+
# * [DeleteBucketInventoryConfiguration][6]
|
7583
7791
|
#
|
7584
|
-
# * ListBucketInventoryConfigurations
|
7792
|
+
# * [ListBucketInventoryConfigurations][7]
|
7585
7793
|
#
|
7586
7794
|
#
|
7587
7795
|
#
|
@@ -7589,6 +7797,9 @@ module Aws::S3
|
|
7589
7797
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9
|
7590
7798
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
7591
7799
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
7800
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html
|
7801
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html
|
7802
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html
|
7592
7803
|
#
|
7593
7804
|
# @option params [required, String] :bucket
|
7594
7805
|
# The name of the bucket where the inventory configuration will be
|
@@ -7646,13 +7857,13 @@ module Aws::S3
|
|
7646
7857
|
end
|
7647
7858
|
|
7648
7859
|
# For an updated version of this API, see
|
7649
|
-
# PutBucketLifecycleConfiguration. This version has been
|
7650
|
-
# Existing lifecycle configurations will work. For new
|
7651
|
-
# configurations, use the updated API.
|
7860
|
+
# [PutBucketLifecycleConfiguration][1]. This version has been
|
7861
|
+
# deprecated. Existing lifecycle configurations will work. For new
|
7862
|
+
# lifecycle configurations, use the updated API.
|
7652
7863
|
#
|
7653
7864
|
# Creates a new lifecycle configuration for the bucket or replaces an
|
7654
7865
|
# existing lifecycle configuration. For information about lifecycle
|
7655
|
-
# configuration, see [Object Lifecycle Management][
|
7866
|
+
# configuration, see [Object Lifecycle Management][2] in the *Amazon
|
7656
7867
|
# Simple Storage Service Developer Guide*.
|
7657
7868
|
#
|
7658
7869
|
# By default, all Amazon S3 resources, including buckets, objects, and
|
@@ -7675,36 +7886,41 @@ module Aws::S3
|
|
7675
7886
|
# * `s3:PutLifecycleConfiguration`
|
7676
7887
|
#
|
7677
7888
|
# For more information about permissions, see [Managing Access
|
7678
|
-
# Permissions to your Amazon S3 Resources][
|
7889
|
+
# Permissions to your Amazon S3 Resources][3] in the *Amazon Simple
|
7679
7890
|
# Storage Service Developer Guide*.
|
7680
7891
|
#
|
7681
7892
|
# For more examples of transitioning objects to storage classes such as
|
7682
7893
|
# STANDARD\_IA or ONEZONE\_IA, see [Examples of Lifecycle
|
7683
|
-
# Configuration][
|
7894
|
+
# Configuration][4].
|
7684
7895
|
#
|
7685
7896
|
# **Related Resources**
|
7686
7897
|
#
|
7687
|
-
# * GetBucketLifecycle(Deprecated)
|
7898
|
+
# * [GetBucketLifecycle][5](Deprecated)
|
7899
|
+
#
|
7900
|
+
# * [GetBucketLifecycleConfiguration][6]
|
7688
7901
|
#
|
7689
|
-
# *
|
7902
|
+
# * [RestoreObject][7]
|
7690
7903
|
#
|
7691
|
-
# *
|
7692
7904
|
# * By default, a resource owner—in this case, a bucket owner, which is
|
7693
7905
|
# the AWS account that created the bucket—can perform any of the
|
7694
7906
|
# operations. A resource owner can also grant others permission to
|
7695
7907
|
# perform the operation. For more information, see the following
|
7696
7908
|
# topics in the Amazon Simple Storage Service Developer Guide:
|
7697
7909
|
#
|
7698
|
-
# * [Specifying Permissions in a Policy][
|
7910
|
+
# * [Specifying Permissions in a Policy][8]
|
7699
7911
|
#
|
7700
|
-
# * [Managing Access Permissions to your Amazon S3 Resources][
|
7912
|
+
# * [Managing Access Permissions to your Amazon S3 Resources][3]
|
7701
7913
|
#
|
7702
7914
|
#
|
7703
7915
|
#
|
7704
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7705
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
7706
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
7707
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
7916
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html
|
7917
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
7918
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
7919
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#lifecycle-configuration-examples
|
7920
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html
|
7921
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html
|
7922
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html
|
7923
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
|
7708
7924
|
#
|
7709
7925
|
# @option params [required, String] :bucket
|
7710
7926
|
#
|
@@ -7770,7 +7986,7 @@ module Aws::S3
|
|
7770
7986
|
# API. The previous version of the API supported filtering based only on
|
7771
7987
|
# an object key name prefix, which is supported for backward
|
7772
7988
|
# compatibility. For the related API description, see
|
7773
|
-
# PutBucketLifecycle.
|
7989
|
+
# [PutBucketLifecycle][2].
|
7774
7990
|
#
|
7775
7991
|
# </note>
|
7776
7992
|
#
|
@@ -7794,8 +8010,8 @@ module Aws::S3
|
|
7794
8010
|
# S3 provides predefined actions that you can specify for current and
|
7795
8011
|
# noncurrent object versions.
|
7796
8012
|
#
|
7797
|
-
# For more information, see [Object Lifecycle Management][
|
7798
|
-
# [Lifecycle Configuration Elements][
|
8013
|
+
# For more information, see [Object Lifecycle Management][3] and
|
8014
|
+
# [Lifecycle Configuration Elements][4].
|
7799
8015
|
#
|
7800
8016
|
# **Permissions**
|
7801
8017
|
#
|
@@ -7823,18 +8039,21 @@ module Aws::S3
|
|
7823
8039
|
#
|
7824
8040
|
# The following are related to `PutBucketLifecycleConfiguration`\:
|
7825
8041
|
#
|
7826
|
-
# * [Examples of Lifecycle Configuration][
|
8042
|
+
# * [Examples of Lifecycle Configuration][5]
|
7827
8043
|
#
|
7828
|
-
# * GetBucketLifecycleConfiguration
|
8044
|
+
# * [GetBucketLifecycleConfiguration][6]
|
7829
8045
|
#
|
7830
|
-
# * DeleteBucketLifecycle
|
8046
|
+
# * [DeleteBucketLifecycle][7]
|
7831
8047
|
#
|
7832
8048
|
#
|
7833
8049
|
#
|
7834
8050
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
7835
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7836
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
7837
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-
|
8051
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html
|
8052
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
8053
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html
|
8054
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-configuration-examples.html
|
8055
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html
|
8056
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html
|
7838
8057
|
#
|
7839
8058
|
# @option params [required, String] :bucket
|
7840
8059
|
# The name of the bucket for which to set the configuration.
|
@@ -7983,23 +8202,27 @@ module Aws::S3
|
|
7983
8202
|
# For more information about server access logging, see [Server Access
|
7984
8203
|
# Logging][1].
|
7985
8204
|
#
|
7986
|
-
# For more information about creating a bucket, see CreateBucket.
|
7987
|
-
# more information about returning the logging status of a bucket,
|
7988
|
-
# GetBucketLogging.
|
8205
|
+
# For more information about creating a bucket, see [CreateBucket][2].
|
8206
|
+
# For more information about returning the logging status of a bucket,
|
8207
|
+
# see [GetBucketLogging][3].
|
7989
8208
|
#
|
7990
8209
|
# The following operations are related to `PutBucketLogging`\:
|
7991
8210
|
#
|
7992
|
-
# * PutObject
|
8211
|
+
# * [PutObject][4]
|
7993
8212
|
#
|
7994
|
-
# * DeleteBucket
|
8213
|
+
# * [DeleteBucket][5]
|
7995
8214
|
#
|
7996
|
-
# * CreateBucket
|
8215
|
+
# * [CreateBucket][2]
|
7997
8216
|
#
|
7998
|
-
# * GetBucketLogging
|
8217
|
+
# * [GetBucketLogging][3]
|
7999
8218
|
#
|
8000
8219
|
#
|
8001
8220
|
#
|
8002
8221
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerLogs.html
|
8222
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
8223
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html
|
8224
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
8225
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html
|
8003
8226
|
#
|
8004
8227
|
# @option params [required, String] :bucket
|
8005
8228
|
# The name of the bucket for which to set the logging parameters.
|
@@ -8091,11 +8314,11 @@ module Aws::S3
|
|
8091
8314
|
# The following operations are related to
|
8092
8315
|
# `PutBucketMetricsConfiguration`\:
|
8093
8316
|
#
|
8094
|
-
# * DeleteBucketMetricsConfiguration
|
8317
|
+
# * [DeleteBucketMetricsConfiguration][4]
|
8095
8318
|
#
|
8096
|
-
# * PutBucketMetricsConfiguration
|
8319
|
+
# * [PutBucketMetricsConfiguration][5]
|
8097
8320
|
#
|
8098
|
-
# * ListBucketMetricsConfigurations
|
8321
|
+
# * [ListBucketMetricsConfigurations][6]
|
8099
8322
|
#
|
8100
8323
|
# `GetBucketLifecycle` has the following special error:
|
8101
8324
|
#
|
@@ -8111,6 +8334,9 @@ module Aws::S3
|
|
8111
8334
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
8112
8335
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
8113
8336
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
|
8337
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html
|
8338
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html
|
8339
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html
|
8114
8340
|
#
|
8115
8341
|
# @option params [required, String] :bucket
|
8116
8342
|
# The name of the bucket for which the metrics configuration is set.
|
@@ -8158,7 +8384,12 @@ module Aws::S3
|
|
8158
8384
|
req.send_request(options)
|
8159
8385
|
end
|
8160
8386
|
|
8161
|
-
# No longer used, see the PutBucketNotificationConfiguration
|
8387
|
+
# No longer used, see the [PutBucketNotificationConfiguration][1]
|
8388
|
+
# operation.
|
8389
|
+
#
|
8390
|
+
#
|
8391
|
+
#
|
8392
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotificationConfiguration.html
|
8162
8393
|
#
|
8163
8394
|
# @option params [required, String] :bucket
|
8164
8395
|
# The name of the bucket.
|
@@ -8266,13 +8497,14 @@ module Aws::S3
|
|
8266
8497
|
# The following operation is related to
|
8267
8498
|
# `PutBucketNotificationConfiguration`\:
|
8268
8499
|
#
|
8269
|
-
# * GetBucketNotificationConfiguration
|
8500
|
+
# * [GetBucketNotificationConfiguration][2]
|
8270
8501
|
#
|
8271
8502
|
# ^
|
8272
8503
|
#
|
8273
8504
|
#
|
8274
8505
|
#
|
8275
8506
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html
|
8507
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html
|
8276
8508
|
#
|
8277
8509
|
# @option params [required, String] :bucket
|
8278
8510
|
# The name of the bucket.
|
@@ -8391,13 +8623,15 @@ module Aws::S3
|
|
8391
8623
|
#
|
8392
8624
|
# The following operations are related to `PutBucketPolicy`\:
|
8393
8625
|
#
|
8394
|
-
# * CreateBucket
|
8626
|
+
# * [CreateBucket][2]
|
8395
8627
|
#
|
8396
|
-
# * DeleteBucket
|
8628
|
+
# * [DeleteBucket][3]
|
8397
8629
|
#
|
8398
8630
|
#
|
8399
8631
|
#
|
8400
8632
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html
|
8633
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
8634
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html
|
8401
8635
|
#
|
8402
8636
|
# @option params [required, String] :bucket
|
8403
8637
|
# The name of the bucket.
|
@@ -8470,6 +8704,17 @@ module Aws::S3
|
|
8470
8704
|
# configuration, you must also add the following elements:
|
8471
8705
|
# `DeleteMarkerReplication`, `Status`, and `Priority`.
|
8472
8706
|
#
|
8707
|
+
# <note markdown="1"> The latest version of the replication configuration XML is V2. XML V2
|
8708
|
+
# replication configurations are those that contain the `Filter` element
|
8709
|
+
# for rules, and rules that specify S3 Replication Time Control (S3
|
8710
|
+
# RTC). In XML V2 replication configurations, Amazon S3 doesn't
|
8711
|
+
# replicate delete markers. Therefore, you must set the
|
8712
|
+
# `DeleteMarkerReplication` element to `Disabled`. For backward
|
8713
|
+
# compatibility, Amazon S3 continues to support the XML V1 replication
|
8714
|
+
# configuration.
|
8715
|
+
#
|
8716
|
+
# </note>
|
8717
|
+
#
|
8473
8718
|
# For information about enabling versioning on a bucket, see [Using
|
8474
8719
|
# Versioning][3].
|
8475
8720
|
#
|
@@ -8490,14 +8735,14 @@ module Aws::S3
|
|
8490
8735
|
# about replication configuration, see [Replicating Objects Created with
|
8491
8736
|
# SSE Using CMKs stored in AWS KMS][6].
|
8492
8737
|
#
|
8493
|
-
# For information on `PutBucketReplication` errors, see
|
8494
|
-
#
|
8738
|
+
# For information on `PutBucketReplication` errors, see [List of
|
8739
|
+
# replication-related error codes][7]
|
8495
8740
|
#
|
8496
8741
|
# The following operations are related to `PutBucketReplication`\:
|
8497
8742
|
#
|
8498
|
-
# * GetBucketReplication
|
8743
|
+
# * [GetBucketReplication][8]
|
8499
8744
|
#
|
8500
|
-
# * DeleteBucketReplication
|
8745
|
+
# * [DeleteBucketReplication][9]
|
8501
8746
|
#
|
8502
8747
|
#
|
8503
8748
|
#
|
@@ -8507,6 +8752,9 @@ module Aws::S3
|
|
8507
8752
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
|
8508
8753
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
8509
8754
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html
|
8755
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList
|
8756
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html
|
8757
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html
|
8510
8758
|
#
|
8511
8759
|
# @option params [required, String] :bucket
|
8512
8760
|
# The name of the bucket
|
@@ -8636,13 +8884,15 @@ module Aws::S3
|
|
8636
8884
|
#
|
8637
8885
|
# The following operations are related to `PutBucketRequestPayment`\:
|
8638
8886
|
#
|
8639
|
-
# * CreateBucket
|
8887
|
+
# * [CreateBucket][2]
|
8640
8888
|
#
|
8641
|
-
# * GetBucketRequestPayment
|
8889
|
+
# * [GetBucketRequestPayment][3]
|
8642
8890
|
#
|
8643
8891
|
#
|
8644
8892
|
#
|
8645
8893
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html
|
8894
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
8895
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketRequestPayment.html
|
8646
8896
|
#
|
8647
8897
|
# @option params [required, String] :bucket
|
8648
8898
|
# The bucket name.
|
@@ -8750,9 +9000,9 @@ module Aws::S3
|
|
8750
9000
|
#
|
8751
9001
|
# The following operations are related to `PutBucketTagging`\:
|
8752
9002
|
#
|
8753
|
-
# * GetBucketTagging
|
9003
|
+
# * [GetBucketTagging][7]
|
8754
9004
|
#
|
8755
|
-
# * DeleteBucketTagging
|
9005
|
+
# * [DeleteBucketTagging][8]
|
8756
9006
|
#
|
8757
9007
|
#
|
8758
9008
|
#
|
@@ -8762,6 +9012,8 @@ module Aws::S3
|
|
8762
9012
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
8763
9013
|
# [5]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html
|
8764
9014
|
# [6]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html
|
9015
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html
|
9016
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html
|
8765
9017
|
#
|
8766
9018
|
# @option params [required, String] :bucket
|
8767
9019
|
# The bucket name.
|
@@ -8837,7 +9089,7 @@ module Aws::S3
|
|
8837
9089
|
# objects added to the bucket receive the version ID null.
|
8838
9090
|
#
|
8839
9091
|
# If the versioning state has never been set on a bucket, it has no
|
8840
|
-
# versioning state; a GetBucketVersioning request does not return a
|
9092
|
+
# versioning state; a [GetBucketVersioning][1] request does not return a
|
8841
9093
|
# versioning state value.
|
8842
9094
|
#
|
8843
9095
|
# If the bucket owner enables MFA Delete in the bucket versioning
|
@@ -8852,19 +9104,22 @@ module Aws::S3
|
|
8852
9104
|
# manage the deletes of the noncurrent object versions in the
|
8853
9105
|
# version-enabled bucket. (A version-enabled bucket maintains one
|
8854
9106
|
# current and zero or more noncurrent object versions.) For more
|
8855
|
-
# information, see [Lifecycle and Versioning][
|
9107
|
+
# information, see [Lifecycle and Versioning][2].
|
8856
9108
|
#
|
8857
9109
|
# **Related Resources**
|
8858
9110
|
#
|
8859
|
-
# * CreateBucket
|
9111
|
+
# * [CreateBucket][3]
|
8860
9112
|
#
|
8861
|
-
# * DeleteBucket
|
9113
|
+
# * [DeleteBucket][4]
|
8862
9114
|
#
|
8863
|
-
# * GetBucketVersioning
|
9115
|
+
# * [GetBucketVersioning][1]
|
8864
9116
|
#
|
8865
9117
|
#
|
8866
9118
|
#
|
8867
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9119
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html
|
9120
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-and-other-bucket-config
|
9121
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
9122
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html
|
8868
9123
|
#
|
8869
9124
|
# @option params [required, String] :bucket
|
8870
9125
|
# The bucket name.
|
@@ -9137,13 +9392,13 @@ module Aws::S3
|
|
9137
9392
|
#
|
9138
9393
|
# For more information about versioning, see [Adding Objects to
|
9139
9394
|
# Versioning Enabled Buckets][6]. For information about returning the
|
9140
|
-
# versioning state of a bucket, see GetBucketVersioning.
|
9395
|
+
# versioning state of a bucket, see [GetBucketVersioning][7].
|
9141
9396
|
#
|
9142
9397
|
# **Related Resources**
|
9143
9398
|
#
|
9144
|
-
# * CopyObject
|
9399
|
+
# * [CopyObject][8]
|
9145
9400
|
#
|
9146
|
-
# * DeleteObject
|
9401
|
+
# * [DeleteObject][9]
|
9147
9402
|
#
|
9148
9403
|
#
|
9149
9404
|
#
|
@@ -9153,6 +9408,9 @@ module Aws::S3
|
|
9153
9408
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html
|
9154
9409
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html
|
9155
9410
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html
|
9411
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html
|
9412
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html
|
9413
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html
|
9156
9414
|
#
|
9157
9415
|
# @option params [String] :acl
|
9158
9416
|
# The canned ACL to apply to the object. For more information, see
|
@@ -9162,7 +9420,7 @@ module Aws::S3
|
|
9162
9420
|
#
|
9163
9421
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
|
9164
9422
|
#
|
9165
|
-
# @option params [String,
|
9423
|
+
# @option params [String, StringIO, File] :body
|
9166
9424
|
# Object data.
|
9167
9425
|
#
|
9168
9426
|
# @option params [required, String] :bucket
|
@@ -9313,7 +9571,7 @@ module Aws::S3
|
|
9313
9571
|
# encrypting data. This value is used to store the object and then it is
|
9314
9572
|
# discarded; Amazon S3 does not store the encryption key. The key must
|
9315
9573
|
# be appropriate for use with the algorithm specified in the
|
9316
|
-
# `x-amz-server-side
|
9574
|
+
# `x-amz-server-side-encryption-customer-algorithm` header.
|
9317
9575
|
#
|
9318
9576
|
# @option params [String] :sse_customer_key_md5
|
9319
9577
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
@@ -9380,134 +9638,134 @@ module Aws::S3
|
|
9380
9638
|
# * {Types::PutObjectOutput#request_charged #request_charged} => String
|
9381
9639
|
#
|
9382
9640
|
#
|
9383
|
-
# @example Example: To upload
|
9641
|
+
# @example Example: To upload object and specify user-defined metadata
|
9384
9642
|
#
|
9385
|
-
# # The following example
|
9386
|
-
# #
|
9643
|
+
# # The following example creates an object. The request also specifies optional metadata. If the bucket is versioning
|
9644
|
+
# # enabled, S3 returns version ID in response.
|
9387
9645
|
#
|
9388
9646
|
# resp = client.put_object({
|
9389
9647
|
# body: "filetoupload",
|
9390
9648
|
# bucket: "examplebucket",
|
9391
9649
|
# key: "exampleobject",
|
9392
|
-
#
|
9393
|
-
#
|
9650
|
+
# metadata: {
|
9651
|
+
# "metadata1" => "value1",
|
9652
|
+
# "metadata2" => "value2",
|
9653
|
+
# },
|
9394
9654
|
# })
|
9395
9655
|
#
|
9396
9656
|
# resp.to_h outputs the following:
|
9397
9657
|
# {
|
9398
9658
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
9399
|
-
#
|
9400
|
-
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
9659
|
+
# version_id: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0",
|
9401
9660
|
# }
|
9402
9661
|
#
|
9403
|
-
# @example Example: To
|
9662
|
+
# @example Example: To upload an object and specify canned ACL.
|
9404
9663
|
#
|
9405
|
-
# # The following example
|
9664
|
+
# # The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ
|
9665
|
+
# # access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.
|
9406
9666
|
#
|
9407
9667
|
# resp = client.put_object({
|
9668
|
+
# acl: "authenticated-read",
|
9408
9669
|
# body: "filetoupload",
|
9409
9670
|
# bucket: "examplebucket",
|
9410
|
-
# key: "
|
9671
|
+
# key: "exampleobject",
|
9411
9672
|
# })
|
9412
9673
|
#
|
9413
9674
|
# resp.to_h outputs the following:
|
9414
9675
|
# {
|
9415
9676
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
9416
|
-
# version_id: "
|
9677
|
+
# version_id: "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr",
|
9417
9678
|
# }
|
9418
9679
|
#
|
9419
|
-
# @example Example: To
|
9680
|
+
# @example Example: To create an object.
|
9420
9681
|
#
|
9421
|
-
# # The following example
|
9422
|
-
# # S3 returns version ID of the newly created object.
|
9682
|
+
# # The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
|
9423
9683
|
#
|
9424
9684
|
# resp = client.put_object({
|
9425
|
-
# body: "
|
9685
|
+
# body: "filetoupload",
|
9426
9686
|
# bucket: "examplebucket",
|
9427
|
-
# key: "
|
9428
|
-
# tagging: "key1=value1&key2=value2",
|
9687
|
+
# key: "objectkey",
|
9429
9688
|
# })
|
9430
9689
|
#
|
9431
9690
|
# resp.to_h outputs the following:
|
9432
9691
|
# {
|
9433
9692
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
9434
|
-
# version_id: "
|
9693
|
+
# version_id: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ",
|
9435
9694
|
# }
|
9436
9695
|
#
|
9437
|
-
# @example Example: To upload an object
|
9696
|
+
# @example Example: To upload an object
|
9438
9697
|
#
|
9439
|
-
# # The following example uploads an object
|
9440
|
-
# #
|
9698
|
+
# # The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file
|
9699
|
+
# # syntax. S3 returns VersionId of the newly created object.
|
9441
9700
|
#
|
9442
9701
|
# resp = client.put_object({
|
9443
9702
|
# body: "HappyFace.jpg",
|
9444
9703
|
# bucket: "examplebucket",
|
9445
9704
|
# key: "HappyFace.jpg",
|
9446
|
-
# server_side_encryption: "AES256",
|
9447
|
-
# storage_class: "STANDARD_IA",
|
9448
9705
|
# })
|
9449
9706
|
#
|
9450
9707
|
# resp.to_h outputs the following:
|
9451
9708
|
# {
|
9452
9709
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
9453
|
-
#
|
9454
|
-
# version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp",
|
9710
|
+
# version_id: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk",
|
9455
9711
|
# }
|
9456
9712
|
#
|
9457
|
-
# @example Example: To upload object and specify
|
9713
|
+
# @example Example: To upload an object and specify optional tags
|
9458
9714
|
#
|
9459
|
-
# # The following example
|
9460
|
-
# #
|
9715
|
+
# # The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore
|
9716
|
+
# # S3 returns version ID of the newly created object.
|
9461
9717
|
#
|
9462
9718
|
# resp = client.put_object({
|
9463
|
-
# body: "
|
9719
|
+
# body: "c:\\HappyFace.jpg",
|
9464
9720
|
# bucket: "examplebucket",
|
9465
|
-
# key: "
|
9466
|
-
#
|
9467
|
-
# "metadata1" => "value1",
|
9468
|
-
# "metadata2" => "value2",
|
9469
|
-
# },
|
9721
|
+
# key: "HappyFace.jpg",
|
9722
|
+
# tagging: "key1=value1&key2=value2",
|
9470
9723
|
# })
|
9471
9724
|
#
|
9472
9725
|
# resp.to_h outputs the following:
|
9473
9726
|
# {
|
9474
9727
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
9475
|
-
# version_id: "
|
9728
|
+
# version_id: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a",
|
9476
9729
|
# }
|
9477
9730
|
#
|
9478
|
-
# @example Example: To upload an object and specify
|
9731
|
+
# @example Example: To upload an object and specify server-side encryption and object tags
|
9479
9732
|
#
|
9480
|
-
# # The following example uploads and object. The request specifies optional
|
9481
|
-
# #
|
9733
|
+
# # The following example uploads and object. The request specifies the optional server-side encryption option. The request
|
9734
|
+
# # also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.
|
9482
9735
|
#
|
9483
9736
|
# resp = client.put_object({
|
9484
|
-
# acl: "authenticated-read",
|
9485
9737
|
# body: "filetoupload",
|
9486
9738
|
# bucket: "examplebucket",
|
9487
9739
|
# key: "exampleobject",
|
9740
|
+
# server_side_encryption: "AES256",
|
9741
|
+
# tagging: "key1=value1&key2=value2",
|
9488
9742
|
# })
|
9489
9743
|
#
|
9490
9744
|
# resp.to_h outputs the following:
|
9491
9745
|
# {
|
9492
9746
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
9493
|
-
#
|
9747
|
+
# server_side_encryption: "AES256",
|
9748
|
+
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
9494
9749
|
# }
|
9495
9750
|
#
|
9496
|
-
# @example Example: To upload an object
|
9751
|
+
# @example Example: To upload an object (specify optional headers)
|
9497
9752
|
#
|
9498
|
-
# # The following example uploads an object
|
9499
|
-
# #
|
9753
|
+
# # The following example uploads an object. The request specifies optional request headers to directs S3 to use specific
|
9754
|
+
# # storage class and use server-side encryption.
|
9500
9755
|
#
|
9501
9756
|
# resp = client.put_object({
|
9502
9757
|
# body: "HappyFace.jpg",
|
9503
9758
|
# bucket: "examplebucket",
|
9504
9759
|
# key: "HappyFace.jpg",
|
9760
|
+
# server_side_encryption: "AES256",
|
9761
|
+
# storage_class: "STANDARD_IA",
|
9505
9762
|
# })
|
9506
9763
|
#
|
9507
9764
|
# resp.to_h outputs the following:
|
9508
9765
|
# {
|
9509
9766
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
9510
|
-
#
|
9767
|
+
# server_side_encryption: "AES256",
|
9768
|
+
# version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp",
|
9511
9769
|
# }
|
9512
9770
|
#
|
9513
9771
|
# @example Streaming a file from disk
|
@@ -9709,15 +9967,17 @@ module Aws::S3
|
|
9709
9967
|
#
|
9710
9968
|
# **Related Resources**
|
9711
9969
|
#
|
9712
|
-
# * CopyObject
|
9970
|
+
# * [CopyObject][4]
|
9713
9971
|
#
|
9714
|
-
# * GetObject
|
9972
|
+
# * [GetObject][5]
|
9715
9973
|
#
|
9716
9974
|
#
|
9717
9975
|
#
|
9718
9976
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
9719
9977
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
|
9720
9978
|
# [3]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
|
9979
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html
|
9980
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
9721
9981
|
#
|
9722
9982
|
# @option params [String] :acl
|
9723
9983
|
# The canned ACL to apply to the object. For more information, see
|
@@ -10118,10 +10378,10 @@ module Aws::S3
|
|
10118
10378
|
# A tag is a key-value pair. You can associate tags with an object by
|
10119
10379
|
# sending a PUT request against the tagging subresource that is
|
10120
10380
|
# associated with the object. You can retrieve tags by sending a GET
|
10121
|
-
# request. For more information, see GetObjectTagging.
|
10381
|
+
# request. For more information, see [GetObjectTagging][1].
|
10122
10382
|
#
|
10123
10383
|
# For tagging-related restrictions related to characters and encodings,
|
10124
|
-
# see [Tag Restrictions][
|
10384
|
+
# see [Tag Restrictions][2]. Note that Amazon S3 limits the maximum
|
10125
10385
|
# number of tags to 10 tags per object.
|
10126
10386
|
#
|
10127
10387
|
# To use this operation, you must have permission to perform the
|
@@ -10132,7 +10392,7 @@ module Aws::S3
|
|
10132
10392
|
# You also need permission for the `s3:PutObjectVersionTagging` action.
|
10133
10393
|
#
|
10134
10394
|
# For information about the Amazon S3 object tagging feature, see
|
10135
|
-
# [Object Tagging][
|
10395
|
+
# [Object Tagging][3].
|
10136
10396
|
#
|
10137
10397
|
# **Special Errors**
|
10138
10398
|
#
|
@@ -10142,7 +10402,7 @@ module Aws::S3
|
|
10142
10402
|
#
|
10143
10403
|
# * *Cause: The tag provided was not a valid tag. This error can occur
|
10144
10404
|
# if the tag did not pass input validation. For more information,
|
10145
|
-
# see [Object Tagging][
|
10405
|
+
# see [Object Tagging][3].*
|
10146
10406
|
#
|
10147
10407
|
# * ****
|
10148
10408
|
#
|
@@ -10162,14 +10422,15 @@ module Aws::S3
|
|
10162
10422
|
#
|
10163
10423
|
# **Related Resources**
|
10164
10424
|
#
|
10165
|
-
# * GetObjectTagging
|
10425
|
+
# * [GetObjectTagging][1]
|
10166
10426
|
#
|
10167
10427
|
# ^
|
10168
10428
|
#
|
10169
10429
|
#
|
10170
10430
|
#
|
10171
|
-
# [1]: https://docs.aws.amazon.com/
|
10172
|
-
# [2]: https://docs.aws.amazon.com/
|
10431
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html
|
10432
|
+
# [2]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html
|
10433
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html
|
10173
10434
|
#
|
10174
10435
|
# @option params [required, String] :bucket
|
10175
10436
|
# The bucket name containing the object.
|
@@ -10187,7 +10448,7 @@ module Aws::S3
|
|
10187
10448
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
10188
10449
|
#
|
10189
10450
|
# @option params [required, String] :key
|
10190
|
-
# Name of the
|
10451
|
+
# Name of the object key.
|
10191
10452
|
#
|
10192
10453
|
# @option params [String] :version_id
|
10193
10454
|
# The versionId of the object that the tag-set will be added to.
|
@@ -10277,19 +10538,22 @@ module Aws::S3
|
|
10277
10538
|
#
|
10278
10539
|
# **Related Resources**
|
10279
10540
|
#
|
10280
|
-
# * GetPublicAccessBlock
|
10541
|
+
# * [GetPublicAccessBlock][3]
|
10281
10542
|
#
|
10282
|
-
# * DeletePublicAccessBlock
|
10543
|
+
# * [DeletePublicAccessBlock][4]
|
10283
10544
|
#
|
10284
|
-
# * GetBucketPolicyStatus
|
10545
|
+
# * [GetBucketPolicyStatus][5]
|
10285
10546
|
#
|
10286
|
-
# * [Using Amazon S3 Block Public Access][
|
10547
|
+
# * [Using Amazon S3 Block Public Access][6]
|
10287
10548
|
#
|
10288
10549
|
#
|
10289
10550
|
#
|
10290
10551
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
|
10291
10552
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status
|
10292
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
10553
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html
|
10554
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html
|
10555
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html
|
10556
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html
|
10293
10557
|
#
|
10294
10558
|
# @option params [required, String] :bucket
|
10295
10559
|
# The name of the Amazon S3 bucket whose `PublicAccessBlock`
|
@@ -10372,12 +10636,12 @@ module Aws::S3
|
|
10372
10636
|
# For more information about the `S3` structure in the request body,
|
10373
10637
|
# see the following:
|
10374
10638
|
#
|
10375
|
-
# * PutObject
|
10639
|
+
# * [PutObject][4]
|
10376
10640
|
#
|
10377
|
-
# * [Managing Access with ACLs][
|
10641
|
+
# * [Managing Access with ACLs][5] in the *Amazon Simple Storage
|
10378
10642
|
# Service Developer Guide*
|
10379
10643
|
#
|
10380
|
-
# * [Protecting Data Using Server-Side Encryption][
|
10644
|
+
# * [Protecting Data Using Server-Side Encryption][6] in the *Amazon
|
10381
10645
|
# Simple Storage Service Developer Guide*
|
10382
10646
|
#
|
10383
10647
|
# * Define the SQL expression for the `SELECT` type of restoration for
|
@@ -10403,7 +10667,7 @@ module Aws::S3
|
|
10403
10667
|
# `SELECT s.Id, s.FirstName, s.SSN FROM S3Object s`
|
10404
10668
|
#
|
10405
10669
|
# For more information about using SQL with S3 Glacier Select restore,
|
10406
|
-
# see [SQL Reference for Amazon S3 Select and S3 Glacier Select][
|
10670
|
+
# see [SQL Reference for Amazon S3 Select and S3 Glacier Select][7] in
|
10407
10671
|
# the *Amazon Simple Storage Service Developer Guide*.
|
10408
10672
|
#
|
10409
10673
|
# When making a select request, you can also do the following:
|
@@ -10478,7 +10742,7 @@ module Aws::S3
|
|
10478
10742
|
#
|
10479
10743
|
# For more information about archive retrieval options and provisioned
|
10480
10744
|
# capacity for `Expedited` data access, see [Restoring Archived
|
10481
|
-
# Objects][
|
10745
|
+
# Objects][8] in the *Amazon Simple Storage Service Developer Guide*.
|
10482
10746
|
#
|
10483
10747
|
# You can use Amazon S3 restore speed upgrade to change the restore
|
10484
10748
|
# speed to a faster speed while it is in progress. You upgrade the speed
|
@@ -10488,14 +10752,14 @@ module Aws::S3
|
|
10488
10752
|
# faster than the tier that the in-progress restore is using. You must
|
10489
10753
|
# not change any other parameters, such as the `Days` request element.
|
10490
10754
|
# For more information, see [ Upgrading the Speed of an In-Progress
|
10491
|
-
# Restore][
|
10755
|
+
# Restore][9] in the *Amazon Simple Storage Service Developer Guide*.
|
10492
10756
|
#
|
10493
10757
|
# To get the status of object restoration, you can send a `HEAD`
|
10494
10758
|
# request. Operations return the `x-amz-restore` header, which provides
|
10495
10759
|
# information about the restoration status, in the response. You can use
|
10496
10760
|
# Amazon S3 event notifications to notify you when a restore is
|
10497
10761
|
# initiated or completed. For more information, see [Configuring Amazon
|
10498
|
-
# S3 Event Notifications][
|
10762
|
+
# S3 Event Notifications][10] in the *Amazon Simple Storage Service
|
10499
10763
|
# Developer Guide*.
|
10500
10764
|
#
|
10501
10765
|
# After restoring an archived object, you can update the restoration
|
@@ -10510,9 +10774,9 @@ module Aws::S3
|
|
10510
10774
|
# that you specify in a restore request. For example, if you restore an
|
10511
10775
|
# object copy for 10 days, but the object is scheduled to expire in 3
|
10512
10776
|
# days, Amazon S3 deletes the object in 3 days. For more information
|
10513
|
-
# about lifecycle configuration, see
|
10514
|
-
# [
|
10515
|
-
# Developer Guide*.
|
10777
|
+
# about lifecycle configuration, see
|
10778
|
+
# [PutBucketLifecycleConfiguration][11] and [Object Lifecycle
|
10779
|
+
# Management][12] in *Amazon Simple Storage Service Developer Guide*.
|
10516
10780
|
#
|
10517
10781
|
# **Responses**
|
10518
10782
|
#
|
@@ -10554,11 +10818,11 @@ module Aws::S3
|
|
10554
10818
|
#
|
10555
10819
|
# **Related Resources**
|
10556
10820
|
#
|
10557
|
-
# * PutBucketLifecycleConfiguration
|
10821
|
+
# * [PutBucketLifecycleConfiguration][11]
|
10558
10822
|
#
|
10559
|
-
# * GetBucketNotificationConfiguration
|
10823
|
+
# * [GetBucketNotificationConfiguration][13]
|
10560
10824
|
#
|
10561
|
-
# * [SQL Reference for Amazon S3 Select and S3 Glacier Select ][
|
10825
|
+
# * [SQL Reference for Amazon S3 Select and S3 Glacier Select ][7] in
|
10562
10826
|
# the *Amazon Simple Storage Service Developer Guide*
|
10563
10827
|
#
|
10564
10828
|
#
|
@@ -10566,13 +10830,16 @@ module Aws::S3
|
|
10566
10830
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
10567
10831
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
10568
10832
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html
|
10569
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
10570
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
10571
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
10572
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
10573
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html
|
10574
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
10575
|
-
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
10833
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
10834
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
|
10835
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html
|
10836
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html
|
10837
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html
|
10838
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html
|
10839
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html
|
10840
|
+
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html
|
10841
|
+
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
10842
|
+
# [13]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html
|
10576
10843
|
#
|
10577
10844
|
# @option params [required, String] :bucket
|
10578
10845
|
# The bucket name or containing the object to restore.
|
@@ -10787,16 +11054,17 @@ module Aws::S3
|
|
10787
11054
|
#
|
10788
11055
|
# For objects that are encrypted with customer-provided encryption
|
10789
11056
|
# keys (SSE-C), you must use HTTPS, and you must use the headers that
|
10790
|
-
# are documented in the GetObject. For more information about
|
10791
|
-
# see [Server-Side Encryption (Using Customer-Provided
|
10792
|
-
# Keys)][
|
11057
|
+
# are documented in the [GetObject][4]. For more information about
|
11058
|
+
# SSE-C, see [Server-Side Encryption (Using Customer-Provided
|
11059
|
+
# Encryption Keys)][5] in the *Amazon Simple Storage Service Developer
|
11060
|
+
# Guide*.
|
10793
11061
|
#
|
10794
11062
|
# For objects that are encrypted with Amazon S3 managed encryption
|
10795
11063
|
# keys (SSE-S3) and customer master keys (CMKs) stored in AWS Key
|
10796
11064
|
# Management Service (SSE-KMS), server-side encryption is handled
|
10797
11065
|
# transparently, so you don't need to specify anything. For more
|
10798
11066
|
# information about server-side encryption, including SSE-S3 and
|
10799
|
-
# SSE-KMS, see [Protecting Data Using Server-Side Encryption][
|
11067
|
+
# SSE-KMS, see [Protecting Data Using Server-Side Encryption][6] in
|
10800
11068
|
# the *Amazon Simple Storage Service Developer Guide*.
|
10801
11069
|
#
|
10802
11070
|
# **Working with the Response Body**
|
@@ -10804,49 +11072,55 @@ module Aws::S3
|
|
10804
11072
|
# Given the response size is unknown, Amazon S3 Select streams the
|
10805
11073
|
# response as a series of messages and includes a `Transfer-Encoding`
|
10806
11074
|
# header with `chunked` as its value in the response. For more
|
10807
|
-
# information, see
|
11075
|
+
# information, see [Appendix: SelectObjectContent Response][7] .
|
10808
11076
|
#
|
10809
11077
|
#
|
10810
11078
|
#
|
10811
11079
|
# **GetObject Support**
|
10812
11080
|
#
|
10813
11081
|
# The `SelectObjectContent` operation does not support the following
|
10814
|
-
# `GetObject` functionality. For more information, see GetObject.
|
11082
|
+
# `GetObject` functionality. For more information, see [GetObject][4].
|
10815
11083
|
#
|
10816
11084
|
# * `Range`\: Although you can specify a scan range for an Amazon S3
|
10817
|
-
# Select request (see SelectObjectContentRequest
|
10818
|
-
# request parameters), you cannot specify the range of bytes of an
|
11085
|
+
# Select request (see [SelectObjectContentRequest - ScanRange][8] in
|
11086
|
+
# the request parameters), you cannot specify the range of bytes of an
|
10819
11087
|
# object to return.
|
10820
11088
|
#
|
10821
11089
|
# * GLACIER, DEEP\_ARCHIVE and REDUCED\_REDUNDANCY storage classes: You
|
10822
11090
|
# cannot specify the GLACIER, DEEP\_ARCHIVE, or `REDUCED_REDUNDANCY`
|
10823
11091
|
# storage classes. For more information, about storage classes see
|
10824
|
-
# [Storage Classes][
|
11092
|
+
# [Storage Classes][9] in the *Amazon Simple Storage Service Developer
|
10825
11093
|
# Guide*.
|
10826
11094
|
#
|
10827
11095
|
#
|
10828
11096
|
#
|
10829
11097
|
# **Special Errors**
|
10830
11098
|
#
|
10831
|
-
# For a list of special errors for this operation, see
|
10832
|
-
#
|
11099
|
+
# For a list of special errors for this operation, see [List of SELECT
|
11100
|
+
# Object Content Error Codes][10]
|
10833
11101
|
#
|
10834
11102
|
# **Related Resources**
|
10835
11103
|
#
|
10836
|
-
# * GetObject
|
11104
|
+
# * [GetObject][4]
|
10837
11105
|
#
|
10838
|
-
# * GetBucketLifecycleConfiguration
|
11106
|
+
# * [GetBucketLifecycleConfiguration][11]
|
10839
11107
|
#
|
10840
|
-
# * PutBucketLifecycleConfiguration
|
11108
|
+
# * [PutBucketLifecycleConfiguration][12]
|
10841
11109
|
#
|
10842
11110
|
#
|
10843
11111
|
#
|
10844
11112
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/selecting-content-from-objects.html
|
10845
11113
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html
|
10846
11114
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
|
10847
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
10848
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
10849
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
11115
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
11116
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
|
11117
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html
|
11118
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTSelectObjectAppendix.html
|
11119
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_SelectObjectContent.html#AmazonS3-SelectObjectContent-request-ScanRange
|
11120
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#storage-class-intro
|
11121
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#SelectObjectContentErrorCodeList
|
11122
|
+
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html
|
11123
|
+
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html
|
10850
11124
|
#
|
10851
11125
|
# @option params [required, String] :bucket
|
10852
11126
|
# The S3 bucket.
|
@@ -11142,11 +11416,11 @@ module Aws::S3
|
|
11142
11416
|
# <note markdown="1"> In this operation, you provide part data in your request. However, you
|
11143
11417
|
# have an option to specify your existing Amazon S3 object as a data
|
11144
11418
|
# source for the part you are uploading. To upload a part from an
|
11145
|
-
# existing object, you use the UploadPartCopy operation.
|
11419
|
+
# existing object, you use the [UploadPartCopy][1] operation.
|
11146
11420
|
#
|
11147
11421
|
# </note>
|
11148
11422
|
#
|
11149
|
-
# You must initiate a multipart upload (see CreateMultipartUpload)
|
11423
|
+
# You must initiate a multipart upload (see [CreateMultipartUpload][2])
|
11150
11424
|
# before you can upload any part. In response to your initiate request,
|
11151
11425
|
# Amazon S3 returns an upload ID, a unique identifier, that you must
|
11152
11426
|
# include in your upload part request.
|
@@ -11171,11 +11445,11 @@ module Aws::S3
|
|
11171
11445
|
# parts storage and stops charging you for the parts storage.
|
11172
11446
|
#
|
11173
11447
|
# For more information on multipart uploads, go to [Multipart Upload
|
11174
|
-
# Overview][
|
11448
|
+
# Overview][3] in the <i>Amazon Simple Storage Service Developer Guide
|
11175
11449
|
# </i>.
|
11176
11450
|
#
|
11177
11451
|
# For information on the permissions required to use the multipart
|
11178
|
-
# upload API, go to [Multipart Upload API and Permissions][
|
11452
|
+
# upload API, go to [Multipart Upload API and Permissions][4] in the
|
11179
11453
|
# *Amazon Simple Storage Service Developer Guide*.
|
11180
11454
|
#
|
11181
11455
|
# You can optionally request server-side encryption where Amazon S3
|
@@ -11185,26 +11459,27 @@ module Aws::S3
|
|
11185
11459
|
# encryption keys. If you choose to provide your own encryption key, the
|
11186
11460
|
# request headers you provide in the request must match the headers you
|
11187
11461
|
# used in the request to initiate the upload by using
|
11188
|
-
# CreateMultipartUpload. For more information, go to [Using
|
11189
|
-
# Encryption][
|
11462
|
+
# [CreateMultipartUpload][2]. For more information, go to [Using
|
11463
|
+
# Server-Side Encryption][5] in the *Amazon Simple Storage Service
|
11464
|
+
# Developer Guide*.
|
11190
11465
|
#
|
11191
11466
|
# Server-side encryption is supported by the S3 Multipart Upload
|
11192
11467
|
# actions. Unless you are using a customer-provided encryption key, you
|
11193
11468
|
# don't need to specify the encryption parameters in each UploadPart
|
11194
11469
|
# request. Instead, you only need to specify the server-side encryption
|
11195
11470
|
# parameters in the initial Initiate Multipart request. For more
|
11196
|
-
# information, see CreateMultipartUpload.
|
11471
|
+
# information, see [CreateMultipartUpload][2].
|
11197
11472
|
#
|
11198
11473
|
# If you requested server-side encryption using a customer-provided
|
11199
11474
|
# encryption key in your initiate multipart upload request, you must
|
11200
11475
|
# provide identical encryption information in each part upload using the
|
11201
11476
|
# following headers.
|
11202
11477
|
#
|
11203
|
-
# * x-amz-server-side
|
11478
|
+
# * x-amz-server-side-encryption-customer-algorithm
|
11204
11479
|
#
|
11205
|
-
# * x-amz-server-side
|
11480
|
+
# * x-amz-server-side-encryption-customer-key
|
11206
11481
|
#
|
11207
|
-
# * x-amz-server-side
|
11482
|
+
# * x-amz-server-side-encryption-customer-key-MD5
|
11208
11483
|
#
|
11209
11484
|
# **Special Errors**
|
11210
11485
|
#
|
@@ -11222,23 +11497,29 @@ module Aws::S3
|
|
11222
11497
|
#
|
11223
11498
|
# **Related Resources**
|
11224
11499
|
#
|
11225
|
-
# * CreateMultipartUpload
|
11500
|
+
# * [CreateMultipartUpload][2]
|
11226
11501
|
#
|
11227
|
-
# * CompleteMultipartUpload
|
11502
|
+
# * [CompleteMultipartUpload][6]
|
11228
11503
|
#
|
11229
|
-
# * AbortMultipartUpload
|
11504
|
+
# * [AbortMultipartUpload][7]
|
11230
11505
|
#
|
11231
|
-
# * ListParts
|
11506
|
+
# * [ListParts][8]
|
11232
11507
|
#
|
11233
|
-
# * ListMultipartUploads
|
11508
|
+
# * [ListMultipartUploads][9]
|
11234
11509
|
#
|
11235
11510
|
#
|
11236
11511
|
#
|
11237
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11238
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11239
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
11512
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html
|
11513
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html
|
11514
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html
|
11515
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
|
11516
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html
|
11517
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html
|
11518
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
|
11519
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
|
11520
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
|
11240
11521
|
#
|
11241
|
-
# @option params [String,
|
11522
|
+
# @option params [String, StringIO, File] :body
|
11242
11523
|
# Object data.
|
11243
11524
|
#
|
11244
11525
|
# @option params [required, String] :bucket
|
@@ -11273,8 +11554,8 @@ module Aws::S3
|
|
11273
11554
|
# encrypting data. This value is used to store the object and then it is
|
11274
11555
|
# discarded; Amazon S3 does not store the encryption key. The key must
|
11275
11556
|
# be appropriate for use with the algorithm specified in the
|
11276
|
-
# `x-amz-server-side
|
11277
|
-
#
|
11557
|
+
# `x-amz-server-side-encryption-customer-algorithm header`. This must be
|
11558
|
+
# the same encryption key specified in the initiate multipart upload
|
11278
11559
|
# request.
|
11279
11560
|
#
|
11280
11561
|
# @option params [String] :sse_customer_key_md5
|
@@ -11365,7 +11646,7 @@ module Aws::S3
|
|
11365
11646
|
# in the *Amazon Simple Storage Service Developer Guide*.
|
11366
11647
|
#
|
11367
11648
|
# <note markdown="1"> Instead of using an existing object as part data, you might use the
|
11368
|
-
# UploadPart operation and provide data in your request.
|
11649
|
+
# [UploadPart][2] operation and provide data in your request.
|
11369
11650
|
#
|
11370
11651
|
# </note>
|
11371
11652
|
#
|
@@ -11378,20 +11659,20 @@ module Aws::S3
|
|
11378
11659
|
# the following:
|
11379
11660
|
#
|
11380
11661
|
# * For conceptual information about multipart uploads, see [Uploading
|
11381
|
-
# Objects Using Multipart Upload][
|
11662
|
+
# Objects Using Multipart Upload][3] in the *Amazon Simple Storage
|
11382
11663
|
# Service Developer Guide*.
|
11383
11664
|
#
|
11384
11665
|
# * For information about permissions required to use the multipart
|
11385
|
-
# upload API, see [Multipart Upload API and Permissions][
|
11666
|
+
# upload API, see [Multipart Upload API and Permissions][4] in the
|
11386
11667
|
# *Amazon Simple Storage Service Developer Guide*.
|
11387
11668
|
#
|
11388
11669
|
# * For information about copying objects using a single atomic
|
11389
|
-
# operation vs. the multipart upload, see [Operations on Objects][
|
11670
|
+
# operation vs. the multipart upload, see [Operations on Objects][5]
|
11390
11671
|
# in the *Amazon Simple Storage Service Developer Guide*.
|
11391
11672
|
#
|
11392
11673
|
# * For information about using server-side encryption with
|
11393
11674
|
# customer-provided encryption keys with the UploadPartCopy operation,
|
11394
|
-
# see CopyObject and UploadPart.
|
11675
|
+
# see [CopyObject][6] and [UploadPart][2].
|
11395
11676
|
#
|
11396
11677
|
# Note the following additional considerations about the request headers
|
11397
11678
|
# `x-amz-copy-source-if-match`, `x-amz-copy-source-if-none-match`,
|
@@ -11464,24 +11745,31 @@ module Aws::S3
|
|
11464
11745
|
#
|
11465
11746
|
# **Related Resources**
|
11466
11747
|
#
|
11467
|
-
# * CreateMultipartUpload
|
11748
|
+
# * [CreateMultipartUpload][7]
|
11468
11749
|
#
|
11469
|
-
# * UploadPart
|
11750
|
+
# * [UploadPart][2]
|
11470
11751
|
#
|
11471
|
-
# * CompleteMultipartUpload
|
11752
|
+
# * [CompleteMultipartUpload][8]
|
11472
11753
|
#
|
11473
|
-
# * AbortMultipartUpload
|
11754
|
+
# * [AbortMultipartUpload][9]
|
11474
11755
|
#
|
11475
|
-
# * ListParts
|
11756
|
+
# * [ListParts][10]
|
11476
11757
|
#
|
11477
|
-
# * ListMultipartUploads
|
11758
|
+
# * [ListMultipartUploads][11]
|
11478
11759
|
#
|
11479
11760
|
#
|
11480
11761
|
#
|
11481
11762
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/qfacts.html
|
11482
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11483
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
11484
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
11763
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html
|
11764
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html
|
11765
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
|
11766
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectOperations.html
|
11767
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html
|
11768
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html
|
11769
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html
|
11770
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
|
11771
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
|
11772
|
+
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
|
11485
11773
|
#
|
11486
11774
|
# @option params [required, String] :bucket
|
11487
11775
|
# The bucket name.
|
@@ -11530,8 +11818,8 @@ module Aws::S3
|
|
11530
11818
|
# encrypting data. This value is used to store the object and then it is
|
11531
11819
|
# discarded; Amazon S3 does not store the encryption key. The key must
|
11532
11820
|
# be appropriate for use with the algorithm specified in the
|
11533
|
-
# `x-amz-server-side
|
11534
|
-
#
|
11821
|
+
# `x-amz-server-side-encryption-customer-algorithm` header. This must be
|
11822
|
+
# the same encryption key specified in the initiate multipart upload
|
11535
11823
|
# request.
|
11536
11824
|
#
|
11537
11825
|
# @option params [String] :sse_customer_key_md5
|
@@ -11575,45 +11863,45 @@ module Aws::S3
|
|
11575
11863
|
# * {Types::UploadPartCopyOutput#request_charged #request_charged} => String
|
11576
11864
|
#
|
11577
11865
|
#
|
11578
|
-
# @example Example: To upload a part by copying
|
11866
|
+
# @example Example: To upload a part by copying byte range from an existing object as data source
|
11579
11867
|
#
|
11580
|
-
# # The following example uploads a part of a multipart upload by copying
|
11868
|
+
# # The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as
|
11869
|
+
# # data source.
|
11581
11870
|
#
|
11582
11871
|
# resp = client.upload_part_copy({
|
11583
11872
|
# bucket: "examplebucket",
|
11584
11873
|
# copy_source: "/bucketname/sourceobjectkey",
|
11874
|
+
# copy_source_range: "bytes=1-100000",
|
11585
11875
|
# key: "examplelargeobject",
|
11586
|
-
# part_number:
|
11876
|
+
# part_number: 2,
|
11587
11877
|
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
11588
11878
|
# })
|
11589
11879
|
#
|
11590
11880
|
# resp.to_h outputs the following:
|
11591
11881
|
# {
|
11592
11882
|
# copy_part_result: {
|
11593
|
-
# etag: "\"
|
11594
|
-
# last_modified: Time.parse("2016-12-29T21:
|
11883
|
+
# etag: "\"65d16d19e65a7508a51f043180edcc36\"",
|
11884
|
+
# last_modified: Time.parse("2016-12-29T21:44:28.000Z"),
|
11595
11885
|
# },
|
11596
11886
|
# }
|
11597
11887
|
#
|
11598
|
-
# @example Example: To upload a part by copying
|
11888
|
+
# @example Example: To upload a part by copying data from an existing object as data source
|
11599
11889
|
#
|
11600
|
-
# # The following example uploads a part of a multipart upload by copying
|
11601
|
-
# # data source.
|
11890
|
+
# # The following example uploads a part of a multipart upload by copying data from an existing object as data source.
|
11602
11891
|
#
|
11603
11892
|
# resp = client.upload_part_copy({
|
11604
11893
|
# bucket: "examplebucket",
|
11605
11894
|
# copy_source: "/bucketname/sourceobjectkey",
|
11606
|
-
# copy_source_range: "bytes=1-100000",
|
11607
11895
|
# key: "examplelargeobject",
|
11608
|
-
# part_number:
|
11896
|
+
# part_number: 1,
|
11609
11897
|
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
11610
11898
|
# })
|
11611
11899
|
#
|
11612
11900
|
# resp.to_h outputs the following:
|
11613
11901
|
# {
|
11614
11902
|
# copy_part_result: {
|
11615
|
-
# etag: "\"
|
11616
|
-
# last_modified: Time.parse("2016-12-29T21:
|
11903
|
+
# etag: "\"b0c6f0e7e054ab8fa2536a2677f8734d\"",
|
11904
|
+
# last_modified: Time.parse("2016-12-29T21:24:43.000Z"),
|
11617
11905
|
# },
|
11618
11906
|
# }
|
11619
11907
|
#
|
@@ -11672,7 +11960,7 @@ module Aws::S3
|
|
11672
11960
|
params: params,
|
11673
11961
|
config: config)
|
11674
11962
|
context[:gem_name] = 'aws-sdk-s3'
|
11675
|
-
context[:gem_version] = '1.
|
11963
|
+
context[:gem_version] = '1.77.0'
|
11676
11964
|
Seahorse::Client::Request.new(handlers, context)
|
11677
11965
|
end
|
11678
11966
|
|