aws-sdk-s3 1.93.1 → 1.97.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 +40 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-s3.rb +1 -1
- data/lib/aws-sdk-s3/arn/access_point_arn.rb +5 -0
- data/lib/aws-sdk-s3/arn/object_lambda_arn.rb +5 -0
- data/lib/aws-sdk-s3/bucket.rb +12 -11
- data/lib/aws-sdk-s3/bucket_acl.rb +4 -2
- data/lib/aws-sdk-s3/bucket_logging.rb +1 -2
- data/lib/aws-sdk-s3/client.rb +237 -228
- data/lib/aws-sdk-s3/customizations/object.rb +30 -11
- data/lib/aws-sdk-s3/encryption/decrypt_handler.rb +2 -2
- data/lib/aws-sdk-s3/encryptionV2/decrypt_handler.rb +2 -2
- data/lib/aws-sdk-s3/encryptionV2/encrypt_handler.rb +1 -1
- data/lib/aws-sdk-s3/file_downloader.rb +6 -1
- data/lib/aws-sdk-s3/multipart_upload.rb +3 -3
- data/lib/aws-sdk-s3/multipart_upload_part.rb +2 -2
- data/lib/aws-sdk-s3/object.rb +19 -20
- data/lib/aws-sdk-s3/object_acl.rb +5 -3
- data/lib/aws-sdk-s3/object_summary.rb +18 -19
- data/lib/aws-sdk-s3/object_version.rb +4 -4
- data/lib/aws-sdk-s3/plugins/get_bucket_location_fix.rb +1 -1
- data/lib/aws-sdk-s3/presigner.rb +12 -3
- data/lib/aws-sdk-s3/resource.rb +4 -2
- data/lib/aws-sdk-s3/types.rb +140 -143
- metadata +5 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 7992ca22a28ca2a1b417c8fc6f49a519b57f63919fa2aed36d480a07ae957dc5
|
4
|
+
data.tar.gz: d9d4af305bad8afada398e44bfb684137a9c630ba39ef9cebd51839c21e516b5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: cc4a654f87fe337ce42a746697f00ea030a7b87f8ef714a16e034f7358a834d6017237ecea6051a9ee14815e8169e344ce29ca32d934152bb657e4ffff883b63
|
7
|
+
data.tar.gz: 3a00aa2bd35429a82cb4bb6a7dcd70d5493c9163c2de53467b413a64d0ffa3a6d9f416ec769fdad9fc774e144e7ab46ec256016d73e6877ac2b37dbc2f6d0338
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,46 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.97.0 (2021-07-28)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.96.2 (2021-07-20)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Issue - Fix file downloading edge case for 1 byte multipart ranges (#2561).
|
13
|
+
|
14
|
+
1.96.1 (2021-06-10)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Issue - fix GetBucketLocation location_constraint XML parsing (#2536)
|
18
|
+
|
19
|
+
1.96.0 (2021-06-03)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - S3 Inventory now supports Bucket Key Status
|
23
|
+
|
24
|
+
1.95.1 (2021-05-24)
|
25
|
+
------------------
|
26
|
+
|
27
|
+
* Issue - Raise an error when FIPS is in the ARN's region for Access Point and Object Lambda.
|
28
|
+
|
29
|
+
1.95.0 (2021-05-21)
|
30
|
+
------------------
|
31
|
+
|
32
|
+
* Feature - Documentation updates for Amazon S3
|
33
|
+
|
34
|
+
1.94.1 (2021-05-05)
|
35
|
+
------------------
|
36
|
+
|
37
|
+
* Issue - Expose presigned request status to the request handler stack #2513
|
38
|
+
|
39
|
+
1.94.0 (2021-04-27)
|
40
|
+
------------------
|
41
|
+
|
42
|
+
* Feature - Allow S3 Presigner to sign non http verbs like (upload_part, multipart_upload_abort, etc.) #2511
|
43
|
+
|
4
44
|
1.93.1 (2021-04-12)
|
5
45
|
------------------
|
6
46
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.97.0
|
data/lib/aws-sdk-s3.rb
CHANGED
@@ -28,6 +28,11 @@ module Aws
|
|
28
28
|
'and an account id.'
|
29
29
|
end
|
30
30
|
|
31
|
+
if @region.include?('-fips') || @region.include?('fips-')
|
32
|
+
raise ArgumentError,
|
33
|
+
'S3 Access Point ARNs cannot contain a FIPS region'
|
34
|
+
end
|
35
|
+
|
31
36
|
if @type != 'accesspoint'
|
32
37
|
raise ArgumentError, 'Invalid ARN, resource format is not correct'
|
33
38
|
end
|
@@ -28,6 +28,11 @@ module Aws
|
|
28
28
|
'and an account id.'
|
29
29
|
end
|
30
30
|
|
31
|
+
if @region.include?('-fips') || @region.include?('fips-')
|
32
|
+
raise ArgumentError,
|
33
|
+
'S3 Access Point ARNs cannot contain a FIPS region'
|
34
|
+
end
|
35
|
+
|
31
36
|
if @type != 'accesspoint'
|
32
37
|
raise ArgumentError, 'Invalid ARN, resource format is not correct.'
|
33
38
|
end
|
data/lib/aws-sdk-s3/bucket.rb
CHANGED
@@ -245,8 +245,10 @@ module Aws::S3
|
|
245
245
|
# @option options [String] :grant_read_acp
|
246
246
|
# Allows grantee to read the bucket ACL.
|
247
247
|
# @option options [String] :grant_write
|
248
|
-
# Allows grantee to create
|
249
|
-
#
|
248
|
+
# Allows grantee to create new objects in the bucket.
|
249
|
+
#
|
250
|
+
# For the bucket and object owners of existing objects, also allows
|
251
|
+
# deletions and overwrites of those objects.
|
250
252
|
# @option options [String] :grant_write_acp
|
251
253
|
# Allows grantee to write the ACL for the applicable bucket.
|
252
254
|
# @option options [Boolean] :object_lock_enabled_for_bucket
|
@@ -306,7 +308,7 @@ module Aws::S3
|
|
306
308
|
# request. Bucket owners need not specify this parameter in their
|
307
309
|
# requests. For information about downloading objects from requester
|
308
310
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
309
|
-
# in the *Amazon S3
|
311
|
+
# in the *Amazon S3 User Guide*.
|
310
312
|
#
|
311
313
|
#
|
312
314
|
#
|
@@ -468,7 +470,7 @@ module Aws::S3
|
|
468
470
|
# and high availability. Depending on performance needs, you can specify
|
469
471
|
# a different Storage Class. Amazon S3 on Outposts only uses the
|
470
472
|
# OUTPOSTS Storage Class. For more information, see [Storage Classes][1]
|
471
|
-
# in the *Amazon S3
|
473
|
+
# in the *Amazon S3 User Guide*.
|
472
474
|
#
|
473
475
|
#
|
474
476
|
#
|
@@ -515,14 +517,12 @@ module Aws::S3
|
|
515
517
|
# If `x-amz-server-side-encryption` is present and has the value of
|
516
518
|
# `aws:kms`, this header specifies the ID of the AWS Key Management
|
517
519
|
# Service (AWS KMS) symmetrical customer managed customer master key
|
518
|
-
# (CMK) that was used for the object.
|
519
|
-
#
|
520
|
-
# If the value of `x-amz-server-side-encryption` is `aws:kms`, this
|
521
|
-
# header specifies the ID of the symmetric customer managed AWS KMS CMK
|
522
|
-
# that will be used for the object. If you specify
|
520
|
+
# (CMK) that was used for the object. If you specify
|
523
521
|
# `x-amz-server-side-encryption:aws:kms`, but do not provide`
|
524
522
|
# x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the AWS
|
525
|
-
# managed CMK in AWS to protect the data.
|
523
|
+
# managed CMK in AWS to protect the data. If the KMS key does not exist
|
524
|
+
# in the same account issuing the command, you must use the full ARN and
|
525
|
+
# not just the ID.
|
526
526
|
# @option options [String] :ssekms_encryption_context
|
527
527
|
# Specifies the AWS KMS Encryption Context to use for object encryption.
|
528
528
|
# The value of this header is a base64-encoded UTF-8 string holding JSON
|
@@ -540,7 +540,7 @@ module Aws::S3
|
|
540
540
|
# request. Bucket owners need not specify this parameter in their
|
541
541
|
# requests. For information about downloading objects from requester
|
542
542
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
543
|
-
# in the *Amazon S3
|
543
|
+
# in the *Amazon S3 User Guide*.
|
544
544
|
#
|
545
545
|
#
|
546
546
|
#
|
@@ -552,6 +552,7 @@ module Aws::S3
|
|
552
552
|
# The Object Lock mode that you want to apply to this object.
|
553
553
|
# @option options [Time,DateTime,Date,Integer,String] :object_lock_retain_until_date
|
554
554
|
# The date and time when you want this object's Object Lock to expire.
|
555
|
+
# Must be formatted as a timestamp parameter.
|
555
556
|
# @option options [String] :object_lock_legal_hold_status
|
556
557
|
# Specifies whether a legal hold will be applied to this object. For
|
557
558
|
# more information about S3 Object Lock, see [Object Lock][1].
|
@@ -235,8 +235,10 @@ module Aws::S3
|
|
235
235
|
# @option options [String] :grant_read_acp
|
236
236
|
# Allows grantee to read the bucket ACL.
|
237
237
|
# @option options [String] :grant_write
|
238
|
-
# Allows grantee to create
|
239
|
-
#
|
238
|
+
# Allows grantee to create new objects in the bucket.
|
239
|
+
#
|
240
|
+
# For the bucket and object owners of existing objects, also allows
|
241
|
+
# deletions and overwrites of those objects.
|
240
242
|
# @option options [String] :grant_write_acp
|
241
243
|
# Allows grantee to write the ACL for the applicable bucket.
|
242
244
|
# @option options [String] :expected_bucket_owner
|
@@ -36,8 +36,7 @@ module Aws::S3
|
|
36
36
|
|
37
37
|
# Describes where logs are stored and the prefix that Amazon S3 assigns
|
38
38
|
# to all log object keys for a bucket. For more information, see [PUT
|
39
|
-
# Bucket logging][1] in the *Amazon
|
40
|
-
# Reference*.
|
39
|
+
# Bucket logging][1] in the *Amazon S3 API Reference*.
|
41
40
|
#
|
42
41
|
#
|
43
42
|
#
|
data/lib/aws-sdk-s3/client.rb
CHANGED
@@ -454,7 +454,7 @@ module Aws::S3
|
|
454
454
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
455
455
|
# When using this action with an access point through the AWS SDKs, you
|
456
456
|
# provide the access point ARN in place of the bucket name. For more
|
457
|
-
# information about access point ARNs, see [Using
|
457
|
+
# information about access point ARNs, see [Using access points][1] in
|
458
458
|
# the *Amazon S3 User Guide*.
|
459
459
|
#
|
460
460
|
# When using this action with Amazon S3 on Outposts, you must direct
|
@@ -482,7 +482,7 @@ module Aws::S3
|
|
482
482
|
# request. Bucket owners need not specify this parameter in their
|
483
483
|
# requests. For information about downloading objects from requester
|
484
484
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
485
|
-
# in the *Amazon S3
|
485
|
+
# in the *Amazon S3 User Guide*.
|
486
486
|
#
|
487
487
|
#
|
488
488
|
#
|
@@ -640,7 +640,7 @@ module Aws::S3
|
|
640
640
|
# request. Bucket owners need not specify this parameter in their
|
641
641
|
# requests. For information about downloading objects from requester
|
642
642
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
643
|
-
# in the *Amazon S3
|
643
|
+
# in the *Amazon S3 User Guide*.
|
644
644
|
#
|
645
645
|
#
|
646
646
|
#
|
@@ -792,9 +792,9 @@ module Aws::S3
|
|
792
792
|
# permissions, you can use the `s3:x-amz-metadata-directive` condition
|
793
793
|
# key to enforce certain metadata behavior when objects are uploaded.
|
794
794
|
# For more information, see [Specifying Conditions in a Policy][6] in
|
795
|
-
# the *Amazon S3
|
796
|
-
#
|
797
|
-
#
|
795
|
+
# the *Amazon S3 User Guide*. For a complete list of Amazon S3-specific
|
796
|
+
# condition keys, see [Actions, Resources, and Condition Keys for Amazon
|
797
|
+
# S3][7].
|
798
798
|
#
|
799
799
|
# <b> <code>x-amz-copy-source-if</code> Headers</b>
|
800
800
|
#
|
@@ -863,7 +863,7 @@ module Aws::S3
|
|
863
863
|
# You can use the `CopyObject` action to change the storage class of an
|
864
864
|
# object that is already stored in Amazon S3 using the `StorageClass`
|
865
865
|
# parameter. For more information, see [Storage Classes][12] in the
|
866
|
-
# *Amazon S3
|
866
|
+
# *Amazon S3 User Guide*.
|
867
867
|
#
|
868
868
|
# **Versioning**
|
869
869
|
#
|
@@ -925,7 +925,7 @@ module Aws::S3
|
|
925
925
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
926
926
|
# When using this action with an access point through the AWS SDKs, you
|
927
927
|
# provide the access point ARN in place of the bucket name. For more
|
928
|
-
# information about access point ARNs, see [Using
|
928
|
+
# information about access point ARNs, see [Using access points][1] in
|
929
929
|
# the *Amazon S3 User Guide*.
|
930
930
|
#
|
931
931
|
# When using this action with Amazon S3 on Outposts, you must direct
|
@@ -1067,7 +1067,7 @@ module Aws::S3
|
|
1067
1067
|
# and high availability. Depending on performance needs, you can specify
|
1068
1068
|
# a different Storage Class. Amazon S3 on Outposts only uses the
|
1069
1069
|
# OUTPOSTS Storage Class. For more information, see [Storage Classes][1]
|
1070
|
-
# in the *Amazon S3
|
1070
|
+
# in the *Amazon S3 User Guide*.
|
1071
1071
|
#
|
1072
1072
|
#
|
1073
1073
|
#
|
@@ -1099,8 +1099,8 @@ module Aws::S3
|
|
1099
1099
|
# PUT requests for an object protected by AWS KMS will fail if not made
|
1100
1100
|
# via SSL or using SigV4. For information about configuring using any of
|
1101
1101
|
# the officially supported AWS SDKs and AWS CLI, see [Specifying the
|
1102
|
-
# Signature Version in Request Authentication][1] in the *Amazon S3
|
1103
|
-
#
|
1102
|
+
# Signature Version in Request Authentication][1] in the *Amazon S3 User
|
1103
|
+
# Guide*.
|
1104
1104
|
#
|
1105
1105
|
#
|
1106
1106
|
#
|
@@ -1139,7 +1139,7 @@ module Aws::S3
|
|
1139
1139
|
# request. Bucket owners need not specify this parameter in their
|
1140
1140
|
# requests. For information about downloading objects from requester
|
1141
1141
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
1142
|
-
# in the *Amazon S3
|
1142
|
+
# in the *Amazon S3 User Guide*.
|
1143
1143
|
#
|
1144
1144
|
#
|
1145
1145
|
#
|
@@ -1280,7 +1280,7 @@ module Aws::S3
|
|
1280
1280
|
# the bucket, you become the bucket owner.
|
1281
1281
|
#
|
1282
1282
|
# Not every string is an acceptable bucket name. For information about
|
1283
|
-
# bucket naming restrictions, see [
|
1283
|
+
# bucket naming restrictions, see [Bucket naming rules][1].
|
1284
1284
|
#
|
1285
1285
|
# If you want to create an Amazon S3 on Outposts bucket, see [Create
|
1286
1286
|
# Bucket][2].
|
@@ -1374,7 +1374,7 @@ module Aws::S3
|
|
1374
1374
|
#
|
1375
1375
|
#
|
1376
1376
|
#
|
1377
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1377
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html
|
1378
1378
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html
|
1379
1379
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro
|
1380
1380
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html
|
@@ -1404,8 +1404,10 @@ module Aws::S3
|
|
1404
1404
|
# Allows grantee to read the bucket ACL.
|
1405
1405
|
#
|
1406
1406
|
# @option params [String] :grant_write
|
1407
|
-
# Allows grantee to create
|
1408
|
-
#
|
1407
|
+
# Allows grantee to create new objects in the bucket.
|
1408
|
+
#
|
1409
|
+
# For the bucket and object owners of existing objects, also allows
|
1410
|
+
# deletions and overwrites of those objects.
|
1409
1411
|
#
|
1410
1412
|
# @option params [String] :grant_write_acp
|
1411
1413
|
# Allows grantee to write the ACL for the applicable bucket.
|
@@ -1523,11 +1525,12 @@ module Aws::S3
|
|
1523
1525
|
# `CreateMultipartUpload`.
|
1524
1526
|
#
|
1525
1527
|
# To perform a multipart upload with encryption using an AWS KMS CMK,
|
1526
|
-
# the requester must have permission to the `kms:
|
1527
|
-
# `kms:
|
1528
|
-
#
|
1529
|
-
#
|
1530
|
-
#
|
1528
|
+
# the requester must have permission to the `kms:Decrypt` and
|
1529
|
+
# `kms:GenerateDataKey*` actions on the key. These permissions are
|
1530
|
+
# required because Amazon S3 must decrypt and read data from the
|
1531
|
+
# encrypted file parts before it completes the multipart upload. For
|
1532
|
+
# more information, see [Multipart upload API and permissions][7] in the
|
1533
|
+
# *Amazon S3 User Guide*.
|
1531
1534
|
#
|
1532
1535
|
# If your AWS Identity and Access Management (IAM) user or role is in
|
1533
1536
|
# the same AWS account as the AWS KMS CMK, then you must have these
|
@@ -1536,7 +1539,7 @@ module Aws::S3
|
|
1536
1539
|
# both the key policy and your IAM user or role.
|
1537
1540
|
#
|
1538
1541
|
# For more information, see [Protecting Data Using Server-Side
|
1539
|
-
# Encryption][
|
1542
|
+
# Encryption][8].
|
1540
1543
|
#
|
1541
1544
|
# Access Permissions
|
1542
1545
|
#
|
@@ -1546,13 +1549,13 @@ module Aws::S3
|
|
1546
1549
|
# request headers:
|
1547
1550
|
#
|
1548
1551
|
# * Specify a canned ACL with the `x-amz-acl` request header. For more
|
1549
|
-
# information, see [Canned ACL][
|
1552
|
+
# information, see [Canned ACL][9].
|
1550
1553
|
#
|
1551
1554
|
# * Specify access permissions explicitly with the `x-amz-grant-read`,
|
1552
1555
|
# `x-amz-grant-read-acp`, `x-amz-grant-write-acp`, and
|
1553
1556
|
# `x-amz-grant-full-control` headers. These parameters map to the
|
1554
1557
|
# set of permissions that Amazon S3 supports in an ACL. For more
|
1555
|
-
# information, see [Access Control List (ACL) Overview][
|
1558
|
+
# information, see [Access Control List (ACL) Overview][10].
|
1556
1559
|
#
|
1557
1560
|
# You can use either a canned ACL or specify access permissions
|
1558
1561
|
# explicitly. You cannot do both.
|
@@ -1588,7 +1591,7 @@ module Aws::S3
|
|
1588
1591
|
#
|
1589
1592
|
# For more information about server-side encryption with CMKs stored
|
1590
1593
|
# in AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
|
1591
|
-
# Encryption with CMKs stored in AWS KMS][
|
1594
|
+
# Encryption with CMKs stored in AWS KMS][11].
|
1592
1595
|
#
|
1593
1596
|
# * Use customer-provided encryption keys – If you want to manage your
|
1594
1597
|
# own encryption keys, provide all the following headers in the
|
@@ -1602,7 +1605,7 @@ module Aws::S3
|
|
1602
1605
|
#
|
1603
1606
|
# For more information about server-side encryption with CMKs stored
|
1604
1607
|
# in AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
|
1605
|
-
# Encryption with CMKs stored in AWS KMS][
|
1608
|
+
# Encryption with CMKs stored in AWS KMS][11].
|
1606
1609
|
#
|
1607
1610
|
# Access-Control-List (ACL)-Specific Request Headers
|
1608
1611
|
#
|
@@ -1612,19 +1615,19 @@ module Aws::S3
|
|
1612
1615
|
# permissions to individual AWS accounts or to predefined groups
|
1613
1616
|
# defined by Amazon S3. These permissions are then added to the access
|
1614
1617
|
# control list (ACL) on the object. For more information, see [Using
|
1615
|
-
# ACLs][
|
1618
|
+
# ACLs][12]. With this operation, you can grant access permissions
|
1616
1619
|
# using one of the following two methods:
|
1617
1620
|
#
|
1618
1621
|
# * Specify a canned ACL (`x-amz-acl`) — Amazon S3 supports a set of
|
1619
1622
|
# predefined ACLs, known as *canned ACLs*. Each canned ACL has a
|
1620
1623
|
# predefined set of grantees and permissions. For more information,
|
1621
|
-
# see [Canned ACL][
|
1624
|
+
# see [Canned ACL][9].
|
1622
1625
|
#
|
1623
1626
|
# * Specify access permissions explicitly — To explicitly grant access
|
1624
1627
|
# permissions to specific AWS accounts or groups, use the following
|
1625
1628
|
# headers. Each header maps to specific permissions that Amazon S3
|
1626
1629
|
# supports in an ACL. For more information, see [Access Control List
|
1627
|
-
# (ACL) Overview][
|
1630
|
+
# (ACL) Overview][10]. In the header, you specify a list of grantees
|
1628
1631
|
# who get the specific permission. To grant permissions explicitly,
|
1629
1632
|
# use:
|
1630
1633
|
#
|
@@ -1669,7 +1672,7 @@ module Aws::S3
|
|
1669
1672
|
# * South America (São Paulo)
|
1670
1673
|
#
|
1671
1674
|
# For a list of all the Amazon S3 supported Regions and endpoints,
|
1672
|
-
# see [Regions and Endpoints][
|
1675
|
+
# see [Regions and Endpoints][13] in the AWS General Reference.
|
1673
1676
|
#
|
1674
1677
|
# </note>
|
1675
1678
|
#
|
@@ -1683,13 +1686,13 @@ module Aws::S3
|
|
1683
1686
|
#
|
1684
1687
|
# * [UploadPart][1]
|
1685
1688
|
#
|
1686
|
-
# * [CompleteMultipartUpload][
|
1689
|
+
# * [CompleteMultipartUpload][14]
|
1687
1690
|
#
|
1688
|
-
# * [AbortMultipartUpload][
|
1691
|
+
# * [AbortMultipartUpload][15]
|
1689
1692
|
#
|
1690
|
-
# * [ListParts][
|
1693
|
+
# * [ListParts][16]
|
1691
1694
|
#
|
1692
|
-
# * [ListMultipartUploads][
|
1695
|
+
# * [ListMultipartUploads][17]
|
1693
1696
|
#
|
1694
1697
|
#
|
1695
1698
|
#
|
@@ -1699,16 +1702,17 @@ module Aws::S3
|
|
1699
1702
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
|
1700
1703
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
|
1701
1704
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html
|
1702
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1703
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
1704
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
1705
|
-
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
1706
|
-
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
1707
|
-
# [12]: https://docs.aws.amazon.com/
|
1708
|
-
# [13]: https://docs.aws.amazon.com/
|
1709
|
-
# [14]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
1710
|
-
# [15]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
1711
|
-
# [16]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
1705
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions
|
1706
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html
|
1707
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
|
1708
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
1709
|
+
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html
|
1710
|
+
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
|
1711
|
+
# [13]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
|
1712
|
+
# [14]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html
|
1713
|
+
# [15]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
|
1714
|
+
# [16]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
|
1715
|
+
# [17]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
|
1712
1716
|
#
|
1713
1717
|
# @option params [String] :acl
|
1714
1718
|
# The canned ACL to apply to the object.
|
@@ -1723,7 +1727,7 @@ module Aws::S3
|
|
1723
1727
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
1724
1728
|
# When using this action with an access point through the AWS SDKs, you
|
1725
1729
|
# provide the access point ARN in place of the bucket name. For more
|
1726
|
-
# information about access point ARNs, see [Using
|
1730
|
+
# information about access point ARNs, see [Using access points][1] in
|
1727
1731
|
# the *Amazon S3 User Guide*.
|
1728
1732
|
#
|
1729
1733
|
# When using this action with Amazon S3 on Outposts, you must direct
|
@@ -1797,7 +1801,7 @@ module Aws::S3
|
|
1797
1801
|
# and high availability. Depending on performance needs, you can specify
|
1798
1802
|
# a different Storage Class. Amazon S3 on Outposts only uses the
|
1799
1803
|
# OUTPOSTS Storage Class. For more information, see [Storage Classes][1]
|
1800
|
-
# in the *Amazon S3
|
1804
|
+
# in the *Amazon S3 User Guide*.
|
1801
1805
|
#
|
1802
1806
|
#
|
1803
1807
|
#
|
@@ -1830,7 +1834,7 @@ module Aws::S3
|
|
1830
1834
|
# protected by AWS KMS will fail if not made via SSL or using SigV4. For
|
1831
1835
|
# information about configuring using any of the officially supported
|
1832
1836
|
# AWS SDKs and AWS CLI, see [Specifying the Signature Version in Request
|
1833
|
-
# Authentication][1] in the *Amazon S3
|
1837
|
+
# Authentication][1] in the *Amazon S3 User Guide*.
|
1834
1838
|
#
|
1835
1839
|
#
|
1836
1840
|
#
|
@@ -1855,7 +1859,7 @@ module Aws::S3
|
|
1855
1859
|
# request. Bucket owners need not specify this parameter in their
|
1856
1860
|
# requests. For information about downloading objects from requester
|
1857
1861
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
1858
|
-
# in the *Amazon S3
|
1862
|
+
# in the *Amazon S3 User Guide*.
|
1859
1863
|
#
|
1860
1864
|
#
|
1861
1865
|
#
|
@@ -2573,7 +2577,7 @@ module Aws::S3
|
|
2573
2577
|
# </note>
|
2574
2578
|
#
|
2575
2579
|
# For information about replication configuration, see [Replication][3]
|
2576
|
-
# in the *Amazon S3
|
2580
|
+
# in the *Amazon S3 User Guide*.
|
2577
2581
|
#
|
2578
2582
|
# The following operations are related to `DeleteBucketReplication`\:
|
2579
2583
|
#
|
@@ -2787,7 +2791,7 @@ module Aws::S3
|
|
2787
2791
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
2788
2792
|
# When using this action with an access point through the AWS SDKs, you
|
2789
2793
|
# provide the access point ARN in place of the bucket name. For more
|
2790
|
-
# information about access point ARNs, see [Using
|
2794
|
+
# information about access point ARNs, see [Using access points][1] in
|
2791
2795
|
# the *Amazon S3 User Guide*.
|
2792
2796
|
#
|
2793
2797
|
# When using this action with Amazon S3 on Outposts, you must direct
|
@@ -2821,7 +2825,7 @@ module Aws::S3
|
|
2821
2825
|
# request. Bucket owners need not specify this parameter in their
|
2822
2826
|
# requests. For information about downloading objects from requester
|
2823
2827
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
2824
|
-
# in the *Amazon S3
|
2828
|
+
# in the *Amazon S3 User Guide*.
|
2825
2829
|
#
|
2826
2830
|
#
|
2827
2831
|
#
|
@@ -2923,7 +2927,7 @@ module Aws::S3
|
|
2923
2927
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
2924
2928
|
# When using this action with an access point through the AWS SDKs, you
|
2925
2929
|
# provide the access point ARN in place of the bucket name. For more
|
2926
|
-
# information about access point ARNs, see [Using
|
2930
|
+
# information about access point ARNs, see [Using access points][1] in
|
2927
2931
|
# the *Amazon S3 User Guide*.
|
2928
2932
|
#
|
2929
2933
|
# When using this action with Amazon S3 on Outposts, you must direct
|
@@ -3071,7 +3075,7 @@ module Aws::S3
|
|
3071
3075
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
3072
3076
|
# When using this action with an access point through the AWS SDKs, you
|
3073
3077
|
# provide the access point ARN in place of the bucket name. For more
|
3074
|
-
# information about access point ARNs, see [Using
|
3078
|
+
# information about access point ARNs, see [Using access points][1] in
|
3075
3079
|
# the *Amazon S3 User Guide*.
|
3076
3080
|
#
|
3077
3081
|
# When using this action with Amazon S3 on Outposts, you must direct
|
@@ -3102,7 +3106,7 @@ module Aws::S3
|
|
3102
3106
|
# request. Bucket owners need not specify this parameter in their
|
3103
3107
|
# requests. For information about downloading objects from requester
|
3104
3108
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
3105
|
-
# in the *Amazon S3
|
3109
|
+
# in the *Amazon S3 User Guide*.
|
3106
3110
|
#
|
3107
3111
|
#
|
3108
3112
|
#
|
@@ -3125,22 +3129,20 @@ module Aws::S3
|
|
3125
3129
|
# * {Types::DeleteObjectsOutput#errors #errors} => Array<Types::Error>
|
3126
3130
|
#
|
3127
3131
|
#
|
3128
|
-
# @example Example: To delete multiple
|
3132
|
+
# @example Example: To delete multiple objects from a versioned bucket
|
3129
3133
|
#
|
3130
|
-
# # The following example deletes objects from a bucket. The
|
3131
|
-
# #
|
3134
|
+
# # The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the
|
3135
|
+
# # object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.
|
3132
3136
|
#
|
3133
3137
|
# resp = client.delete_objects({
|
3134
3138
|
# bucket: "examplebucket",
|
3135
3139
|
# delete: {
|
3136
3140
|
# objects: [
|
3137
3141
|
# {
|
3138
|
-
# key: "
|
3139
|
-
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
3142
|
+
# key: "objectkey1",
|
3140
3143
|
# },
|
3141
3144
|
# {
|
3142
|
-
# key: "
|
3143
|
-
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
3145
|
+
# key: "objectkey2",
|
3144
3146
|
# },
|
3145
3147
|
# ],
|
3146
3148
|
# quiet: false,
|
@@ -3151,30 +3153,34 @@ module Aws::S3
|
|
3151
3153
|
# {
|
3152
3154
|
# deleted: [
|
3153
3155
|
# {
|
3154
|
-
#
|
3155
|
-
#
|
3156
|
+
# delete_marker: true,
|
3157
|
+
# delete_marker_version_id: "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
|
3158
|
+
# key: "objectkey1",
|
3156
3159
|
# },
|
3157
3160
|
# {
|
3158
|
-
#
|
3159
|
-
#
|
3161
|
+
# delete_marker: true,
|
3162
|
+
# delete_marker_version_id: "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
|
3163
|
+
# key: "objectkey2",
|
3160
3164
|
# },
|
3161
3165
|
# ],
|
3162
3166
|
# }
|
3163
3167
|
#
|
3164
|
-
# @example Example: To delete multiple
|
3168
|
+
# @example Example: To delete multiple object versions from a versioned bucket
|
3165
3169
|
#
|
3166
|
-
# # The following example deletes objects from a bucket. The
|
3167
|
-
# #
|
3170
|
+
# # The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object
|
3171
|
+
# # versions and returns the key and versions of deleted objects in the response.
|
3168
3172
|
#
|
3169
3173
|
# resp = client.delete_objects({
|
3170
3174
|
# bucket: "examplebucket",
|
3171
3175
|
# delete: {
|
3172
3176
|
# objects: [
|
3173
3177
|
# {
|
3174
|
-
# key: "
|
3178
|
+
# key: "HappyFace.jpg",
|
3179
|
+
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
3175
3180
|
# },
|
3176
3181
|
# {
|
3177
|
-
# key: "
|
3182
|
+
# key: "HappyFace.jpg",
|
3183
|
+
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
3178
3184
|
# },
|
3179
3185
|
# ],
|
3180
3186
|
# quiet: false,
|
@@ -3185,14 +3191,12 @@ module Aws::S3
|
|
3185
3191
|
# {
|
3186
3192
|
# deleted: [
|
3187
3193
|
# {
|
3188
|
-
#
|
3189
|
-
#
|
3190
|
-
# key: "objectkey1",
|
3194
|
+
# key: "HappyFace.jpg",
|
3195
|
+
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
3191
3196
|
# },
|
3192
3197
|
# {
|
3193
|
-
#
|
3194
|
-
#
|
3195
|
-
# key: "objectkey2",
|
3198
|
+
# key: "HappyFace.jpg",
|
3199
|
+
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
3196
3200
|
# },
|
3197
3201
|
# ],
|
3198
3202
|
# }
|
@@ -3803,7 +3807,7 @@ module Aws::S3
|
|
3803
3807
|
# resp.inventory_configuration.id #=> String
|
3804
3808
|
# resp.inventory_configuration.included_object_versions #=> String, one of "All", "Current"
|
3805
3809
|
# resp.inventory_configuration.optional_fields #=> Array
|
3806
|
-
# resp.inventory_configuration.optional_fields[0] #=> String, one of "Size", "LastModifiedDate", "StorageClass", "ETag", "IsMultipartUploaded", "ReplicationStatus", "EncryptionStatus", "ObjectLockRetainUntilDate", "ObjectLockMode", "ObjectLockLegalHoldStatus", "IntelligentTieringAccessTier"
|
3810
|
+
# resp.inventory_configuration.optional_fields[0] #=> String, one of "Size", "LastModifiedDate", "StorageClass", "ETag", "IsMultipartUploaded", "ReplicationStatus", "EncryptionStatus", "ObjectLockRetainUntilDate", "ObjectLockMode", "ObjectLockLegalHoldStatus", "IntelligentTieringAccessTier", "BucketKeyStatus"
|
3807
3811
|
# resp.inventory_configuration.schedule.frequency #=> String, one of "Daily", "Weekly"
|
3808
3812
|
#
|
3809
3813
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketInventoryConfiguration AWS API Documentation
|
@@ -5231,7 +5235,7 @@ module Aws::S3
|
|
5231
5235
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5232
5236
|
# When using this action with an access point through the AWS SDKs, you
|
5233
5237
|
# provide the access point ARN in place of the bucket name. For more
|
5234
|
-
# information about access point ARNs, see [Using
|
5238
|
+
# information about access point ARNs, see [Using access points][1] in
|
5235
5239
|
# the *Amazon S3 User Guide*.
|
5236
5240
|
#
|
5237
5241
|
# When using this action with Amazon S3 on Outposts, you must direct
|
@@ -5323,7 +5327,7 @@ module Aws::S3
|
|
5323
5327
|
# request. Bucket owners need not specify this parameter in their
|
5324
5328
|
# requests. For information about downloading objects from requester
|
5325
5329
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
5326
|
-
# in the *Amazon S3
|
5330
|
+
# in the *Amazon S3 User Guide*.
|
5327
5331
|
#
|
5328
5332
|
#
|
5329
5333
|
#
|
@@ -5377,49 +5381,49 @@ module Aws::S3
|
|
5377
5381
|
# * {Types::GetObjectOutput#object_lock_legal_hold_status #object_lock_legal_hold_status} => String
|
5378
5382
|
#
|
5379
5383
|
#
|
5380
|
-
# @example Example: To retrieve an object
|
5384
|
+
# @example Example: To retrieve a byte range of an object
|
5381
5385
|
#
|
5382
|
-
# # The following example retrieves an object for an S3 bucket.
|
5386
|
+
# # The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a
|
5387
|
+
# # specific byte range.
|
5383
5388
|
#
|
5384
5389
|
# resp = client.get_object({
|
5385
5390
|
# bucket: "examplebucket",
|
5386
|
-
# key: "
|
5391
|
+
# key: "SampleFile.txt",
|
5392
|
+
# range: "bytes=0-9",
|
5387
5393
|
# })
|
5388
5394
|
#
|
5389
5395
|
# resp.to_h outputs the following:
|
5390
5396
|
# {
|
5391
5397
|
# accept_ranges: "bytes",
|
5392
|
-
# content_length:
|
5393
|
-
#
|
5394
|
-
#
|
5395
|
-
#
|
5398
|
+
# content_length: 10,
|
5399
|
+
# content_range: "bytes 0-9/43",
|
5400
|
+
# content_type: "text/plain",
|
5401
|
+
# etag: "\"0d94420ffd0bc68cd3d152506b97a9cc\"",
|
5402
|
+
# last_modified: Time.parse("Thu, 09 Oct 2014 22:57:28 GMT"),
|
5396
5403
|
# metadata: {
|
5397
5404
|
# },
|
5398
|
-
# tag_count: 2,
|
5399
5405
|
# version_id: "null",
|
5400
5406
|
# }
|
5401
5407
|
#
|
5402
|
-
# @example Example: To retrieve
|
5408
|
+
# @example Example: To retrieve an object
|
5403
5409
|
#
|
5404
|
-
# # The following example retrieves an object for an S3 bucket.
|
5405
|
-
# # specific byte range.
|
5410
|
+
# # The following example retrieves an object for an S3 bucket.
|
5406
5411
|
#
|
5407
5412
|
# resp = client.get_object({
|
5408
5413
|
# bucket: "examplebucket",
|
5409
|
-
# key: "
|
5410
|
-
# range: "bytes=0-9",
|
5414
|
+
# key: "HappyFace.jpg",
|
5411
5415
|
# })
|
5412
5416
|
#
|
5413
5417
|
# resp.to_h outputs the following:
|
5414
5418
|
# {
|
5415
5419
|
# accept_ranges: "bytes",
|
5416
|
-
# content_length:
|
5417
|
-
#
|
5418
|
-
#
|
5419
|
-
#
|
5420
|
-
# last_modified: Time.parse("Thu, 09 Oct 2014 22:57:28 GMT"),
|
5420
|
+
# content_length: 3191,
|
5421
|
+
# content_type: "image/jpeg",
|
5422
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
5423
|
+
# last_modified: Time.parse("Thu, 15 Dec 2016 01:19:41 GMT"),
|
5421
5424
|
# metadata: {
|
5422
5425
|
# },
|
5426
|
+
# tag_count: 2,
|
5423
5427
|
# version_id: "null",
|
5424
5428
|
# }
|
5425
5429
|
#
|
@@ -5557,7 +5561,7 @@ module Aws::S3
|
|
5557
5561
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5558
5562
|
# When using this action with an access point through the AWS SDKs, you
|
5559
5563
|
# provide the access point ARN in place of the bucket name. For more
|
5560
|
-
# information about access point ARNs, see [Using
|
5564
|
+
# information about access point ARNs, see [Using access points][1] in
|
5561
5565
|
# the *Amazon S3 User Guide*.
|
5562
5566
|
#
|
5563
5567
|
#
|
@@ -5575,7 +5579,7 @@ module Aws::S3
|
|
5575
5579
|
# request. Bucket owners need not specify this parameter in their
|
5576
5580
|
# requests. For information about downloading objects from requester
|
5577
5581
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
5578
|
-
# in the *Amazon S3
|
5582
|
+
# in the *Amazon S3 User Guide*.
|
5579
5583
|
#
|
5580
5584
|
#
|
5581
5585
|
#
|
@@ -5694,7 +5698,7 @@ module Aws::S3
|
|
5694
5698
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5695
5699
|
# When using this action with an access point through the AWS SDKs, you
|
5696
5700
|
# provide the access point ARN in place of the bucket name. For more
|
5697
|
-
# information about access point ARNs, see [Using
|
5701
|
+
# information about access point ARNs, see [Using access points][1] in
|
5698
5702
|
# the *Amazon S3 User Guide*.
|
5699
5703
|
#
|
5700
5704
|
#
|
@@ -5714,7 +5718,7 @@ module Aws::S3
|
|
5714
5718
|
# request. Bucket owners need not specify this parameter in their
|
5715
5719
|
# requests. For information about downloading objects from requester
|
5716
5720
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
5717
|
-
# in the *Amazon S3
|
5721
|
+
# in the *Amazon S3 User Guide*.
|
5718
5722
|
#
|
5719
5723
|
#
|
5720
5724
|
#
|
@@ -5769,7 +5773,7 @@ module Aws::S3
|
|
5769
5773
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5770
5774
|
# When using this action with an access point through the AWS SDKs, you
|
5771
5775
|
# provide the access point ARN in place of the bucket name. For more
|
5772
|
-
# information about access point ARNs, see [Using
|
5776
|
+
# information about access point ARNs, see [Using access points][1] in
|
5773
5777
|
# the *Amazon S3 User Guide*.
|
5774
5778
|
#
|
5775
5779
|
#
|
@@ -5826,7 +5830,7 @@ module Aws::S3
|
|
5826
5830
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5827
5831
|
# When using this action with an access point through the AWS SDKs, you
|
5828
5832
|
# provide the access point ARN in place of the bucket name. For more
|
5829
|
-
# information about access point ARNs, see [Using
|
5833
|
+
# information about access point ARNs, see [Using access points][1] in
|
5830
5834
|
# the *Amazon S3 User Guide*.
|
5831
5835
|
#
|
5832
5836
|
#
|
@@ -5846,7 +5850,7 @@ module Aws::S3
|
|
5846
5850
|
# request. Bucket owners need not specify this parameter in their
|
5847
5851
|
# requests. For information about downloading objects from requester
|
5848
5852
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
5849
|
-
# in the *Amazon S3
|
5853
|
+
# in the *Amazon S3 User Guide*.
|
5850
5854
|
#
|
5851
5855
|
#
|
5852
5856
|
#
|
@@ -5922,7 +5926,7 @@ module Aws::S3
|
|
5922
5926
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5923
5927
|
# When using this action with an access point through the AWS SDKs, you
|
5924
5928
|
# provide the access point ARN in place of the bucket name. For more
|
5925
|
-
# information about access point ARNs, see [Using
|
5929
|
+
# information about access point ARNs, see [Using access points][1] in
|
5926
5930
|
# the *Amazon S3 User Guide*.
|
5927
5931
|
#
|
5928
5932
|
# When using this action with Amazon S3 on Outposts, you must direct
|
@@ -5955,7 +5959,7 @@ module Aws::S3
|
|
5955
5959
|
# request. Bucket owners need not specify this parameter in their
|
5956
5960
|
# requests. For information about downloading objects from requester
|
5957
5961
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
5958
|
-
# in the *Amazon S3
|
5962
|
+
# in the *Amazon S3 User Guide*.
|
5959
5963
|
#
|
5960
5964
|
#
|
5961
5965
|
#
|
@@ -6078,7 +6082,7 @@ module Aws::S3
|
|
6078
6082
|
# request. Bucket owners need not specify this parameter in their
|
6079
6083
|
# requests. For information about downloading objects from requester
|
6080
6084
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
6081
|
-
# in the *Amazon S3
|
6085
|
+
# in the *Amazon S3 User Guide*.
|
6082
6086
|
#
|
6083
6087
|
#
|
6084
6088
|
#
|
@@ -6231,7 +6235,7 @@ module Aws::S3
|
|
6231
6235
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
6232
6236
|
# When using this action with an access point through the AWS SDKs, you
|
6233
6237
|
# provide the access point ARN in place of the bucket name. For more
|
6234
|
-
# information about access point ARNs, see [Using
|
6238
|
+
# information about access point ARNs, see [Using access points][1] in
|
6235
6239
|
# the *Amazon S3 User Guide*.
|
6236
6240
|
#
|
6237
6241
|
# When using this action with Amazon S3 on Outposts, you must direct
|
@@ -6384,7 +6388,7 @@ module Aws::S3
|
|
6384
6388
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
6385
6389
|
# When using this action with an access point through the AWS SDKs, you
|
6386
6390
|
# provide the access point ARN in place of the bucket name. For more
|
6387
|
-
# information about access point ARNs, see [Using
|
6391
|
+
# information about access point ARNs, see [Using access points][1] in
|
6388
6392
|
# the *Amazon S3 User Guide*.
|
6389
6393
|
#
|
6390
6394
|
# When using this action with Amazon S3 on Outposts, you must direct
|
@@ -6458,7 +6462,7 @@ module Aws::S3
|
|
6458
6462
|
# request. Bucket owners need not specify this parameter in their
|
6459
6463
|
# requests. For information about downloading objects from requester
|
6460
6464
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
6461
|
-
# in the *Amazon S3
|
6465
|
+
# in the *Amazon S3 User Guide*.
|
6462
6466
|
#
|
6463
6467
|
#
|
6464
6468
|
#
|
@@ -6868,7 +6872,7 @@ module Aws::S3
|
|
6868
6872
|
# resp.inventory_configuration_list[0].id #=> String
|
6869
6873
|
# resp.inventory_configuration_list[0].included_object_versions #=> String, one of "All", "Current"
|
6870
6874
|
# resp.inventory_configuration_list[0].optional_fields #=> Array
|
6871
|
-
# resp.inventory_configuration_list[0].optional_fields[0] #=> String, one of "Size", "LastModifiedDate", "StorageClass", "ETag", "IsMultipartUploaded", "ReplicationStatus", "EncryptionStatus", "ObjectLockRetainUntilDate", "ObjectLockMode", "ObjectLockLegalHoldStatus", "IntelligentTieringAccessTier"
|
6875
|
+
# resp.inventory_configuration_list[0].optional_fields[0] #=> String, one of "Size", "LastModifiedDate", "StorageClass", "ETag", "IsMultipartUploaded", "ReplicationStatus", "EncryptionStatus", "ObjectLockRetainUntilDate", "ObjectLockMode", "ObjectLockLegalHoldStatus", "IntelligentTieringAccessTier", "BucketKeyStatus"
|
6872
6876
|
# resp.inventory_configuration_list[0].schedule.frequency #=> String, one of "Daily", "Weekly"
|
6873
6877
|
# resp.is_truncated #=> Boolean
|
6874
6878
|
# resp.next_continuation_token #=> String
|
@@ -7091,7 +7095,7 @@ module Aws::S3
|
|
7091
7095
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
7092
7096
|
# When using this action with an access point through the AWS SDKs, you
|
7093
7097
|
# provide the access point ARN in place of the bucket name. For more
|
7094
|
-
# information about access point ARNs, see [Using
|
7098
|
+
# information about access point ARNs, see [Using access points][1] in
|
7095
7099
|
# the *Amazon S3 User Guide*.
|
7096
7100
|
#
|
7097
7101
|
# When using this action with Amazon S3 on Outposts, you must direct
|
@@ -7556,7 +7560,7 @@ module Aws::S3
|
|
7556
7560
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
7557
7561
|
# When using this action with an access point through the AWS SDKs, you
|
7558
7562
|
# provide the access point ARN in place of the bucket name. For more
|
7559
|
-
# information about access point ARNs, see [Using
|
7563
|
+
# information about access point ARNs, see [Using access points][1] in
|
7560
7564
|
# the *Amazon S3 User Guide*.
|
7561
7565
|
#
|
7562
7566
|
# When using this action with Amazon S3 on Outposts, you must direct
|
@@ -7702,13 +7706,14 @@ module Aws::S3
|
|
7702
7706
|
req.send_request(options)
|
7703
7707
|
end
|
7704
7708
|
|
7705
|
-
# Returns some or all (up to 1,000) of the objects in a bucket
|
7706
|
-
# use the request parameters as selection criteria to
|
7707
|
-
# the objects in a bucket. A `200 OK` response can
|
7708
|
-
# invalid XML. Make sure to design your application to
|
7709
|
-
# contents of the response and handle it appropriately.
|
7710
|
-
# returned sorted in an ascending order of the respective
|
7711
|
-
# the list.
|
7709
|
+
# Returns some or all (up to 1,000) of the objects in a bucket with each
|
7710
|
+
# request. You can use the request parameters as selection criteria to
|
7711
|
+
# return a subset of the objects in a bucket. A `200 OK` response can
|
7712
|
+
# contain valid or invalid XML. Make sure to design your application to
|
7713
|
+
# parse the contents of the response and handle it appropriately.
|
7714
|
+
# Objects are returned sorted in an ascending order of the respective
|
7715
|
+
# key names in the list. For more information about listing objects, see
|
7716
|
+
# [Listing object keys programmatically][1]
|
7712
7717
|
#
|
7713
7718
|
# To use this operation, you must have READ access to the bucket.
|
7714
7719
|
#
|
@@ -7716,33 +7721,34 @@ module Aws::S3
|
|
7716
7721
|
# policy, you must have permissions to perform the `s3:ListBucket`
|
7717
7722
|
# action. The bucket owner has this permission by default and can grant
|
7718
7723
|
# this permission to others. For more information about permissions, see
|
7719
|
-
# [Permissions Related to Bucket Subresource Operations][
|
7720
|
-
# [Managing Access Permissions to Your Amazon S3 Resources][
|
7724
|
+
# [Permissions Related to Bucket Subresource Operations][2] and
|
7725
|
+
# [Managing Access Permissions to Your Amazon S3 Resources][3].
|
7721
7726
|
#
|
7722
7727
|
# This section describes the latest revision of this action. We
|
7723
7728
|
# recommend that you use this revised API for application development.
|
7724
7729
|
# For backward compatibility, Amazon S3 continues to support the prior
|
7725
|
-
# version of this API, [ListObjects][
|
7730
|
+
# version of this API, [ListObjects][4].
|
7726
7731
|
#
|
7727
|
-
# To get a list of your buckets, see [ListBuckets][
|
7732
|
+
# To get a list of your buckets, see [ListBuckets][5].
|
7728
7733
|
#
|
7729
7734
|
# The following operations are related to `ListObjectsV2`\:
|
7730
7735
|
#
|
7731
|
-
# * [GetObject][
|
7736
|
+
# * [GetObject][6]
|
7732
7737
|
#
|
7733
|
-
# * [PutObject][
|
7738
|
+
# * [PutObject][7]
|
7734
7739
|
#
|
7735
|
-
# * [CreateBucket][
|
7740
|
+
# * [CreateBucket][8]
|
7736
7741
|
#
|
7737
7742
|
#
|
7738
7743
|
#
|
7739
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
7740
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-
|
7741
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7742
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
7743
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
7744
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
7745
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
7744
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html
|
7745
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
7746
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
7747
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html
|
7748
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html
|
7749
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
7750
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
7751
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
7746
7752
|
#
|
7747
7753
|
# @option params [required, String] :bucket
|
7748
7754
|
# Bucket name to list.
|
@@ -7752,7 +7758,7 @@ module Aws::S3
|
|
7752
7758
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
7753
7759
|
# When using this action with an access point through the AWS SDKs, you
|
7754
7760
|
# provide the access point ARN in place of the bucket name. For more
|
7755
|
-
# information about access point ARNs, see [Using
|
7761
|
+
# information about access point ARNs, see [Using access points][1] in
|
7756
7762
|
# the *Amazon S3 User Guide*.
|
7757
7763
|
#
|
7758
7764
|
# When using this action with Amazon S3 on Outposts, you must direct
|
@@ -7958,7 +7964,7 @@ module Aws::S3
|
|
7958
7964
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
7959
7965
|
# When using this action with an access point through the AWS SDKs, you
|
7960
7966
|
# provide the access point ARN in place of the bucket name. For more
|
7961
|
-
# information about access point ARNs, see [Using
|
7967
|
+
# information about access point ARNs, see [Using access points][1] in
|
7962
7968
|
# the *Amazon S3 User Guide*.
|
7963
7969
|
#
|
7964
7970
|
# When using this action with Amazon S3 on Outposts, you must direct
|
@@ -7994,7 +8000,7 @@ module Aws::S3
|
|
7994
8000
|
# request. Bucket owners need not specify this parameter in their
|
7995
8001
|
# requests. For information about downloading objects from requester
|
7996
8002
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
7997
|
-
# in the *Amazon S3
|
8003
|
+
# in the *Amazon S3 User Guide*.
|
7998
8004
|
#
|
7999
8005
|
#
|
8000
8006
|
#
|
@@ -8374,8 +8380,10 @@ module Aws::S3
|
|
8374
8380
|
# Allows grantee to read the bucket ACL.
|
8375
8381
|
#
|
8376
8382
|
# @option params [String] :grant_write
|
8377
|
-
# Allows grantee to create
|
8378
|
-
#
|
8383
|
+
# Allows grantee to create new objects in the bucket.
|
8384
|
+
#
|
8385
|
+
# For the bucket and object owners of existing objects, also allows
|
8386
|
+
# deletions and overwrites of those objects.
|
8379
8387
|
#
|
8380
8388
|
# @option params [String] :grant_write_acp
|
8381
8389
|
# Allows grantee to write the ACL for the applicable bucket.
|
@@ -9061,7 +9069,7 @@ module Aws::S3
|
|
9061
9069
|
# },
|
9062
9070
|
# id: "InventoryId", # required
|
9063
9071
|
# included_object_versions: "All", # required, accepts All, Current
|
9064
|
-
# optional_fields: ["Size"], # accepts Size, LastModifiedDate, StorageClass, ETag, IsMultipartUploaded, ReplicationStatus, EncryptionStatus, ObjectLockRetainUntilDate, ObjectLockMode, ObjectLockLegalHoldStatus, IntelligentTieringAccessTier
|
9072
|
+
# optional_fields: ["Size"], # accepts Size, LastModifiedDate, StorageClass, ETag, IsMultipartUploaded, ReplicationStatus, EncryptionStatus, ObjectLockRetainUntilDate, ObjectLockMode, ObjectLockLegalHoldStatus, IntelligentTieringAccessTier, BucketKeyStatus
|
9065
9073
|
# schedule: { # required
|
9066
9074
|
# frequency: "Daily", # required, accepts Daily, Weekly
|
9067
9075
|
# },
|
@@ -9207,8 +9215,7 @@ module Aws::S3
|
|
9207
9215
|
|
9208
9216
|
# Creates a new lifecycle configuration for the bucket or replaces an
|
9209
9217
|
# existing lifecycle configuration. For information about lifecycle
|
9210
|
-
# configuration, see [Managing
|
9211
|
-
# Resources][1].
|
9218
|
+
# configuration, see [Managing your storage lifecycle][1].
|
9212
9219
|
#
|
9213
9220
|
# <note markdown="1"> Bucket lifecycle configuration now supports specifying a lifecycle
|
9214
9221
|
# rule using an object key name prefix, one or more object tags, or a
|
@@ -9265,25 +9272,26 @@ module Aws::S3
|
|
9265
9272
|
# * s3:PutLifecycleConfiguration
|
9266
9273
|
#
|
9267
9274
|
# For more information about permissions, see [Managing Access
|
9268
|
-
# Permissions to Your Amazon S3 Resources][
|
9275
|
+
# Permissions to Your Amazon S3 Resources][5].
|
9269
9276
|
#
|
9270
9277
|
# The following are related to `PutBucketLifecycleConfiguration`\:
|
9271
9278
|
#
|
9272
|
-
# * [Examples of Lifecycle Configuration][
|
9279
|
+
# * [Examples of Lifecycle Configuration][6]
|
9273
9280
|
#
|
9274
|
-
# * [GetBucketLifecycleConfiguration][
|
9281
|
+
# * [GetBucketLifecycleConfiguration][7]
|
9275
9282
|
#
|
9276
|
-
# * [DeleteBucketLifecycle][
|
9283
|
+
# * [DeleteBucketLifecycle][8]
|
9277
9284
|
#
|
9278
9285
|
#
|
9279
9286
|
#
|
9280
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
9287
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html
|
9281
9288
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html
|
9282
9289
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
9283
9290
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html
|
9284
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9285
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9286
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
9291
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
9292
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-configuration-examples.html
|
9293
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html
|
9294
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html
|
9287
9295
|
#
|
9288
9296
|
# @option params [required, String] :bucket
|
9289
9297
|
# The name of the bucket for which to set the configuration.
|
@@ -10016,8 +10024,7 @@ module Aws::S3
|
|
10016
10024
|
end
|
10017
10025
|
|
10018
10026
|
# Creates a replication configuration or replaces an existing one. For
|
10019
|
-
# more information, see [Replication][1] in the *Amazon S3
|
10020
|
-
# Guide*.
|
10027
|
+
# more information, see [Replication][1] in the *Amazon S3 User Guide*.
|
10021
10028
|
#
|
10022
10029
|
# <note markdown="1"> To perform this operation, the user or role performing the action must
|
10023
10030
|
# have the [iam:PassRole][2] permission.
|
@@ -10308,11 +10315,12 @@ module Aws::S3
|
|
10308
10315
|
# values. For example, you can tag several resources with a specific
|
10309
10316
|
# application name, and then organize your billing information to see
|
10310
10317
|
# the total cost of that application across several services. For more
|
10311
|
-
# information, see [Cost Allocation and Tagging][1]
|
10318
|
+
# information, see [Cost Allocation and Tagging][1] and [Using Cost
|
10319
|
+
# Allocation in Amazon S3 Bucket Tags][2].
|
10312
10320
|
#
|
10313
|
-
# <note markdown="1">
|
10314
|
-
#
|
10315
|
-
#
|
10321
|
+
# <note markdown="1"> When this operation sets the tags for a bucket, it will overwrite any
|
10322
|
+
# current tags the bucket already has. You cannot use this operation to
|
10323
|
+
# add tags to an existing list of tags.
|
10316
10324
|
#
|
10317
10325
|
# </note>
|
10318
10326
|
#
|
@@ -10768,7 +10776,7 @@ module Aws::S3
|
|
10768
10776
|
# and high availability. Depending on performance needs, you can specify
|
10769
10777
|
# a different Storage Class. Amazon S3 on Outposts only uses the
|
10770
10778
|
# OUTPOSTS Storage Class. For more information, see [Storage Classes][6]
|
10771
|
-
# in the *Amazon S3
|
10779
|
+
# in the *Amazon S3 User Guide*.
|
10772
10780
|
#
|
10773
10781
|
# **Versioning**
|
10774
10782
|
#
|
@@ -10822,7 +10830,7 @@ module Aws::S3
|
|
10822
10830
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
10823
10831
|
# When using this action with an access point through the AWS SDKs, you
|
10824
10832
|
# provide the access point ARN in place of the bucket name. For more
|
10825
|
-
# information about access point ARNs, see [Using
|
10833
|
+
# information about access point ARNs, see [Using access points][1] in
|
10826
10834
|
# the *Amazon S3 User Guide*.
|
10827
10835
|
#
|
10828
10836
|
# When using this action with Amazon S3 on Outposts, you must direct
|
@@ -10947,7 +10955,7 @@ module Aws::S3
|
|
10947
10955
|
# and high availability. Depending on performance needs, you can specify
|
10948
10956
|
# a different Storage Class. Amazon S3 on Outposts only uses the
|
10949
10957
|
# OUTPOSTS Storage Class. For more information, see [Storage Classes][1]
|
10950
|
-
# in the *Amazon S3
|
10958
|
+
# in the *Amazon S3 User Guide*.
|
10951
10959
|
#
|
10952
10960
|
#
|
10953
10961
|
#
|
@@ -10999,14 +11007,12 @@ module Aws::S3
|
|
10999
11007
|
# If `x-amz-server-side-encryption` is present and has the value of
|
11000
11008
|
# `aws:kms`, this header specifies the ID of the AWS Key Management
|
11001
11009
|
# Service (AWS KMS) symmetrical customer managed customer master key
|
11002
|
-
# (CMK) that was used for the object.
|
11003
|
-
#
|
11004
|
-
# If the value of `x-amz-server-side-encryption` is `aws:kms`, this
|
11005
|
-
# header specifies the ID of the symmetric customer managed AWS KMS CMK
|
11006
|
-
# that will be used for the object. If you specify
|
11010
|
+
# (CMK) that was used for the object. If you specify
|
11007
11011
|
# `x-amz-server-side-encryption:aws:kms`, but do not provide`
|
11008
11012
|
# x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the AWS
|
11009
|
-
# managed CMK in AWS to protect the data.
|
11013
|
+
# managed CMK in AWS to protect the data. If the KMS key does not exist
|
11014
|
+
# in the same account issuing the command, you must use the full ARN and
|
11015
|
+
# not just the ID.
|
11010
11016
|
#
|
11011
11017
|
# @option params [String] :ssekms_encryption_context
|
11012
11018
|
# Specifies the AWS KMS Encryption Context to use for object encryption.
|
@@ -11027,7 +11033,7 @@ module Aws::S3
|
|
11027
11033
|
# request. Bucket owners need not specify this parameter in their
|
11028
11034
|
# requests. For information about downloading objects from requester
|
11029
11035
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
11030
|
-
# in the *Amazon S3
|
11036
|
+
# in the *Amazon S3 User Guide*.
|
11031
11037
|
#
|
11032
11038
|
#
|
11033
11039
|
#
|
@@ -11042,6 +11048,7 @@ module Aws::S3
|
|
11042
11048
|
#
|
11043
11049
|
# @option params [Time,DateTime,Date,Integer,String] :object_lock_retain_until_date
|
11044
11050
|
# The date and time when you want this object's Object Lock to expire.
|
11051
|
+
# Must be formatted as a timestamp parameter.
|
11045
11052
|
#
|
11046
11053
|
# @option params [String] :object_lock_legal_hold_status
|
11047
11054
|
# Specifies whether a legal hold will be applied to this object. For
|
@@ -11070,38 +11077,21 @@ module Aws::S3
|
|
11070
11077
|
# * {Types::PutObjectOutput#request_charged #request_charged} => String
|
11071
11078
|
#
|
11072
11079
|
#
|
11073
|
-
# @example Example: To upload an object
|
11080
|
+
# @example Example: To upload an object
|
11074
11081
|
#
|
11075
|
-
# # The following example uploads an object
|
11076
|
-
# # S3 returns
|
11082
|
+
# # The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file
|
11083
|
+
# # syntax. S3 returns VersionId of the newly created object.
|
11077
11084
|
#
|
11078
11085
|
# resp = client.put_object({
|
11079
|
-
# body: "
|
11086
|
+
# body: "HappyFace.jpg",
|
11080
11087
|
# bucket: "examplebucket",
|
11081
11088
|
# key: "HappyFace.jpg",
|
11082
|
-
# tagging: "key1=value1&key2=value2",
|
11083
|
-
# })
|
11084
|
-
#
|
11085
|
-
# resp.to_h outputs the following:
|
11086
|
-
# {
|
11087
|
-
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11088
|
-
# version_id: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a",
|
11089
|
-
# }
|
11090
|
-
#
|
11091
|
-
# @example Example: To create an object.
|
11092
|
-
#
|
11093
|
-
# # The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
|
11094
|
-
#
|
11095
|
-
# resp = client.put_object({
|
11096
|
-
# body: "filetoupload",
|
11097
|
-
# bucket: "examplebucket",
|
11098
|
-
# key: "objectkey",
|
11099
11089
|
# })
|
11100
11090
|
#
|
11101
11091
|
# resp.to_h outputs the following:
|
11102
11092
|
# {
|
11103
11093
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11104
|
-
# version_id: "
|
11094
|
+
# version_id: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk",
|
11105
11095
|
# }
|
11106
11096
|
#
|
11107
11097
|
# @example Example: To upload object and specify user-defined metadata
|
@@ -11125,21 +11115,40 @@ module Aws::S3
|
|
11125
11115
|
# version_id: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0",
|
11126
11116
|
# }
|
11127
11117
|
#
|
11128
|
-
# @example Example: To upload an object
|
11118
|
+
# @example Example: To upload an object (specify optional headers)
|
11129
11119
|
#
|
11130
|
-
# # The following example uploads an object
|
11131
|
-
# #
|
11120
|
+
# # The following example uploads an object. The request specifies optional request headers to directs S3 to use specific
|
11121
|
+
# # storage class and use server-side encryption.
|
11132
11122
|
#
|
11133
11123
|
# resp = client.put_object({
|
11134
11124
|
# body: "HappyFace.jpg",
|
11135
11125
|
# bucket: "examplebucket",
|
11136
11126
|
# key: "HappyFace.jpg",
|
11127
|
+
# server_side_encryption: "AES256",
|
11128
|
+
# storage_class: "STANDARD_IA",
|
11137
11129
|
# })
|
11138
11130
|
#
|
11139
11131
|
# resp.to_h outputs the following:
|
11140
11132
|
# {
|
11141
11133
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11142
|
-
#
|
11134
|
+
# server_side_encryption: "AES256",
|
11135
|
+
# version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp",
|
11136
|
+
# }
|
11137
|
+
#
|
11138
|
+
# @example Example: To create an object.
|
11139
|
+
#
|
11140
|
+
# # The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
|
11141
|
+
#
|
11142
|
+
# resp = client.put_object({
|
11143
|
+
# body: "filetoupload",
|
11144
|
+
# bucket: "examplebucket",
|
11145
|
+
# key: "objectkey",
|
11146
|
+
# })
|
11147
|
+
#
|
11148
|
+
# resp.to_h outputs the following:
|
11149
|
+
# {
|
11150
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11151
|
+
# version_id: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ",
|
11143
11152
|
# }
|
11144
11153
|
#
|
11145
11154
|
# @example Example: To upload an object and specify server-side encryption and object tags
|
@@ -11162,42 +11171,40 @@ module Aws::S3
|
|
11162
11171
|
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
11163
11172
|
# }
|
11164
11173
|
#
|
11165
|
-
# @example Example: To upload an object and specify
|
11174
|
+
# @example Example: To upload an object and specify optional tags
|
11166
11175
|
#
|
11167
|
-
# # The following example uploads
|
11168
|
-
# #
|
11176
|
+
# # The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore
|
11177
|
+
# # S3 returns version ID of the newly created object.
|
11169
11178
|
#
|
11170
11179
|
# resp = client.put_object({
|
11171
|
-
#
|
11172
|
-
# body: "filetoupload",
|
11180
|
+
# body: "c:\\HappyFace.jpg",
|
11173
11181
|
# bucket: "examplebucket",
|
11174
|
-
# key: "
|
11182
|
+
# key: "HappyFace.jpg",
|
11183
|
+
# tagging: "key1=value1&key2=value2",
|
11175
11184
|
# })
|
11176
11185
|
#
|
11177
11186
|
# resp.to_h outputs the following:
|
11178
11187
|
# {
|
11179
11188
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11180
|
-
# version_id: "
|
11189
|
+
# version_id: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a",
|
11181
11190
|
# }
|
11182
11191
|
#
|
11183
|
-
# @example Example: To upload an object
|
11192
|
+
# @example Example: To upload an object and specify canned ACL.
|
11184
11193
|
#
|
11185
|
-
# # The following example uploads
|
11186
|
-
# #
|
11194
|
+
# # The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ
|
11195
|
+
# # access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.
|
11187
11196
|
#
|
11188
11197
|
# resp = client.put_object({
|
11189
|
-
#
|
11198
|
+
# acl: "authenticated-read",
|
11199
|
+
# body: "filetoupload",
|
11190
11200
|
# bucket: "examplebucket",
|
11191
|
-
# key: "
|
11192
|
-
# server_side_encryption: "AES256",
|
11193
|
-
# storage_class: "STANDARD_IA",
|
11201
|
+
# key: "exampleobject",
|
11194
11202
|
# })
|
11195
11203
|
#
|
11196
11204
|
# resp.to_h outputs the following:
|
11197
11205
|
# {
|
11198
11206
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11199
|
-
#
|
11200
|
-
# version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp",
|
11207
|
+
# version_id: "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr",
|
11201
11208
|
# }
|
11202
11209
|
#
|
11203
11210
|
# @example Streaming a file from disk
|
@@ -11280,7 +11287,7 @@ module Aws::S3
|
|
11280
11287
|
# if you have an existing application that updates a bucket ACL using
|
11281
11288
|
# the request body, you can continue to use that approach. For more
|
11282
11289
|
# information, see [Access Control List (ACL) Overview][2] in the
|
11283
|
-
# *Amazon S3
|
11290
|
+
# *Amazon S3 User Guide*.
|
11284
11291
|
#
|
11285
11292
|
# **Access Permissions**
|
11286
11293
|
#
|
@@ -11440,7 +11447,7 @@ module Aws::S3
|
|
11440
11447
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11441
11448
|
# When using this action with an access point through the AWS SDKs, you
|
11442
11449
|
# provide the access point ARN in place of the bucket name. For more
|
11443
|
-
# information about access point ARNs, see [Using
|
11450
|
+
# information about access point ARNs, see [Using access points][1] in
|
11444
11451
|
# the *Amazon S3 User Guide*.
|
11445
11452
|
#
|
11446
11453
|
#
|
@@ -11477,8 +11484,10 @@ module Aws::S3
|
|
11477
11484
|
# This action is not supported by Amazon S3 on Outposts.
|
11478
11485
|
#
|
11479
11486
|
# @option params [String] :grant_write
|
11480
|
-
# Allows grantee to create
|
11481
|
-
#
|
11487
|
+
# Allows grantee to create new objects in the bucket.
|
11488
|
+
#
|
11489
|
+
# For the bucket and object owners of existing objects, also allows
|
11490
|
+
# deletions and overwrites of those objects.
|
11482
11491
|
#
|
11483
11492
|
# @option params [String] :grant_write_acp
|
11484
11493
|
# Allows grantee to write the ACL for the applicable bucket.
|
@@ -11493,7 +11502,7 @@ module Aws::S3
|
|
11493
11502
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11494
11503
|
# When using this action with an access point through the AWS SDKs, you
|
11495
11504
|
# provide the access point ARN in place of the bucket name. For more
|
11496
|
-
# information about access point ARNs, see [Using
|
11505
|
+
# information about access point ARNs, see [Using access points][1] in
|
11497
11506
|
# the *Amazon S3 User Guide*.
|
11498
11507
|
#
|
11499
11508
|
# When using this action with Amazon S3 on Outposts, you must direct
|
@@ -11515,7 +11524,7 @@ module Aws::S3
|
|
11515
11524
|
# request. Bucket owners need not specify this parameter in their
|
11516
11525
|
# requests. For information about downloading objects from requester
|
11517
11526
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
11518
|
-
# in the *Amazon S3
|
11527
|
+
# in the *Amazon S3 User Guide*.
|
11519
11528
|
#
|
11520
11529
|
#
|
11521
11530
|
#
|
@@ -11618,7 +11627,7 @@ module Aws::S3
|
|
11618
11627
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11619
11628
|
# When using this action with an access point through the AWS SDKs, you
|
11620
11629
|
# provide the access point ARN in place of the bucket name. For more
|
11621
|
-
# information about access point ARNs, see [Using
|
11630
|
+
# information about access point ARNs, see [Using access points][1] in
|
11622
11631
|
# the *Amazon S3 User Guide*.
|
11623
11632
|
#
|
11624
11633
|
#
|
@@ -11637,7 +11646,7 @@ module Aws::S3
|
|
11637
11646
|
# request. Bucket owners need not specify this parameter in their
|
11638
11647
|
# requests. For information about downloading objects from requester
|
11639
11648
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
11640
|
-
# in the *Amazon S3
|
11649
|
+
# in the *Amazon S3 User Guide*.
|
11641
11650
|
#
|
11642
11651
|
#
|
11643
11652
|
#
|
@@ -11721,7 +11730,7 @@ module Aws::S3
|
|
11721
11730
|
# request. Bucket owners need not specify this parameter in their
|
11722
11731
|
# requests. For information about downloading objects from requester
|
11723
11732
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
11724
|
-
# in the *Amazon S3
|
11733
|
+
# in the *Amazon S3 User Guide*.
|
11725
11734
|
#
|
11726
11735
|
#
|
11727
11736
|
#
|
@@ -11796,7 +11805,7 @@ module Aws::S3
|
|
11796
11805
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11797
11806
|
# When using this action with an access point through the AWS SDKs, you
|
11798
11807
|
# provide the access point ARN in place of the bucket name. For more
|
11799
|
-
# information about access point ARNs, see [Using
|
11808
|
+
# information about access point ARNs, see [Using access points][1] in
|
11800
11809
|
# the *Amazon S3 User Guide*.
|
11801
11810
|
#
|
11802
11811
|
#
|
@@ -11815,7 +11824,7 @@ module Aws::S3
|
|
11815
11824
|
# request. Bucket owners need not specify this parameter in their
|
11816
11825
|
# requests. For information about downloading objects from requester
|
11817
11826
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
11818
|
-
# in the *Amazon S3
|
11827
|
+
# in the *Amazon S3 User Guide*.
|
11819
11828
|
#
|
11820
11829
|
#
|
11821
11830
|
#
|
@@ -11938,7 +11947,7 @@ module Aws::S3
|
|
11938
11947
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11939
11948
|
# When using this action with an access point through the AWS SDKs, you
|
11940
11949
|
# provide the access point ARN in place of the bucket name. For more
|
11941
|
-
# information about access point ARNs, see [Using
|
11950
|
+
# information about access point ARNs, see [Using access points][1] in
|
11942
11951
|
# the *Amazon S3 User Guide*.
|
11943
11952
|
#
|
11944
11953
|
# When using this action with Amazon S3 on Outposts, you must direct
|
@@ -11980,7 +11989,7 @@ module Aws::S3
|
|
11980
11989
|
# request. Bucket owners need not specify this parameter in their
|
11981
11990
|
# requests. For information about downloading objects from requester
|
11982
11991
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
11983
|
-
# in the *Amazon S3
|
11992
|
+
# in the *Amazon S3 User Guide*.
|
11984
11993
|
#
|
11985
11994
|
#
|
11986
11995
|
#
|
@@ -12382,7 +12391,7 @@ module Aws::S3
|
|
12382
12391
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
12383
12392
|
# When using this action with an access point through the AWS SDKs, you
|
12384
12393
|
# provide the access point ARN in place of the bucket name. For more
|
12385
|
-
# information about access point ARNs, see [Using
|
12394
|
+
# information about access point ARNs, see [Using access points][1] in
|
12386
12395
|
# the *Amazon S3 User Guide*.
|
12387
12396
|
#
|
12388
12397
|
# When using this action with Amazon S3 on Outposts, you must direct
|
@@ -12413,7 +12422,7 @@ module Aws::S3
|
|
12413
12422
|
# request. Bucket owners need not specify this parameter in their
|
12414
12423
|
# requests. For information about downloading objects from requester
|
12415
12424
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
12416
|
-
# in the *Amazon S3
|
12425
|
+
# in the *Amazon S3 User Guide*.
|
12417
12426
|
#
|
12418
12427
|
#
|
12419
12428
|
#
|
@@ -13086,7 +13095,7 @@ module Aws::S3
|
|
13086
13095
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
13087
13096
|
# When using this action with an access point through the AWS SDKs, you
|
13088
13097
|
# provide the access point ARN in place of the bucket name. For more
|
13089
|
-
# information about access point ARNs, see [Using
|
13098
|
+
# information about access point ARNs, see [Using access points][1] in
|
13090
13099
|
# the *Amazon S3 User Guide*.
|
13091
13100
|
#
|
13092
13101
|
# When using this action with Amazon S3 on Outposts, you must direct
|
@@ -13146,7 +13155,7 @@ module Aws::S3
|
|
13146
13155
|
# request. Bucket owners need not specify this parameter in their
|
13147
13156
|
# requests. For information about downloading objects from requester
|
13148
13157
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
13149
|
-
# in the *Amazon S3
|
13158
|
+
# in the *Amazon S3 User Guide*.
|
13150
13159
|
#
|
13151
13160
|
#
|
13152
13161
|
#
|
@@ -13360,7 +13369,7 @@ module Aws::S3
|
|
13360
13369
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
13361
13370
|
# When using this action with an access point through the AWS SDKs, you
|
13362
13371
|
# provide the access point ARN in place of the bucket name. For more
|
13363
|
-
# information about access point ARNs, see [Using
|
13372
|
+
# information about access point ARNs, see [Using access points][1] in
|
13364
13373
|
# the *Amazon S3 User Guide*.
|
13365
13374
|
#
|
13366
13375
|
# When using this action with Amazon S3 on Outposts, you must direct
|
@@ -13491,7 +13500,7 @@ module Aws::S3
|
|
13491
13500
|
# request. Bucket owners need not specify this parameter in their
|
13492
13501
|
# requests. For information about downloading objects from requester
|
13493
13502
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
13494
|
-
# in the *Amazon S3
|
13503
|
+
# in the *Amazon S3 User Guide*.
|
13495
13504
|
#
|
13496
13505
|
#
|
13497
13506
|
#
|
@@ -13910,7 +13919,7 @@ module Aws::S3
|
|
13910
13919
|
params: params,
|
13911
13920
|
config: config)
|
13912
13921
|
context[:gem_name] = 'aws-sdk-s3'
|
13913
|
-
context[:gem_version] = '1.
|
13922
|
+
context[:gem_version] = '1.97.0'
|
13914
13923
|
Seahorse::Client::Request.new(handlers, context)
|
13915
13924
|
end
|
13916
13925
|
|