aws-sdk-s3 1.134.0 → 1.136.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-s3/bucket.rb +25 -16
- data/lib/aws-sdk-s3/client.rb +428 -384
- data/lib/aws-sdk-s3/multipart_upload.rb +15 -9
- data/lib/aws-sdk-s3/multipart_upload_part.rb +10 -6
- data/lib/aws-sdk-s3/object.rb +65 -47
- data/lib/aws-sdk-s3/object_acl.rb +5 -3
- data/lib/aws-sdk-s3/object_summary.rb +60 -44
- data/lib/aws-sdk-s3/object_version.rb +20 -12
- data/lib/aws-sdk-s3/types.rb +182 -119
- data/lib/aws-sdk-s3.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-s3/client.rb
CHANGED
@@ -544,9 +544,11 @@ module Aws::S3
|
|
544
544
|
# @option params [String] :request_payer
|
545
545
|
# Confirms that the requester knows that they will be charged for the
|
546
546
|
# request. Bucket owners need not specify this parameter in their
|
547
|
-
# requests.
|
548
|
-
# Pays
|
549
|
-
#
|
547
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
548
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
549
|
+
# charges to copy the object. For information about downloading objects
|
550
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
551
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
550
552
|
#
|
551
553
|
#
|
552
554
|
#
|
@@ -780,9 +782,11 @@ module Aws::S3
|
|
780
782
|
# @option params [String] :request_payer
|
781
783
|
# Confirms that the requester knows that they will be charged for the
|
782
784
|
# request. Bucket owners need not specify this parameter in their
|
783
|
-
# requests.
|
784
|
-
# Pays
|
785
|
-
#
|
785
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
786
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
787
|
+
# charges to copy the object. For information about downloading objects
|
788
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
789
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
786
790
|
#
|
787
791
|
#
|
788
792
|
#
|
@@ -1117,10 +1121,13 @@ module Aws::S3
|
|
1117
1121
|
# `StorageClass` parameter. For more information, see [Storage
|
1118
1122
|
# Classes][13] in the *Amazon S3 User Guide*.
|
1119
1123
|
#
|
1120
|
-
# If the source object's storage class is GLACIER
|
1121
|
-
#
|
1122
|
-
#
|
1123
|
-
#
|
1124
|
+
# If the source object's storage class is GLACIER or DEEP\_ARCHIVE,
|
1125
|
+
# or the object's storage class is INTELLIGENT\_TIERING and it's [
|
1126
|
+
# S3 Intelligent-Tiering access tier][14] is Archive Access or Deep
|
1127
|
+
# Archive Access, you must restore a copy of this object before you
|
1128
|
+
# can use it as a source object for the copy operation. For more
|
1129
|
+
# information, see [RestoreObject][15]. For more information, see
|
1130
|
+
# [Copying Objects][16].
|
1124
1131
|
#
|
1125
1132
|
# Versioning
|
1126
1133
|
#
|
@@ -1140,9 +1147,9 @@ module Aws::S3
|
|
1140
1147
|
#
|
1141
1148
|
# The following operations are related to `CopyObject`:
|
1142
1149
|
#
|
1143
|
-
# * [PutObject][
|
1150
|
+
# * [PutObject][17]
|
1144
1151
|
#
|
1145
|
-
# * [GetObject][
|
1152
|
+
# * [GetObject][18]
|
1146
1153
|
#
|
1147
1154
|
#
|
1148
1155
|
#
|
@@ -1159,10 +1166,11 @@ module Aws::S3
|
|
1159
1166
|
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html
|
1160
1167
|
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html
|
1161
1168
|
# [13]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html
|
1162
|
-
# [14]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1163
|
-
# [15]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1164
|
-
# [16]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1165
|
-
# [17]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
1169
|
+
# [14]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/intelligent-tiering-overview.html#intel-tiering-tier-definition
|
1170
|
+
# [15]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html
|
1171
|
+
# [16]: https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html
|
1172
|
+
# [17]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
1173
|
+
# [18]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
1166
1174
|
#
|
1167
1175
|
# @option params [String] :acl
|
1168
1176
|
# The canned ACL to apply to the object.
|
@@ -1324,12 +1332,13 @@ module Aws::S3
|
|
1324
1332
|
# Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
1325
1333
|
#
|
1326
1334
|
# @option params [String] :storage_class
|
1327
|
-
#
|
1328
|
-
#
|
1329
|
-
#
|
1330
|
-
#
|
1331
|
-
#
|
1332
|
-
# in the *Amazon S3 User
|
1335
|
+
# If the `x-amz-storage-class` header is not used, the copied object
|
1336
|
+
# will be stored in the STANDARD Storage Class by default. The STANDARD
|
1337
|
+
# storage class provides high durability and high availability.
|
1338
|
+
# Depending on performance needs, you can specify a different Storage
|
1339
|
+
# Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For
|
1340
|
+
# more information, see [Storage Classes][1] in the *Amazon S3 User
|
1341
|
+
# Guide*.
|
1333
1342
|
#
|
1334
1343
|
#
|
1335
1344
|
#
|
@@ -1360,12 +1369,12 @@ module Aws::S3
|
|
1360
1369
|
# ensure that the encryption key was transmitted without error.
|
1361
1370
|
#
|
1362
1371
|
# @option params [String] :ssekms_key_id
|
1363
|
-
# Specifies the KMS
|
1364
|
-
# requests for an object protected by KMS
|
1365
|
-
# via SSL or using SigV4. For information
|
1366
|
-
#
|
1367
|
-
# CLI, see [Specifying the Signature
|
1368
|
-
# Authentication][1] in the *Amazon S3 User Guide*.
|
1372
|
+
# Specifies the KMS ID (Key ID, Key ARN, or Key Alias) to use for object
|
1373
|
+
# encryption. All GET and PUT requests for an object protected by KMS
|
1374
|
+
# will fail if they're not made via SSL or using SigV4. For information
|
1375
|
+
# about configuring any of the officially supported Amazon Web Services
|
1376
|
+
# SDKs and Amazon Web Services CLI, see [Specifying the Signature
|
1377
|
+
# Version in Request Authentication][1] in the *Amazon S3 User Guide*.
|
1369
1378
|
#
|
1370
1379
|
#
|
1371
1380
|
#
|
@@ -1402,9 +1411,11 @@ module Aws::S3
|
|
1402
1411
|
# @option params [String] :request_payer
|
1403
1412
|
# Confirms that the requester knows that they will be charged for the
|
1404
1413
|
# request. Bucket owners need not specify this parameter in their
|
1405
|
-
# requests.
|
1406
|
-
# Pays
|
1407
|
-
#
|
1414
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
1415
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
1416
|
+
# charges to copy the object. For information about downloading objects
|
1417
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
1418
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
1408
1419
|
#
|
1409
1420
|
#
|
1410
1421
|
#
|
@@ -1556,11 +1567,13 @@ module Aws::S3
|
|
1556
1567
|
# Bucket][2].
|
1557
1568
|
#
|
1558
1569
|
# By default, the bucket is created in the US East (N. Virginia) Region.
|
1559
|
-
# You can optionally specify a Region in the request body.
|
1560
|
-
#
|
1561
|
-
#
|
1562
|
-
#
|
1563
|
-
#
|
1570
|
+
# You can optionally specify a Region in the request body. To constrain
|
1571
|
+
# the bucket creation to a specific Region, you can use [
|
1572
|
+
# `LocationConstraint` ][3] condition key. You might choose a Region to
|
1573
|
+
# optimize latency, minimize costs, or address regulatory requirements.
|
1574
|
+
# For example, if you reside in Europe, you will probably find it
|
1575
|
+
# advantageous to create buckets in the Europe (Ireland) Region. For
|
1576
|
+
# more information, see [Accessing a bucket][4].
|
1564
1577
|
#
|
1565
1578
|
# <note markdown="1"> If you send your create bucket request to the `s3.amazonaws.com`
|
1566
1579
|
# endpoint, the request goes to the `us-east-1` Region. Accordingly, the
|
@@ -1569,7 +1582,7 @@ module Aws::S3
|
|
1569
1582
|
# another Region where the bucket is to be created. If you create a
|
1570
1583
|
# bucket in a Region other than US East (N. Virginia), your application
|
1571
1584
|
# must be able to handle 307 redirect. For more information, see
|
1572
|
-
# [Virtual hosting of buckets][
|
1585
|
+
# [Virtual hosting of buckets][5].
|
1573
1586
|
#
|
1574
1587
|
# </note>
|
1575
1588
|
#
|
@@ -1602,19 +1615,19 @@ module Aws::S3
|
|
1602
1615
|
# you can use the `x-amz-object-ownership` header in your
|
1603
1616
|
# `CreateBucket` request to set the `ObjectOwnership` setting of
|
1604
1617
|
# your choice. For more information about S3 Object Ownership, see
|
1605
|
-
# [Controlling object ownership ][
|
1618
|
+
# [Controlling object ownership ][6] in the *Amazon S3 User Guide*.
|
1606
1619
|
#
|
1607
1620
|
# * **S3 Block Public Access** - If your specific use case requires
|
1608
1621
|
# granting public access to your S3 resources, you can disable Block
|
1609
1622
|
# Public Access. You can create a new bucket with Block Public
|
1610
1623
|
# Access enabled, then separately call the [
|
1611
|
-
# `DeletePublicAccessBlock` ][
|
1624
|
+
# `DeletePublicAccessBlock` ][7] API. To use this operation, you
|
1612
1625
|
# must have the `s3:PutBucketPublicAccessBlock` permission. By
|
1613
1626
|
# default, all Block Public Access settings are enabled for new
|
1614
1627
|
# buckets. To avoid inadvertent exposure of your resources, we
|
1615
1628
|
# recommend keeping the S3 Block Public Access settings enabled. For
|
1616
1629
|
# more information about S3 Block Public Access, see [Blocking
|
1617
|
-
# public access to your Amazon S3 storage ][
|
1630
|
+
# public access to your Amazon S3 storage ][6] in the *Amazon S3
|
1618
1631
|
# User Guide*.
|
1619
1632
|
#
|
1620
1633
|
# If your `CreateBucket` request sets `BucketOwnerEnforced` for Amazon
|
@@ -1622,25 +1635,26 @@ module Aws::S3
|
|
1622
1635
|
# an external Amazon Web Services account, your request fails with a
|
1623
1636
|
# `400` error and returns the `InvalidBucketAcLWithObjectOwnership`
|
1624
1637
|
# error code. For more information, see [Setting Object Ownership on an
|
1625
|
-
# existing bucket ][
|
1638
|
+
# existing bucket ][8] in the *Amazon S3 User Guide*.
|
1626
1639
|
#
|
1627
1640
|
# The following operations are related to `CreateBucket`:
|
1628
1641
|
#
|
1629
|
-
# * [PutObject][
|
1642
|
+
# * [PutObject][9]
|
1630
1643
|
#
|
1631
|
-
# * [DeleteBucket][
|
1644
|
+
# * [DeleteBucket][10]
|
1632
1645
|
#
|
1633
1646
|
#
|
1634
1647
|
#
|
1635
1648
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html
|
1636
1649
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html
|
1637
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1638
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
1639
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1640
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1641
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1642
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1643
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
1650
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketConfiguration.html
|
1651
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro
|
1652
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html
|
1653
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html
|
1654
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html
|
1655
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-ownership-existing-bucket.html
|
1656
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
1657
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html
|
1644
1658
|
#
|
1645
1659
|
# @option params [String] :acl
|
1646
1660
|
# The canned ACL to apply to the bucket.
|
@@ -2135,13 +2149,13 @@ module Aws::S3
|
|
2135
2149
|
# ensure that the encryption key was transmitted without error.
|
2136
2150
|
#
|
2137
2151
|
# @option params [String] :ssekms_key_id
|
2138
|
-
# Specifies the ID
|
2139
|
-
# use for object encryption. All GET
|
2140
|
-
# protected by KMS will fail if they're
|
2141
|
-
# SigV4. For information about configuring any
|
2142
|
-
# supported Amazon Web Services SDKs and Amazon Web
|
2143
|
-
# [Specifying the Signature Version in Request
|
2144
|
-
# *Amazon S3 User Guide*.
|
2152
|
+
# Specifies the ID (Key ID, Key ARN, or Key Alias) of the symmetric
|
2153
|
+
# encryption customer managed key to use for object encryption. All GET
|
2154
|
+
# and PUT requests for an object protected by KMS will fail if they're
|
2155
|
+
# not made via SSL or using SigV4. For information about configuring any
|
2156
|
+
# of the officially supported Amazon Web Services SDKs and Amazon Web
|
2157
|
+
# Services CLI, see [Specifying the Signature Version in Request
|
2158
|
+
# Authentication][1] in the *Amazon S3 User Guide*.
|
2145
2159
|
#
|
2146
2160
|
#
|
2147
2161
|
#
|
@@ -2164,9 +2178,11 @@ module Aws::S3
|
|
2164
2178
|
# @option params [String] :request_payer
|
2165
2179
|
# Confirms that the requester knows that they will be charged for the
|
2166
2180
|
# request. Bucket owners need not specify this parameter in their
|
2167
|
-
# requests.
|
2168
|
-
# Pays
|
2169
|
-
#
|
2181
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
2182
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
2183
|
+
# charges to copy the object. For information about downloading objects
|
2184
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
2185
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
2170
2186
|
#
|
2171
2187
|
#
|
2172
2188
|
#
|
@@ -3150,9 +3166,11 @@ module Aws::S3
|
|
3150
3166
|
# @option params [String] :request_payer
|
3151
3167
|
# Confirms that the requester knows that they will be charged for the
|
3152
3168
|
# request. Bucket owners need not specify this parameter in their
|
3153
|
-
# requests.
|
3154
|
-
# Pays
|
3155
|
-
#
|
3169
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
3170
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
3171
|
+
# charges to copy the object. For information about downloading objects
|
3172
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
3173
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
3156
3174
|
#
|
3157
3175
|
#
|
3158
3176
|
#
|
@@ -3175,6 +3193,15 @@ module Aws::S3
|
|
3175
3193
|
# * {Types::DeleteObjectOutput#request_charged #request_charged} => String
|
3176
3194
|
#
|
3177
3195
|
#
|
3196
|
+
# @example Example: To delete an object (from a non-versioned bucket)
|
3197
|
+
#
|
3198
|
+
# # The following example deletes an object from a non-versioned bucket.
|
3199
|
+
#
|
3200
|
+
# resp = client.delete_object({
|
3201
|
+
# bucket: "ExampleBucket",
|
3202
|
+
# key: "HappyFace.jpg",
|
3203
|
+
# })
|
3204
|
+
#
|
3178
3205
|
# @example Example: To delete an object
|
3179
3206
|
#
|
3180
3207
|
# # The following example deletes an object from an S3 bucket.
|
@@ -3188,15 +3215,6 @@ module Aws::S3
|
|
3188
3215
|
# {
|
3189
3216
|
# }
|
3190
3217
|
#
|
3191
|
-
# @example Example: To delete an object (from a non-versioned bucket)
|
3192
|
-
#
|
3193
|
-
# # The following example deletes an object from a non-versioned bucket.
|
3194
|
-
#
|
3195
|
-
# resp = client.delete_object({
|
3196
|
-
# bucket: "ExampleBucket",
|
3197
|
-
# key: "HappyFace.jpg",
|
3198
|
-
# })
|
3199
|
-
#
|
3200
3218
|
# @example Request syntax with placeholder values
|
3201
3219
|
#
|
3202
3220
|
# resp = client.delete_object({
|
@@ -3431,9 +3449,11 @@ module Aws::S3
|
|
3431
3449
|
# @option params [String] :request_payer
|
3432
3450
|
# Confirms that the requester knows that they will be charged for the
|
3433
3451
|
# request. Bucket owners need not specify this parameter in their
|
3434
|
-
# requests.
|
3435
|
-
# Pays
|
3436
|
-
#
|
3452
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
3453
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
3454
|
+
# charges to copy the object. For information about downloading objects
|
3455
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
3456
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
3437
3457
|
#
|
3438
3458
|
#
|
3439
3459
|
#
|
@@ -3475,20 +3495,22 @@ module Aws::S3
|
|
3475
3495
|
# * {Types::DeleteObjectsOutput#errors #errors} => Array<Types::Error>
|
3476
3496
|
#
|
3477
3497
|
#
|
3478
|
-
# @example Example: To delete multiple
|
3498
|
+
# @example Example: To delete multiple object versions from a versioned bucket
|
3479
3499
|
#
|
3480
|
-
# # The following example deletes objects from a bucket. The
|
3481
|
-
# #
|
3500
|
+
# # The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object
|
3501
|
+
# # versions and returns the key and versions of deleted objects in the response.
|
3482
3502
|
#
|
3483
3503
|
# resp = client.delete_objects({
|
3484
3504
|
# bucket: "examplebucket",
|
3485
3505
|
# delete: {
|
3486
3506
|
# objects: [
|
3487
3507
|
# {
|
3488
|
-
# key: "
|
3508
|
+
# key: "HappyFace.jpg",
|
3509
|
+
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
3489
3510
|
# },
|
3490
3511
|
# {
|
3491
|
-
# key: "
|
3512
|
+
# key: "HappyFace.jpg",
|
3513
|
+
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
3492
3514
|
# },
|
3493
3515
|
# ],
|
3494
3516
|
# quiet: false,
|
@@ -3499,34 +3521,30 @@ module Aws::S3
|
|
3499
3521
|
# {
|
3500
3522
|
# deleted: [
|
3501
3523
|
# {
|
3502
|
-
#
|
3503
|
-
#
|
3504
|
-
# key: "objectkey1",
|
3524
|
+
# key: "HappyFace.jpg",
|
3525
|
+
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
3505
3526
|
# },
|
3506
3527
|
# {
|
3507
|
-
#
|
3508
|
-
#
|
3509
|
-
# key: "objectkey2",
|
3528
|
+
# key: "HappyFace.jpg",
|
3529
|
+
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
3510
3530
|
# },
|
3511
3531
|
# ],
|
3512
3532
|
# }
|
3513
3533
|
#
|
3514
|
-
# @example Example: To delete multiple
|
3534
|
+
# @example Example: To delete multiple objects from a versioned bucket
|
3515
3535
|
#
|
3516
|
-
# # The following example deletes objects from a bucket. The
|
3517
|
-
# #
|
3536
|
+
# # The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the
|
3537
|
+
# # object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.
|
3518
3538
|
#
|
3519
3539
|
# resp = client.delete_objects({
|
3520
3540
|
# bucket: "examplebucket",
|
3521
3541
|
# delete: {
|
3522
3542
|
# objects: [
|
3523
3543
|
# {
|
3524
|
-
# key: "
|
3525
|
-
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
3544
|
+
# key: "objectkey1",
|
3526
3545
|
# },
|
3527
3546
|
# {
|
3528
|
-
# key: "
|
3529
|
-
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
3547
|
+
# key: "objectkey2",
|
3530
3548
|
# },
|
3531
3549
|
# ],
|
3532
3550
|
# quiet: false,
|
@@ -3537,12 +3555,14 @@ module Aws::S3
|
|
3537
3555
|
# {
|
3538
3556
|
# deleted: [
|
3539
3557
|
# {
|
3540
|
-
#
|
3541
|
-
#
|
3558
|
+
# delete_marker: true,
|
3559
|
+
# delete_marker_version_id: "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
|
3560
|
+
# key: "objectkey1",
|
3542
3561
|
# },
|
3543
3562
|
# {
|
3544
|
-
#
|
3545
|
-
#
|
3563
|
+
# delete_marker: true,
|
3564
|
+
# delete_marker_version_id: "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
|
3565
|
+
# key: "objectkey2",
|
3546
3566
|
# },
|
3547
3567
|
# ],
|
3548
3568
|
# }
|
@@ -3694,9 +3714,11 @@ module Aws::S3
|
|
3694
3714
|
# @option params [String] :request_payer
|
3695
3715
|
# Confirms that the requester knows that they will be charged for the
|
3696
3716
|
# request. Bucket owners need not specify this parameter in their
|
3697
|
-
# requests.
|
3698
|
-
# Pays
|
3699
|
-
#
|
3717
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
3718
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
3719
|
+
# charges to copy the object. For information about downloading objects
|
3720
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
3721
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
3700
3722
|
#
|
3701
3723
|
#
|
3702
3724
|
#
|
@@ -5867,9 +5889,11 @@ module Aws::S3
|
|
5867
5889
|
# @option params [String] :request_payer
|
5868
5890
|
# Confirms that the requester knows that they will be charged for the
|
5869
5891
|
# request. Bucket owners need not specify this parameter in their
|
5870
|
-
# requests.
|
5871
|
-
# Pays
|
5872
|
-
#
|
5892
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
5893
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
5894
|
+
# charges to copy the object. For information about downloading objects
|
5895
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
5896
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
5873
5897
|
#
|
5874
5898
|
#
|
5875
5899
|
#
|
@@ -5930,49 +5954,49 @@ module Aws::S3
|
|
5930
5954
|
# * {Types::GetObjectOutput#object_lock_legal_hold_status #object_lock_legal_hold_status} => String
|
5931
5955
|
#
|
5932
5956
|
#
|
5933
|
-
# @example Example: To retrieve an object
|
5957
|
+
# @example Example: To retrieve a byte range of an object
|
5934
5958
|
#
|
5935
|
-
# # The following example retrieves an object for an S3 bucket.
|
5959
|
+
# # The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a
|
5960
|
+
# # specific byte range.
|
5936
5961
|
#
|
5937
5962
|
# resp = client.get_object({
|
5938
5963
|
# bucket: "examplebucket",
|
5939
|
-
# key: "
|
5964
|
+
# key: "SampleFile.txt",
|
5965
|
+
# range: "bytes=0-9",
|
5940
5966
|
# })
|
5941
5967
|
#
|
5942
5968
|
# resp.to_h outputs the following:
|
5943
5969
|
# {
|
5944
5970
|
# accept_ranges: "bytes",
|
5945
|
-
# content_length:
|
5946
|
-
#
|
5947
|
-
#
|
5948
|
-
#
|
5971
|
+
# content_length: 10,
|
5972
|
+
# content_range: "bytes 0-9/43",
|
5973
|
+
# content_type: "text/plain",
|
5974
|
+
# etag: "\"0d94420ffd0bc68cd3d152506b97a9cc\"",
|
5975
|
+
# last_modified: Time.parse("Thu, 09 Oct 2014 22:57:28 GMT"),
|
5949
5976
|
# metadata: {
|
5950
5977
|
# },
|
5951
|
-
# tag_count: 2,
|
5952
5978
|
# version_id: "null",
|
5953
5979
|
# }
|
5954
5980
|
#
|
5955
|
-
# @example Example: To retrieve
|
5981
|
+
# @example Example: To retrieve an object
|
5956
5982
|
#
|
5957
|
-
# # The following example retrieves an object for an S3 bucket.
|
5958
|
-
# # specific byte range.
|
5983
|
+
# # The following example retrieves an object for an S3 bucket.
|
5959
5984
|
#
|
5960
5985
|
# resp = client.get_object({
|
5961
5986
|
# bucket: "examplebucket",
|
5962
|
-
# key: "
|
5963
|
-
# range: "bytes=0-9",
|
5987
|
+
# key: "HappyFace.jpg",
|
5964
5988
|
# })
|
5965
5989
|
#
|
5966
5990
|
# resp.to_h outputs the following:
|
5967
5991
|
# {
|
5968
5992
|
# accept_ranges: "bytes",
|
5969
|
-
# content_length:
|
5970
|
-
#
|
5971
|
-
#
|
5972
|
-
#
|
5973
|
-
# last_modified: Time.parse("Thu, 09 Oct 2014 22:57:28 GMT"),
|
5993
|
+
# content_length: 3191,
|
5994
|
+
# content_type: "image/jpeg",
|
5995
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
5996
|
+
# last_modified: Time.parse("Thu, 15 Dec 2016 01:19:41 GMT"),
|
5974
5997
|
# metadata: {
|
5975
5998
|
# },
|
5999
|
+
# tag_count: 2,
|
5976
6000
|
# version_id: "null",
|
5977
6001
|
# }
|
5978
6002
|
#
|
@@ -6065,7 +6089,7 @@ module Aws::S3
|
|
6065
6089
|
# resp.bucket_key_enabled #=> Boolean
|
6066
6090
|
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW"
|
6067
6091
|
# resp.request_charged #=> String, one of "requester"
|
6068
|
-
# resp.replication_status #=> String, one of "COMPLETE", "PENDING", "FAILED", "REPLICA"
|
6092
|
+
# resp.replication_status #=> String, one of "COMPLETE", "PENDING", "FAILED", "REPLICA", "COMPLETED"
|
6069
6093
|
# resp.parts_count #=> Integer
|
6070
6094
|
# resp.tag_count #=> Integer
|
6071
6095
|
# resp.object_lock_mode #=> String, one of "GOVERNANCE", "COMPLIANCE"
|
@@ -6145,9 +6169,11 @@ module Aws::S3
|
|
6145
6169
|
# @option params [String] :request_payer
|
6146
6170
|
# Confirms that the requester knows that they will be charged for the
|
6147
6171
|
# request. Bucket owners need not specify this parameter in their
|
6148
|
-
# requests.
|
6149
|
-
# Pays
|
6150
|
-
#
|
6172
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
6173
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
6174
|
+
# charges to copy the object. For information about downloading objects
|
6175
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
6176
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
6151
6177
|
#
|
6152
6178
|
#
|
6153
6179
|
#
|
@@ -6413,9 +6439,11 @@ module Aws::S3
|
|
6413
6439
|
# @option params [String] :request_payer
|
6414
6440
|
# Confirms that the requester knows that they will be charged for the
|
6415
6441
|
# request. Bucket owners need not specify this parameter in their
|
6416
|
-
# requests.
|
6417
|
-
# Pays
|
6418
|
-
#
|
6442
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
6443
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
6444
|
+
# charges to copy the object. For information about downloading objects
|
6445
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
6446
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
6419
6447
|
#
|
6420
6448
|
#
|
6421
6449
|
#
|
@@ -6536,9 +6564,11 @@ module Aws::S3
|
|
6536
6564
|
# @option params [String] :request_payer
|
6537
6565
|
# Confirms that the requester knows that they will be charged for the
|
6538
6566
|
# request. Bucket owners need not specify this parameter in their
|
6539
|
-
# requests.
|
6540
|
-
# Pays
|
6541
|
-
#
|
6567
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
6568
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
6569
|
+
# charges to copy the object. For information about downloading objects
|
6570
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
6571
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
6542
6572
|
#
|
6543
6573
|
#
|
6544
6574
|
#
|
@@ -6682,9 +6712,11 @@ module Aws::S3
|
|
6682
6712
|
# @option params [String] :request_payer
|
6683
6713
|
# Confirms that the requester knows that they will be charged for the
|
6684
6714
|
# request. Bucket owners need not specify this parameter in their
|
6685
|
-
# requests.
|
6686
|
-
# Pays
|
6687
|
-
#
|
6715
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
6716
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
6717
|
+
# charges to copy the object. For information about downloading objects
|
6718
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
6719
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
6688
6720
|
#
|
6689
6721
|
#
|
6690
6722
|
#
|
@@ -6794,9 +6826,11 @@ module Aws::S3
|
|
6794
6826
|
# @option params [String] :request_payer
|
6795
6827
|
# Confirms that the requester knows that they will be charged for the
|
6796
6828
|
# request. Bucket owners need not specify this parameter in their
|
6797
|
-
# requests.
|
6798
|
-
# Pays
|
6799
|
-
#
|
6829
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
6830
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
6831
|
+
# charges to copy the object. For information about downloading objects
|
6832
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
6833
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
6800
6834
|
#
|
6801
6835
|
#
|
6802
6836
|
#
|
@@ -6808,49 +6842,49 @@ module Aws::S3
|
|
6808
6842
|
# * {Types::GetObjectTaggingOutput#tag_set #tag_set} => Array<Types::Tag>
|
6809
6843
|
#
|
6810
6844
|
#
|
6811
|
-
# @example Example: To retrieve tag set of
|
6845
|
+
# @example Example: To retrieve tag set of an object
|
6812
6846
|
#
|
6813
|
-
# # The following example retrieves tag set of an object.
|
6847
|
+
# # The following example retrieves tag set of an object.
|
6814
6848
|
#
|
6815
6849
|
# resp = client.get_object_tagging({
|
6816
6850
|
# bucket: "examplebucket",
|
6817
|
-
# key: "
|
6818
|
-
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
6851
|
+
# key: "HappyFace.jpg",
|
6819
6852
|
# })
|
6820
6853
|
#
|
6821
6854
|
# resp.to_h outputs the following:
|
6822
6855
|
# {
|
6823
6856
|
# tag_set: [
|
6824
6857
|
# {
|
6825
|
-
# key: "
|
6826
|
-
# value: "
|
6858
|
+
# key: "Key4",
|
6859
|
+
# value: "Value4",
|
6860
|
+
# },
|
6861
|
+
# {
|
6862
|
+
# key: "Key3",
|
6863
|
+
# value: "Value3",
|
6827
6864
|
# },
|
6828
6865
|
# ],
|
6829
|
-
# version_id: "
|
6866
|
+
# version_id: "null",
|
6830
6867
|
# }
|
6831
6868
|
#
|
6832
|
-
# @example Example: To retrieve tag set of
|
6869
|
+
# @example Example: To retrieve tag set of a specific object version
|
6833
6870
|
#
|
6834
|
-
# # The following example retrieves tag set of an object.
|
6871
|
+
# # The following example retrieves tag set of an object. The request specifies object version.
|
6835
6872
|
#
|
6836
6873
|
# resp = client.get_object_tagging({
|
6837
6874
|
# bucket: "examplebucket",
|
6838
|
-
# key: "
|
6875
|
+
# key: "exampleobject",
|
6876
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
6839
6877
|
# })
|
6840
6878
|
#
|
6841
6879
|
# resp.to_h outputs the following:
|
6842
6880
|
# {
|
6843
6881
|
# tag_set: [
|
6844
6882
|
# {
|
6845
|
-
# key: "
|
6846
|
-
# value: "
|
6847
|
-
# },
|
6848
|
-
# {
|
6849
|
-
# key: "Key3",
|
6850
|
-
# value: "Value3",
|
6883
|
+
# key: "Key1",
|
6884
|
+
# value: "Value1",
|
6851
6885
|
# },
|
6852
6886
|
# ],
|
6853
|
-
# version_id: "
|
6887
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
6854
6888
|
# }
|
6855
6889
|
#
|
6856
6890
|
# @example Request syntax with placeholder values
|
@@ -6915,9 +6949,11 @@ module Aws::S3
|
|
6915
6949
|
# @option params [String] :request_payer
|
6916
6950
|
# Confirms that the requester knows that they will be charged for the
|
6917
6951
|
# request. Bucket owners need not specify this parameter in their
|
6918
|
-
# requests.
|
6919
|
-
# Pays
|
6920
|
-
#
|
6952
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
6953
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
6954
|
+
# charges to copy the object. For information about downloading objects
|
6955
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
6956
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
6921
6957
|
#
|
6922
6958
|
#
|
6923
6959
|
#
|
@@ -7317,9 +7353,11 @@ module Aws::S3
|
|
7317
7353
|
# @option params [String] :request_payer
|
7318
7354
|
# Confirms that the requester knows that they will be charged for the
|
7319
7355
|
# request. Bucket owners need not specify this parameter in their
|
7320
|
-
# requests.
|
7321
|
-
# Pays
|
7322
|
-
#
|
7356
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
7357
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
7358
|
+
# charges to copy the object. For information about downloading objects
|
7359
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
7360
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
7323
7361
|
#
|
7324
7362
|
#
|
7325
7363
|
#
|
@@ -7457,7 +7495,7 @@ module Aws::S3
|
|
7457
7495
|
# resp.bucket_key_enabled #=> Boolean
|
7458
7496
|
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW"
|
7459
7497
|
# resp.request_charged #=> String, one of "requester"
|
7460
|
-
# resp.replication_status #=> String, one of "COMPLETE", "PENDING", "FAILED", "REPLICA"
|
7498
|
+
# resp.replication_status #=> String, one of "COMPLETE", "PENDING", "FAILED", "REPLICA", "COMPLETED"
|
7461
7499
|
# resp.parts_count #=> Integer
|
7462
7500
|
# resp.object_lock_mode #=> String, one of "GOVERNANCE", "COMPLIANCE"
|
7463
7501
|
# resp.object_lock_retain_until_date #=> Time
|
@@ -8053,9 +8091,11 @@ module Aws::S3
|
|
8053
8091
|
# @option params [String] :request_payer
|
8054
8092
|
# Confirms that the requester knows that they will be charged for the
|
8055
8093
|
# request. Bucket owners need not specify this parameter in their
|
8056
|
-
# requests.
|
8057
|
-
# Pays
|
8058
|
-
#
|
8094
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
8095
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
8096
|
+
# charges to copy the object. For information about downloading objects
|
8097
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
8098
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
8059
8099
|
#
|
8060
8100
|
#
|
8061
8101
|
#
|
@@ -8080,97 +8120,97 @@ module Aws::S3
|
|
8080
8120
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8081
8121
|
#
|
8082
8122
|
#
|
8083
|
-
# @example Example:
|
8123
|
+
# @example Example: To list in-progress multipart uploads on a bucket
|
8084
8124
|
#
|
8085
|
-
# # The following example
|
8086
|
-
# # setup of multipart uploads.
|
8125
|
+
# # The following example lists in-progress multipart uploads on a specific bucket.
|
8087
8126
|
#
|
8088
8127
|
# resp = client.list_multipart_uploads({
|
8089
8128
|
# bucket: "examplebucket",
|
8090
|
-
# key_marker: "nextkeyfrompreviousresponse",
|
8091
|
-
# max_uploads: 2,
|
8092
|
-
# upload_id_marker: "valuefrompreviousresponse",
|
8093
8129
|
# })
|
8094
8130
|
#
|
8095
8131
|
# resp.to_h outputs the following:
|
8096
8132
|
# {
|
8097
|
-
# bucket: "acl1",
|
8098
|
-
# is_truncated: true,
|
8099
|
-
# key_marker: "",
|
8100
|
-
# max_uploads: 2,
|
8101
|
-
# next_key_marker: "someobjectkey",
|
8102
|
-
# next_upload_id_marker: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
8103
|
-
# upload_id_marker: "",
|
8104
8133
|
# uploads: [
|
8105
8134
|
# {
|
8106
8135
|
# initiated: Time.parse("2014-05-01T05:40:58.000Z"),
|
8107
8136
|
# initiator: {
|
8108
|
-
# display_name: "
|
8137
|
+
# display_name: "display-name",
|
8109
8138
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
8110
8139
|
# },
|
8111
8140
|
# key: "JavaFile",
|
8112
8141
|
# owner: {
|
8113
|
-
# display_name: "
|
8114
|
-
# id: "
|
8142
|
+
# display_name: "display-name",
|
8143
|
+
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
8115
8144
|
# },
|
8116
8145
|
# storage_class: "STANDARD",
|
8117
|
-
# upload_id: "
|
8146
|
+
# upload_id: "examplelUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--",
|
8118
8147
|
# },
|
8119
8148
|
# {
|
8120
8149
|
# initiated: Time.parse("2014-05-01T05:41:27.000Z"),
|
8121
8150
|
# initiator: {
|
8122
|
-
# display_name: "
|
8151
|
+
# display_name: "display-name",
|
8123
8152
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
8124
8153
|
# },
|
8125
8154
|
# key: "JavaFile",
|
8126
8155
|
# owner: {
|
8127
|
-
# display_name: "
|
8156
|
+
# display_name: "display-name",
|
8128
8157
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
8129
8158
|
# },
|
8130
8159
|
# storage_class: "STANDARD",
|
8131
|
-
# upload_id: "
|
8160
|
+
# upload_id: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
8132
8161
|
# },
|
8133
8162
|
# ],
|
8134
8163
|
# }
|
8135
8164
|
#
|
8136
|
-
# @example Example:
|
8165
|
+
# @example Example: List next set of multipart uploads when previous result is truncated
|
8137
8166
|
#
|
8138
|
-
# # The following example
|
8167
|
+
# # The following example specifies the upload-id-marker and key-marker from previous truncated response to retrieve next
|
8168
|
+
# # setup of multipart uploads.
|
8139
8169
|
#
|
8140
8170
|
# resp = client.list_multipart_uploads({
|
8141
8171
|
# bucket: "examplebucket",
|
8172
|
+
# key_marker: "nextkeyfrompreviousresponse",
|
8173
|
+
# max_uploads: 2,
|
8174
|
+
# upload_id_marker: "valuefrompreviousresponse",
|
8142
8175
|
# })
|
8143
8176
|
#
|
8144
8177
|
# resp.to_h outputs the following:
|
8145
8178
|
# {
|
8179
|
+
# bucket: "acl1",
|
8180
|
+
# is_truncated: true,
|
8181
|
+
# key_marker: "",
|
8182
|
+
# max_uploads: 2,
|
8183
|
+
# next_key_marker: "someobjectkey",
|
8184
|
+
# next_upload_id_marker: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
8185
|
+
# upload_id_marker: "",
|
8146
8186
|
# uploads: [
|
8147
8187
|
# {
|
8148
8188
|
# initiated: Time.parse("2014-05-01T05:40:58.000Z"),
|
8149
8189
|
# initiator: {
|
8150
|
-
# display_name: "display-name",
|
8190
|
+
# display_name: "ownder-display-name",
|
8151
8191
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
8152
8192
|
# },
|
8153
8193
|
# key: "JavaFile",
|
8154
8194
|
# owner: {
|
8155
|
-
# display_name: "
|
8156
|
-
# id: "
|
8195
|
+
# display_name: "mohanataws",
|
8196
|
+
# id: "852b113e7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
8157
8197
|
# },
|
8158
8198
|
# storage_class: "STANDARD",
|
8159
|
-
# upload_id: "
|
8199
|
+
# upload_id: "gZ30jIqlUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--",
|
8160
8200
|
# },
|
8161
8201
|
# {
|
8162
8202
|
# initiated: Time.parse("2014-05-01T05:41:27.000Z"),
|
8163
8203
|
# initiator: {
|
8164
|
-
# display_name: "display-name",
|
8204
|
+
# display_name: "ownder-display-name",
|
8165
8205
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
8166
8206
|
# },
|
8167
8207
|
# key: "JavaFile",
|
8168
8208
|
# owner: {
|
8169
|
-
# display_name: "display-name",
|
8209
|
+
# display_name: "ownder-display-name",
|
8170
8210
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
8171
8211
|
# },
|
8172
8212
|
# storage_class: "STANDARD",
|
8173
|
-
# upload_id: "
|
8213
|
+
# upload_id: "b7tZSqIlo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
8174
8214
|
# },
|
8175
8215
|
# ],
|
8176
8216
|
# }
|
@@ -8307,9 +8347,11 @@ module Aws::S3
|
|
8307
8347
|
# @option params [String] :request_payer
|
8308
8348
|
# Confirms that the requester knows that they will be charged for the
|
8309
8349
|
# request. Bucket owners need not specify this parameter in their
|
8310
|
-
# requests.
|
8311
|
-
# Pays
|
8312
|
-
#
|
8350
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
8351
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
8352
|
+
# charges to copy the object. For information about downloading objects
|
8353
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
8354
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
8313
8355
|
#
|
8314
8356
|
#
|
8315
8357
|
#
|
@@ -8952,9 +8994,11 @@ module Aws::S3
|
|
8952
8994
|
# @option params [String] :request_payer
|
8953
8995
|
# Confirms that the requester knows that they will be charged for the
|
8954
8996
|
# request. Bucket owners need not specify this parameter in their
|
8955
|
-
# requests.
|
8956
|
-
# Pays
|
8957
|
-
#
|
8997
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
8998
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
8999
|
+
# charges to copy the object. For information about downloading objects
|
9000
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
9001
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
8958
9002
|
#
|
8959
9003
|
#
|
8960
9004
|
#
|
@@ -9806,13 +9850,13 @@ module Aws::S3
|
|
9806
9850
|
# uses server-side encryption with Amazon S3 managed keys (SSE-S3). You
|
9807
9851
|
# can optionally configure default encryption for a bucket by using
|
9808
9852
|
# server-side encryption with Key Management Service (KMS) keys
|
9809
|
-
# (SSE-KMS)
|
9810
|
-
# KMS keys (DSSE-KMS)
|
9811
|
-
#
|
9812
|
-
#
|
9813
|
-
#
|
9814
|
-
#
|
9815
|
-
#
|
9853
|
+
# (SSE-KMS) or dual-layer server-side encryption with Amazon Web
|
9854
|
+
# Services KMS keys (DSSE-KMS). If you specify default encryption by
|
9855
|
+
# using SSE-KMS, you can also configure [Amazon S3 Bucket Keys][1]. If
|
9856
|
+
# you use PutBucketEncryption to set your [default bucket encryption][2]
|
9857
|
+
# to SSE-KMS, you should verify that your KMS key ID is correct. Amazon
|
9858
|
+
# S3 does not validate the KMS key ID provided in PutBucketEncryption
|
9859
|
+
# requests.
|
9816
9860
|
#
|
9817
9861
|
# This action requires Amazon Web Services Signature Version 4. For more
|
9818
9862
|
# information, see [ Authenticating Requests (Amazon Web Services
|
@@ -9834,8 +9878,8 @@ module Aws::S3
|
|
9834
9878
|
#
|
9835
9879
|
#
|
9836
9880
|
#
|
9837
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-
|
9838
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-
|
9881
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html
|
9882
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
|
9839
9883
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
|
9840
9884
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
9841
9885
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
@@ -11262,7 +11306,9 @@ module Aws::S3
|
|
11262
11306
|
# replication configuration, you provide the name of the destination
|
11263
11307
|
# bucket or buckets where you want Amazon S3 to replicate objects, the
|
11264
11308
|
# IAM role that Amazon S3 can assume to replicate objects on your
|
11265
|
-
# behalf, and other relevant information.
|
11309
|
+
# behalf, and other relevant information. You can invoke this request
|
11310
|
+
# for a specific Amazon Web Services Region by using the [
|
11311
|
+
# `aws:RequestedRegion` ][2] condition key.
|
11266
11312
|
#
|
11267
11313
|
# A replication configuration must include at least one rule, and can
|
11268
11314
|
# contain a maximum of 1,000. Each rule identifies a subset of objects
|
@@ -11279,12 +11325,12 @@ module Aws::S3
|
|
11279
11325
|
#
|
11280
11326
|
# <note markdown="1"> If you are using an earlier version of the replication configuration,
|
11281
11327
|
# Amazon S3 handles replication of delete markers differently. For more
|
11282
|
-
# information, see [Backward Compatibility][
|
11328
|
+
# information, see [Backward Compatibility][3].
|
11283
11329
|
#
|
11284
11330
|
# </note>
|
11285
11331
|
#
|
11286
11332
|
# For information about enabling versioning on a bucket, see [Using
|
11287
|
-
# Versioning][
|
11333
|
+
# Versioning][4].
|
11288
11334
|
#
|
11289
11335
|
# Handling Replication of Encrypted Objects
|
11290
11336
|
#
|
@@ -11294,10 +11340,10 @@ module Aws::S3
|
|
11294
11340
|
# `SourceSelectionCriteria`, `SseKmsEncryptedObjects`, `Status`,
|
11295
11341
|
# `EncryptionConfiguration`, and `ReplicaKmsKeyID`. For information
|
11296
11342
|
# about replication configuration, see [Replicating Objects Created
|
11297
|
-
# with SSE Using KMS keys][
|
11343
|
+
# with SSE Using KMS keys][5].
|
11298
11344
|
#
|
11299
11345
|
# For information on `PutBucketReplication` errors, see [List of
|
11300
|
-
# replication-related error codes][
|
11346
|
+
# replication-related error codes][6]
|
11301
11347
|
#
|
11302
11348
|
# Permissions
|
11303
11349
|
#
|
@@ -11308,32 +11354,33 @@ module Aws::S3
|
|
11308
11354
|
# account that created the bucket, can perform this operation. The
|
11309
11355
|
# resource owner can also grant others permissions to perform the
|
11310
11356
|
# operation. For more information about permissions, see [Specifying
|
11311
|
-
# Permissions in a Policy][
|
11312
|
-
# Amazon S3 Resources][
|
11357
|
+
# Permissions in a Policy][7] and [Managing Access Permissions to Your
|
11358
|
+
# Amazon S3 Resources][8].
|
11313
11359
|
#
|
11314
11360
|
# <note markdown="1"> To perform this operation, the user or role performing the action
|
11315
|
-
# must have the [iam:PassRole][
|
11361
|
+
# must have the [iam:PassRole][9] permission.
|
11316
11362
|
#
|
11317
11363
|
# </note>
|
11318
11364
|
#
|
11319
11365
|
# The following operations are related to `PutBucketReplication`:
|
11320
11366
|
#
|
11321
|
-
# * [GetBucketReplication][
|
11367
|
+
# * [GetBucketReplication][10]
|
11322
11368
|
#
|
11323
|
-
# * [DeleteBucketReplication][
|
11369
|
+
# * [DeleteBucketReplication][11]
|
11324
11370
|
#
|
11325
11371
|
#
|
11326
11372
|
#
|
11327
11373
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html
|
11328
|
-
# [2]: https://docs.aws.amazon.com/
|
11329
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
11330
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
11331
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11332
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11333
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11334
|
-
# [8]: https://docs.aws.amazon.com/
|
11335
|
-
# [9]: https://docs.aws.amazon.com/
|
11336
|
-
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
11374
|
+
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requestedregion
|
11375
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations
|
11376
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html
|
11377
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html
|
11378
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList
|
11379
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
|
11380
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
11381
|
+
# [9]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html
|
11382
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html
|
11383
|
+
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html
|
11337
11384
|
#
|
11338
11385
|
# @option params [required, String] :bucket
|
11339
11386
|
# The name of the bucket
|
@@ -11605,54 +11652,37 @@ module Aws::S3
|
|
11605
11652
|
# Operations][3] and [Managing Access Permissions to Your Amazon S3
|
11606
11653
|
# Resources][4].
|
11607
11654
|
#
|
11608
|
-
# `PutBucketTagging` has the following special errors
|
11609
|
-
#
|
11610
|
-
# * Error code: `InvalidTagError`
|
11611
|
-
#
|
11612
|
-
# * Description: The tag provided was not a valid tag. This error can
|
11613
|
-
# occur if the tag did not pass input validation. For information
|
11614
|
-
# about tag restrictions, see [User-Defined Tag Restrictions][5] and
|
11615
|
-
# [Amazon Web Services-Generated Cost Allocation Tag
|
11616
|
-
# Restrictions][6].
|
11617
|
-
#
|
11618
|
-
# ^
|
11619
|
-
#
|
11620
|
-
# * Error code: `MalformedXMLError`
|
11621
|
-
#
|
11622
|
-
# * Description: The XML provided does not match the schema.
|
11623
|
-
#
|
11624
|
-
# ^
|
11625
|
-
#
|
11626
|
-
# * Error code: `OperationAbortedError `
|
11655
|
+
# `PutBucketTagging` has the following special errors. For more Amazon
|
11656
|
+
# S3 errors see, [Error Responses][5].
|
11627
11657
|
#
|
11628
|
-
#
|
11629
|
-
#
|
11658
|
+
# * `InvalidTag` - The tag provided was not a valid tag. This error can
|
11659
|
+
# occur if the tag did not pass input validation. For more
|
11660
|
+
# information, see [Using Cost Allocation in Amazon S3 Bucket
|
11661
|
+
# Tags][2].
|
11630
11662
|
#
|
11631
|
-
#
|
11632
|
-
#
|
11633
|
-
# * Error code: `InternalError`
|
11663
|
+
# * `MalformedXML` - The XML provided does not match the schema.
|
11634
11664
|
#
|
11635
|
-
#
|
11636
|
-
#
|
11665
|
+
# * `OperationAborted` - A conflicting conditional action is currently
|
11666
|
+
# in progress against this resource. Please try again.
|
11637
11667
|
#
|
11638
|
-
#
|
11668
|
+
# * `InternalError` - The service was unable to apply the provided tag
|
11669
|
+
# to the bucket.
|
11639
11670
|
#
|
11640
11671
|
# The following operations are related to `PutBucketTagging`:
|
11641
11672
|
#
|
11642
|
-
# * [GetBucketTagging][
|
11673
|
+
# * [GetBucketTagging][6]
|
11643
11674
|
#
|
11644
|
-
# * [DeleteBucketTagging][
|
11675
|
+
# * [DeleteBucketTagging][7]
|
11645
11676
|
#
|
11646
11677
|
#
|
11647
11678
|
#
|
11648
11679
|
# [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html
|
11649
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11680
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/CostAllocTagging.html
|
11650
11681
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
11651
11682
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
11652
|
-
# [5]: https://docs.aws.amazon.com/
|
11653
|
-
# [6]: https://docs.aws.amazon.com/
|
11654
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
11655
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html
|
11683
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html
|
11684
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html
|
11685
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html
|
11656
11686
|
#
|
11657
11687
|
# @option params [required, String] :bucket
|
11658
11688
|
# The bucket name.
|
@@ -11938,6 +11968,8 @@ module Aws::S3
|
|
11938
11968
|
# object redirect. For more information, see [Configuring an Object
|
11939
11969
|
# Redirect][2] in the *Amazon S3 User Guide*.
|
11940
11970
|
#
|
11971
|
+
# The maximum request length is limited to 128 KB.
|
11972
|
+
#
|
11941
11973
|
#
|
11942
11974
|
#
|
11943
11975
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html
|
@@ -12416,10 +12448,11 @@ module Aws::S3
|
|
12416
12448
|
#
|
12417
12449
|
# @option params [String] :ssekms_key_id
|
12418
12450
|
# If `x-amz-server-side-encryption` has a valid value of `aws:kms` or
|
12419
|
-
# `aws:kms:dsse`, this header specifies the ID
|
12420
|
-
# Service (KMS) symmetric encryption
|
12421
|
-
# for the object. If you specify
|
12422
|
-
#
|
12451
|
+
# `aws:kms:dsse`, this header specifies the ID (Key ID, Key ARN, or Key
|
12452
|
+
# Alias) of the Key Management Service (KMS) symmetric encryption
|
12453
|
+
# customer managed key that was used for the object. If you specify
|
12454
|
+
# `x-amz-server-side-encryption:aws:kms` or
|
12455
|
+
# `x-amz-server-side-encryption:aws:kms:dsse`, but do not provide`
|
12423
12456
|
# x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the
|
12424
12457
|
# Amazon Web Services managed key (`aws/s3`) to protect the data. If the
|
12425
12458
|
# KMS key does not exist in the same account that's issuing the
|
@@ -12445,9 +12478,11 @@ module Aws::S3
|
|
12445
12478
|
# @option params [String] :request_payer
|
12446
12479
|
# Confirms that the requester knows that they will be charged for the
|
12447
12480
|
# request. Bucket owners need not specify this parameter in their
|
12448
|
-
# requests.
|
12449
|
-
# Pays
|
12450
|
-
#
|
12481
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
12482
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
12483
|
+
# charges to copy the object. For information about downloading objects
|
12484
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
12485
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
12451
12486
|
#
|
12452
12487
|
#
|
12453
12488
|
#
|
@@ -12495,95 +12530,99 @@ module Aws::S3
|
|
12495
12530
|
# * {Types::PutObjectOutput#request_charged #request_charged} => String
|
12496
12531
|
#
|
12497
12532
|
#
|
12498
|
-
# @example Example: To upload an object
|
12533
|
+
# @example Example: To upload an object and specify server-side encryption and object tags
|
12499
12534
|
#
|
12500
|
-
# # The following example uploads an object. The request specifies optional
|
12501
|
-
# #
|
12535
|
+
# # The following example uploads an object. The request specifies the optional server-side encryption option. The request
|
12536
|
+
# # also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.
|
12502
12537
|
#
|
12503
12538
|
# resp = client.put_object({
|
12504
|
-
# body: "
|
12539
|
+
# body: "filetoupload",
|
12505
12540
|
# bucket: "examplebucket",
|
12506
|
-
# key: "
|
12541
|
+
# key: "exampleobject",
|
12507
12542
|
# server_side_encryption: "AES256",
|
12508
|
-
#
|
12543
|
+
# tagging: "key1=value1&key2=value2",
|
12509
12544
|
# })
|
12510
12545
|
#
|
12511
12546
|
# resp.to_h outputs the following:
|
12512
12547
|
# {
|
12513
12548
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
12514
12549
|
# server_side_encryption: "AES256",
|
12515
|
-
# version_id: "
|
12550
|
+
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
12516
12551
|
# }
|
12517
12552
|
#
|
12518
|
-
# @example Example: To
|
12553
|
+
# @example Example: To create an object.
|
12519
12554
|
#
|
12520
|
-
# # The following example
|
12521
|
-
# # S3 returns version ID of the newly created object.
|
12555
|
+
# # The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
|
12522
12556
|
#
|
12523
12557
|
# resp = client.put_object({
|
12524
|
-
# body: "
|
12558
|
+
# body: "filetoupload",
|
12525
12559
|
# bucket: "examplebucket",
|
12526
|
-
# key: "
|
12527
|
-
# tagging: "key1=value1&key2=value2",
|
12560
|
+
# key: "objectkey",
|
12528
12561
|
# })
|
12529
12562
|
#
|
12530
12563
|
# resp.to_h outputs the following:
|
12531
12564
|
# {
|
12532
12565
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
12533
|
-
# version_id: "
|
12566
|
+
# version_id: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ",
|
12534
12567
|
# }
|
12535
12568
|
#
|
12536
|
-
# @example Example: To upload an object
|
12569
|
+
# @example Example: To upload an object (specify optional headers)
|
12537
12570
|
#
|
12538
|
-
# # The following example uploads an object. The request specifies
|
12539
|
-
# #
|
12571
|
+
# # The following example uploads an object. The request specifies optional request headers to directs S3 to use specific
|
12572
|
+
# # storage class and use server-side encryption.
|
12540
12573
|
#
|
12541
12574
|
# resp = client.put_object({
|
12542
|
-
# body: "
|
12575
|
+
# body: "HappyFace.jpg",
|
12543
12576
|
# bucket: "examplebucket",
|
12544
|
-
# key: "
|
12577
|
+
# key: "HappyFace.jpg",
|
12545
12578
|
# server_side_encryption: "AES256",
|
12546
|
-
#
|
12579
|
+
# storage_class: "STANDARD_IA",
|
12547
12580
|
# })
|
12548
12581
|
#
|
12549
12582
|
# resp.to_h outputs the following:
|
12550
12583
|
# {
|
12551
12584
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
12552
12585
|
# server_side_encryption: "AES256",
|
12553
|
-
# version_id: "
|
12586
|
+
# version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp",
|
12554
12587
|
# }
|
12555
12588
|
#
|
12556
|
-
# @example Example: To
|
12589
|
+
# @example Example: To upload an object and specify optional tags
|
12557
12590
|
#
|
12558
|
-
# # The following example
|
12591
|
+
# # The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore
|
12592
|
+
# # S3 returns version ID of the newly created object.
|
12559
12593
|
#
|
12560
12594
|
# resp = client.put_object({
|
12561
|
-
# body: "
|
12595
|
+
# body: "c:\\HappyFace.jpg",
|
12562
12596
|
# bucket: "examplebucket",
|
12563
|
-
# key: "
|
12597
|
+
# key: "HappyFace.jpg",
|
12598
|
+
# tagging: "key1=value1&key2=value2",
|
12564
12599
|
# })
|
12565
12600
|
#
|
12566
12601
|
# resp.to_h outputs the following:
|
12567
12602
|
# {
|
12568
12603
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
12569
|
-
# version_id: "
|
12604
|
+
# version_id: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a",
|
12570
12605
|
# }
|
12571
12606
|
#
|
12572
|
-
# @example Example: To upload
|
12607
|
+
# @example Example: To upload object and specify user-defined metadata
|
12573
12608
|
#
|
12574
|
-
# # The following example
|
12575
|
-
# #
|
12609
|
+
# # The following example creates an object. The request also specifies optional metadata. If the bucket is versioning
|
12610
|
+
# # enabled, S3 returns version ID in response.
|
12576
12611
|
#
|
12577
12612
|
# resp = client.put_object({
|
12578
|
-
# body: "
|
12613
|
+
# body: "filetoupload",
|
12579
12614
|
# bucket: "examplebucket",
|
12580
|
-
# key: "
|
12615
|
+
# key: "exampleobject",
|
12616
|
+
# metadata: {
|
12617
|
+
# "metadata1" => "value1",
|
12618
|
+
# "metadata2" => "value2",
|
12619
|
+
# },
|
12581
12620
|
# })
|
12582
12621
|
#
|
12583
12622
|
# resp.to_h outputs the following:
|
12584
12623
|
# {
|
12585
12624
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
12586
|
-
# version_id: "
|
12625
|
+
# version_id: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0",
|
12587
12626
|
# }
|
12588
12627
|
#
|
12589
12628
|
# @example Example: To upload an object and specify canned ACL.
|
@@ -12604,25 +12643,21 @@ module Aws::S3
|
|
12604
12643
|
# version_id: "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr",
|
12605
12644
|
# }
|
12606
12645
|
#
|
12607
|
-
# @example Example: To upload object
|
12646
|
+
# @example Example: To upload an object
|
12608
12647
|
#
|
12609
|
-
# # The following example
|
12610
|
-
# #
|
12648
|
+
# # The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file
|
12649
|
+
# # syntax. S3 returns VersionId of the newly created object.
|
12611
12650
|
#
|
12612
12651
|
# resp = client.put_object({
|
12613
|
-
# body: "
|
12652
|
+
# body: "HappyFace.jpg",
|
12614
12653
|
# bucket: "examplebucket",
|
12615
|
-
# key: "
|
12616
|
-
# metadata: {
|
12617
|
-
# "metadata1" => "value1",
|
12618
|
-
# "metadata2" => "value2",
|
12619
|
-
# },
|
12654
|
+
# key: "HappyFace.jpg",
|
12620
12655
|
# })
|
12621
12656
|
#
|
12622
12657
|
# resp.to_h outputs the following:
|
12623
12658
|
# {
|
12624
12659
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
12625
|
-
# version_id: "
|
12660
|
+
# version_id: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk",
|
12626
12661
|
# }
|
12627
12662
|
#
|
12628
12663
|
# @example Streaming a file from disk
|
@@ -12978,9 +13013,11 @@ module Aws::S3
|
|
12978
13013
|
# @option params [String] :request_payer
|
12979
13014
|
# Confirms that the requester knows that they will be charged for the
|
12980
13015
|
# request. Bucket owners need not specify this parameter in their
|
12981
|
-
# requests.
|
12982
|
-
# Pays
|
12983
|
-
#
|
13016
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
13017
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
13018
|
+
# charges to copy the object. For information about downloading objects
|
13019
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
13020
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
12984
13021
|
#
|
12985
13022
|
#
|
12986
13023
|
#
|
@@ -13101,9 +13138,11 @@ module Aws::S3
|
|
13101
13138
|
# @option params [String] :request_payer
|
13102
13139
|
# Confirms that the requester knows that they will be charged for the
|
13103
13140
|
# request. Bucket owners need not specify this parameter in their
|
13104
|
-
# requests.
|
13105
|
-
# Pays
|
13106
|
-
#
|
13141
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
13142
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
13143
|
+
# charges to copy the object. For information about downloading objects
|
13144
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
13145
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
13107
13146
|
#
|
13108
13147
|
#
|
13109
13148
|
#
|
@@ -13204,9 +13243,11 @@ module Aws::S3
|
|
13204
13243
|
# @option params [String] :request_payer
|
13205
13244
|
# Confirms that the requester knows that they will be charged for the
|
13206
13245
|
# request. Bucket owners need not specify this parameter in their
|
13207
|
-
# requests.
|
13208
|
-
# Pays
|
13209
|
-
#
|
13246
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
13247
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
13248
|
+
# charges to copy the object. For information about downloading objects
|
13249
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
13250
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
13210
13251
|
#
|
13211
13252
|
#
|
13212
13253
|
#
|
@@ -13319,9 +13360,11 @@ module Aws::S3
|
|
13319
13360
|
# @option params [String] :request_payer
|
13320
13361
|
# Confirms that the requester knows that they will be charged for the
|
13321
13362
|
# request. Bucket owners need not specify this parameter in their
|
13322
|
-
# requests.
|
13323
|
-
# Pays
|
13324
|
-
#
|
13363
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
13364
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
13365
|
+
# charges to copy the object. For information about downloading objects
|
13366
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
13367
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
13325
13368
|
#
|
13326
13369
|
#
|
13327
13370
|
#
|
@@ -13398,15 +13441,16 @@ module Aws::S3
|
|
13398
13441
|
end
|
13399
13442
|
|
13400
13443
|
# Sets the supplied tag-set to an object that already exists in a
|
13401
|
-
# bucket.
|
13444
|
+
# bucket. A tag is a key-value pair. For more information, see [Object
|
13445
|
+
# Tagging][1].
|
13402
13446
|
#
|
13403
|
-
#
|
13404
|
-
#
|
13405
|
-
#
|
13406
|
-
#
|
13447
|
+
# You can associate tags with an object by sending a PUT request against
|
13448
|
+
# the tagging subresource that is associated with the object. You can
|
13449
|
+
# retrieve tags by sending a GET request. For more information, see
|
13450
|
+
# [GetObjectTagging][2].
|
13407
13451
|
#
|
13408
13452
|
# For tagging-related restrictions related to characters and encodings,
|
13409
|
-
# see [Tag Restrictions][
|
13453
|
+
# see [Tag Restrictions][3]. Note that Amazon S3 limits the maximum
|
13410
13454
|
# number of tags to 10 tags per object.
|
13411
13455
|
#
|
13412
13456
|
# To use this operation, you must have permission to perform the
|
@@ -13416,43 +13460,34 @@ module Aws::S3
|
|
13416
13460
|
# To put tags of any other version, use the `versionId` query parameter.
|
13417
13461
|
# You also need permission for the `s3:PutObjectVersionTagging` action.
|
13418
13462
|
#
|
13419
|
-
#
|
13420
|
-
# [
|
13421
|
-
#
|
13422
|
-
# `PutObjectTagging` has the following special errors:
|
13463
|
+
# `PutObjectTagging` has the following special errors. For more Amazon
|
13464
|
+
# S3 errors see, [Error Responses][4].
|
13423
13465
|
#
|
13424
|
-
# *
|
13466
|
+
# * `InvalidTag` - The tag provided was not a valid tag. This error can
|
13467
|
+
# occur if the tag did not pass input validation. For more
|
13468
|
+
# information, see [Object Tagging][1].
|
13425
13469
|
#
|
13426
|
-
#
|
13427
|
-
# if the tag did not pass input validation. For more information,
|
13428
|
-
# see [Object Tagging][3].*
|
13470
|
+
# * `MalformedXML` - The XML provided does not match the schema.
|
13429
13471
|
#
|
13430
|
-
# *
|
13472
|
+
# * `OperationAborted` - A conflicting conditional action is currently
|
13473
|
+
# in progress against this resource. Please try again.
|
13431
13474
|
#
|
13432
|
-
#
|
13433
|
-
#
|
13434
|
-
# * * <i>Code: OperationAbortedError </i>
|
13435
|
-
#
|
13436
|
-
# * *Cause: A conflicting conditional action is currently in progress
|
13437
|
-
# against this resource. Please try again.*
|
13438
|
-
#
|
13439
|
-
# * * *Code: InternalError*
|
13440
|
-
#
|
13441
|
-
# * *Cause: The service was unable to apply the provided tag to the
|
13442
|
-
# object.*
|
13475
|
+
# * `InternalError` - The service was unable to apply the provided tag
|
13476
|
+
# to the object.
|
13443
13477
|
#
|
13444
13478
|
# The following operations are related to `PutObjectTagging`:
|
13445
13479
|
#
|
13446
|
-
# * [GetObjectTagging][
|
13480
|
+
# * [GetObjectTagging][2]
|
13447
13481
|
#
|
13448
|
-
# * [DeleteObjectTagging][
|
13482
|
+
# * [DeleteObjectTagging][5]
|
13449
13483
|
#
|
13450
13484
|
#
|
13451
13485
|
#
|
13452
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13453
|
-
# [2]: https://docs.aws.amazon.com/
|
13454
|
-
# [3]: https://docs.aws.amazon.com/
|
13455
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
13486
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-tagging.html
|
13487
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html
|
13488
|
+
# [3]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html
|
13489
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html
|
13490
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html
|
13456
13491
|
#
|
13457
13492
|
# @option params [required, String] :bucket
|
13458
13493
|
# The bucket name containing the object.
|
@@ -13519,9 +13554,11 @@ module Aws::S3
|
|
13519
13554
|
# @option params [String] :request_payer
|
13520
13555
|
# Confirms that the requester knows that they will be charged for the
|
13521
13556
|
# request. Bucket owners need not specify this parameter in their
|
13522
|
-
# requests.
|
13523
|
-
# Pays
|
13524
|
-
#
|
13557
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
13558
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
13559
|
+
# charges to copy the object. For information about downloading objects
|
13560
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
13561
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
13525
13562
|
#
|
13526
13563
|
#
|
13527
13564
|
#
|
@@ -13600,7 +13637,7 @@ module Aws::S3
|
|
13600
13637
|
# bucket or an object, it checks the `PublicAccessBlock` configuration
|
13601
13638
|
# for both the bucket (or the bucket that contains the object) and the
|
13602
13639
|
# bucket owner's account. If the `PublicAccessBlock` configurations are
|
13603
|
-
# different between the bucket and the account,
|
13640
|
+
# different between the bucket and the account, S3 uses the most
|
13604
13641
|
# restrictive combination of the bucket-level and account-level
|
13605
13642
|
# settings.
|
13606
13643
|
#
|
@@ -13953,9 +13990,11 @@ module Aws::S3
|
|
13953
13990
|
# @option params [String] :request_payer
|
13954
13991
|
# Confirms that the requester knows that they will be charged for the
|
13955
13992
|
# request. Bucket owners need not specify this parameter in their
|
13956
|
-
# requests.
|
13957
|
-
# Pays
|
13958
|
-
#
|
13993
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
13994
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
13995
|
+
# charges to copy the object. For information about downloading objects
|
13996
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
13997
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
13959
13998
|
#
|
13960
13999
|
#
|
13961
14000
|
#
|
@@ -14779,9 +14818,11 @@ module Aws::S3
|
|
14779
14818
|
# @option params [String] :request_payer
|
14780
14819
|
# Confirms that the requester knows that they will be charged for the
|
14781
14820
|
# request. Bucket owners need not specify this parameter in their
|
14782
|
-
# requests.
|
14783
|
-
# Pays
|
14784
|
-
#
|
14821
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
14822
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
14823
|
+
# charges to copy the object. For information about downloading objects
|
14824
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
14825
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
14785
14826
|
#
|
14786
14827
|
#
|
14787
14828
|
#
|
@@ -15137,9 +15178,11 @@ module Aws::S3
|
|
15137
15178
|
# @option params [String] :request_payer
|
15138
15179
|
# Confirms that the requester knows that they will be charged for the
|
15139
15180
|
# request. Bucket owners need not specify this parameter in their
|
15140
|
-
# requests.
|
15141
|
-
# Pays
|
15142
|
-
#
|
15181
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
15182
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
15183
|
+
# charges to copy the object. For information about downloading objects
|
15184
|
+
# from Requester Pays buckets, see [Downloading Objects in Requester
|
15185
|
+
# Pays Buckets][1] in the *Amazon S3 User Guide*.
|
15143
15186
|
#
|
15144
15187
|
#
|
15145
15188
|
#
|
@@ -15167,45 +15210,45 @@ module Aws::S3
|
|
15167
15210
|
# * {Types::UploadPartCopyOutput#request_charged #request_charged} => String
|
15168
15211
|
#
|
15169
15212
|
#
|
15170
|
-
# @example Example: To upload a part by copying
|
15213
|
+
# @example Example: To upload a part by copying data from an existing object as data source
|
15171
15214
|
#
|
15172
|
-
# # The following example uploads a part of a multipart upload by copying
|
15173
|
-
# # data source.
|
15215
|
+
# # The following example uploads a part of a multipart upload by copying data from an existing object as data source.
|
15174
15216
|
#
|
15175
15217
|
# resp = client.upload_part_copy({
|
15176
15218
|
# bucket: "examplebucket",
|
15177
15219
|
# copy_source: "/bucketname/sourceobjectkey",
|
15178
|
-
# copy_source_range: "bytes=1-100000",
|
15179
15220
|
# key: "examplelargeobject",
|
15180
|
-
# part_number:
|
15221
|
+
# part_number: 1,
|
15181
15222
|
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
15182
15223
|
# })
|
15183
15224
|
#
|
15184
15225
|
# resp.to_h outputs the following:
|
15185
15226
|
# {
|
15186
15227
|
# copy_part_result: {
|
15187
|
-
# etag: "\"
|
15188
|
-
# last_modified: Time.parse("2016-12-29T21:
|
15228
|
+
# etag: "\"b0c6f0e7e054ab8fa2536a2677f8734d\"",
|
15229
|
+
# last_modified: Time.parse("2016-12-29T21:24:43.000Z"),
|
15189
15230
|
# },
|
15190
15231
|
# }
|
15191
15232
|
#
|
15192
|
-
# @example Example: To upload a part by copying
|
15233
|
+
# @example Example: To upload a part by copying byte range from an existing object as data source
|
15193
15234
|
#
|
15194
|
-
# # The following example uploads a part of a multipart upload by copying
|
15235
|
+
# # The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as
|
15236
|
+
# # data source.
|
15195
15237
|
#
|
15196
15238
|
# resp = client.upload_part_copy({
|
15197
15239
|
# bucket: "examplebucket",
|
15198
15240
|
# copy_source: "/bucketname/sourceobjectkey",
|
15241
|
+
# copy_source_range: "bytes=1-100000",
|
15199
15242
|
# key: "examplelargeobject",
|
15200
|
-
# part_number:
|
15243
|
+
# part_number: 2,
|
15201
15244
|
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
15202
15245
|
# })
|
15203
15246
|
#
|
15204
15247
|
# resp.to_h outputs the following:
|
15205
15248
|
# {
|
15206
15249
|
# copy_part_result: {
|
15207
|
-
# etag: "\"
|
15208
|
-
# last_modified: Time.parse("2016-12-29T21:
|
15250
|
+
# etag: "\"65d16d19e65a7508a51f043180edcc36\"",
|
15251
|
+
# last_modified: Time.parse("2016-12-29T21:44:28.000Z"),
|
15209
15252
|
# },
|
15210
15253
|
# }
|
15211
15254
|
#
|
@@ -15547,9 +15590,10 @@ module Aws::S3
|
|
15547
15590
|
# Amazon S3.
|
15548
15591
|
#
|
15549
15592
|
# @option params [String] :ssekms_key_id
|
15550
|
-
# If present, specifies the ID
|
15551
|
-
# Service (Amazon Web Services KMS)
|
15552
|
-
# managed key that was used for stored in
|
15593
|
+
# If present, specifies the ID (Key ID, Key ARN, or Key Alias) of the
|
15594
|
+
# Amazon Web Services Key Management Service (Amazon Web Services KMS)
|
15595
|
+
# symmetric encryption customer managed key that was used for stored in
|
15596
|
+
# Amazon S3 object.
|
15553
15597
|
#
|
15554
15598
|
# @option params [String] :sse_customer_key_md5
|
15555
15599
|
# 128-bit MD5 digest of customer-provided encryption key used in Amazon
|
@@ -15618,7 +15662,7 @@ module Aws::S3
|
|
15618
15662
|
# object_lock_legal_hold_status: "ON", # accepts ON, OFF
|
15619
15663
|
# object_lock_retain_until_date: Time.now,
|
15620
15664
|
# parts_count: 1,
|
15621
|
-
# replication_status: "COMPLETE", # accepts COMPLETE, PENDING, FAILED, REPLICA
|
15665
|
+
# replication_status: "COMPLETE", # accepts COMPLETE, PENDING, FAILED, REPLICA, COMPLETED
|
15622
15666
|
# request_charged: "requester", # accepts requester
|
15623
15667
|
# restore: "Restore",
|
15624
15668
|
# server_side_encryption: "AES256", # accepts AES256, aws:kms, aws:kms:dsse
|
@@ -15653,7 +15697,7 @@ module Aws::S3
|
|
15653
15697
|
params: params,
|
15654
15698
|
config: config)
|
15655
15699
|
context[:gem_name] = 'aws-sdk-s3'
|
15656
|
-
context[:gem_version] = '1.
|
15700
|
+
context[:gem_version] = '1.136.0'
|
15657
15701
|
Seahorse::Client::Request.new(handlers, context)
|
15658
15702
|
end
|
15659
15703
|
|